Contracts - Document escrow state machine and authorization matrix in contracts README
Description
contracts/README.md lists functions but lacks a formal state-machine diagram and an authorization matrix. Document every EscrowStatus transition, which entrypoint triggers it, and who is authorized, so integrators and auditors can reason about the contract in contracts/escrow/src/lib.rs.
Requirements and context
- Must be secure, tested, and documented
- Should be efficient and easy to review
- Add a state-transition diagram for
EscrowStatus
- Add an authorization matrix per entrypoint (owner/admin/attestor/any)
- Cross-reference the
#[contracterror] codes
- Keep it in sync with
contracts/escrow/src/lib.rs
Suggested execution
- Fork the repo and create a branch
git checkout -b docs/escrow-state-machine- Implement changes
- Expand
contracts/README.md with the diagram and matrix
- Add a doc-consistency note referencing the test file
- Reference function names exactly as in
lib.rs
- Verify accuracy against the implementation
- Test and commit
- Run tests, cover edge cases
- Include test output and notes
Example commit message
docs: add escrow state machine and authorization matrix
Guidelines
- Minimum 95 percent test coverage
- Clear documentation
- Timeframe: 96 hours
Contracts - Document escrow state machine and authorization matrix in contracts README
Description
contracts/README.mdlists functions but lacks a formal state-machine diagram and an authorization matrix. Document everyEscrowStatustransition, which entrypoint triggers it, and who is authorized, so integrators and auditors can reason about the contract incontracts/escrow/src/lib.rs.Requirements and context
EscrowStatus#[contracterror]codescontracts/escrow/src/lib.rsSuggested execution
git checkout -b docs/escrow-state-machinecontracts/README.mdwith the diagram and matrixlib.rsExample commit message
docs: add escrow state machine and authorization matrixGuidelines