Skip to content

Commit 2ae9352

Browse files
authored
docs: mdbook add snapshot (#477)
* docs: mdbook add snapshot
1 parent 2f76e0f commit 2ae9352

File tree

2 files changed

+70
-2
lines changed

2 files changed

+70
-2
lines changed

book/src/docker-operations.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,43 @@ Key environment variables:
4242

4343
**Note**: You must provide your own RPC endpoints. Configure these in your `.env` file before starting the stack.
4444

45-
### 3. Start the Stack
45+
### 3. Download Snapshot (Optional)
46+
47+
For faster initial sync, you can optionally download a snapshot of the blockchain data before starting the stack.
48+
49+
**This step is recommended but not required.** Without a snapshot, the node will sync from genesis, which can take considerably longer.
50+
51+
**Step 1:** Create the volume directory if it doesn't exist:
52+
53+
```bash
54+
mkdir -p volumes/l2reth
55+
```
56+
57+
**Step 2:** Download the snapshot for your target network:
58+
59+
For Scroll Mainnet:
60+
```bash
61+
wget https://scroll-geth-snapshot.s3.us-west-2.amazonaws.com/reth/latest.tar
62+
```
63+
64+
For Scroll Sepolia:
65+
```bash
66+
wget https://scroll-sepolia-l2geth-snapshots.s3.us-west-2.amazonaws.com/reth/latest.tar
67+
```
68+
69+
**Step 3:** Extract the snapshot to the volume directory (`volumes/l2reth`):
70+
71+
```bash
72+
tar -xvf latest.tar -C volumes/l2reth
73+
```
74+
75+
**Step 4:** Clean up the downloaded archive:
76+
77+
```bash
78+
rm latest.tar
79+
```
80+
81+
### 4. Start the Stack
4682

4783
For standard operation (following public networks):
4884

@@ -56,7 +92,7 @@ For shadow-fork mode:
5692
docker compose --profile shadow-fork up -d
5793
```
5894

59-
### 4. Access the Services
95+
### 5. Access the Services
6096

6197
Once running, the following endpoints are available:
6298

book/src/running-a-node.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,38 @@ For development builds (faster compilation, slower runtime):
3737
cargo build --bin rollup-node
3838
```
3939

40+
## Download Snapshot (Optional)
41+
42+
For faster initial sync, you can optionally download a snapshot of the blockchain data instead of syncing from genesis.
43+
44+
**This step is recommended but not required.** Without a snapshot, the node will sync from genesis, which can take considerably longer.
45+
46+
**Step 1:** Download the snapshot for your target network:
47+
48+
For Scroll Mainnet:
49+
```bash
50+
wget https://scroll-geth-snapshot.s3.us-west-2.amazonaws.com/reth/latest.tar
51+
```
52+
53+
For Scroll Sepolia:
54+
```bash
55+
wget https://scroll-sepolia-l2geth-snapshots.s3.us-west-2.amazonaws.com/reth/latest.tar
56+
```
57+
58+
**Step 2:** Extract the snapshot to your data directory:
59+
60+
```bash
61+
tar -xvf latest.tar -C <DATADIR_PATH>
62+
```
63+
64+
Replace `<DATADIR_PATH>` with your node's data directory path. This should match the `--datadir` flag you'll use when running the node (see configuration section below).
65+
66+
**Step 3:** Clean up the downloaded archive:
67+
68+
```bash
69+
rm latest.tar
70+
```
71+
4072
## Running the Node
4173

4274
### Basic Command

0 commit comments

Comments
 (0)