From 6b0e94a9e40be727fd9b2e449d36d6a81ea66755 Mon Sep 17 00:00:00 2001 From: Axiom Bot <0xAxiom@users.noreply.github.com> Date: Fri, 22 May 2026 05:26:56 -0700 Subject: [PATCH] docs: fix Without Fault Proofs section to use custom network flags 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 #78 --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 79aa131..b8de594 100644 --- a/README.md +++ b/README.md @@ -36,28 +36,30 @@ go install . > [!CAUTION] > Do not send ERC-20 or other tokens to the L2StandardBridge, only native ETH is supported. -### Without Fault Proofs +### Without Fault Proofs (custom networks only) + +> [!IMPORTANT] +> All named networks (`base-mainnet`, `base-sepolia`, `op-mainnet`, `op-sepolia`) use fault proofs and require the `--fault-proofs` flag. This section applies only to custom op-stack networks that do **not** use fault proofs. Use `--l2-rpc`, `--portal-address`, and `--l2oo-address` to target a custom network. #### Step 1 Initiate a withdrawal on L2 by sending ETH to the `L2StandardBridge` contract at `0x4200000000000000000000000000000000000010`, and note the tx hash. -Example on Base Sepolia: [0x5e47346867cf87d8e8c82cae1d30a94b8d5587dc9d354aef5c5a7b4c84ad9463](https://sepolia.basescan.org/tx/0x5e47346867cf87d8e8c82cae1d30a94b8d5587dc9d354aef5c5a7b4c84ad9463). > [!NOTE] -> Users are required to wait for a period of seven days when moving assets out of Base mainnet into the Ethereum mainnet. This period of time is called the Challenge Period and serves to help secure the assets stored on Base mainnet. +> Users are required to wait for the Challenge Period (typically seven days) when moving assets out of the network into Ethereum mainnet. #### Step 2 Prove your withdrawal: ``` -withdrawer --network base-mainnet --withdrawal --rpc --private-key +withdrawer --l2-rpc --portal-address --l2oo-address --withdrawal --rpc --private-key ``` or use a ledger: ``` -withdrawer --network base-mainnet --withdrawal --rpc --ledger +withdrawer --l2-rpc --portal-address --l2oo-address --withdrawal --rpc --ledger ``` Example output: @@ -75,7 +77,7 @@ _Note: this can be called from any L1 address, it does not have to be the same a After the finalization period, finalize your withdrawal (same command as above): ``` -withdrawer --network base-mainnet --withdrawal --rpc --private-key +withdrawer --l2-rpc --portal-address --l2oo-address --withdrawal --rpc --private-key ``` Example output: