Files
Shade/packages/shade-transport-webrtc
Sterister d47774ef1c
Some checks failed
Test / test (push) Has been cancelled
Cross-platform vectors / TypeScript vectors (bun) (push) Has been cancelled
Cross-platform vectors / Kotlin vectors (gradle) (push) Has been cancelled
release(v4.8.3): cross-channel msgId dedup + Shade.aliasSession
Two follow-ups to the V4.8.2 duplicate-fan-out fixes Prism filed.

1. `Inbox.acceptBridgeFrame(blob)` + shared 4096-entry msgId LRU.
   The relay durably stores blobs and pushes them to every active
   delivery channel; without a cross-channel ack the bridge frame
   ran first and the next inbox-poll re-dispatched the same blob
   ~30 s later, tripping on consumed prekeys. Bridge consumers now
   plumb pushed frames through `acceptBridgeFrame`, which shares
   the dedup gate + ack path with `pollOnce`. Whichever channel
   delivers first wins; the other acks-and-skips. Inbox records
   the msgId before the ack so a parallel poll can't observe an
   in-flight ack window.

2. `Shade.aliasSession(oldLabel, newLabel)`. First-contact forces
   the receiver to label the new session by the relay's sender
   fingerprint hint (`fp:<senderfp>`); the post-decrypt plaintext
   typically announces the peer's real address. Aliasing moves
   session, trusted identity, peer-verification, and identity-
   version under the canonical label. Holds the per-peer mutex on
   both labels (lexicographic order) so concurrent crypto ops can't
   observe a half-moved state. Refuses to overwrite an existing
   session at the new label.

Wire change: `IncomingMessage.expiresAt?` now surfaces the relay's
expiry so receivers can pass bridge frames straight to
`acceptBridgeFrame` without inventing a TTL.

Tests cover bridge-then-poll, poll-then-bridge, aliasSession happy
path, refuse-to-overwrite, and same-label no-op.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-08 15:49:36 +02:00
..

@shade/transport-webrtc

V3.11 — direct peer-to-peer chunk transport for Shade transfers via RTCDataChannel. Plugs into @shade/transfer's ITransferTransport contract and wires automatically into @shade/sdk via shade.configureWebRTC().

import { createShade } from '@shade/sdk';
import { nativeRtcFactory } from '@shade/transport-webrtc';

const shade = await createShade({ prekeyServer });
shade.configureWebRTC({ factory: nativeRtcFactory() });
shade.configureTransfers({ resolveBaseUrl });

await shade.upload({ to: 'bob', input: file });    // → P2P when NAT allows,
                                                    //   HTTP otherwise.

See docs/webrtc.md for the full guide: NAT-traversal realities, TURN config, glare resolution, wire format, diagnostics, and end-to-end test recipes.

What's inside

  • WebRtcConnection — one peer connection between two Shade endpoints, driving offer/answer/ICE through Shade's own ratchet.
  • WebRtcConnectionManager — per-peer pool with deterministic glare resolution.
  • WebRtcSignalingChannel — JSON signaling messages multiplexed over Shade.send / Shade.onMessage.
  • WebRtcTransferTransport — implements ITransferTransport over the managed DataChannel; ack-correlated by 16-byte requestId tokens.
  • MemoryRtcFactory — in-process WebRTC simulator for tests.
  • nativeRtcFactory() — adapter over globalThis.RTCPeerConnection (browsers / Deno / Cloudflare Workers).

Adapters

@shade/transport-webrtc ships only the standard-API adapter (nativeRtcFactory). For Bun / Node, wrap your library of choice behind the IRtcFactory interface — only createPeerConnection, createDataChannel, and standard addEventListener are required.

Recommended adapters: