Skip to content

docs: document storage layout and migration risks #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
El-swaggerito merged 1 commit into from
Jul 29, 2026
Merged

docs: document storage layout and migration risks #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ for detailed guidance.
- [ ] Incomplete criteria include a rationale and, where applicable, a link to
a follow-up issue.

### 7. Storage Compatibility (required for storage-changing PRs)
- [ ] I completed the [storage-change reviewer checklist](../docs/storage-audit-map.md#mandatory-reviewer-checklist).
- [ ] I documented the compatibility classification and migration plan, and
added tests that start from the previous stored layout.
- [ ] **OR** this PR does not change persisted keys, value models, defaults, or
storage classes (explain in Additional Context).

### Policy & Standards
- [ ] I have read the [Contributor Evaluation Policy](../docs/contributor-evaluation-policy.md) and understand that **merge does not guarantee payment**.
- [ ] I have read the `CONTRIBUTING.md` guidelines.
Expand Down
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
Fixes #

## Contributor Self-Assessment
Please complete and confirm the requirements from the [Contributor Self-Assessment Form](docs/SELF_ASSESSMENT.md):
Please complete and confirm the requirements from the [Contributor Self-Assessment Form](../docs/SELF_ASSESSMENT.md):

- [ ] **Scope Confirmation:** Changes match issue scope without unnecessary edits.
- [ ] **Test Evidence:** All tests pass locally.
- [ ] **CI Status:** CI pipeline and linting checks pass cleanly.
- [ ] **Known Limitations:** Any trade-offs or limitations are documented.
- [ ] **Acceptance Criteria:** Every requirement from the issue is verified.
- [ ] **Storage Compatibility:** I completed the [storage-change reviewer checklist](../docs/storage-audit-map.md#mandatory-reviewer-checklist), or explained why this PR does not change storage.
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ value-encoding rules, and the no-real-user-data guarantee.

> **Important**: Please read our [Legal Boundary Disclaimer](docs/legal-boundary-disclaimer.md) to understand the off-chain assumptions and limitations of the RWA tokenization model.

- [Contract Storage Layout and Migration Guide](docs/storage-audit-map.md) — complete key inventory, stored data models, cross-key invariants, upgrade assumptions, migration strategies, and the mandatory storage-change review checklist
- [RWA Protocol Threat Model](docs/threat-model.md) — protected assets, trust boundaries, threat catalog (compliance bypass, admin/role misuse, minting and transfer risks, pause misuse, event reliability), and explicit off-chain/legal out-of-scope items
- [Emergency Pause Policy](docs/emergency-pause.md) — global pause mechanism, authorization, and trust model
- [Admin Roles & Permissions](docs/admin-roles.md) — role-based access control (RBAC) design
Expand Down
Loading