The arkworks ecosystem consist of Rust libraries for designing and working with zero knowledge succinct non-interactive arguments (zkSNARKs). This repository contains efficient implementations some of the key algebraic components underlying zkSNARKs: finite fields, elliptic curves, and polynomials.
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.
This repository contains several Rust crates:
ark-ff
: Provides generic implementations of various finite fieldsark-ec
: Provides generic implementations for different kinds of elliptic curves, along with pairings over theseark-poly
: Implements univariate, multivariate, and multilinear polynomials, and FFTs over finite fields.ark-serialize
: Provides efficient serialization and point compression for finite fields and elliptic curves
In addition, the curves
repository contains implementations of popular elliptic curves; see here for details.
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:
rustup install stable
After that, use cargo
, the standard Rust build tool, to build the libraries:
git clone https://github.com/arkworks-rs/algebra.git
cd algebra
cargo build --release
This library comes with comprehensive unit and integration tests for each of the provided crates. Run the tests with:
cargo test --all
To run the benchmarks, install the nightly Rust toolchain, via rustup install nightly
, and then run the following command:
cargo +nightly bench
The ark-ff
crate contains (off-by-default) optimized assembly implementations of field arithmetic that rely on the adcxq
, adoxq
and mulxq
instructions. These are available on most x86_64
platforms (Broadwell onwards for Intel and Ryzen onwards for AMD). Using this backend can lead to a 30-70% speedup in finite field and elliptic curve arithmetic. To build with this backend enabled, run the following command:
RUSTFLAGS="-C target-feature=+bmi2,+adx" cargo +nightly test/build/bench --features asm
To enable this in the Cargo.toml
of your own projects, enable the asm
feature flag:
...
ark-ff = { version = "0.1", features = [ "asm" ] }
Note that because inline assembly support in Rust is currently unstable, using this backend requires using the Nightly compiler at the moment.
The crates in this repo are licensed under either of the following licenses, at your discretion.
- Apache License Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://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.
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".