Skip to content

docs: document RETH_HISTORICAL_PROOFS optional feature #1146

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

Open
consumeobeydie wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

docs: document RETH_HISTORICAL_PROOFS optional feature #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .env.mainnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ STATSD_ADDRESS="172.17.0.1"
# FLASHBLOCKS (OPTIONAL - UNCOMMENT TO ENABLE)
# RETH_FB_WEBSOCKET_URL=wss://mainnet.flashblocks.base.org/ws

# HISTORICAL PROOFS (OPTIONAL - UNCOMMENT TO ENABLE)
# Enables historical proof generation. Initialization may take up to 6 hours on first run.
# RETH_HISTORICAL_PROOFS=true
# RETH_HISTORICAL_PROOFS_STORAGE_PATH=/data/proofs

# PRUNING (OPTIONAL - UNCOMMENT TO ENABLE)
# NOTE: Set to any number of blocks you want, but it should be >10064
# NOTE: The node type that was chosen when first running a node cannot be changed after the initial sync. Turning Archive into Pruned, or Pruned into Full is not supported [source](https://reth.rs/run/faq/pruning/).
Expand Down
5 changes: 5 additions & 0 deletions .env.sepolia
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ STATSD_ADDRESS="172.17.0.1"
# FLASHBLOCKS (OPTIONAL - UNCOMMENT TO ENABLE)
# RETH_FB_WEBSOCKET_URL=wss://sepolia.flashblocks.base.org/ws

# HISTORICAL PROOFS (OPTIONAL - UNCOMMENT TO ENABLE)
# Enables historical proof generation. Initialization may take up to 6 hours on first run.
# RETH_HISTORICAL_PROOFS=true
# RETH_HISTORICAL_PROOFS_STORAGE_PATH=/data/proofs

# PRUNING (OPTIONAL - UNCOMMENT TO ENABLE)
# NOTE: Set to any number of blocks you want, but it should be >10064
# NOTE: The node type that was chosen when first running a node cannot be changed after the initial sync. Turning Archive into Pruned, or Pruned into Full is not supported [source](https://reth.rs/run/faq/pruning/).
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ The following are the hardware specifications we use in production:
- Flashblocks: set `RETH_FB_WEBSOCKET_URL`. When set, the execution client runs in Flashblocks mode; otherwise it runs in vanilla mode.
- Follow mode: set `BASE_NODE_SOURCE_L2_RPC`
- Pruning: set `RETH_PRUNING_ARGS`
- Historical Proofs: set `RETH_HISTORICAL_PROOFS=true` and `RETH_HISTORICAL_PROOFS_STORAGE_PATH=<path>`. Enables historical proof generation. Note: initialization may take up to 6 hours on first run.

For full configuration options, see `.env.mainnet` or `.env.sepolia`.

Expand Down