Skip to content

rename --reconstruct-historic-states to --archive#8795

Merged
mergify[bot] merged 4 commits into
sigp:unstablefrom
dapplion:rename-archive-flag
Feb 11, 2026
Merged

rename --reconstruct-historic-states to --archive#8795
mergify[bot] merged 4 commits into
sigp:unstablefrom
dapplion:rename-archive-flag

Conversation

@dapplion

@dapplion dapplion commented Feb 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Rename the --reconstruct-historic-states CLI flag to --archive
  • Keep --reconstruct-historic-states as a hidden alias for backwards compatibility
  • Rename the internal config field reconstruct_historic_states to archive
  • Update all documentation references in the book
  • Update and add CLI tests (including alias test)

Test plan

  • cargo check passes
  • cargo fmt clean
  • make lint-full passes (ran via pre-push hook)
  • CLI tests pass in release mode: archive_flag, archive_flag_alias, no_archive_flag, genesis_backfill_with_archive_flag

@dapplion
spec'ed by me, written by opus 4.6, manually reviewed by me

Rename the CLI flag and the internal config field to the shorter
`--archive` name. The old `--reconstruct-historic-states` flag is
kept as a hidden alias for backwards compatibility.

Update documentation and tests accordingly.

@michaelsproul michaelsproul left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. The only change I can think of that's missing is a deprecation warning for the old flag. Unless we don't want to deprecate it yet?

Comment thread beacon_node/src/cli.rs
.long("reconstruct-historic-states")
Arg::new("archive")
.long("archive")
.alias("reconstruct-historic-states")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically this description is wrong, the flag is now also relevant for genesis sync. Maybe we could state something general like "store all states" and elaborate that for checkpoint sync it means the states will be reconstructed after backfill completes

@michaelsproul michaelsproul added the waiting-on-author The reviewer has suggested changes and awaits thier implementation. label Feb 10, 2026
@dapplion dapplion force-pushed the rename-archive-flag branch from accf986 to f329c9e Compare February 11, 2026 20:59
@dapplion

Copy link
Copy Markdown
Collaborator Author

Updated the help text to be more general: "Store all beacon states in the database. When checkpoint syncing, states are reconstructed after backfill completes."

Re deprecation: we'd prefer to keep --reconstruct-historic-states as a permanent alias rather than deprecate it, so no warning added.

@michaelsproul michaelsproul left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now, thanks!

I'll label this as backwards-incompat (even though it isn't technically) so it gets flagged for a mention in the release notes.

@michaelsproul michaelsproul added ready-for-merge This PR is ready to merge. and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. labels Feb 11, 2026
@mergify mergify Bot added the queued label Feb 11, 2026
@mergify

mergify Bot commented Feb 11, 2026

Copy link
Copy Markdown

Merge Queue Status

Rule: default


This pull request spent 29 minutes 42 seconds in the queue, including 28 minutes 2 seconds running CI.

Required conditions to merge
  • check-success=local-testnet-success
  • check-success=test-suite-success

mergify Bot added a commit that referenced this pull request Feb 11, 2026
@mergify mergify Bot merged commit d7c78a7 into sigp:unstable Feb 11, 2026
37 checks passed
@mergify mergify Bot removed the queued label Feb 11, 2026
@michaelsproul michaelsproul added the backwards-incompat Backwards-incompatible API change label Feb 12, 2026
@dapplion dapplion deleted the rename-archive-flag branch February 14, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backwards-incompat Backwards-incompatible API change ready-for-merge This PR is ready to merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants