testudo/README.md
README.mdRaw
1# Spartan: High-speed zkSNARKs without trusted setup
2
3
4[]((https://crates.io/crates/curve25519-dalek))
5
6Spartan is a high-speed zero-knowledge proof system, a cryptographic primitive that enables a prover to prove a mathematical statement to a verifier without revealing anything besides the validity of the statement. This repository provides `libspartan,` a Rust library that implements a zero-knowledge succinct non-interactive argument of knowledge (zkSNARK), which is a type of zero-knowledge proof system with short proofs and fast verification times. The details of the Spartan proof system are described in our [paper](https://eprint.iacr.org/2019/550) published at [CRYPTO 2020](https://crypto.iacr.org/2020/). The security of the Spartan variant implemented in this library is based on the discrete logarithm problem in the random oracle model.
7
8A simple example application is proving the knowledge of a secret s such that H(s) == d for a public d, where H is a cryptographic hash function (e.g., SHA-256, Keccak). A more complex application is a database-backed cloud service that produces proofs of correct state machine transitions for auditability. See this [paper](https://eprint.iacr.org/2020/758.pdf) for an overview and this [paper](https://eprint.iacr.org/2018/907.pdf) for details.
9
10Note that this library has *not* received a security review or audit.
11
12## Highlights
13We now highlight Spartan's distinctive features.
14
15* **No "toxic" waste:** Spartan is a *transparent* zkSNARK and does not require a trusted setup. So, it does not involve any trapdoors that must be kept secret or require a multi-party ceremony to produce public parameters.
16
17* **General-purpose:** Spartan produces proofs for arbitrary NP statements. `libspartan` supports NP statements expressed as rank-1 constraint satisfiability (R1CS) instances, a popular language for which there exists efficient transformations and compiler toolchains from high-level programs of interest.
18
19* **Sub-linear verification costs and linear-time proving costs:** Spartan is the first transparent proof system with sub-linear verification costs for arbitrary NP statements (e.g., R1CS). Spartan also features a linear-time prover, a property that has remained elusive for nearly all zkSNARKs in the literature.
20
21* **Standardized security:** Spartan's security relies on the hardness of computing discrete logarithms (a standard cryptographic assumption) in the random oracle model. `libspartan` uses `ristretto255`, a prime-order group abstraction atop `curve25519` (a high-speed elliptic curve). We use [`curve25519-dalek`](https://docs.rs/curve25519-dalek) for arithmetic over `ristretto255`.
22
23* **State-of-the-art performance:**
24Among transparent SNARKs, Spartan offers the fastest prover with speedups of 36–152× depending on the baseline, produces proofs that are shorter by 1.2–416×, and incurs the lowest verification times with speedups of 3.6–1326×. The only exception is proof sizes under Bulletproofs, but Bulletproofs incurs slower verification both asymptotically and concretely. When compared to the state-of-the-art zkSNARK with trusted setup, Spartan’s prover is 2× faster for arbitrary R1CS instances and 16× faster for data-parallel workloads.
25
26### Implementation details
27`libspartan` uses [`merlin`](https://docs.rs/merlin/) to automate the Fiat-Shamir transform. We also introduce a new type called `RandomTape` that extends a `Transcript` in `merlin` to allow the prover's internal methods to produce private randomness using its private transcript without having to create `OsRng` objects throughout the code. An object of type `RandomTape` is initialized with a new random seed from `OsRng` for each proof produced by the library.
28
29## Examples
30To import `libspartan` into your Rust project, add the following dependency to `Cargo.toml`:
31```text
32spartan = "0.2.1"
33```
34
35The following example shows how to use `libspartan` to create and verify a SNARK proof.
36Some of our public APIs' style is inspired by the underlying crates we use.
37
38```rust
39# extern crate libspartan;
40# extern crate merlin;
41# use libspartan::{Instance, SNARKGens, SNARK};
42# use merlin::Transcript;
43# fn main() {
44 // specify the size of an R1CS instance
45 let num_vars = 1024;
46 let num_cons = 1024;
47 let num_inputs = 10;
48 let num_non_zero_entries = 1024;
49
50 // produce public parameters
51 let gens = SNARKGens::new(num_cons, num_vars, num_inputs, num_non_zero_entries);
52
53 // ask the library to produce a synthentic R1CS instance
54 let (inst, vars, inputs) = Instance::produce_synthetic_r1cs(num_cons, num_vars, num_inputs);
55
56 // create a commitment to the R1CS instance
57 let (comm, decomm) = SNARK::encode(&inst, &gens);
58
59 // produce a proof of satisfiability
60 let mut prover_transcript = Transcript::new(b"snark_example");
61 let proof = SNARK::prove(&inst, &decomm, vars, &inputs, &gens, &mut prover_transcript);
62
63 // verify the proof of satisfiability
64 let mut verifier_transcript = Transcript::new(b"snark_example");
65 assert!(proof
66 .verify(&comm, &inputs, &mut verifier_transcript, &gens)
67 .is_ok());
68 println!("proof verification successful!");
69# }
70```
71
72Here is another example to use the NIZK variant of the Spartan proof system:
73```rust
74# extern crate libspartan;
75# extern crate merlin;
76# use libspartan::{Instance, NIZKGens, NIZK};
77# use merlin::Transcript;
78# fn main() {
79 // specify the size of an R1CS instance
80 let num_vars = 1024;
81 let num_cons = 1024;
82 let num_inputs = 10;
83
84 // produce public parameters
85 let gens = NIZKGens::new(num_cons, num_vars);
86
87 // ask the library to produce a synthentic R1CS instance
88 let (inst, vars, inputs) = Instance::produce_synthetic_r1cs(num_cons, num_vars, num_inputs);
89
90 // produce a proof of satisfiability
91 let mut prover_transcript = Transcript::new(b"nizk_example");
92 let proof = NIZK::prove(&inst, vars, &inputs, &gens, &mut prover_transcript);
93
94 // verify the proof of satisfiability
95 let mut verifier_transcript = Transcript::new(b"nizk_example");
96 assert!(proof
97 .verify(&inst, &inputs, &mut verifier_transcript, &gens)
98 .is_ok());
99 println!("proof verification successful!");
100# }
101```
102
103Finally, we provide an example that specifies a custom R1CS instance instead of using a synthetic instance
104```rust
105# extern crate curve25519_dalek;
106# extern crate libspartan;
107# extern crate merlin;
108# use curve25519_dalek::scalar::Scalar;
109# use libspartan::{InputsAssignment, Instance, SNARKGens, VarsAssignment, SNARK};
110# use merlin::Transcript;
111# use rand::rngs::OsRng;
112# fn main() {
113 // produce a tiny instance
114 let (
115 num_cons,
116 num_vars,
117 num_inputs,
118 num_non_zero_entries,
119 inst,
120 assignment_vars,
121 assignment_inputs,
122 ) = produce_tiny_r1cs();
123
124 // produce public parameters
125 let gens = SNARKGens::new(num_cons, num_vars, num_inputs, num_non_zero_entries);
126
127 // create a commitment to the R1CS instance
128 let (comm, decomm) = SNARK::encode(&inst, &gens);
129
130 // produce a proof of satisfiability
131 let mut prover_transcript = Transcript::new(b"snark_example");
132 let proof = SNARK::prove(
133 &inst,
134 &decomm,
135 assignment_vars,
136 &assignment_inputs,
137 &gens,
138 &mut prover_transcript,
139 );
140
141 // verify the proof of satisfiability
142 let mut verifier_transcript = Transcript::new(b"snark_example");
143 assert!(proof
144 .verify(&comm, &assignment_inputs, &mut verifier_transcript, &gens)
145 .is_ok());
146 println!("proof verification successful!");
147# }
148
149# fn produce_tiny_r1cs() -> (
150# usize,
151# usize,
152# usize,
153# usize,
154# Instance,
155# VarsAssignment,
156# InputsAssignment,
157# ) {
158 // We will use the following example, but one could construct any R1CS instance.
159 // Our R1CS instance is three constraints over five variables and two public inputs
160 // (Z0 + Z1) * I0 - Z2 = 0
161 // (Z0 + I1) * Z2 - Z3 = 0
162 // Z4 * 1 - 0 = 0
163
164 // parameters of the R1CS instance rounded to the nearest power of two
165 let num_cons = 4;
166 let num_vars = 8;
167 let num_inputs = 2;
168 let num_non_zero_entries = 8;
169
170 // We will encode the above constraints into three matrices, where
171 // the coefficients in the matrix are in the little-endian byte order
172 let mut A: Vec<(usize, usize, [u8; 32])> = Vec::new();
173 let mut B: Vec<(usize, usize, [u8; 32])> = Vec::new();
174 let mut C: Vec<(usize, usize, [u8; 32])> = Vec::new();
175
176 // The constraint system is defined over a finite field, which in our case is
177 // the scalar field of ristreeto255/curve25519 i.e., p = 2^{252}+27742317777372353535851937790883648493
178 // To construct these matrices, we will use `curve25519-dalek` but one can use any other method.
179
180 // a variable that holds a byte representation of 1
181 let one = Scalar::one().to_bytes();
182
183 // R1CS is a set of three sparse matrices A B C, where is a row for every
184 // constraint and a column for every entry in z = (vars, 1, inputs)
185 // An R1CS instance is satisfiable iff:
186 // Az \circ Bz = Cz, where z = (vars, 1, inputs)
187
188 // constraint 0 entries in (A,B,C)
189 // constraint 0 is (Z0 + Z1) * I0 - Z2 = 0.
190 // We set 1 in matrix A for columns that correspond to Z0 and Z1
191 // We set 1 in matrix B for column that corresponds to I0
192 // We set 1 in matrix C for column that corresponds to Z2
193 A.push((0, 0, one));
194 A.push((0, 1, one));
195 B.push((0, num_vars + 1, one));
196 C.push((0, 2, one));
197
198 // constraint 1 entries in (A,B,C)
199 A.push((1, 0, one));
200 A.push((1, num_vars + 2, one));
201 B.push((1, 2, one));
202 C.push((1, 3, one));
203
204 // constraint 3 entries in (A,B,C)
205 A.push((2, 4, one));
206 B.push((2, num_vars, one));
207
208 let inst = Instance::new(num_cons, num_vars, num_inputs, &A, &B, &C).unwrap();
209
210 // compute a satisfying assignment
211 let mut csprng: OsRng = OsRng;
212 let i0 = Scalar::random(&mut csprng);
213 let i1 = Scalar::random(&mut csprng);
214 let z0 = Scalar::random(&mut csprng);
215 let z1 = Scalar::random(&mut csprng);
216 let z2 = (z0 + z1) * i0; // constraint 0
217 let z3 = (z0 + i1) * z2; // constraint 1
218 let z4 = Scalar::zero(); //constraint 2
219
220 // create a VarsAssignment
221 let mut vars = vec![Scalar::zero().to_bytes(); num_vars];
222 vars[0] = z0.to_bytes();
223 vars[1] = z1.to_bytes();
224 vars[2] = z2.to_bytes();
225 vars[3] = z3.to_bytes();
226 vars[4] = z4.to_bytes();
227 let assignment_vars = VarsAssignment::new(&vars).unwrap();
228
229 // create an InputsAssignment
230 let mut inputs = vec![Scalar::zero().to_bytes(); num_inputs];
231 inputs[0] = i0.to_bytes();
232 inputs[1] = i1.to_bytes();
233 let assignment_inputs = InputsAssignment::new(&inputs).unwrap();
234
235 // check if the instance we created is satisfiable
236 let res = inst.is_sat(&assignment_vars, &assignment_inputs);
237 assert_eq!(res.unwrap(), true);
238
239 (
240 num_cons,
241 num_vars,
242 num_inputs,
243 num_non_zero_entries,
244 inst,
245 assignment_vars,
246 assignment_inputs,
247 )
248# }
249```
250
251## Building `libspartan`
252Install [`rustup`](https://rustup.rs/)
253
254Switch to nightly Rust using `rustup`:
255```text
256rustup default nightly
257```
258
259Clone the repository:
260```text
261git clone https://github.com/Microsoft/Spartan
262cd Spartan
263```
264
265To build docs for public APIs of `libspartan`:
266```text
267cargo doc
268```
269
270To run tests:
271```text
272RUSTFLAGS="-C target_cpu=native" cargo test
273```
274
275To build `libspartan`:
276```text
277RUSTFLAGS="-C target_cpu=native" cargo build --release
278```
279
280> NOTE: We enable SIMD instructions in `curve25519-dalek` by default, so if it fails to build remove the "simd_backend" feature argument in `Cargo.toml`.
281
282### Supported features
283* `profile`: enables fine-grained profiling information (see below for its use)
284
285## Performance
286
287### End-to-end benchmarks
288`libspartan` includes two benches: `benches/nizk.rs` and `benches/snark.rs`. If you report the performance of Spartan in a research paper, we recommend using these benches for higher accuracy instead of fine-grained profiling (listed below).
289
290To run end-to-end benchmarks:
291```text
292RUSTFLAGS="-C target_cpu=native" cargo bench
293```
294
295### Fine-grained profiling
296Build `libspartan` with `profile` feature enabled. It creates two profilers: `./target/release/snark` and `./target/release/nizk`.
297
298These profilers report performance as depicted below (for varying R1CS instance sizes). The reported
299performance is from running the profilers on a Microsoft Surface Laptop 3 on a single CPU core of Intel Core i7-1065G7 running Ubuntu 20.04 (atop WSL2 on Windows 10).
300See Section 9 in our [paper](https://eprint.iacr.org/2019/550) to see how this compares with other zkSNARKs in the literature.
301
302```text
303$ ./target/release/snark
304Profiler:: SNARK
305 * number_of_constraints 1048576
306 * number_of_variables 1048576
307 * number_of_inputs 10
308 * number_non-zero_entries_A 1048576
309 * number_non-zero_entries_B 1048576
310 * number_non-zero_entries_C 1048576
311 * SNARK::encode
312 * SNARK::encode 14.2644201s
313 * SNARK::prove
314 * R1CSProof::prove
315 * polycommit
316 * polycommit 2.7175848s
317 * prove_sc_phase_one
318 * prove_sc_phase_one 683.7481ms
319 * prove_sc_phase_two
320 * prove_sc_phase_two 846.1056ms
321 * polyeval
322 * polyeval 193.4216ms
323 * R1CSProof::prove 4.4416193s
324 * len_r1cs_sat_proof 47024
325 * eval_sparse_polys
326 * eval_sparse_polys 377.357ms
327 * R1CSEvalProof::prove
328 * commit_nondet_witness
329 * commit_nondet_witness 14.4507331s
330 * build_layered_network
331 * build_layered_network 3.4360521s
332 * evalproof_layered_network
333 * len_product_layer_proof 64712
334 * evalproof_layered_network 15.5708066s
335 * R1CSEvalProof::prove 34.2930559s
336 * len_r1cs_eval_proof 133720
337 * SNARK::prove 39.1297568s
338 * SNARK::proof_compressed_len 141768
339 * SNARK::verify
340 * verify_sat_proof
341 * verify_sat_proof 20.0828ms
342 * verify_eval_proof
343 * verify_polyeval_proof
344 * verify_prod_proof
345 * verify_prod_proof 1.1847ms
346 * verify_hash_proof
347 * verify_hash_proof 81.06ms
348 * verify_polyeval_proof 82.3583ms
349 * verify_eval_proof 82.8937ms
350 * SNARK::verify 103.0536ms
351```
352
353```text
354$ ./target/release/nizk
355Profiler:: NIZK
356 * number_of_constraints 1048576
357 * number_of_variables 1048576
358 * number_of_inputs 10
359 * number_non-zero_entries_A 1048576
360 * number_non-zero_entries_B 1048576
361 * number_non-zero_entries_C 1048576
362 * NIZK::prove
363 * R1CSProof::prove
364 * polycommit
365 * polycommit 2.7220635s
366 * prove_sc_phase_one
367 * prove_sc_phase_one 722.5487ms
368 * prove_sc_phase_two
369 * prove_sc_phase_two 862.6796ms
370 * polyeval
371 * polyeval 190.2233ms
372 * R1CSProof::prove 4.4982305s
373 * len_r1cs_sat_proof 47024
374 * NIZK::prove 4.5139888s
375 * NIZK::proof_compressed_len 48134
376 * NIZK::verify
377 * eval_sparse_polys
378 * eval_sparse_polys 395.0847ms
379 * verify_sat_proof
380 * verify_sat_proof 19.286ms
381 * NIZK::verify 414.5102ms
382```
383
384## LICENSE
385
386See [LICENSE](./LICENSE)
387
388## Contributing
389
390See [CONTRIBUTING](./CONTRIBUTING.md)