You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+56-10Lines changed: 56 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,33 @@
1
1
# LambdaWorks
2
-
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.
3
2
4
-
<div>
3
+
The library for kids who wanna learn how to do STARKs, SNARKs and learn other cryptographic stuff too.
4
+
5
+
> From the heights of these towers of fields, forty centuries of mathematics look down on us.
6
+
7
+
This library provides efficient implementation of cryptographic primitives used to build proving systems. Along with it, many backends for proving systems are shipped, and compatibility with different frontends is supported.
8
+
9
+
-[Our vision on ZKP](https://blog.lambdaclass.com/transforming-the-future-with-zero-knowledge-proofs-fully-homomorphic-encryption-and-new-distributed-systems-algorithms/)
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.
Additionally, provers are compatible with the following frontends and VMs:
61
88
62
-
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.
63
-
64
-
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.
89
+
| Backend | Frontend | Status |
90
+
|---------|----------|--------|
91
+
| Groth16 | Arkworks |:heavy_check_mark:|
92
+
| Groth16 | Gnark |:x:|
93
+
| Groth16 | Circom | 🏗️ |
94
+
| Plonk | Gnark | 🏗️ |
95
+
| Plonk | Noir |:x:|
96
+
| Stark | Winterfell |:heavy_check_mark:|
97
+
| Stark | Miden |:heavy_check_mark:|
98
+
| Stark | Cairo |:heavy_check_mark:|
65
99
100
+
This can be used in a multi prover setting for extra security, or as a standalone to be used with Rust.
Finite Field crate fully supports no-std with `no-default-features`
82
119
@@ -87,6 +124,9 @@ Both Math and Crypto support wasm with target `wasm32-unknown-unknown` by defaul
87
124
88
125
## Exercises and Challenges
89
126
-[Lambdaworks exercises and challenges](https://github.com/lambdaclass/lambdaworks_exercises/tree/main)
127
+
-[Roadmap for Sparkling Water Bootcamp](https://github.com/lambdaclass/sparkling_water_bootcamp/blob/main/README.md)
128
+
129
+
## Citing Lambdaworks
90
130
91
131
If you use ```Lambdaworks``` libraries in your research projects, please cite them using the following template:
92
132
@@ -99,9 +139,15 @@ If you use ```Lambdaworks``` libraries in your research projects, please cite th
99
139
}
100
140
```
101
141
102
-
### Gadgets
142
+
## Why we built Lambdaworks
143
+
144
+
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.
145
+
146
+
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.
147
+
148
+
## Additional tooling usage
103
149
104
-
## Fuzzers
150
+
###Fuzzers
105
151
106
152
Fuzzers are divided between the ones that use only the CPU, the ones that use Metal, and the ones that use CUDA.
107
153
@@ -124,7 +170,7 @@ Run a specific fuzzer from the ones contained in **fuzz/fuzz_targets/** folder w
124
170
make run-fuzzer FUZZER=field_from_hex
125
171
```
126
172
127
-
## Documentation
173
+
###Documentation building
128
174
129
175
To serve the documentation locally, first install both [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html) and the [Katex preprocessor](https://github.com/lzanini/mdbook-katex#getting-started) to render LaTeX, then run
0 commit comments