Add storage-tier documentation for validators - #1026
Merged
greatest0fallt1me merged 1 commit intoJul 30, 2026
Conversation
|
@Manta-Byte Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
Documents every storage key used in the validators contract, organized by Soroban storage tier (Instance / Persistent / Temporary), with rationale for each tier classification.
Changes
contracts/validators/docs/storage.md: a full tier reference covering all storage keys used by the contract (Admin,StorageVersion,AuthorisedUpgrade— all Instance tier), including a tier-overview table, per-key access metadata, TTL management strategy, and explicit rationale for why the Persistent and Temporary tiers are unused here.///rustdoc on theStorageKeyenum inmigrate.rswith per-variant tier rationale matching the docs.Security checklist
require_authon all state-changing entrypointsunwrap()in production paths (onlyunwrap_or/unwrap_or_elsewith safe defaults)checked_add)Closes #719