From 5bfba3f423913913e597a44bcebb4b259b751100 Mon Sep 17 00:00:00 2001 From: Typo Fix Bot Date: Sun, 31 May 2026 14:24:19 +0000 Subject: [PATCH] docs: clarify fault-proofs requirement for named networks in README --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 79aa131..d5fb19c 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,10 @@ 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) require the `--fault-proofs` flag to work. The non-fault-proofs flow only works with custom networks using `--l2-rpc`, `--portal-address`, and `--l2oo-address`. #### Step 1 @@ -51,13 +54,13 @@ Example on Base Sepolia: [0x5e47346867cf87d8e8c82cae1d30a94b8d5587dc9d354aef5c5a Prove your withdrawal: ``` -withdrawer --network base-mainnet --withdrawal --rpc --private-key +withdrawer --l2-rpc --l2oo-address --portal-address --withdrawal --rpc --private-key ``` or use a ledger: ``` -withdrawer --network base-mainnet --withdrawal --rpc --ledger +withdrawer --l2-rpc --l2oo-address --portal-address --withdrawal --rpc --ledger ``` Example output: @@ -75,7 +78,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 --l2oo-address --portal-address --withdrawal --rpc --private-key ``` Example output: