protocol: publish the immutable bitwire/1 specification and independent vectors

[jm9e]

Outcome and owner

bitwire owns a self-contained, immutable specification for bitwire/1; bitruntime owns implementations. This is the protocol-publication work packet under #39 and #47, following accepted decisions 0008 and 0010.

Settled scope and boundaries

Revision 1 records the released nightseam v0.6.0 profile at 5cc9723a24646c40ed1861f892b2b23eb6d785d7. Preserve bytes and meanings; record differences as findings, not silent repairs. Native bitwire v0.3.0 names Wire, WireTree and AddressedWire do not revise frames. Existing carrier access uses AddressedWire. No new protocol revision, negotiation, identity exchange, generated adapters, or production runtime belongs here.

Deliverables and order

1. Inventory the exact released protocol specifications, runner protocol, tables and scenarios. Copy with provenance/license and a machine-checked source/destination hash manifest; keep unreleased nightseam changes separate.
2. Make envelope/path encoding, roles, limits, serials, cancellation, closure and supported wire-only vocabulary self-contained under bitwire. Identify any unresolved ambiguity with alternatives and an explicit decision before normative changes.
3. Publish a stable revision identity and runner contract. Implementation drivers consume inputs while independently authored expectations remain in bitwire.
4. Pin bitruntime's drivers to the resulting public artifact/revision; coordinate runtime #1 and PR52. Candidate evidence may precede publication; final reports identify released implementation artifacts.

Acceptance and closure

• Hash manifest verifies the exact v0.6.0 baseline; no unreleased source or private checkout dependency.
• Go/TypeScript peers exercise both roles, real WebSockets and local carriers; reports name specification, suite hash and implementation release.
• Malformed envelopes, noncanonical paths, serial reuse/order, limits, cancellation and close behavior have independent expected observations; deliberately invalid drivers fail.
• Protocol publication and runtime adoption are recorded separately. Existing runtime-v0.2.0 interoperability evidence is linked, not relabeled as this missing normative publication.
• Public release/source identity, clean consumer instructions and reciprocal wire: coordinate protocol, carrier, evidence and independent runtime acceptance #39/runtime links are recorded before closure.

Use component-first two-letter language paths for drivers, such as conformance/runtime/go and conformance/runtime/ts; preserve existing immutable fixtures.

Reciprocal implementation handoff

Published baseline engine adoption is runtime #1; later consumers of the normative vocabulary include streams #10, tunnels #11, and live #12. Identity exchange remains bitlink #1's responsibility. This publication does not adopt unreleased nightseam semantics.

[jm9e]

bitwire/1 published: PR #58, merged as b7611b1

Identity: (bitwire/1, 7797682b0f05f86c508eafbd3be23c2084acd2f5cfc766922f9372b652dc416e)

Bundle: protocol/bitwire-1.

• Entry page: README.md.
• Normative scope: SCOPE.md. It is hashed into the identity.
• Upstream files: 60 files byte-identical to Nightseam v0.6.0 at 5cc9723a24646c40ed1861f892b2b23eb6d785d7.
• Findings: FINDINGS.md, informative, with 13 text findings and 3 implementation divergences.
• Verify: node scripts/protocol.mjs verify --source.

How it was decided: research 0003 (outside consultation, verified advice, evaluated and applied). An independent review of SCOPE.md against the source found nine defects, all resolved before merge.

Against this issue's acceptance

• Hash manifest verifies the exact v0.6.0 baseline.
  • No unreleased source and no private checkout.
  • check.mjs verifies the bundle offline.
  • The CI conformance job re-fetches the public source at 5cc9723 and compares every upstream file.
