Skip to content

Stellar Soroban event topic v2 schema documentation #34

@truthixify

Description

@truthixify

Tier: M (2-4 days) Type: writing

Context

Contracts wave shipped stealth-announcer v2 with indexed event topics. Indexer builders need clear docs on the schema, the migration story from v1, and how to filter via getEvents topic filters.

Scope

Write docs/reference/stellar-event-schemas.mdx:

  • v1 vs v2 event topic comparison
  • v2 layout: (announce, scheme_id, view_tag_bucket, metadata_kind)
  • view_tag_bucket derivation rule (stable, metadata[0])
  • metadata_kind values and forward-compat semantics
  • Example getEvents filter queries
  • Migration timing: v1 events remain readable; v2 is a new deployment
  • Indexer recommendations (read both during transition)

Acceptance criteria

  • Page committed
  • Example queries verified against futurenet
  • Linked from contracts Stellar page + SDK Stellar fetch helpers

Files to start with

  • New: docs/reference/stellar-event-schemas.mdx
  • contracts/stellar/EVENT_TOPIC_DESIGN.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programdocsDocumentationdripsFunded via Drips Networkhelp wantedExtra attention is needed

    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