From bb6ce3471fa9480eeb6b1291d70c9d6ee04660c6 Mon Sep 17 00:00:00 2001 From: benperlmutter Date: Mon, 26 Jan 2026 17:25:49 -0800 Subject: [PATCH] docs: add Default Ports and Stopping the Node sections to README - Add Default Ports section documenting exposed ports for Execution Client and OP Node - Add Stopping the Node section with graceful shutdown instructions Closes #903 Closes #904 --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 1cbaad17..a895df2d 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,44 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [ - `geth` - `nethermind` +## Default Ports + +The node exposes the following ports by default: + +**Execution Client:** +| Port | Protocol | Description | +|------|----------|-------------| +| 8545 | TCP | HTTP JSON-RPC | +| 8546 | TCP | WebSocket | +| 7301 | TCP | Metrics | +| 30303 | TCP/UDP | P2P | + +**OP Node:** +| Port | Protocol | Description | +|------|----------|-------------| +| 7545 | TCP | HTTP JSON-RPC | +| 9222 | TCP/UDP | P2P | +| 7300 | TCP | Metrics | +| 6060 | TCP | pprof | + +These ports can be customized by modifying the `docker-compose.yml` file. + +## Stopping the Node + +To stop the node gracefully: + +```bash +docker compose down +``` + +To stop the node and remove all data volumes (full reset): + +```bash +docker compose down -v +``` + +If running in the foreground, you can also press `Ctrl+C` to initiate a graceful shutdown. + ## Requirements ### Minimum Requirements