Skip to content

Clarify handling of snapshots in README #141

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

Merged
mdehoog merged 3 commits into from
Nov 7, 2023
Merged

Clarify handling of snapshots in README #141

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0722390
docs: clarify that snapshots have to be decompressed
boldkoala4615 Nov 1, 2023
0193f11
Update README.md
boldkoala4615 Nov 7, 2023
3bc2940
Merge branch 'base-org:main' into patch-1
boldkoala4615 Nov 7, 2023
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
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