-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: refactor docs and main readme (#10)
- Loading branch information
1 parent
db4b679
commit 83b0d04
Showing
4 changed files
with
32 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# OpenVM Stark Backend | ||
|
||
[Contributor Docs](./docs) | ||
| [Crate Docs](https://docs.openvm.dev/stark-backend) | ||
|
||
A modular proof system backend for proving and verifying multi-chip circuits with inter-chip communication. | ||
|
||
The backend is designed to be modular and compatible with different proof systems, with a focus on performance and extensibility. The aim is to support different circuit representations and permutation/lookup arguments. | ||
|
||
## Crates | ||
|
||
- [`openvm-stark-backend`](crates/stark-backend): General purpose STARK proving system with multi-trace and logup support, built on top of Plonky3. | ||
- [`openvm-stark-sdk`](crates/stark-sdk): Low-level SDK for use with STARK backend to generate proofs for specific STARK configurations. | ||
|
||
## Security Status | ||
|
||
As of December 2024, the STARK backend has not been audited and is currently not recommended for production use. We plan to continue development towards a production-ready release in 2025. | ||
|
||
## Acknowledgements | ||
|
||
We studied and built upon the work of other teams in our quest to design a modular and performant proving framework. | ||
We would like to thank these teams for sharing their code for open source development: | ||
|
||
- [Plonky3](https://github.com/Plonky3/Plonky3): This codebase is built on top of Plonky3, where we have heavily benefited from their modular design at the polynomial IOP level. We extend Plonky3 by providing higher level interfaces for proving multi-chip circuits. | ||
- [Valida](https://github.com/valida-xyz/valida): Valida introduced the exceptionally elegant interactions interface for multi-chip communication via logup permutation arguments. We have found this interface quite well thought out and have built upon and extended it. | ||
- [SP1](https://github.com/succinctlabs/sp1): We learned from SP1's `AirBuilder` designs, and the original design for the `InteractionBuilder` was inspired by them. | ||
- [Stwo](https://github.com/starkware-libs/stwo): We studied Stwo's performant sumcheck implementations and have begun integrating them into our backend. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Contributor Docs | ||
|
||
- [STARK Backend](./stark-backend.md) | ||
- [AIR Interactions](./interactions.md) |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters