Skip to content

Add an event schema reference for indexers - #279

Open
Esc1200 wants to merge 1 commit into
tributary-protocol:mainfrom
Esc1200:docs/event-schema-138
Open

Add an event schema reference for indexers#279
Esc1200 wants to merge 1 commit into
tributary-protocol:mainfrom
Esc1200:docs/event-schema-138

Conversation

@Esc1200

@Esc1200 Esc1200 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Adds docs/events.md, a full event schema reference for integrators building indexers.

What it covers

  • All 7 contract events: SplitCreated, SplitPaid, SplitUpdated, SplitClosed, ControlTransferred, Deposited, Distributed.
  • The topic/data layout of each event: the snake_case name symbol as topic 0, the split id (#[topic]) as topic 1, and the remaining fields serialized into the data map.
  • A per-event table plus per-event detail (which entrypoint emits it, topics, data fields).
  • A TypeScript decoding snippet using scValToNative matching how the dashboard reads events, and a note that indexers can filter by contract id and follow one split via the id topic.

Linked from the README Docs section. Docs-only change; no contract behaviour changes.

Fixes #138

@Esc1200
Esc1200 requested a review from Spagero763 as a code owner July 17, 2026 14:16
@Spagero763
Spagero763 enabled auto-merge (squash) July 20, 2026 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an event schema reference for indexers

1 participant