https://github.com/arkworks-rs/snark

Interfaces for Relations and SNARKs for these relations

https://github.com/arkworks-rs/snark

Science Score: 36.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    5 of 30 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.0%) to scientific vocabulary

Keywords

cryptography r1cs zero-knowledge-proofs

Keywords from Contributors

pairings zksnark elliptic-curves finite-fields polynomials snark groth16 marlin polynomial-commitments sonic
Last synced: 5 months ago · JSON representation

Repository

Interfaces for Relations and SNARKs for these relations

Basic Info
  • Host: GitHub
  • Owner: arkworks-rs
  • License: apache-2.0
  • Language: Rust
  • Default Branch: master
  • Homepage: https://www.arkworks.rs
  • Size: 2.21 MB
Statistics
  • Stars: 875
  • Watchers: 34
  • Forks: 246
  • Open Issues: 35
  • Releases: 1
Topics
cryptography r1cs zero-knowledge-proofs
Created almost 7 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License

README.md

SNARK and Relation Traits

The arkworks ecosystem consists of Rust libraries for designing and working with zero knowledge succinct non-interactive arguments (zkSNARKs). This repository contains efficient libraries that describe interfaces for zkSNARKs, as well as interfaces for programming them.

This library is released under the MIT License and the Apache v2 License (see License).

WARNING: This is an academic proof-of-concept prototype, and in particular has not received careful code review. This implementation is NOT ready for production use.

Directory structure

This repository contains two Rust crates:

  • ark-snark: Provides generic traits for zkSNARKs
  • ark-relations: Provides generic traits for NP relations used in programming zkSNARKs, such as R1CS

Overview

This repository provides the core infrastructure for using the succinct argument systems that arkworks provides. Users who want to produce arguments about various problems of interest will first reduce those problems to an NP relation, various examples of which are defined in the ark-relations crate. Then a SNARK system defined over that relation is used to produce a succinct argument. The ark-snark crate defines a SNARK trait that encapsulates the general functionality, as well as specific traits for various types of SNARK (those with transparent and universal setup, for instance). Different repositories within the arkworks ecosystem implement this trait for various specific SNARK constructions, such as Groth16, GM17, and Marlin.

Build guide

The library compiles on the stable toolchain of the Rust compiler. To install the latest version of Rust, first install rustup by following the instructions here, or via your platform's package manager. Once rustup is installed, install the Rust toolchain by invoking: bash rustup install stable

After that, use cargo, the standard Rust build tool, to build the libraries: bash git clone https://github.com/arkworks-rs/snark.git cd snark cargo build --release

Tests

This library comes with comprehensive unit and integration tests for each of the provided crates. Run the tests with: bash cargo test --all

License

The crates in this repo are licensed under either of the following licenses, at your discretion.

  • Apache License Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Unless you explicitly state otherwise, any contribution submitted for inclusion in this library by you shall be dual licensed as above (as defined in the Apache v2 License), without any additional terms or conditions.

Acknowledgements

This work was supported by: a Google Faculty Award; the National Science Foundation; the UC Berkeley Center for Long-Term Cybersecurity; and donations from the Ethereum Foundation, the Interchain Foundation, and Qtum.

An earlier version of this library was developed as part of the paper "ZEXE: Enabling Decentralized Private Computation".

Owner

  • Name: arkworks
  • Login: arkworks-rs
  • Kind: organization

An ecosystem for developing and programming with zkSNARKs

GitHub Events

Total
  • Issues event: 1
  • Watch event: 81
  • Issue comment event: 13
  • Push event: 49
  • Pull request review comment event: 46
  • Pull request review event: 35
  • Pull request event: 62
  • Fork event: 33
  • Create event: 10
Last Year
  • Issues event: 1
  • Watch event: 81
  • Issue comment event: 13
  • Push event: 49
  • Pull request review comment event: 46
  • Pull request review event: 35
  • Pull request event: 62
  • Fork event: 33
  • Create event: 10

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 480
  • Total Committers: 30
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.548
Past Year
  • Commits: 5
  • Committers: 4
  • Avg Commits per committer: 1.25
  • Development Distribution Score (DDS): 0.6
