Skip to content

docs: clarify fault-proofs requirement for named networks in README #80

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

Open
Arvuno wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify fault-proofs requirement for named networks in README #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -51,13 +54,13 @@ Example on Base Sepolia: [0x5e47346867cf87d8e8c82cae1d30a94b8d5587dc9d354aef5c5a
Prove your withdrawal:

```
withdrawer --network base-mainnet --withdrawal <withdrawal tx hash> --rpc <L1 RPC URL> --private-key <L1 private key>
withdrawer --l2-rpc <L2 RPC URL> --l2oo-address <L2OutputOracle address> --portal-address <OptimismPortal address> --withdrawal <withdrawal tx hash> --rpc <L1 RPC URL> --private-key <L1 private key>
```

or use a ledger:

```
withdrawer --network base-mainnet --withdrawal <withdrawal tx hash> --rpc <L1 RPC URL> --ledger
withdrawer --l2-rpc <L2 RPC URL> --l2oo-address <L2OutputOracle address> --portal-address <OptimismPortal address> --withdrawal <withdrawal tx hash> --rpc <L1 RPC URL> --ledger
```

Example output:
Expand All @@ -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 <withdrawal tx hash> --rpc <L1 RPC URL> --private-key <L1 private key>
withdrawer --l2-rpc <L2 RPC URL> --l2oo-address <L2OutputOracle address> --portal-address <OptimismPortal address> --withdrawal <withdrawal tx hash> --rpc <L1 RPC URL> --private-key <L1 private key>
```

Example output:
Expand Down