docs: Add comprehensive storage layout reference with namespace mappi…#881
Merged
Merged
Conversation
…ng and upgrade safety guidelines - Document all 9 storage namespaces (Core, Governance, User, Shipment, Fee, Withdrawal, Oracle, Emergency, Strategy) - Map 50+ storage keys with types, parameterization patterns, and access constraints - Include proxy storage separation and EIP-1967 slot constants - Provide upgrade safety constraints: forbidden operations (reordering, deletion, mutation) and safe operations (append-only, field extension) - Add version migration patterns and backward compatibility guidelines - Include storage collision prevention validation and namespace isolation - Add audit checklist for pre-deployment verification - Include unsafe/safe extension examples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
2 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.
PR: Add Contract Storage Layout Reference with Upgrade Notes (#613)
Description
Introduces a comprehensive storage layout reference document to map active contract state allocations and establishes clear guidelines to guarantee storage compatibility and safety during future contract upgrades.
Changes Implemented
docs/storage-layout-reference.md: Developed a centralized reference tracking all storage structures, mapping strategies, and slot allocations.Verification Checklist
Closes #613