Skip to content

docs: PROTOCOL.md — a real wire-protocol specification #113

Description

@saucam

From the protocol audit (P3, but it's the 'industry standard' artifact itself). The protocol lives only as TS types + doc comments. World-class protocols ship a spec: wire examples per message, the auth handshake + capability negotiation flow, ordering/delivery guarantees (single-WS ordering, replay/live interleaving, chunked + incremental replay semantics, seq domains — chunk index vs session cursor), the additive-evolution rules (ignore-unknown, when PROTOCOL_VERSION bumps), the capabilities registry, LIMITS, error codes, and a verb→scope table.

Home: packages/protocol/PROTOCOL.md, shipped with the npm package. Most content already exists as doc comments in types.ts — this is assembly + examples, not invention. Becomes the canonical reference for the Rust TUI and the mobile client.

Metadata

Metadata

Assignees

No one assigned

    Labels

    auditSurfaced in a code auditdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions