logos-storage/proof-aggregation
1
0
Fork 0
mirror of https://github.com/logos-storage/proof-aggregation.git synced 2026-01-02 13:53:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

update circuits README.md

Browse Source
This commit is contained in:
M Alghazwi 2025-07-03 13:51:35 +02:00
parent 4188fe282a
commit 5f438ed86a
No known key found for this signature in database
GPG Key ID: 646E567CAD7DB607
1 changed files with 5 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
codex-plonky2-circuits/README.md
View File

@ -1,31 +1,20 @@
# Codex Plonky2 Circuits
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 is an implementation of the [codex storage proofs circuits](https://github.com/codex-storage/codex-storage-proofs-circuits) for the plonky2 proof system.
## Code organization
- [`merkle_circuit`](./src/circuits/merkle_circuit) is the Plonky2 Circuit implementation of "safe" merkle tree.
- [`circuit_trait`](./src/circuit_trait) contains a general trait for all Plonky2 circuit to automate the building and proving.
- [`sample_cells`](./src/circuits/sample_cells.rs) is the Plonky2 Circuit implementation for sampling cells in dataset merkle tree.
- [`circuits`](./src/circuits/) is the Plonky2 Circuit implementation for sampling cells in dataset merkle tree.
- [`keyed_compress`](./src/circuits/keyed_compress.rs) is the compression function used in the construction (and reconstruction) of the Merkle tree root. The function takes 2 hash digest (4 Goldilocks field elements each) and a key, then outputs a single hash digest.
- [`recursion`](./src/recursion/) contains the (2-to-1 tree) recursion circuits for aggregating proofs.
- [`sponge`](./src/circuits/sponge.rs) contains the hash function (with and without padding) used to hash cells and during sampling.
- [`bn254_wrapper`](./src/bn254_wrapper/) contains the poseidon hash implementation for bn254 curve.
- [`params`](./src/circuits/params.rs) is the parameters used in the circuits.
- [`utils`](./src/circuits/utils.rs) contains helper functions.
- [`circuit_helper`](./src/circuit_helper) contains a general trait for all Plonky2 circuit to automate the building and proving.
- [`serialization`](./src/serialization.rs) contains functions for serializing and deserializing the circuit data and proofs.
- [`error`](./src/error.rs) contains the list of error related to the circuits.
- [`uniform recursion`](./src/recursion/uniform) contains the uniform (2-to-1 tree) recursion circuits for aggregating proofs.
## Usage
see [`workflow`](../workflow) for how to use the circuits and run them.
## Benchmarks
see [`BENCHMARKS.md`](../workflow/BENCHMARKS.md)