/lambdaworks

The library for kids who wanna learn how to do SNARKs and learn other cryptographic stuff too

Primary LanguageRustApache License 2.0Apache-2.0

LambdaWorks

From the heights of these towers of fields, forty centuries of mathematics look down on us. The library for kids who wanna learn how to do STARKs, SNARKs and learn other cryptographic stuff too.

Telegram Chat codecov

Documentation

List of features

Disclaimer: This list contains cryptographic primitives and mathematical structures that we want to support in Lambdaworks. It can be expanded later to include new primitives. If you find there is a mistake or there has been an update in another library, please let us know.

List of symbols:

  • ✔️ means the feature is currently supported.
  • 🏗️ means that the feature is partially implemented or is under active construction.
  • ❌ means that the feature is not currently supported.
Finite Fields Lambdaworks Arkworks Halo2 gnark Constantine
StarkField 252 ✔️ ✔️
Mersenne 31 🏗️
Baby Bear 🏗️
MiniGoldilocks 🏗️
ZK friendly Hash function Lambdaworks Arkworks Halo2 gnark Constantine
Poseidon 🏗️ ✔️
Pedersen 🏗️ ✔️
Rescue Prime XLIX ❌
Elliptic Curves Lambdaworks Arkworks Halo2 gnark Constantine
BLS12-381 ✔️ ✔️
BLS12-377 🏗️ ✔️ ✔️
BN-254 ❌ ✔️
Pallas 🏗️ ✔️
Vesta 🏗️ ✔️
Bandersnatch 🏗️ ✔️
STARKs Lambdaworks Arkworks Halo2 gnark Constantine
STARK Prover ✔️ ❌ ❌
CAIRO Prover 🏗️ ❌ ❌
SNARKs Lambdaworks Arkworks Halo2 gnark Constantine
Groth16 🏗️ ✔️ ✔️
Plonk 🏗️ ❌ ✔️ ✔️
Spartan ❌ ✔️
Marlin ❌ ✔️
GKR ❌ ✔️ ✔️
Polynomial Commitment Schemes Lambdaworks Arkworks Halo2 gnark Constantine
FRI 🏗️ ❌ ❌ ✔️
IPA ❌ ✔️ ✔️
Hyrax ❌ ❌
KZG10 ✔️ ✔️ ✔️ ✔️
Folding Schemes Lambdaworks Arkworks Halo2 gnark Constantine
Nova ❌
Supernova ❌
Protostar ❌
Protogalaxy ❌

Zero-Knowledge and Validity Proofs have gained a lot of attention over the last few years. We strongly believe in this potential and that is why we decided to start working in this challenging ecosystem, where math, cryptography and distributed systems meet. The main barrier in the beginning was not the cryptography or math but the lack of good libraries which are performant and developer friendly. There are some exceptions, though, like gnark or halo2. Some have nice APIs and are easy to work with, but they are not written in Rust, and some are written in Rust but have poor programming and engineering practices. Most of them don't have support for CUDA, Metal and WebGPU or distributed FFT calculation using schedulers like Dask.

So, we decided to build our library, focusing on performance, with clear documentation and developer-focused. Our core team is a group of passionate people from different backgrounds and different strengths; we think that the whole is greater than just the addition of the parts. We don't want to be a compilation of every research result in the ZK space. We want this to be a library that can be used in production, not just in academic research. We want to offer developers the main building blocks and proof systems so that they can build their applications on top of this library.

Main crates

If you are interested in proving Cairo programs, use the Cairo Prover CLI.

Crypto

Finite Field crate fully supports no-std with no-default-features

Both Math and Crypto support wasm with target wasm32-unknown-unknown by default, with std feature.

Examples - mini apps

Exercises and Challenges

If you use Lambdaworks libraries in your research projects, please cite them using the following template:

@software{Lambdaworks,
  author={Lambdaworks contributors},
  title={Lambdaworks},
  url={https://github.com/lambdaclass/lambdaworks},
  year={2023}
}

Gadgets

Fuzzers

Fuzzers are divided between the ones that use only the CPU, the ones that use Metal, and the ones that use CUDA.

CPU Fuzzers can be run with the command bash make run-fuzzer FUZZER=fuzzer_name

For example:

make run-fuzzer FUZZER=field_from_hex

The list of fuzzers can be found in fuzz/no_gpu_fuzz

Fuzzers for FTT in Metal and Cuda can be run with make run-metal-fuzzer and make run-cuda-fuzzer

Run a specific fuzzer from the ones contained in fuzz/fuzz_targets/ folder withcargo, for example to run the one for the target field_from_hex:

make run-fuzzer FUZZER=field_from_hex

Documentation

To serve the documentation locally, first install both mdbook and the Katex preprocessor to render LaTeX, then run

make docs

📊 Benchmarks

Benchmark results are hosted here.

These are the results of execution of the benchmarks for finite field arithmetic using the STARK field prime (p = 3618502788666131213697322783095070105623107215331596699973092056135872020481).

Differences of 3% are common for some measurements, so small differences are not statistically relevant.

ARM - M1

Operation N Arkworks Lambdaworks
mul 10k 112 μs 115 μs
add 1M 8.5 ms 7.0 ms
sub 1M 7.53 ms 7.12 ms
pow 10k 11.2 ms 12.4 ms
invert 10k 30.0 ms 27.2 ms

x86 - AMD Ryzen 7 PRO

Operation N Arkworks (ASM)* Lambdaworks
mul 10k 118.9 us 95.7 us
add 1M 6.8 ms 5.4 ms
sub 1M 6.6 ms 5.2 ms
pow 10k 10.6 ms 9.4 ms
invert 10k 34.2 ms 35.74 ms

*assembly feature was enabled manually for that bench, and is not activated by default when running criterion

To run them locally, you will need cargo-criterion and cargo-flamegraph. Install it with:

cargo install cargo-criterion

Run the complete benchmark suite with:

make benchmarks

Run a specific benchmark suite with cargo, for example to run the one for field:

make benchmark BENCH=field

You can check the generated HTML report in target/criterion/reports/index.html

📚 References

The following links, repos and projects have been important in the development of this library and we want to thank and acknowledge them.