Document the storage model
Description
The storage model and its invariants are undocumented, making audits harder. This issue documents them.
Requirements and context
- Repository scope: Agentpay-Org/Agentpay-contracts only.
- Add
docs/storage.md describing the storage data model, its invariants, and the entrypoints that touch it.
- Cross-reference the code with a worked example; keep it accurate.
- Read the relevant module first.
Suggested execution
- Fork the repo and create a branch
git checkout -b docs/storage-01-model- Implement changes
- Write code in: the relevant module.
- Write comprehensive tests in: cover the new behaviour and edge cases.
- Test and commit
Test and commit
- Run
cargo fmt, cargo clippy --all-targets -- -D warnings, and cargo test.
- Cover edge cases: n/a — verify invariants against source.
- Include the full test output in the PR description.
Example commit message
docs(storage): document the model and invariants
Guidelines
- Minimum 95 percent test coverage for impacted modules.
- Clear, reviewer-focused documentation.
- Timeframe: 96 hours.
Community & contribution rewards
- 💬 Join the AgentPay community on Discord: https://discord.gg/eXvRKkgcv
- ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — a 5-star rating is much appreciated.
Document the storage model
Description
The storage model and its invariants are undocumented, making audits harder. This issue documents them.
Requirements and context
docs/storage.mddescribing the storage data model, its invariants, and the entrypoints that touch it.Suggested execution
git checkout -b docs/storage-01-modelTest and commit
cargo fmt,cargo clippy --all-targets -- -D warnings, andcargo test.Example commit message
docs(storage): document the model and invariantsGuidelines
Community & contribution rewards