Skip to content

RELAY spec v0.2 — please review and raise feedback on the RELAY repo #19

@SoundMatt

Description

@SoundMatt

RELAY spec v0.2 (draft) is now available at https://github.com/SoundMatt/RELAY

It defines:

  • The universal `relay.Message` envelope and canonical frame types for all six protocols
  • Mandatory interface contracts (§8) with exact method signatures
  • Common error sentinels and wrapping semantics (§5)
  • Lifecycle invariants (§6)
  • CLI contract (§11) and capability discovery (§12)
  • Application interface — `relay.Node` / `relay.Caller` with per-protocol `Adapt()` (§10)
  • Language bindings for Go, C++, and Rust (§18)

Conformance gaps for this repo have been filed as separate issues here. This issue is a standing invitation for the inverse direction: if anything in the spec is wrong, ambiguous, or impractical to implement for this protocol, please raise an issue on the RELAY repo at https://github.com/SoundMatt/RELAY/issues

Things worth raising:

  • Spec requirements that conflict with the protocol wire format or hardware behaviour
  • Method signatures that are awkward for this protocol
  • Missing definitions (e.g. PublisherOption is referenced in §8.2 but not yet defined)
  • Ambiguous wording in any normative section
  • Lifecycle invariants that cannot be guaranteed on this transport

The spec is a living document at v0.2 draft — feedback now shapes v0.3 before any conformance tooling is built.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions