Skip to content

About

Libraries for finite field, elliptic curve, and polynomial arithmetic

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

904 Commits

Folders and files

Repository files navigation

arkworks::algebra

The arkworks ecosystem consist of Rust libraries for designing and working with zero knowledge succinct non-interactive arguments (zkSNARKs). This repository contains efficient implementations 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.

Directory structure

This repository contains several Rust crates:

  • ark-ff: Generic abstractions for, and implementations of various kinds of finite fields
  • ark-ec: Generic abstractions for prime-order groups, and implementations of various kinds of (pairing-friendly and standard) elliptic curves
  • ark-poly: Interfaces for univariate, multivariate, and multilinear polynomials, and FFTs over finite fields
  • ark-serialize: Efficient interfaces for serialization and point compression for finite fields and elliptic curves

In addition, the curves repository contains concrete implementations of popular elliptic curves; see here for details.

Build guide

The library compiles on the stable toolchain of the Rust compiler (v 1.51+). For the optimized assembly backend, Rust 1.59+ is required. 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

Tests

This library comes with comprehensive unit and integration tests for each of the provided crates. Run the tests with:

cargo test --all

Benchmarks

To run the benchmarks, install the nightly Rust toolchain, via rustup install nightly, and then run the following command:

cargo +nightly bench

Assembly backend for field arithmetic

The ark-ff crate's off-by-default asm feature enables assembly field arithmetic:

  • On x86_64, Montgomery multiplication and squaring and the 4-limb deferred inner-product accumulator with the mulx, adcx and adox instructions (BMI2 and ADX: Broadwell onwards for Intel, Zen onwards for AMD). Pasta-shape fields keep the portable multiplication. A run-time CPUID check selects these kernels, so a binary built with asm still runs on older CPUs, which take the portable path.
  • On aarch64, kernels for Pasta-shape moduli (Pallas and Vesta) and the deferred inner-product accumulator.

Every kernel returns the same canonical result as the portable path.

ark-ff = { version = "0.5", features = [ "asm" ] }

BMI2 and ADX at compile time on x86-64

Building with -C target-feature=+bmi2,+adx folds the CPUID check to true and lets LLVM emit mulx in the Rust code around the kernels. Such a binary faults with an illegal instruction on a CPU without BMI2 and ADX, so builds in this repository do not enable the flags by default. .cargo/bmi2-adx.toml holds them for an explicit opt-in:

cargo --config .cargo/bmi2-adx.toml test -p ark-ff --features asm

A set RUSTFLAGS takes precedence over the file. Downstream crates opt in with the same flags in their own RUSTFLAGS or Cargo config.

License

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

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".

About

Libraries for finite field, elliptic curve, and polynomial arithmetic

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages