Skip to content

Commit 1fc41a6

Browse files
docs: align README with default execution client (Geth)
1 parent 3bac950 commit 1fc41a6

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [
2424
```
2525
4. Start the node:
2626

27+
The default [execution client](#supported-clients) is **Geth** unless you set the `CLIENT` environment variable (see the root `.env` and `docker-compose.yml`).
28+
2729
```bash
28-
# For mainnet (default):
30+
# For mainnet (default, Geth):
2931
docker compose up --build
3032

3133
# For testnet:
3234
NETWORK_ENV=.env.sepolia docker compose up --build
3335

34-
# To use a specific client (optional):
36+
# To use a different client (e.g. Reth):
3537
CLIENT=reth docker compose up --build
3638

3739
# For testnet with a specific client:
@@ -40,8 +42,10 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [
4042

4143
### Supported Clients
4244

43-
- `reth` (default)
44-
- `geth`
45+
Execution clients (override with `CLIENT=…`; default is **Geth**):
46+
47+
- `geth` (default)
48+
- `reth`
4549
- `nethermind`
4650

4751
## Requirements
@@ -71,13 +75,7 @@ The following are the hardware specifications we use in production:
7175
- **Filesystem**: ext4
7276

7377
> [!NOTE]
74-
To run the node using a supported client, you can use the following command:
75-
`CLIENT=supported_client docker compose up --build`
76-
77-
Supported clients:
78-
- reth (runs vanilla node by default, Flashblocks mode enabled by providing RETH_FB_WEBSOCKET_URL, see [Reth Node README](./reth/README.md))
79-
- geth
80-
- nethermind
78+
The default image is Geth. To use another client, set `CLIENT` and rebuild, for example: `CLIENT=reth docker compose up --build` or `CLIENT=nethermind docker compose up --build`. For Reth-specific options (e.g. Flashblocks via `RETH_FB_WEBSOCKET_URL`), see the [Reth Node README](./reth/README.md).
8179

8280
## Configuration
8381

0 commit comments

Comments
 (0)