Skip to content

Commit 029e923

Browse files
ropaduropadu
authored
Radu/snapshots (#795)
* feat: add worldchain snapshot * feat: add aptos and avalanche snapshots * feat: change link * fix: add tutorials slug --------- Co-authored-by: Radu Popa <[email protected]>
1 parent 5315291 commit 029e923

File tree

4 files changed

+210
-0
lines changed

4 files changed

+210
-0
lines changed

‎fern/docs.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -657,6 +657,15 @@ navigation:
657657
tutorials/understanding-the-evm/how-to-deploy-a-contract-to-the-same-address-on-multiple-networks/create2-an-alternative-to-deriving-contract-addresses.mdx
658658
slug: how-to-deploy-a-contract-to-the-same-address-on-multiple-networks
659659
slug: understanding-the-evm
660+
- section: Snapshots Service
661+
contents:
662+
- page: Worldchain
663+
path: tutorials/snapshots/worldchain.mdx
664+
- page: Avalanche
665+
path: tutorials/snapshots/avalanche.mdx
666+
- page: Aptos
667+
path: tutorials/snapshots/aptos.mdx
668+
slug: /tutorials/snapshots
660669
slug: tutorials
661670
- section: New to Web3
662671
contents:

‎fern/tutorials/snapshots/aptos.mdx‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Aptos
3+
slug: docs/snapshots/aptos
4+
---
5+
6+
* [Official Docs](https://aptos.dev/)
7+
* [Github Repository](https://github.com/aptos-labs/aptos-core)
8+
9+
The snapshot service for Aptos is available [here](https://alchemy.com/snapshots/aptos).
10+
11+
Whether you need to bootstrap your full node or you are in need of a snapshot to ease the migration or kick-start of your validator, you can use our daily snapshot service to speed up the process.
12+
13+
Note: the nodes used for snapshotting are using the default pruning values of Aptos and are hosted as Docker containers on machines using Ubuntu 22.04.
14+
15+
### How to use
16+
17+
You simply go to our [aptos snapshot service](https://alchemy.com/snapshots/aptos) and you can download the latest available snapshot! In order to use it, simply decompress the archive as per the following instructions and start your node.
18+
19+
**1. Download the snapshot**
20+
21+
```bash
22+
wget <APTOS_SNAPSHOT_URL>
23+
```
24+
25+
**2. Stop your Aptos service**
26+
27+
If Aptos was already running on your machine, stop your services:
28+
29+
```bash
30+
sudo systemctl stop aptos.service
31+
```
32+
33+
OR if you are using a container:
34+
35+
```bash
36+
docker stop <APTOS_CONTAINER_NAME>
37+
```
38+
39+
Make sure there is no process running that might try to write to the database:
40+
41+
```bash
42+
ps -ef | grep aptos-node
43+
```
44+
45+
**3. Clean the data directory**
46+
47+
Make sure your Aptos data directory is clean (let us assume `<APTOS_HOME>` is your root Aptos directory):
48+
49+
```bash
50+
rm -rf <APTOS_HOME>/data/*
51+
```
52+
53+
**4. Install lz4 and decompress the archive**
54+
55+
```bash
56+
sudo apt-get install lz4
57+
```
58+
59+
```bash
60+
lz4 -c -d <APTOS_SNAPSHOT_NAME>.tar.lz4 | tar -x -C <APTOS_HOME>/data
61+
```
62+
63+
**5. Start the Aptos service or container**
64+
65+
You should be in-sync with the network in minutes after starting the node.
66+
67+
<Info>
68+
Please make sure to also check the Official Documentation and the Github Repository posted above in order to correctly deploy the node of your choice.
69+
</Info>

‎fern/tutorials/snapshots/avalanche.mdx‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Avalanche
3+
slug: docs/snapshots/avalanche
4+
---
5+
6+
* [Official Docs](https://build.avax.network/docs)
7+
* [Github Repository](https://github.com/ava-labs)
8+
9+
The snapshot service for Avalanche is available [here](https://alchemy.com/snapshots/avalanche).
10+
11+
Whether you need to bootstrap your full node or you are in need of a snapshot to ease the migration or kick-start of your validator, you can use our daily snapshot service to speed up the process.
12+
13+
Note: the nodes used for snapshotting are using the default pruning values of Avalanche and are hosted as Docker containers on machines using Ubuntu 22.04.
14+
15+
### How to use
16+
17+
You simply go to our [avalanche snapshot service](https://alchemy.com/snapshots/avalanche) and you can download the latest available snapshot! In order to use it, simply decompress the archive as per the following instructions and start your node.
18+
19+
**1. Download the snapshot**
20+
21+
```bash
22+
wget <AVALANCHE_SNAPSHOT_URL>
23+
```
24+
25+
**2. Stop your Avalanche service**
26+
27+
If Avalanche was already running on your machine, stop your services:
28+
29+
```bash
30+
sudo systemctl stop avalanche.service
31+
```
32+
33+
OR if you are using a container:
34+
35+
```bash
36+
docker stop <AVALANCHE_CONTAINER_NAME>
37+
```
38+
39+
Make sure there is no process running that might try to write to the database.
40+
41+
**3. Clean the data directory**
42+
43+
Make sure your Avalanche data directory is clean (let us assume `<AVALANCHE_HOME>` is your root Avalanche directory):
44+
45+
```bash
46+
rm -rf <AVALANCHE_HOME>/db/mainnet/*
47+
```
48+
49+
**4. Install lz4 and decompress the archive**
50+
51+
```bash
52+
sudo apt-get install lz4
53+
```
54+
55+
```bash
56+
lz4 -c -d <AVALANCHE_SNAPSHOT_NAME>.tar.lz4 | tar -x -C <AVALANCHE_HOME>/db/mainnet/
57+
```
58+
59+
**5. Start the Avalanche service or container**
60+
61+
You should be in-sync with the network in minutes after starting the node.
62+
63+
<Info>
64+
Please make sure to also check the Official Documentation and the Github Repository posted above in order to correctly deploy the node of your choice.
65+
</Info>

‎fern/tutorials/snapshots/worldchain.mdx‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Worldchain
3+
slug: docs/snapshots/worldchain
4+
---
5+
6+
* [Official Docs](https://docs.world.org/world-chain)
7+
* [Github Repository](https://github.com/worldcoin/world-chain)
8+
9+
The snapshot service for Worldchain is available [here](https://alchemy.com/snapshots/worldchain).
10+
11+
Whether you need to bootstrap your full node, you can use our daily snapshot service to speed up the process.
12+
13+
Note: the nodes used for snapshotting are using the archive pruning values of Worldchain and are hosted as Systemd services on machines using Ubuntu 22.04.
14+
15+
### How to use
16+
17+
You simply go to our [worldchain snapshot service](https://alchemy.com/snapshots/worldchain) and you can download the latest available snapshot! In order to use it, simply decompress the archive as per the following instructions and start your node.
18+
19+
**1. Download the snapshot**
20+
21+
```bash
22+
wget <WORLDCHAIN_SNAPSHOT_URL>
23+
```
24+
25+
**2. Stop your Worldchain service**
26+
27+
If Worldchain was already running on your machine, stop your services:
28+
29+
```bash
30+
sudo systemctl stop <WORLDCHAIN_GETH_SERVICE>
31+
sudo systemctl stop <WORLDCHAIN_OP_NODE_SERVICE>
32+
```
33+
34+
OR if you are using the recommended docker compose setup:
35+
36+
```bash
37+
docker compose down
38+
```
39+
40+
Make sure there is no process running that might try to write to the database.
41+
42+
**3. Clean the data directory**
43+
44+
Make sure your Worldchain data directory is clean (let us assume `<WORLDCHAIN_HOME>` is your root Worldchain directory):
45+
46+
```bash
47+
rm -rf <WORLDCHAIN_HOME>/geth/chaindata
48+
rm -rf <WORLDCHAIN_HOME>/geth/lightchaindata
49+
```
50+
51+
**4. Install lz4 and decompress the archive**
52+
53+
```bash
54+
sudo apt-get install lz4
55+
```
56+
57+
```bash
58+
lz4 -c -d <WORLDCHAIN_SNAPSHOT_NAME>.tar.lz4 | tar -x -C <WORLDCHAIN_HOME>/geth/
59+
```
60+
61+
**5. Start the Worldchain service or container**
62+
63+
You should be in-sync with the network in minutes after starting the node.
64+
65+
<Info>
66+
Please make sure to also check the Official Documentation and the Github Repository posted above in order to correctly deploy the node of your choice.
67+
</Info>

0 commit comments

Comments
 (0)