chore(l2): update prover docs #5105
Open
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for the ethrex prover system, reorganizing and expanding the existing L2 prover documentation. The changes focus on explaining how zero-knowledge proofs are generated for block execution using stateless execution and execution witnesses.
- Adds new standalone prover documentation explaining stateless execution, execution witnesses, and zkVM integration
- Reorganizes L2 architecture documentation by extracting detailed prover internals into dedicated files
- Adds documentation for data availability, execution witnesses, and developer setup instructions
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/prover/prover.md | New comprehensive guide explaining prover architecture, stateless execution, and L2-specific checks |
| docs/prover/guest_program.md | New detailed documentation of the guest program execution steps and public inputs/outputs |
| docs/l2/fundamentals/execution_witness.md | New explanation of execution witness creation, MPT proofs, and trie restructuring edge cases |
| docs/l2/fundamentals/data_availability.md | New documentation on state diffs, blob data, and KZG commitments for data availability |
| docs/l2/architecture/prover.md | Simplified to high-level overview with references to detailed prover documentation |
| docs/l2/architecture/overview.md | Streamlined by removing detailed prover explanations now in dedicated files |
| docs/developers/l2/prover.md | New developer guide with setup instructions, GPU configuration, and environment variables |
| docs/SUMMARY.md | Updated with new documentation entries |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Updated validation steps to clarify state trie root comparison and merkle proof verification.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
tomip01
reviewed
Oct 30, 2025
| ETHREX_L2_SP1=true | ||
| # Check the if the verification contract is present on your preferred network. Don't define this if you want it to be deployed automatically. | ||
| ETHREX_DEPLOYER_SP1_VERIFIER_ADDRESS=<address> | ||
| # Set to true if you want proofs to be required |
There was a problem hiding this comment.
Suggested change
| # Set to true if you want proofs to be required | |
| # Set to true if you want RISC0 proofs to be required |
Comment on lines
+118
to
+119
| - `make rm-db-l2 && make down` | ||
| - `make deploy-l1 && make init-l2` (if running a risc0 prover, see the next step before invoking the L1 contract deployer) |
There was a problem hiding this comment.
Suggested change
| - `make rm-db-l2 && make down` | |
| - `make deploy-l1 && make init-l2` (if running a risc0 prover, see the next step before invoking the L1 contract deployer) | |
| - `make rm-db-l2 down` | |
| - `make deploy-l1 init-l2` (if running a risc0 prover, see the next step before invoking the L1 contract deployer) |
| - `make rm-db-l2 && make down` | ||
| - `make deploy-l1 && make init-l2` (if running a risc0 prover, see the next step before invoking the L1 contract deployer) | ||
|
|
||
| - If running with a local L1 (for development), you will need to manually deploy the risc0 contracts by following the instructions [here](https://github.com/risc0/risc0-ethereum/tree/main/contracts/script). |
There was a problem hiding this comment.
We could mention how to deploy the sp1 verifier contract with the deployer
|
We should add more details on the prover's inputs/outputs, what it commits as public values and what remains private, and which computation it does with each value, as this is one of the most critical aspects of the prover (thank you @MauroToscano for the feedback!) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Organizes and updates some older docs