Skip to content

Bug: revenue_pool emits inconsistent event shape vs schema documentation #508

Description

@greatest0fallt1me

Description

This is a smart-contract issue for the GrantFox campaign. Two events in revenue_pool include a 4th topic that doesn't exist in EVENT_SCHEMA.md.

Requirements and Context

  • Identify the mismatch
  • Choose schema vs code as source-of-truth
  • Fix the side that's wrong
  • Add CI check
  • Must be secure, tested, and documented
  • Should be efficient and easy to review

Suggested Execution

  1. Fork the repo and create a branch
    git checkout -b bug/revenue-event-shape
  2. Implement changes
    • contracts/revenue_pool/src/events.rs
    • docs/EVENT_SCHEMA.md
    • scripts/check-event-shape.sh
  3. Test and commit
    • Run the repo's standard test suite and lint
    • Cover edge cases; include output in the PR

Example commit message

fix: revenue_pool event shape vs schema

Acceptance Criteria

  • Mismatch identified
  • Code matches docs
  • CI gate works
  • No regressions

Guidelines

  • Minimum 95% test coverage with cargo test
  • require_auth on every state-changing entrypoint
  • Overflow-safe math; no unwrap() in production paths
  • Clear NatSpec-style /// rustdoc
  • Timeframe: 96 hours

Metadata

Metadata

Labels

GRANTFOX OSSGrantFox open-source campaign taskOFFICIAL CAMPAIGNOfficial GrantFox campaign issueStellar WaveIssues in the Stellar wave programdocumentationDocumentationrustRust implementationsmart-contractSoroban smart-contract work

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions