Skip to content

Commit 0a25f3a

Browse files
authored
update erigon doc (#470)
1 parent ea22378 commit 0a25f3a

File tree

3 files changed

+55
-16
lines changed

3 files changed

+55
-16
lines changed

docs/bnb-smart-chain/developers/node_operators/archive_node.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,8 @@ Running an archive node will take a high cost as it includes all the block and s
2727

2828
### Run with an Erigon client
2929

30-
[Erigon](https://github.com/node-real/bsc-erigon) has supported BSC mainnet. You can also refer to [Free public BNB Smart Chain Archive Snapshot](https://github.com/allada/bsc-archive-snapshot) for the guide to run a BSC archive node with an Erigon client. The owner has switched to using an Erigon client for a BSC archive node recently. You can download the archive snapshot which is a tarball from aws s3. The s3 path is "s3://public-blockchain-snapshots/bsc/erigon-latest.tar.zstd". This path is public, but is configured as requester-pays. Also this means you'll need an AWS account in order to download it.
30+
[Erigon](https://github.com/node-real/bsc-erigon) now supports the BSC mainnet. The latest version allows you to sync an archive node from scratch in just 3 days, using 4.3 TB of disk space. You can use Erigon to operate an archive node; for more information, please refer to the [Erigon Node](./erigon_node.md).
3131

32-
* Command to download to local dir:
33-
34-
```
35-
aws s3 cp --request-payer=requester "s3://public-blockchain-snapshots/bsc/erigon-latest.tar.zstd" local_data_dir
36-
37-
tar --use-compress-program=unzstd -xvf erigon-latest.tar.zstd
38-
```
39-
40-
* Command to run:
41-
42-
```
43-
./erigon --chain=bsc --datadir local_data_dir
44-
```
45-
46-
The known Issue with an Erigon client is that it does not really keep up with the latest blocks as mentioned in the Github. If you want to keep up with the latest blocks it is suggested to run a BSC archive node with high performance disk such as NVME, or run a BSC full node with a Geth client at the same time which means you need one proxy that will ask Erigon if it has the block height and if not forward it to the Geth client.
4732

4833
### Run with a Reth client
4934

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: BSC Erigon Node Deployment Guide
3+
---
4+
5+
# BSC Erigon Node Deployment Guide
6+
7+
BSC Erigon, maintained by the Node Real team, is a fork of Erigon aimed at becoming the premier archive node implementation for the BSC network.
8+
9+
## Hardware Requirements
10+
11+
To ensure optimal performance of your BSC Erigon node, we recommend the following hardware specifications:
12+
13+
* RAM: 64GB or more (higher RAM correlates with better performance)
14+
* Storage: SSD or NVMe
15+
- Archive Node: Minimum 5TB
16+
- Fast Node: Minimum 700GB
17+
18+
## BSC Erigon Node Deployment Steps
19+
20+
### 1. Obtain the Erigon Binary
21+
22+
Option 1: Build from source
23+
```shell
24+
git clone https://github.com/node-real/bsc-erigon.git
25+
cd bsc-erigon
26+
make erigon
27+
```
28+
Option 2: Use Docker image
29+
```shell
30+
docker pull ghcr.io/node-real/bsc-erigon:${latest_version}
31+
```
32+
### 2. Launch the Erigon Node
33+
By default, the node will run in archive mode. Syncing from scratch typically takes about 3 days.
34+
```shell
35+
./build/bin/erigon \
36+
--datadir="<your_data_directory_path>" \
37+
--chain=bsc \
38+
--port=30303 \
39+
--http.port=8545 \
40+
--authrpc.port=8551 \
41+
--torrent.port=42069 \
42+
--private.api.addr=127.0.0.1:9090 \
43+
--http --ws \
44+
--http.api=eth,debug,net,trace,web3,erigon,bsc
45+
```
46+
**Note**: To avoid port conflicts, specify different ports for each chain if running multiple instances.
47+
48+
### 3. Running a Fast Node (Non-Archive Mode)
49+
Add the --prune.mode=minimal flag to start a fast node. This mode retains only the last 3 days of state and block data, supporting debug_trace* operations for the past 3 days.
50+
51+
If you prefer not to spend days syncing, you can obtain fast node snapshots from [community-maintained repositories](https://github.com/48Club/bsc-snapshots).
52+
53+
By following these steps, you can flexibly deploy either a full BSC Erigon node or a fast node based on your requirements. Whichever option you choose, BSC Erigon will provide you with an efficient and reliable node service.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ nav:
126126
- Full Node: ./bnb-smart-chain/developers/node_operators/full_node.md
127127
- Archive Node: ./bnb-smart-chain/developers/node_operators/archive_node.md
128128
- Fast Node: ./bnb-smart-chain/developers/node_operators/fast_node.md
129+
- Erigon Node: ./bnb-smart-chain/developers/node_operators/erigon_node.md
129130
- Reth Node: ./bnb-smart-chain/developers/node_operators/reth_node.md
130131
- Boot Node: ./bnb-smart-chain/developers/node_operators/boot_node.md
131132
- Docker Image: ./bnb-smart-chain/developers/node_operators/docker.md

0 commit comments

Comments
 (0)