gnark

package module
v0.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 4, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

README

gnark zk-SNARK library

Twitter URL License Go Report Card PkgGoDev Documentation Status DOI

gnark is a fast zk-SNARK library that offers a high-level API to design circuits. The library is open source and developed under the Apache 2.0 license

gnark Users

To get started with gnark and write your first circuit, follow these instructions.

Checkout the online playground to compile circuits and visualize constraint systems.

Warning

gnark has not been audited and is provided as-is, we make no guarantees or warranties to its safety and reliability. In particular, gnark makes no security guarantees such as constant time implementation or side-channel attack resistance.

gnark and gnark-crypto packages are optimized for 64bits architectures (x86 amd64) and tested on Unix (Linux / macOS).

Issues

gnark issues are tracked in the GitHub issues tab.

To report a security bug, please refer to gnark Security Policy.

If you have any questions, queries or comments, GitHub discussions is the place to find us.

You can also get in touch directly: gnark@consensys.net

Release Notes

Release Notes

Proving schemes and curves

Refer to Proving schemes and curves for more details.

gnark support the following zk-SNARKs:

which can be instantiated with the following curves

  • BN254
  • BLS12-381
  • BLS12-377
  • BW6-761
  • BLS24-315
  • BW6-633
Example

Refer to the gnark User Documentation

Here is what x**3 + x + 5 = y looks like

// CubicCircuit defines a simple circuit
// x**3 + x + 5 == y
type CubicCircuit struct {
	// struct tags on a variable is optional
	// default uses variable name and secret visibility.
	X frontend.Variable `gnark:"x"`
	Y frontend.Variable `gnark:",public"`
}

// Define declares the circuit constraints
// x**3 + x + 5 == y
func (circuit *CubicCircuit) Define(api frontend.API) error {
	x3 := api.Mul(circuit.X, circuit.X, circuit.X)
	api.AssertIsEqual(circuit.Y, api.Add(x3, circuit.X, 5))
	return nil
}

// compiles our circuit into a R1CS
var circuit CubicCircuit
ccs, err := frontend.Compile(ecc.BN254, r1cs.NewBuilder, &circuit)

// groth16 zkSNARK: Setup
pk, vk, err := groth16.Setup(ccs)

// witness definition
assignment := CubicCircuit{X: 3, Y: 35}
witness, err := frontend.NewWitness(&assignment, ecc.BN254)
publicWitness, _ := witness.Public()

// groth16: Prove & Verify
proof, err := groth16.Prove(ccs, pk, witness)
err := groth16.Verify(proof, vk, publicWitness)

Citing

If you use gnark in your research a citation would be appreciated. Please use the following BibTeX to cite the most recent release.

@software{gnark-v0.6.4,
  author       = {Gautam Botrel and
                  Thomas Piellard and
                  Youssef El Housni and
                  Ivo Kubjas and
                  Arya Tabaie},
  title        = {ConsenSys/gnark: v0.6.4},
  month        = feb,
  year         = 2022,
  publisher    = {Zenodo},
  version      = {v0.6.4},
  doi          = {10.5281/zenodo.6093969},
  url          = {https://doi.org/10.5281/zenodo.6093969}
}

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache 2 License - see the LICENSE file for details

Documentation

Overview

Package gnark provides fast Zero Knowledge Proofs (ZKP) systems and a high level APIs to design ZKP circuits.

gnark supports the following ZKP schemes:

  • Groth16
  • PLONK

gnark supports the following curves:

  • BN254
  • BLS12_377
  • BLS12_381
  • BW6_761
  • BLS24_315
  • BW6_633

User documentation https://docs.gnark.consensys.net

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Curves 

func Curves() []ecc.ID

Curves return the curves supported by gnark

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
Package backend implements Zero Knowledge Proof systems: it consumes circuit compiled with gnark/frontend.
 Package backend implements Zero Knowledge Proof systems: it consumes circuit compiled with gnark/frontend.
groth16
Package groth16 implements Groth16 Zero Knowledge Proof system (aka zkSNARK).
 Package groth16 implements Groth16 Zero Knowledge Proof system (aka zkSNARK).
hint
Package hint allows to define computations outside of a circuit.
 Package hint allows to define computations outside of a circuit.
plonk
Package plonk implements PLONK Zero Knowledge Proof system.
 Package plonk implements PLONK Zero Knowledge Proof system.
witness
Package witness provides serialization helpers to encode a witness into a []byte.
 Package witness provides serialization helpers to encode a witness into a []byte.
examples
cubic
exponentiate
mimc
plonk
rollup
serialization
compiled
cs
cs/r1cs
cs/scs
schema
internal
backend/bls12-377/cs
backend/bls12-377/groth16
backend/bls12-377/plonk
backend/bls12-377/witness
backend/bls12-381/cs
backend/bls12-381/groth16
backend/bls12-381/plonk
backend/bls12-381/witness
backend/bls24-315/cs
backend/bls24-315/groth16
backend/bls24-315/plonk
backend/bls24-315/witness
backend/bn254/cs
backend/bn254/groth16
backend/bn254/plonk
backend/bn254/witness
backend/bw6-633/cs
backend/bw6-633/groth16
backend/bw6-633/plonk
backend/bw6-633/witness
backend/bw6-761/cs
backend/bw6-761/groth16
backend/bw6-761/plonk
backend/bw6-761/witness
backend/circuits
Package circuits contains test circuits
 Package circuits contains test circuits
backend/ioutils
generator/backend
stats
stats/generate
utils
Package io offers serialization interfaces for gnark objects.
 Package io offers serialization interfaces for gnark objects.
Package logger provides a configurable logger accross gnark components
 Package logger provides a configurable logger accross gnark components
std
Package std provides components or functions to help design gnark circuits.
 Package std provides components or functions to help design gnark circuits.
accumulator/merkle
Package merkle provides a ZKP-circuit function to verify merkle proofs.
 Package merkle provides a ZKP-circuit function to verify merkle proofs.
algebra/fields_bls12377
algebra/fields_bls24315
algebra/sw_bls12377
Package sw (short weierstrass)
 Package sw (short weierstrass)
algebra/sw_bls24315
Package sw (short weierstrass)
 Package sw (short weierstrass)
algebra/twistededwards
fiat-shamir
groth16_bls12377
Package groth16_bls12377 provides a ZKP-circuit function to verify BLS12_377 Groth16 inside a BW6_761 circuit.
 Package groth16_bls12377 provides a ZKP-circuit function to verify BLS12_377 Groth16 inside a BW6_761 circuit.
groth16_bls24315
Package groth16_bls24315 provides a ZKP-circuit function to verify BLS24-315 Groth16 inside a BW6-633 circuit.
 Package groth16_bls24315 provides a ZKP-circuit function to verify BLS24-315 Groth16 inside a BW6-633 circuit.
hash
Package hash provides an interface that hash functions (as gadget) should implement.
 Package hash provides an interface that hash functions (as gadget) should implement.
hash/mimc
Package mimc provides a ZKP-circuit function to compute a MiMC hash.
 Package mimc provides a ZKP-circuit function to compute a MiMC hash.
math/bits
signature/eddsa
Package eddsa provides a ZKP-circuit function to verify a EdDSA signature.
 Package eddsa provides a ZKP-circuit function to verify a EdDSA signature.
Package test provides components or functions to help test and fuzz gnark circuits.
 Package test provides components or functions to help test and fuzz gnark circuits.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.