• Go/TypeScript peers in both roles over real WebSockets and local carriers, with reports naming specification, suite hash and implementation release. Staged in conformance: publish the bitwire/1 conformance contract, a test-only runner and revision-labelled scenarios #59 (conformance contract, runner, revision-labelled scenarios, report format). Existing bitruntime interoperability evidence (wire: coordinate protocol, carrier, evidence and independent runtime acceptance #39, PR conformance: run bitwire's independent cases against bitruntime. #52) is linked, not relabeled.
• Malformed envelopes, non-canonical paths, serial reuse and order, limits, cancellation and close behavior have independent expected observations, and deliberately invalid drivers fail.
  • The adopted tables are now normative constraints with interpretations in SCOPE.md.
  • Scenario derivatives, the path evidence (F3) and invalid-driver checks are conformance: publish the bitwire/1 conformance contract, a test-only runner and revision-labelled scenarios #59.
• Protocol publication and runtime adoption are recorded separately.
  • SCOPE.md separates the protocol, the conformance contract and evidence.
  • Runtime adoption stays with bitruntime.
• Public release and source identity, clean consumer instructions and reciprocal links before closure.
  • The bundle is public on main at b7611b1, and the README carries the consumer instructions.
  • The release-asset archive, checksum and source bundle (research 0003 row 20) come with the next bitwire release.
  • bitruntime is asked to pin its protocol drivers to this bundle.

Decisions this publication records

• Tunnel abort. v0.6.0's Go tunnel transmits channel.close 1006 on abort. Revision 1 keeps this under decision 0008. Decision 0007's "1006 is never transmitted" applies from the carrier contract (carriers: settle close, refusal and stream-framing guarantees with independent cases #54), recorded in 0007, the carrier draft and F2.
• Tunnel in the identity. The tunnel is inside bitwire/1's identity, with core and core and tunnel conformance scopes.
• Tunnel digest ownership.
  • bitwire specifies the tunnel digest's carriage and admission.
  • bittype specifies what a digest identifies.
  • Bitlink owns the identity exchange.
• Paths. The path encoding maps addressed traffic, and plain method names remain valid.
• Definitions supplied by SCOPE.md, each checked in v0.6.0's Go and TypeScript sources:
  • nonempty names (4011);
  • ignored unsolicited responses;
  • the 1009 over-limit close;
  • the tunnel's default window of 32;
  • canonical decoding.

[jm9e]

Two more acceptance items are met, through #59 (now closed):

• Go/TypeScript peers in both roles over real WebSockets and local carriers, with reports naming the specification, suite hash and implementation release. Since 502ae40 (conformance: run the bitwire/1 runner against bitruntime's released testees #68), CI runs bitwire's runner against bitruntime v0.4.2's released testees. Both claims are supported, 345/345 each, in every pairing, with conn.pipe cases in process. Each report names:
  • (bitwire/1, 7797682b…);
  • contract edition 1, contractDigest 310daabd…, released in f74b612 (conformance: release edition 1 of the bitwire/1 conformance contract #72);
  • evidenceDigest 84f5051d…;
  • the runner's revision, and the pinned bitruntime release and artifacts.
• Malformed envelopes, non-canonical paths, serial reuse and order, limits, cancellation and close behavior have independent expected observations, and deliberately invalid drivers fail.
  • The observations are the derived and authored scenarios: c3440df (conformance: authored bitwire/1 evidence, and driver names as canonical paths. #63), repaired in a13d0f8 (conformance: repair evidence that could certify broken behavior. #67) and 69099bf (conformance: deliberately invalid bitwire/1 testees, and the sender's 1009 they exposed #71).
  • Since 69099bf (conformance: deliberately invalid bitwire/1 testees, and the sender's 1009 they exposed #71), 17 deliberately invalid testees must each be rejected by a named scenario: malformed Unicode, non-canonical names, repeated serials, ignored limits, 4011 for 1009, ignored cancellation, deadlines and pending limits, wrong or aborted closes, dropped meta, error data and events. A relay-only control must be supported.
  • Paths beyond one segment need a new driver: conformance: path-encoding evidence beyond one segment (finding F3), with a new driver #73.

Still open, so this stays open:

• Public release and source identity. The release-asset archive, checksum and source bundle come with the next bitwire release (research 0003, row 20). That release is not cut yet; it is an outward-facing multi-registry publication, and I have put the timing to the maintainer.