Skip to content

Commit

Permalink
docs: remove reth docs (#548)
Browse files Browse the repository at this point in the history
  • Loading branch information
j75689 authored Jan 23, 2025
1 parent f6ff36a commit 121615a
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 251 deletions.
11 changes: 0 additions & 11 deletions docs/bnb-opbnb/advanced/node-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,6 @@ It is particularly advised to operate a full node with PBSS and pebble to minimi

For comprehensive details, consult the [PBSS document](./run-with-pebbledb-and-pbss.md).

### Archive Node(with op-reth)

The Archive node mode archives the entirety of history trie data.
This mode is apt for scenarios necessitating access to the complete history trie data, such as block explorers and analytics.

The current volume of history trie data approximates 3TB (as of the end of April, 2024).
Significant performance issues may arise in the op-geth implementation when managing extensive history trie data.
Therefore, it is recommended to operate the archive node in conjunction with op-reth.

You can refer to [Reth Node for opBNB](./reth-node.md) for additional details.

## Snapshots

The latest snapshot data is accessible via the [opbnb-snapshot](https://github.com/bnb-chain/opbnb-snapshot) repository.
Expand Down
159 changes: 0 additions & 159 deletions docs/bnb-opbnb/advanced/reth-node.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,6 @@ Running an archive node will take a high cost as it includes all the block and s

[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 as shown below.


### Run with a Reth client

[Reth](https://github.com/bnb-chain/reth) now supports the BSC network and demonstrates superior performance compared to Geth and Erigon in recent benchmark tests. You can utilize reth to operate an archive node (as well as full node); for more information, refer to [Full Node](./full_node.md).



---
title: BSC Erigon Node Deployment Guide
---
Expand Down
74 changes: 1 addition & 73 deletions docs/bnb-smart-chain/developers/node_operators/full_node.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ Full node stores the full world state on disk and is capable of:
Currently, there are 3 different clients to run a BSC full:

* Geth: https://github.com/bnb-chain/bsc
* Reth: https://github.com/bnb-chain/reth
* Erigon: https://github.com/node-real/bsc-erigon

Only Geth and Reth will be covered in this page, as Erigon is mainly to support archive mode, pls refer [archive_node.md](./archive_node.md) for its usage.
Only Geth will be covered in this page, as Erigon is mainly to support archive mode, pls refer [archive_node.md](./archive_node.md) for its usage.

!!! tip
If you want high performance and care little about state consistency, you can run a fast node, which is a full node with the flag `--tries-verify-mode none` set.
Expand Down Expand Up @@ -125,74 +124,3 @@ Please read [this guide](node_maintenance.md)

#### d.Upgrade Geth
Please read [this guide](upgrade_geth.md)

## 3.Run BSC Full Node: Reth

BSC Reth is a cutting-edge Rust client developed in collaboration with Paradigm, designed to provide seamless support for BNB Smart Chain (BSC). It aims to enhance client diversity on the BNB Chain by offering a secure and efficient execution client.

### 3.1.Hardware Specifications

To run BSC Reth effectively, ensure your system meets the following hardware requirements:

* CPU with 16+ cores
* 128GB RAM
* High-performance NVMe SSD with at least 4TB of free space for a full node and 8TB for an archive node
* Broadband internet connection with upload/download speeds of 25 MB/s

### 3.2.Running BSC Reth

1. Download source code and build binary.
```shell
git clone https://github.com/bnb-chain/reth.git
cd reth
make build-bsc
```

2. Start the reth node, it will run in archive mode by default. You can add the `--full` flag to start a full node.
```shell
# for mainnet
export network=bsc
# for testnet
# export network=bsc-testnet
./target/release/bsc-reth node \
--datadir=./datadir \
--chain=${network} \
--http \
--http.api="eth, net, txpool, web3, rpc" \
--log.file.directory ./datadir/logs
```

3. Optionally, you can run the reth node with docker.
```shell
# for mainnet
export network=bsc
# for testnet
# export network=bsc-testnet
# check this for version of the docker image, https://github.com/bnb-chain/reth/pkgs/container/bsc-reth
export version=latest
# the directory where reth data will be stored
export data_dir=/xxx/xxx
docker run -d -p 8545:8545 -p 30303:30303 -p 30303:30303/udp -v ${data_dir}:/data \
--name bsc-reth ghcr.io/bnb-chain/bsc-reth:${version} node \
--datadir=/data \
--chain=${network} \
--http \
--http.api="eth, net, txpool, web3, rpc" \
--log.file.directory /data/logs
```

### 3.3.Snapshot

To synchronize a BSC reth node from scratch to the current block height can be a time-consuming process.
As We benchmark [Reth(v1.0.0)](https://github.com/bnb-chain/reth/releases/tag/v1.0.0) on AWS [lm4gn.8xlarge](https://instances.vantage.sh/aws/ec2/im4gn.8xlarge)(32 core 128G) with 2 x 7500 NVMe SSD for BSC mainnet.
It may take approximately 30 days to sync the latest block on BSC mainnet for an archive node and 24 days for a full node.

Given the extended duration required for stage synchronization of the BSC network, the BNB Chain team is developing a segmented snapshot download solution, scheduled for release in the near future.
Currently, developers seeking to expedite the process can obtain archive node snapshots from [community-maintained repositories](https://github.com/fuzzland/snapshots).
These snapshots offer a faster alternative to syncing from genesis, allowing for quicker node setup and network participation.
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,6 @@ nav:
- Node Best Practices: ./bnb-opbnb/advanced/node-best-practices.md
- Local Node: ./bnb-opbnb/advanced/local-node.md
- Run with PebbleDB and PBSS: ./bnb-opbnb/advanced/run-with-pebbledb-and-pbss.md
- Reth Node: ./bnb-opbnb/advanced/reth-node.md
- FAQs:
- Protocol FAQs: ./bnb-opbnb/faq/protocol-faqs.md
- Gas and Fees FAQs: ./bnb-opbnb/faq/gas-and-fees-faqs.md
Expand Down

0 comments on commit 121615a

Please sign in to comment.