Description
Review payload sizes vs Soroban event limits; minimize redundant data.
Requirements and context
-
Tests assert event emission
-
Must be secure, tested, and documented
-
Must be secure, fully tested, and documented
-
Should be efficient and easy to review for auditors and integrators
Suggested execution
- Fork the repository and create a branch:
git checkout -b feature/event-payload-audit
- Implement the changes listed below
- Open a draft PR early for design feedback
Implement
- Implement or document per issue scope
- Add tests where behavior is normative
Tests and documentation
- Add or extend automated tests:
src/lib.rs, tests/create_vault.rs
- Add or update documentation:
vesting.md or README.md
- Add Rustdoc (
///) on public contract APIs where applicable (NatSpec-style)
- Validate stated security assumptions explicitly in PR description
Test and commit
- Run the full contract test suite (e.g.
cargo test, Soroban local sandbox if applicable)
- Cover edge cases called out in this issue
- Attach test output summary and short security notes in the PR
- Ensure minimum 95% line coverage for touched modules (
cargo tarpaulin / project standard)
Example commit message
chore(soroban): feature event-payload-audit
Guidelines
| Item |
Target |
| Test coverage |
≥ 95% on changed code |
| Documentation |
Clear, versioned, matches on-chain behavior |
| Timeframe |
96 hours from assignment |
Description
Review payload sizes vs Soroban event limits; minimize redundant data.
Requirements and context
Tests assert event emission
Must be secure, tested, and documented
Must be secure, fully tested, and documented
Should be efficient and easy to review for auditors and integrators
Suggested execution
git checkout -b feature/event-payload-auditImplement
Tests and documentation
src/lib.rs,tests/create_vault.rsvesting.mdorREADME.md///) on public contract APIs where applicable (NatSpec-style)Test and commit
cargo test, Soroban local sandbox if applicable)cargo tarpaulin/ project standard)Example commit message
Guidelines