Skip to content

Event payload: include amounts only where non-indexable needed #131

@1nonlypiece

Description

@1nonlypiece

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

  1. Fork the repository and create a branch: git checkout -b feature/event-payload-audit
  2. Implement the changes listed below
  3. 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

  1. Run the full contract test suite (e.g. cargo test, Soroban local sandbox if applicable)
  2. Cover edge cases called out in this issue
  3. Attach test output summary and short security notes in the PR
  4. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programrustRust languagesmart-contractSoroban / on-chain worksorobanStellar Soroban

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions