docs: add on-chain event schema documentation (#109)#187
Open
Philzwrist07 wants to merge 1 commit into
Open
Conversation
- docs/events.md: full schema for all 18 events across governance and token contracts — topics, data fields, types, and JSON examples - frontend/src/events.ts: TypeScript interfaces for every event, GovernanceEvent / TokenEvent / CosmosVoteEvent union types, and GOV_TAGS / TOKEN_TAGS constants for type-safe topic matching Closes PrincessnJoy#109
|
@Philzwrist07 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #109
Summary
Both contracts emit Soroban events on every state transition, but there was no documentation of
the topic names, data fields, or encoding format, making it impossible for off-chain indexers
and frontends to reliably parse them.
This PR adds the missing documentation and TypeScript types to fully address that gap.
Changes
docs/events.md
a JSON example
frontend/src/events.ts
in consumers
Testing
Documentation-only change. No contract logic was modified.
───────────────────────────────────────────────────────────────────────────────────────────────