add information about this fork into the README

This commit is contained in:
Balazs Komuves 2024-12-06 14:26:53 +01:00
parent 5ead86a97a
commit a228ba76d7
No known key found for this signature in database
GPG Key ID: F63B7AEF18435562

View File

@ -3,6 +3,22 @@
This repository was originally for Plonky2, a SNARK implementation based on techniques from PLONK and FRI. It has since expanded to include tools such as Starky, a highly performant STARK implementation.
## Codex fork
This repo is Codex's fork of the original Plonky2 repository at https://github.com/0xPolygonZero/plonky2/.
For now at least, our modifications are in the [`codex` branch](https://github.com/codex-storage/plonky2/tree/codex).
These include:
- [x] option to turn off randomizing unused wires
- [x] option to export the witness and related metadata
- [x] simple web-based tool to visualize the witness
- [ ] tooling to analyze circuits
- [ ] support for Monolith hash
- [ ] support for Poseidon2-Goldilocks hash
- [ ] support for Poseidon2-BN254 hash (for more efficient BN254 wrapper)
## Documentation