docs: fix Without Fault Proofs section to use custom network flags#79
Open
0xAxiom wants to merge 1 commit into
Open
docs: fix Without Fault Proofs section to use custom network flags#790xAxiom wants to merge 1 commit into
0xAxiom wants to merge 1 commit into
Conversation
All named networks (base-mainnet, base-sepolia, op-mainnet, op-sepolia) have faultProofs=true in main.go, so running any of them without --fault-proofs exits with "Fault proofs are required on this network". The "Without Fault Proofs" section was showing --network base-mainnet commands that would always fail for users copying from the README. Fix: - Retitle the section to clarify it applies to custom networks only - Add an IMPORTANT callout explaining that all named networks require --fault-proofs and pointing to the custom network flags - Replace --network base-mainnet examples with custom network flag form (--l2-rpc, --portal-address, --l2oo-address) which is the correct usage pattern for networks without fault proofs Closes base#78
Collaborator
🟡 Heimdall Review Status
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #78
What
The "Without Fault Proofs" section showed
--network base-mainnetcommands that always fail —main.gomarksbase-mainnet(and all other named networks) asfaultProofs: true, so running without--fault-proofsexits immediately with:Changes
[!IMPORTANT]callout explaining that all four named networks require--fault-proofsand pointing users to the custom network flags (--l2-rpc,--portal-address,--l2oo-address)--network base-mainnetexample commands with the correct custom-network flag form, which is the only valid usage pattern for non-fault-proof networks