docs(rpc): document the historical account state retention window - #2618
Open
devorun wants to merge 1 commit into
Open
docs(rpc): document the historical account state retention window#2618devorun wants to merge 1 commit into
devorun wants to merge 1 commit into
Conversation
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.
Summary
Addresses #2597.
GetAccountcan return public account state at a past block, but the node only retains that history for the most recent 50 blocks (HISTORICAL_BLOCK_RETENTION, a compile-time store constant). Older blocks are rejected withINVALID_ARGUMENT("block N has been pruned"). None of this was documented, so clients that anchor a flow to a reference block — e.g. multi-party signing — only discover the window by hitting the error.This adds a "Historical State Retention" section to the RPC errors-and-limits page describing the window, how it is enforced, the error it produces, and that the boundary can lag the tip while readers still pin older snapshots.
Documentation only; no behavior change.
Changelog