Top Committers
Name Email Commits
Pratyush Mishra p****a@b****u 217
jon-chuang 9****g@u****m 54
Kobi Gurkan k****k@g****m 31
Youssef El Housni y****1@g****m 30
François Garillot f****s@g****t 28
ValarDragon d****2@g****m 18
Pascal Berrang c****t@p****t 17
Georgios Konstantopoulos me@g****m 14
Weikeng Chen w****k@b****u 14
Howard Wu h****u@b****u 12
debris m****z@g****m 10
Dev Ojha V****n@u****m 7
Sergey Vasilyev s****v@g****m 5
dependabot-preview[bot] 2****]@u****m 4
mmagician m****4@p****m 3
Dimitris Apostolou d****u@i****m 2
ChenxingLi l****7@g****m 1
Antoine Rondelet r****e@g****m 1
Noah Vesely f****s@r****t 1
Fedor Sakharov f****v@g****m 1
Pascal Berrang p****l@g****m 1
Cheng XU g****t@x****e 1
Nicholas Ward n****d@b****u 1
onewayfunc 5****c@u****m 1
Bruno França 4****a@u****m 1
savil s****l@c****u 1
Ryan Lehmkuhl r****b@g****m 1
Ralph Giles g****s@t****t 1
oblivious-app 5****p@u****m 1
혜민 Hyemin Lee 4****e@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 40
  • Total pull requests: 130
  • Average time to close issues: 6 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 13
  • Total pull request authors: 41
  • Average comments per issue: 3.35
  • Average comments per pull request: 1.22
  • Merged pull requests: 50
  • Bot issues: 0
  • Bot pull requests: 6
Past Year
  • Issues: 0
  • Pull requests: 61
  • Average time to close issues: N/A
  • Average time to close pull requests: 30 days
  • Issue authors: 0
  • Pull request authors: 19
  • Average comments per issue: 0
  • Average comments per pull request: 0.23
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Pratyush (12)
  • weikengchen (9)
  • ValarDragon (5)
  • tsunrise (3)
  • brucechin (2)
  • jon-chuang (2)
  • yizhihuaqi (1)
  • amyzx (1)
  • yuquan1210 (1)
  • mmagician (1)
  • gakonst (1)
  • saurabhchalke (1)
  • BoyuanFeng (1)
Pull Request Authors
  • Pratyush (26)
  • jon-chuang (9)
  • kobigurk (9)
  • dependabot-preview[bot] (6)
  • ValarDragon (6)
  • mmagician (5)
  • MozirDmitriy (4)
  • weikengchen (4)
  • VolodymyrBg (4)
  • yelhousni (4)
  • crStiv (4)
  • famouswizard (3)
  • alireza-shirzad (3)
  • GarmashAlex (3)
  • cypriansakwa (2)
Top Labels
Issue Labels
T-feature (7) D-easy (4) T-design (4) D-hard (4) P-medium (4) T-performance (2) T-test (1) D-medium (1)
Pull Request Labels
dependencies (6)

Packages

  • Total packages: 3
  • Total downloads:
    • cargo 8,485,503 total
  • Total docker downloads: 7,606
  • Total dependent packages: 75
    (may contain duplicates)
  • Total dependent repositories: 1,189
    (may contain duplicates)
  • Total versions: 20
  • Total maintainers: 2
crates.io: ark-relations

A library for rank-one constraint systems

  • Versions: 7
  • Dependent Packages: 60
  • Dependent Repositories: 679
  • Downloads: 4,629,988 Total
  • Docker Downloads: 7,565
Rankings
Dependent packages count: 0.8%
Dependent repos count: 1.6%
Downloads: 1.8%
Docker downloads count: 1.9%
Average: 2.9%
Forks count: 4.6%
Stargazers count: 6.6%
Maintainers (1)
Last synced: 6 months ago
crates.io: ark-snark

A library for SNARK traits

  • Versions: 6
  • Dependent Packages: 15
  • Dependent Repositories: 510
  • Downloads: 3,846,259 Total
  • Docker Downloads: 41
Rankings
Dependent repos count: 1.8%
Downloads: 2.0%
Dependent packages count: 2.6%
Average: 3.5%
Forks count: 4.6%
Stargazers count: 6.6%
Maintainers (1)
Last synced: 6 months ago
crates.io: ark-relations-zkhub

A library for rank-one constraint systems

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 9,256 Total
Rankings
Dependent repos count: 29.8%
Dependent packages count: 35.1%
Average: 53.8%
Downloads: 96.5%
Maintainers (1)
Last synced: 6 months ago

Dependencies

relations/Cargo.toml cargo
  • ark-test-curves ^0.3.0 development
  • ark-ff ^0.3.0
  • ark-std ^0.3.0
  • tracing 0.1
  • tracing-subscriber 0.2
.github/workflows/ci.yml actions
  • actions-rs/cargo v1 composite
  • actions-rs/toolchain v1 composite
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/checkout v1 composite
.github/workflows/linkify_changelog.yml actions
  • actions/checkout v2 composite
Cargo.toml cargo
snark/Cargo.toml cargo