Files
Shade/packages/shade-transport-webrtc
Sterister 1bd7037a6d
Some checks failed
Test / test (push) Has been cancelled
release(v4.10.0): cross-host approval routing primitives in @shade/sdk
Builds on V4.9's encrypted profile blob: ships the canonical
profile-blob schema (hosts/clients/trustedApproverFingerprints) and
the build/sign/verify trio for proxy-approval frames. Headless servers
can now route a `linkRequest` to a trusted-approver phone, verify the
phone's Ed25519 signature against the fresh profile blob, and complete
pairing without a GUI host being available.

Length-prefixed binary signing payload so any platform (Kotlin, Swift,
Go) can produce byte-identical signing input from test vectors. No
relay or transport changes — entirely SDK-level.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-09 17:09:59 +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: