celer-gnark

A copy of celer-gnark for icicle integration

https://github.com/ingonyama-zk/celer-gnark

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary

Keywords from Contributors

cryptography pairing zksnark zkp snark mimc hash-to-curve fri finite-field-arithmetic elliptic-curves
Last synced: 7 months ago · JSON representation ·

Repository

A copy of celer-gnark for icicle integration

Basic Info
  • Host: GitHub
  • Owner: ingonyama-zk
  • License: apache-2.0
  • Language: Go
  • Default Branch: icicle-integration
  • Size: 8.25 MB
Statistics
  • Stars: 1
  • Watchers: 6
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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

Useful Links

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 been partially 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

  • [x] BN254
  • [x] BLS12-381
  • [x] BLS12-377
  • [x] BW6-761
  • [x] BLS24-315
  • [x] BW6-633
  • [x] BLS24-317

Example

Refer to the gnark User Documentation

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

```golang package main

import ( "github.com/consensys/gnark-crypto/ecc" "github.com/consensys/gnark/backend/groth16" "github.com/consensys/gnark/frontend" "github.com/consensys/gnark/frontend/cs/r1cs" )

// 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 }

func main() { // compiles our circuit into a R1CS var circuit CubicCircuit ccs, _ := frontend.Compile(ecc.BN254.ScalarField(), r1cs.NewBuilder, &circuit)

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

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

// groth16: Prove & Verify
proof, _ := groth16.Prove(ccs, pk, witness)
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.

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

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

Owner

  • Name: Ingonyama
  • Login: ingonyama-zk
  • Kind: organization
  • Email: hi@ingonyama.com

Shipping the world's fastest provers

Citation (CITATION.bib)

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

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 1,615
  • Total Committers: 23
  • Avg Commits per committer: 70.217
  • Development Distribution Score (DDS): 0.485
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Gautam Botrel g****l@g****m 831
Thomas Piellard t****d@c****t 394
Ivo Kubjas i****s@c****t 189
Youssef El Housni y****1@g****m 85
Arya Tabaie a****e@g****m 48
liuxiaobleach 1****7@q****m 21
Jeremy Felder j****1@g****m 10
Gus Gutoski g****i@p****m 10
Hisham Galal 0****l@g****m 4
Behrouz b****i@y****m 4
ImmanuelSegol 3****s@g****m 4
SherLzp l****r@g****m 2
Nicolas Liochon l****n@g****m 2
AlexandreBelling a****8@g****m 2
Elliott He e****e@o****m 1
Henry Harder h****9@g****m 1
Luiz Hamilton Soares l****9@g****m 1
Mikerah m****4@g****m 1
Nikolai Golub n****b@g****m 1
liyue201 l****1@1****m 1
omahs 7****s 1
mottla w****s@o****m 1
tinywell z****w@1****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 15
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.27
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • liuxiaobleach (6)
  • ImmanuelSegol (3)
Top Labels
Issue Labels
Pull Request Labels