@shade/transport-webrtc (4.11.1)

Published 2026-05-21 13:30:32 +02:00 by Stian

Set up this registry in your project .npmrc file:

@shade:registry=

To install the package using npm, run the following command:

npm install @shade/transport-webrtc@4.11.1

or add it to the package.json file:

"@shade/transport-webrtc": "4.11.1"

For more information on the npm registry, see the documentation.

@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:

Dependencies

ID	Version
@shade/core	^4.11.1
@shade/streams	^4.11.1
@shade/transfer	^4.11.1

Details

npm

2026-05-21 13:30:32 +02:00

latest

24 KiB

Assets (1)

transport-webrtc-4.11.1.tgz 24 KiB

Versions (22) View all

4.11.1

2026-05-21

4.11.0

2026-05-15

4.10.0

2026-05-09

4.9.0

2026-05-09

4.8.5

2026-05-08

@shade/transport-webrtc (4.11.1)

Installation

About this package

@shade/transport-webrtc

What's inside

Adapters

Dependencies