Skip to content
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

docs: solidity recomended workflow note #2003

Merged
merged 3 commits into from
Feb 24, 2025
Merged

docs: solidity recomended workflow note #2003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a18ff4
docs: solidity reccomended workflow note
nhtyy Jan 30, 2025
82f14dc
fix: incorporate reccomendations
nhtyy Jan 30, 2025
f0813ea
Apply suggestions from code review
ratankaliani Feb 24, 2025
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 book/docs/verification/onchain/contract-addresses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ If you want support for a canonical verifier on your chain, contact us [here](ht

## ISP1Verifier Interface

All verifiers implement the [ISP1Verifier](https://github.com/succinctlabs/sp1-contracts/blob/main/contracts/src/ISP1Verifier.sol) interface.
All verifiers (including the gateway) implement the [ISP1Verifier](https://github.com/succinctlabs/sp1-contracts/blob/main/contracts/src/ISP1Verifier.sol) interface.

```c++
// SPDX-License-Identifier: MIT
Expand Down
7 changes: 7 additions & 0 deletions book/docs/verification/onchain/solidity-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ contract Fibonacci {

```

The recommended on-chain SP1 proof verification workflow is to use the `ISP1Verifier` interface on the [`SP1VerifierGateway`](./contract-addresses.md),
so the `SP1VerifierGateway` automatically routes your proof to the correct verifier.

Your program’s verification key should be upgradeable within your contract, in case you want to upgrade to a newer version of SP1 or modify your program.

Succinct maintains the ability to freeze verifiers on the canonical verifier gateway in the event of a security issue to prevent abuse. Note that verifier contract deployment is permissionless to enable customizable security configurations.

### Finding your program vkey

The program vkey (`fibonacciProgramVKey` in the example above) is passed into the `ISP1Verifier` along with the public values and proof bytes. You
Expand Down