Skip to content

docs: Clarify that both PLONK and Groth16 proofs are supported #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wayne-o wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Clarify that both PLONK and Groth16 proofs are supported #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Change `v3.0.0` to the desired version to freeze.

## For Developers: Integrate SP1 Contracts

This repository contains the EVM contracts for verifying SP1 PLONK EVM proofs.
This repository contains the EVM contracts for verifying SP1 proofs, supporting both PLONK and Groth16 proof systems.

You can find more details on the contracts in the [`contracts`](./contracts/README.md) directory.

Expand Down
18 changes: 14 additions & 4 deletions contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,17 @@
This repository contains the smart contracts for verifying [SP1](https://github.com/succinctlabs/sp1) EVM proofs.

## Overview
- [`SP1Verifier`](./src/SP1Verifier.sol): The main contract for verifying SP1 EVM proofs.
- [`SP1MockVerifier`](./src/SP1MockVerifier.sol): A mock contract for testing SP1 EVM proofs.
- [`ISP1Verifier`](./src/ISP1Verifier.sol): Interface for SP1Verifier.
- [`PlonkVerifier`](./src/PlonkVerifier.sol): Core logic for verifying Plonk EVM proofs.
The repository supports both PLONK and Groth16 proof systems:

### Core Contracts
- [`ISP1Verifier`](./src/ISP1Verifier.sol): Interface for SP1 verifiers
- [`ISP1VerifierGateway`](./src/ISP1VerifierGateway.sol): Interface for the verifier gateway
- [`SP1VerifierGateway`](./src/SP1VerifierGateway.sol): Gateway contract that routes to appropriate verifier versions
- [`SP1MockVerifier`](./src/SP1MockVerifier.sol): Mock contract for testing

### Verifier Implementations by Version
Each version directory (e.g., `v5.0.0/`) contains:
- `SP1VerifierPlonk.sol`: PLONK proof verifier
- `SP1VerifierGroth16.sol`: Groth16 proof verifier
- `PlonkVerifier.sol`: Core PLONK verification logic
- `Groth16Verifier.sol`: Core Groth16 verification logic