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 README.md

Browse Source
This commit is contained in:
M Alghazwi 2025-06-23 09:14:38 +02:00
parent 06ae6ffd30
commit 717c9ee4d7
No known key found for this signature in database
GPG Key ID: 646E567CAD7DB607
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,33 +1,31 @@
Proof Aggregation
================================
**WARNING**: This repository contains work-in-progress prototypes, and has not received careful code review. It is NOT ready for production use.
This repository contains all work related to the Codex proof system which supports proof aggregation (currently only local proof aggregation).
This repository contains all work related to the Codex storage proof system which supports proof aggregation (currently only local proof aggregation).
## Quick Usage
see [`codex-storage-proofs-circuits`](../codex-storage-proofs-circuits) to look at the circuits.
see [`codex-storage-proofs-circuits`](./codex-storage-proofs-circuits) to look at the circuits.
see [`proof-input`](./proof-input) to test the circuits.
see [`workflow`](../workflow) for an overview of the whole workflow and how to use the circuits and run them.
see [`workflow`](./workflow) for an overview of the whole workflow and how to use the circuits and run them.
Repository organization
-----------------
- [`plonly2_poseidon2`](./plonky2_poseidon2) is the crate for plonky2 which supports the poseidon2 hash function.
- [`plonly2_poseidon2`](./plonky2_poseidon2) is the poseidon2 hash function for Plonky2.
- [`codex-plonky2-circuits`](./codex-plonky2-circuits) contains the codex proof circuits tailored specifically for plonky2. These circuits have the functionality as those in [**here**](https://github.com/codex-storage/codex-storage-proofs-circuits)
- [`codex-plonky2-circuits`](./codex-plonky2-circuits) contains the Plonky2 codex storage proof circuits. These circuits have the functionality as those in [**here**](https://github.com/codex-storage/codex-storage-proofs-circuits)
- [`proof-input`](./proof-input) contains the lib code to generate proof input for the circuit from fake dataset.
- [`proof-input`](./proof-input) contains the code to generate proof input for the circuit from fake dataset + some tests for the circuits.
- [`gnark-wrapper`](./gnark-wrapper) contains a Go-based CLI for compiling, proving, and verifying Plonky2-wrapped circuits using our version of [gnark-plonky2-verifier](https://github.com/codex-storage/gnark-plonky2-verifier)
- [`workflow`](./workflow) contains the scripts and example code to generate input, run the circuits, generate a proof, and verify the proof.
- [`goldibear_experiments`](./goldibear_experiments) contains experiments with using [Plonky2_Goldibear](https://github.com/telosnetwork/plonky2_goldibear/tree/main).
- [`recursion_experiments`](./recursion_experiments) contains experiment with multiple recursion approaches prior to settling with the uniform 2-to-1 tree aggregation.
Documentation
-----------------
See the write-ups on [plonky2 storage proofs](https://hackmd.io/@NQdG6IOmQE6astjwhJ6ACw/rJSsScfAR).
**WARNING**: This repository contains work-in-progress prototypes, and has not received careful code review. It is NOT ready for production use.