Skip to content

docs(run-a-node): fix historical proofs ExEx setup and compose PROFILE default - #1962

Open
kriss39 wants to merge 1 commit into
base:masterfrom
kriss39:fix/run-a-node-proofs-env
Open

docs(run-a-node): fix historical proofs ExEx setup and compose PROFILE default#1962
kriss39 wants to merge 1 commit into
base:masterfrom
kriss39:fix/run-a-node-proofs-env

Conversation

@kriss39

@kriss39 kriss39 commented Sep 13, 2026

Copy link
Copy Markdown

What changed? Why?

Three statements on specifications/node-operators/run-a-node don't match what base/base actually does (checked against main at 9469da2):

  1. RETH_HISTORICAL_PROOFS=true alone does nothing. etc/scripts/node/execution-entrypoint only adds --proofs-history (and runs proofs init) when RETH_HISTORICAL_PROOFS == "true" and RETH_HISTORICAL_PROOFS_STORAGE_PATH is non-empty. There is no <datadir>/proofs default; an operator following the page as written gets a node with the ExEx silently disabled. The page now shows both variables, with /data/proofs as the example path (the execution container's data dir).
  2. Default retention is 30 days, not 28. crates/execution/node/src/args.rs: DEFAULT_PROOFS_HISTORY_WINDOW_BLOCKS = 1_296_000 (30 * 24 * 60 * 60 / 2).
  3. RETH_PROOFS_HISTORY_WINDOW does not exist. No file in base/base reads it; the window is the --proofs-history.window CLI flag, and the entrypoint doesn't map an env var to it. The note now says that instead of promising an env var that is ignored.

Separately, the compose variable table listed PROFILE as defaulting to maxperf. docker-compose.yml uses ${PROFILE:-release}. The published ghcr.io/base/node image is built with maxperf (build-release.yml), so the row now says the default is release and how to match the image.

Notes to reviewers

If you'd rather expose the window through the entrypoint on the base/base side, happy to reword this once that lands.

How has it been tested?

node scripts/lint-mdx.js docs/specifications/node-operators/run-a-node.mdx passes (0 errors, 0 warnings).

Screenshots

N/A (prose and one table cell; no layout change)

@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/2
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