Files
Shade/packages/shade-transport-webrtc
Sterister 70e319fef8
Some checks failed
Test / test (push) Has been cancelled
Docker build and publish / docker (push) Has been cancelled
Publish / publish (push) Has been cancelled
release(v4.0.1): strict-TS publishability fixes
4.0.0 shipped TypeScript source as published main/types, but several
files only compiled inside the monorepo. Consumer projects (Dispatch,
etc.) running their own strict tsc against our published source hit:

- @shade/key-transparency: 4 noUnusedLocals violations
  (IndexAbsenceProof, IndexInclusionProof, IndexProofWire, nodeHash)
- @shade/sdk: KT verifier callbacks returned Promise<unknown> instead
  of Promise<STHWire> / Promise<{ proof: string[] }>
- @shade/sdk: thumbnail.ts globalThis cast collided with consumer's
  lib.dom-supplied createImageBitmap signature
- @shade/files: cycle with @shade/sdk produced "this is not assignable
  to type 'Shade'" because hoisted node_modules layouts duplicated the
  Shade class. Broken by replacing `import type { Shade }` with a
  local structural ShadeBridge interface.
- @shade/storage-encrypted: KeyUsage (lib.dom) used under
  lib: ["ES2022"]
- @shade/transport-bridge: ReadableStreamDefaultReader<any> ↔
  <Uint8Array> mismatch
- @shade/keychain / @shade/dashboard / @shade/storage-encrypted
  tsconfig rootDir / include hygiene

Tooling: scripts/typecheck-all.ts runs `bunx tsc --noEmit` against
every workspace package's tsconfig and fails on any error. Wired into
publish:dry / publish:all and publish-shade.sh as a hard gate so this
class of bug cannot recur.

All 24 packages bumped to 4.0.1 in lockstep.

Migration: <ShadeFilesProvider> now requires an explicit `files` prop
(pass `shade.files`). Wire format unchanged.

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