Skip to content

docs: document RETH_HISTORICAL_PROOFS optional feature#1146

Open
consumeobeydie wants to merge 1 commit into
base:mainfrom
consumeobeydie:docs/add-historical-proofs-documentation
Open

docs: document RETH_HISTORICAL_PROOFS optional feature#1146
consumeobeydie wants to merge 1 commit into
base:mainfrom
consumeobeydie:docs/add-historical-proofs-documentation

Conversation

@consumeobeydie

Copy link
Copy Markdown

What changed? Why?

The execution-entrypoint supports Historical Proofs via RETH_HISTORICAL_PROOFS and RETH_HISTORICAL_PROOFS_STORAGE_PATH environment variables, but these were not documented in the README or the .env template files.

All other optional features (Flashblocks, Follow mode, Pruning) follow a consistent pattern: documented in README + commented in .env.mainnet and .env.sepolia. This PR applies the same pattern to Historical Proofs.

Changes:

  • README.md: Added Historical Proofs to the Optional Features section
  • .env.mainnet: Added commented Historical Proofs section before Pruning
  • .env.sepolia: Added commented Historical Proofs section before Pruning

Notes to reviewers

No code changes — documentation only. The feature already exists in execution-entrypoint (lines 77-128).

How has it been tested?

Verified against execution-entrypoint source to confirm variable names and behavior.

@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants