plonky2/README.md

# Plonky2

Plonky2 is a SNARK implementation based on techniques from PLONK and FRI. It is the successor of [Plonky](https://github.com/mir-protocol/plonky), which was based on PLONK and Halo.

Plonky2 is built for speed, particularly fast recursion. On a Macbook Pro, recursive proofs can be generated in about 170 ms.


## Documentation

For more details about the Plonky2 argument system, see this [writeup](plonky2.pdf).


## Running

To see recursion performance, one can run this test, which generates a chain of three recursion proofs:

```sh
RUST_LOG=debug RUSTFLAGS=-Ctarget-cpu=native cargo test --release test_recursive_recursive_verifier -- --ignored
```


## Copyright

Plonky2 was developed by Polygon Zero (formerly Mir). While we plan to adopt an open source license, we haven't selected one yet, so all rights are reserved for the time being. Please reach out to us if you have thoughts on licensing.


## Disclaimer

This code has not yet been audited, and should not be used in any production systems.
licensing note 2022-01-03 10:00:15 -08:00			`# Plonky2`
Split main into multiple binaries ... and other minor refactoring. `bench_recursion` will be the default bin run by `cargo run`; the otheres can be selected with the `--bin` flag. We could probably delete some of the other binaries later. E.g. `field_search` might not be useful any more. `bench_fft` should maybe be converted to a benchmark (although there are some pros and cons, e.g. the bench framework has a minimum number of runs, and isn't helpful in testing multi-core performance). 2021-04-06 13:14:59 -07:00
readme updates 2022-01-09 09:52:19 -08:00			`Plonky2 is a SNARK implementation based on techniques from PLONK and FRI. It is the successor of [Plonky](https://github.com/mir-protocol/plonky), which was based on PLONK and Halo.`
Tweak readme 2021-05-20 19:42:10 -07:00
readme updates 2022-01-09 09:52:19 -08:00			`Plonky2 is built for speed, particularly fast recursion. On a Macbook Pro, recursive proofs can be generated in about 170 ms.`


			`## Documentation`

			`For more details about the Plonky2 argument system, see this [writeup](plonky2.pdf).`
Update README 2021-05-05 19:24:04 -07:00

			`## Running`

Update running example 2021-08-19 08:27:14 -07:00			`To see recursion performance, one can run this test, which generates a chain of three recursion proofs:`
Update README 2021-05-05 19:24:04 -07:00
			```sh
Update running example 2021-08-19 08:27:14 -07:00			`RUST_LOG=debug RUSTFLAGS=-Ctarget-cpu=native cargo test --release test_recursive_recursive_verifier -- --ignored`
Update README 2021-05-05 19:24:04 -07:00			```
Licenses 2021-04-08 09:37:08 -07:00

licensing note 2022-01-03 10:00:15 -08:00			`## Copyright`

			`Plonky2 was developed by Polygon Zero (formerly Mir). While we plan to adopt an open source license, we haven't selected one yet, so all rights are reserved for the time being. Please reach out to us if you have thoughts on licensing.`


Licenses 2021-04-08 09:37:08 -07:00			`## Disclaimer`

readme updates 2022-01-09 09:52:19 -08:00			`This code has not yet been audited, and should not be used in any production systems.`
Licenses 2021-04-08 09:37:08 -07:00