plonky2/README.md

# plonky2

plonky2 is an implementation of recursive arguments based on Plonk and FRI. It is the successor of [plonky](https://github.com/mir-protocol/plonky), which was based on Plonk and Halo.

plonky2 is largely focused on recursion performance. We use custom gates to mitigate the bottlenecks of FRI verification, such as hashing and interpolation. We also encode witness data in a ~64 bit field, so field operations take just a few cycles. We use an extension field to boost soundness when needed.


## Running

To run the recursion benchmark,

```sh
RUSTFLAGS=-Ctarget-cpu=native cargo run --release
```


## Disclaimer

This code has not been thoroughly reviewed or tested, and should not be used in any production systems.


## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.


## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
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			`# plonky2`

Tweak readme 2021-05-20 19:42:10 -07:00			`plonky2 is an implementation of recursive arguments based on Plonk and FRI. It is the successor of [plonky](https://github.com/mir-protocol/plonky), which was based on Plonk and Halo.`

			`plonky2 is largely focused on recursion performance. We use custom gates to mitigate the bottlenecks of FRI verification, such as hashing and interpolation. We also encode witness data in a ~64 bit field, so field operations take just a few cycles. We use an extension field to boost soundness when needed.`
Update README 2021-05-05 19:24:04 -07:00

			`## Running`

			`To run the recursion benchmark,`

			```sh
			`RUSTFLAGS=-Ctarget-cpu=native cargo run --release`
			```
Licenses 2021-04-08 09:37:08 -07:00

			`## Disclaimer`

			`This code has not been thoroughly reviewed or tested, and should not be used in any production systems.`


			`## License`

			`Licensed under either of`

			`* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)`
			`* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)`

			`at your option.`


			`## Contribution`

			`Unless you explicitly state otherwise, any contribution intentionally submitted`
			`for inclusion in the work by you, as defined in the Apache-2.0 license, shall be`
			`dual licensed as above, without any additional terms or conditions.`