proof-aggregation/proof-input/README.md

24 lines
1.1 KiB
Markdown

# Input Generator for the Plonky2 Circuit
WARNING: This is a work-in-progress prototype, and has not received careful code review. This implementation is NOT ready for production use.
This crate generates input to the proof circuit based on the test parameters. The proof input generated can be ported into
the [`plonky2 codex proof circuits`](../codex-plonky2-circuits). Currently only generates fake data for testing.
## Code organization
- [`gen_input`](./src/gen_input.rs) contains the necessary function to generate the proof input.
- [`json`](./src/json.rs) contains the serialization function to read and write the proof input from/to json files.
- [`params`](./src/params.rs) is the test parameters used to generate the input. The params include circuit params as well.
- [`sponge`](./src/sponge.rs) contains the non-circuit version of hash function (with and without padding) used to hash cells and during sampling.
- [`utils`](./src/utils.rs) contains helper functions.
## Usage
see [`workflow`](../workflow) for how to generate proof input.
## Benchmarks
see [`BENCHMARKS.md`](../proof-input/BENCHMARKS.md)