Skip to content

Commit

Permalink
Clarify handling of snapshots in README (#141)
Browse files Browse the repository at this point in the history
* docs: clarify that snapshots have to be decompressed

* Update README.md

docs: clarify that a volume has to be mounted for snapshots
  • Loading branch information
boldkoala4615 authored Nov 7, 2023
1 parent b966cc4 commit 9138035
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If you encounter problems with your node, please open a [GitHub issue](https://g
docker compose up --build
```

3. You should now be able to `curl` your Base node:
4. You should now be able to `curl` your Base node:

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

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.

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

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

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

### Snapshots

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.
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.

**Mainnet**

Expand All @@ -105,6 +107,8 @@ wget https://base-mainnet-archive-snapshots.s3.us-east-1.amazonaws.com/$(curl ht
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)
```
Use `tar -xvf` to decompress the downloaded archive to the local data directory you previously configured a volume mapping for.
### Syncing
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:
Expand Down

0 comments on commit 9138035

Please sign in to comment.