49 lines
1.9 KiB
Markdown
49 lines
1.9 KiB
Markdown
|
# @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()`.
|
||
|
|
|
||
|
|
```ts
|
||
|
|
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](../../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:
|
||
|
|
|
||
|
|
- [`node-datachannel`](https://github.com/murat-dogan/node-datachannel)
|
||
|
|
- [`@roamhq/wrtc`](https://www.npmjs.com/package/@roamhq/wrtc)
|