Skip to content

Add storage-tier documentation for validators - #1026

Merged
greatest0fallt1me merged 1 commit into
CalloraOrg:mainfrom
Manta-Byte:feature/storage-tier-docs-719
Jul 30, 2026
Merged

Add storage-tier documentation for validators#1026
greatest0fallt1me merged 1 commit into
CalloraOrg:mainfrom
Manta-Byte:feature/storage-tier-docs-719

Conversation

@Manta-Byte

Copy link
Copy Markdown
Contributor

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

  • Added 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.
  • Enhanced inline /// rustdoc on the StorageKey enum in migrate.rs with per-variant tier rationale matching the docs.
  • Added 10 new unit tests (20 → 30 total) covering tier segregation (confirming reads/writes stay on the Instance tier), TTL bump-path behavior, an upgrade-overwrite case, and an enum exhaustiveness guard.

Security checklist

  • require_auth on all state-changing entrypoints
  • No unwrap() in production paths (only unwrap_or/unwrap_or_else with safe defaults)
  • Overflow-safe arithmetic (checked_add)
  • Rustdoc present on all storage-related public items

Closes #719

@drips-wave

drips-wave Bot commented Jul 30, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

@greatest0fallt1me
greatest0fallt1me merged commit 75e4ae0 into CalloraOrg:main Jul 30, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add storage-tier documentation for validators

3 participants