diff --git a/circuit/README.md b/circuit/README.md index dd932aa..863a2e3 100644 --- a/circuit/README.md +++ b/circuit/README.md @@ -6,16 +6,19 @@ See the [README in the parent dir](../README.md) for the (draft) specification. ### Organization of the circuit code -- `slot_main.circom` - main component, generated by tests -- `sample_cells.circom` - compute cell indices to sample, prove sampled cells +- `sample_cells.circom` - compute cell indices to sample, and prove those cells - `single_cell.circom` - prove a single cell +- `merkle.circom` - Merkle inclusion proof (using our custom Merkle tree convention) - `extract_bits.circom` - extract lower bits of the *standard representation* of a field element - `binary_compare.circom` - compare numbers given in binary representation (the point is that they can be bigger than the field size!) +- `log2.circom` - circom code for computing base 2 logarithm - `misc.circom` - miscellaneous helper funtions - `poseidon2_hash.circom` - compute Poseidon2 hash with sponge construction - `poseidon2_sponge.circom` - generic sponge construction -- `poseidon2_merkle.circom` - compute Poseidon2 Merkle root - `poseidon2_perm.circom` - the Poseidon2 permutation +Note: the main component is not included in the above, as it depends on the +parameters. You can use one of the reference input generators to create one; +or look at `deprecated/slot_main.circom` for an example. diff --git a/circuit/main_test_compare.circom b/circuit/deprecated/main_test_compare.circom similarity index 100% rename from circuit/main_test_compare.circom rename to circuit/deprecated/main_test_compare.circom diff --git a/circuit/slot_main.circom b/circuit/deprecated/slot_main.circom similarity index 100% rename from circuit/slot_main.circom rename to circuit/deprecated/slot_main.circom diff --git a/circuit/test_compare.sh b/circuit/deprecated/test_compare.sh similarity index 100% rename from circuit/test_compare.sh rename to circuit/deprecated/test_compare.sh diff --git a/circuit/test_prove.sh b/circuit/deprecated/test_prove.sh similarity index 100% rename from circuit/test_prove.sh rename to circuit/deprecated/test_prove.sh diff --git a/circuit/test_slotmain.sh b/circuit/deprecated/test_slotmain.sh similarity index 100% rename from circuit/test_slotmain.sh rename to circuit/deprecated/test_slotmain.sh diff --git a/workflow/params.sh b/workflow/params.sh index 5035dce..5b67f6d 100644 --- a/workflow/params.sh +++ b/workflow/params.sh @@ -11,5 +11,5 @@ SEED=12345 # seed for creating fake data NSLOTS=11 # number of slots in the dataset SLOTINDEX=3 # which slot we prove (0..NSLOTS-1) -NCELLS=512 # number of cells in a slot +NCELLS=512 # number of cells in this slot