Document history pruning modes and the EraE format - #355
Merged
Conversation
Rolling pruning and the EraE archive format were both missing from the history pruning page, and the two EraE admin methods were missing from the JSON-RPC reference because the doc generator does not scan Nethermind.EraE.
svlachakis
marked this pull request as ready for review
August 18, 2026 11:15
flcl42
approved these changes
Aug 18, 2026
kamilchodola
approved these changes
Aug 18, 2026
admin.md is produced by DocGen, so hand-inserting the two EraE methods would be overwritten on the next regeneration. NethermindEth/nethermind#12873 makes the generator emit them; until that runs, the page names the methods without linking into the reference.
rubo
approved these changes
Aug 18, 2026
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
4 participants
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.
Two gaps on the history pruning page.
Pruning modes.
History.Pruningwas undocumented, so there was no description ofRollinganywhere, even though it has shipped since 1.33. Added the three modes, the retention floor rule, and the genesis/sync-pivot guarantee.Wording of the intro note. It said history pruning is enabled by default, which reads as "stored history is deleted by default". What is on by default is the barrier-limited download; deleting stored history is opt-in via
History.Pruning. Split the two.EraE format. The page only covered Era1. Added the post-Merge format: layout, slim receipts,
.ereextension with thenoproofsprofile, theEraE.*import/export options, and remote archive downloads.The page names
admin_importEraHistoryandadmin_exportEraHistorywithout linking into the JSON-RPC reference, because that reference is generated and does not contain them yet: DocGen's assembly list omitsNethermind.EraE, so the two methods have never been emitted even though they ship. NethermindEth/nethermind#12873 fixes the generator, and the entries appear the next time the reference is regenerated.