docs(run-a-node): fix historical proofs ExEx setup and compose PROFILE default - #1962
Open
kriss39 wants to merge 1 commit into
Open
docs(run-a-node): fix historical proofs ExEx setup and compose PROFILE default#1962kriss39 wants to merge 1 commit into
kriss39 wants to merge 1 commit into
Conversation
Collaborator
🟡 Heimdall Review Status
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed? Why?
Three statements on
specifications/node-operators/run-a-nodedon't match whatbase/baseactually does (checked againstmainat9469da2):RETH_HISTORICAL_PROOFS=truealone does nothing.etc/scripts/node/execution-entrypointonly adds--proofs-history(and runsproofs init) whenRETH_HISTORICAL_PROOFS == "true"andRETH_HISTORICAL_PROOFS_STORAGE_PATHis non-empty. There is no<datadir>/proofsdefault; an operator following the page as written gets a node with the ExEx silently disabled. The page now shows both variables, with/data/proofsas the example path (the execution container's data dir).crates/execution/node/src/args.rs:DEFAULT_PROOFS_HISTORY_WINDOW_BLOCKS = 1_296_000(30 * 24 * 60 * 60 / 2).RETH_PROOFS_HISTORY_WINDOWdoes not exist. No file inbase/basereads it; the window is the--proofs-history.windowCLI 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
PROFILEas defaulting tomaxperf.docker-compose.ymluses${PROFILE:-release}. The publishedghcr.io/base/nodeimage is built withmaxperf(build-release.yml), so the row now says the default isreleaseand how to match the image.Notes to reviewers
DEFAULT_PROOFS_HISTORY_WINDOW_BLOCKS,proofs_history_window)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.mdxpasses (0 errors, 0 warnings).Screenshots
N/A (prose and one table cell; no layout change)