Skip to content

[TRIVIAL] Fix op-rbuilder local devnet docs #557

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

Closed
wants to merge 1 commit into from
Closed

[TRIVIAL] Fix op-rbuilder local devnet docs #557

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
20 changes: 13 additions & 7 deletions crates/op-rbuilder/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To run op-rbuilder with the op-stack, you need:
To run the op-rbuilder, run:

```bash
cargo run -p op-rbuilder --bin op-rbuilder --features optimism -- node \
cargo run -p op-rbuilder --bin op-rbuilder -- node \
--chain /path/to/chain-config.json \
--http \
--authrpc.port 9551 \
Expand All @@ -24,7 +24,7 @@ cargo run -p op-rbuilder --bin op-rbuilder --features optimism -- node \
To build the op-rbuilder, run:

```bash
cargo build -p op-rbuilder --bin op-rbuilder --features optimism
cargo build -p op-rbuilder --bin op-rbuilder
```

## Observability
Expand All @@ -50,13 +50,13 @@ To run the integration tests, run:

```bash
# Generate a genesis file
cargo run -p op-rbuilder --bin tester --features optimism -- genesis --output genesis.json
cargo run -p op-rbuilder --bin tester -- genesis --output genesis.json

# Build the op-rbuilder binary
cargo build -p op-rbuilder --bin op-rbuilder --features optimism
cargo build -p op-rbuilder --bin op-rbuilder

# Run the integration tests
cargo run -p op-rbuilder --bin tester --features optimism -- run
cargo run -p op-rbuilder --bin tester -- run
```

## Local Devnet
Expand All @@ -77,7 +77,13 @@ git checkout op-rbuilder
- Windows: `{FOLDERID_RoamingAppData}/reth/`
- macOS: `$HOME/Library/Application Support/reth/`

3. Run a clean OP stack in the `optimism` repo:
3. Ensure the required foundry version is installed:

```bash
foundryup -C $(jq -r '.foundry' versions.json)
```

4. Run a clean OP stack in the `optimism` repo:

```bash
make devnet-clean && make devnet-down && make devnet-up
Expand All @@ -86,7 +92,7 @@ make devnet-clean && make devnet-down && make devnet-up
4. Run `op-rbuilder` in the `rbuilder` repo on port 8547:

```bash
cargo run -p op-rbuilder --bin op-rbuilder --features optimism -- node \
cargo run -p op-rbuilder --bin op-rbuilder -- node \
--chain ../optimism/.devnet/genesis-l2.json \
--http \
--http.port 8547 \
Expand Down