Skip to content

Document the WebSocket Message Schema #129

Description

@maugauwi-hash

Labels: documentation, api-contract
Priority: Medium
Estimated Time: 1 hour

Description:
shared/api-contract.md's WebSocket section is a single line: the URL and "real-time vault
events." No event types, payload shapes, authentication-over-WS mechanism, or reconnection guidance
are specified — blocking both #20 and #69 (and their joint tracking item #110) from being
implemented against a well-defined contract.

Tasks:

  • Document each event type the socket can emit (e.g., balance change, status change, TTL update) with its payload shape
  • Document how the connection authenticates (query param token? header? initial handshake message?)
  • Document expected reconnection/heartbeat behavior so both clients implement it identically

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions