Repository navigation
docs: consolidate storage key metadata and layout docs - #912
Open
pelumixxril wants to merge 1 commit into
Open
pelumixxril wants to merge 1 commit into
pelumixxril wants to merge 1 commit into
Conversation
|
@pelumixxril 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.
Overview
This PR consolidates the storage key layout and metadata documentation for the
Foldercontract so that key definitions, storage schema notes, and their corresponding tests live in one coherent place. Previously, key layout comments were scattered acrossstorage.rs,types.rs, and separate upgrade-safety docs, making it hard to verify that documented layouts matched the actual storage implementation. This change centralizes that metadata, links it to the tests that exercise it, and updates the affected docs to point at the single source of truth.Related Issue
Changes
🗂️ Storage Key Metadata Consolidation
[MODIFY]
app/contract/contracts/Folder/src/storage.rs[MODIFY]
app/contract/contracts/Folder/src/storage_test.rs[MODIFY]
app/contract/README.mdstorage.rsand the corresponding tests.[MODIFY]
app/contract/docs/UPGRADE_SAFETY_GATE_IMPLEMENTATION.md[MODIFY]
app/contract/docs/UPGRADE_SAFETY_GATE_QUICK_REFERENCE.md🔑 API Key Type Metadata Alignment
app/backend/src/api-keys/api-keys.types.jsapp/backend/src/api-keys/api-keys.types.tsVerification Results
storage.rsstorage_test.rsapi-keys.types.js/.tscomments alignedCloses #335