codex-storage/proof-aggregation
1
0
Fork 0
mirror of https://github.com/codex-storage/proof-aggregation.git synced 2025-02-13 15:16:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
M Alghazwi 2025-01-17 10:05:39 +01:00
parent 00ee710354
commit 6641199f78
No known key found for this signature in database
GPG Key ID: 646E567CAD7DB607
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -5,9 +5,7 @@ This crate is an implementation of the [codex storage proofs circuits](https://g
## Code organization
- [`merkle_safe`](./src/merkle_tree/merkle_safe.rs) is the implementation of "safe" merkle tree used in codex, consistent with the one [here](https://github.com/codex-storage/nim-codex/blob/master/codex/merkletree/merkletree.nim).
- [`merkle_circuit`](./src/circuits/merkle_circuit) is the Plonky2 Circuit implementation of "safe" merkle tree above.
- [`merkle_circuit`](./src/circuits/merkle_circuit) is the Plonky2 Circuit implementation of "safe" merkle tree.
- [`sample_cells`](./src/circuits/sample_cells.rs) is the Plonky2 Circuit implementation for sampling cells in dataset merkle tree.

6
proof-input/README.md
View File

@ -4,11 +4,13 @@ WARNING: This is a work-in-progress prototype, and has not received careful code
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
## Code organization
- [`merkle_tree`](./src/merkle_tree) is the implementation of "safe" merkle tree used in codex, consistent with the one [here](https://github.com/codex-storage/nim-codex/blob/master/codex/merkletree/merkletree.nim).
- [`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.
- [`json`](./src/serialization) contains the serialization functions 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.

4
workflow/README.md
View File

@ -65,10 +65,10 @@ export NCELLS=512 # Number of cells in this slot
Alternatively, for testing you can just use the default parameters as follows:
```rust
use proof_input::params::TestParams;
use proof_input::params::Params;
fn main() {
let params = TestParams::<F,D>::default();
let params = Params::default();
}
```
#### Step 2: Run the Script