Skip to content

docs: clarify --serveHistoricalState and --chain.pruneHistory help text #9328

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

Merged
nflaig merged 5 commits into from
May 6, 2026
Merged

docs: clarify --serveHistoricalState and --chain.pruneHistory help text #9328

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a967ead
docs(cli): clarify --serveHistoricalState and --chain.pruneHistory he…
lodekeeper May 5, 2026
7a3cfa0
docs(cli): address Gemini review on --serveHistoricalState and --chai…
lodekeeper May 5, 2026
09ff2cb
docs(cli): apply Nico review on --serveHistoricalState and --chain.pr…
lodekeeper May 6, 2026
e8c7ca7
docs(cli): drop 'debug' qualifier from REST API reference in --serveH…
lodekeeper May 6, 2026
9f90b57
docs(cli): tighten pruneHistory disk-usage wording
lodekeeper May 6, 2026
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
9 changes: 7 additions & 2 deletions packages/cli/src/options/beaconNodeOptions/chain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ export const options: CliCommandOptions<ChainArgs> = {

serveHistoricalState: {
description:
"Enable regenerating finalized state to serve historical data. Fetching this data is expensive and may affect validator performance.",
"Regenerate finalized beacon states on demand and serve them via the REST API (e.g. `/eth/v2/debug/beacon/states/{state_id}`). \
Does not backfill historical data, only states the node already has (since genesis sync or `--checkpointState`) can be regenerated. \
Regeneration cost depends on `--chain.archiveStateEpochFrequency` and may affect validator performance.",
type: "boolean",
default: defaultOptions.chain.serveHistoricalState,
group: "chain",
Expand Down Expand Up @@ -315,7 +317,10 @@ Will double processing times. Use only for debugging purposes.",
},

"chain.pruneHistory": {
description: "Prune historical blocks and state",
description:
"Continually prune finalized blocks older than `MIN_EPOCHS_FOR_BLOCK_REQUESTS` (33024 epochs / ~5 months on mainnet) and all archived states before the finalized epoch. \
This is useful to minimize disk usage when the node does not need to serve historical data. \
Initial pruning may be slow on first startup with an existing large database.",
type: "boolean",
default: defaultOptions.chain.pruneHistory,
group: "chain",
Expand Down
Loading