Skip to content

Improvement: structured, queryable contract events with a documented EVENTS.md schema #429

Description

@Psalmuel01

Contracts emit events but the topic/data schema is only in code comments. Document it authoritatively and keep it stable for indexers.

Scope

  • Write EVENTS.md documenting every event: contract, topics, data struct fields, and when it fires (submitted, revoked, paused, upgraded, metadata set, etc.).
  • Add a test that asserts the emitted event shapes match the doc so they cannot drift.
  • Reference it from the indexer and SDK.

Value

A stable event contract that indexers and integrators can rely on.

Acceptance

  • EVENTS.md documents all events; a test guards the shapes against drift; referenced by indexer/SDK.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programcontractsSoroban/Rust contract workdocumentationImprovements or additions to documentationeasyGood for newcomers, low complexity

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions