Skip to content

Commit 9138035

Browse files
Clarify handling of snapshots in README (#141)
* docs: clarify that snapshots have to be decompressed * Update README.md docs: clarify that a volume has to be mounted for snapshots
1 parent b966cc4 commit 9138035

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If you encounter problems with your node, please open a [GitHub issue](https://g
5959
docker compose up --build
6060
```
6161

62-
3. You should now be able to `curl` your Base node:
62+
4. You should now be able to `curl` your Base node:
6363

6464
```
6565
curl -d '{"id":0,"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false]}' \
@@ -68,7 +68,7 @@ curl -d '{"id":0,"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["late
6868

6969
Note: Some L1 nodes (e.g. Erigon) do not support fetching storage proofs. You can work around this by specifying `--l1.trustrpc` when starting op-node (add it in `op-node-entrypoint` and rebuild the docker image with `docker compose build`.) Do not do this unless you fully trust the L1 node provider.
7070

71-
You can map a local data directory for `op-geth` by adding a volume mapping to the `docker-compose.yaml`:
71+
5. Map a local data directory for `op-geth` by adding a volume mapping to the `docker-compose.yaml`:
7272

7373
```yaml
7474
services:
@@ -78,6 +78,8 @@ services:
7878
- $HOME/data/base:/data
7979
```
8080
81+
This is where your node data will be stored. This is for example where you would extract your [snapshot](#snapshots) to.
82+
8183
#### Running in single container with `supervisord`
8284

8385
If you'd like to run the node in a single container instead of `docker-compose`, you can use the `supervisord` entrypoint.
@@ -91,7 +93,7 @@ docker run --env-file .env.goerli -e OP_NODE_L2_ENGINE_RPC=ws://localhost:8551 -
9193

9294
### Snapshots
9395

94-
If you're a prospective or current Base Node operator and would like to restore from a snapshot to save time on the initial sync, it's possible to always get the latest available snapshot of the Base chain on mainnet and/or testnet by using the following CLI commands. The snapshots are updated every hour.
96+
If you're a prospective or current Base Node operator and would like to restore from a snapshot to save time on the initial sync, it's always possible to download and decompress the latest available snapshot of the Base chain on mainnet and/or testnet by using the following CLI commands. The snapshots are updated every hour.
9597

9698
**Mainnet**
9799

@@ -105,6 +107,8 @@ wget https://base-mainnet-archive-snapshots.s3.us-east-1.amazonaws.com/$(curl ht
105107
wget https://base-goerli-archive-snapshots.s3.us-east-1.amazonaws.com/$(curl https://base-goerli-archive-snapshots.s3.us-east-1.amazonaws.com/latest)
106108
```
107109
110+
Use `tar -xvf` to decompress the downloaded archive to the local data directory you previously configured a volume mapping for.
111+
108112
### Syncing
109113
110114
Sync speed depends on your L1 node, as the majority of the chain is derived from data submitted to the L1. You can check your syncing status using the `optimism_syncStatus` RPC on the `op-node` container. Example:

0 commit comments

Comments
 (0)