@hashtree/fips-transport

Hashtree blob exchange over reliable TCP/FIPS streams.

Install

Install the FIPS peers from their immutable release archives alongside this package. These two peers are not yet available in the npm registry:

npm install @hashtree/fips-transport \
  https://github.com/mmalmi/fips-ts/releases/download/runtime-v0.0.42/fips-core-0.0.42.tgz \
  https://github.com/mmalmi/fips-ts/releases/download/runtime-v0.0.29/fips-transport-webrtc-0.0.45.tgz

With npm 12, add --allow-remote=all to this command and subsequent npm install or npm ci commands, because the FIPS packages use release URL dependencies.

Usage

This package keeps FIPS below Hashtree: FIPS discovers peers, signals transports, and moves authenticated datagrams between node identities. TCP/FIPS owns ordered byte delivery, flow control, and segment retransmission. Hashtree still owns hash verification, peer choice, one whole-session retry, and cache writes. The byte framing is documented in the networking protocol.

Browser providers join the shared FIPS discovery fabric by default:

fips-overlay-v1

The adapter exposes one transport: TcpBlobTransport. It uses @fips/tcp service 39018 and verifies each blob hash before returning or caching data:

import { MemoryStore, sha256 } from '@hashtree/core';
import {
  TcpBlobTransport,
  DEFAULT_FIPS_DISCOVERY_APP,
} from '@hashtree/fips-transport';

const localStore = new MemoryStore();
const transport = new TcpBlobTransport({
  endpoint: fipsNode,
  localStore,
});

console.log(DEFAULT_FIPS_DISCOVERY_APP); // fips-overlay-v1
const hash = await sha256(new TextEncoder().encode('hello'));
const data = await transport.get(hash, [peerId]);
await transport.close();

HashtreeWorkerClient can use a managed browser FIPS node directly. FIPS owns Nostr peer discovery and WebRTC signaling; this package only carries Hashtree blob streams over authenticated FIPS service datagrams:

import { createBrowserHashtreeFipsProvider } from '@hashtree/fips-transport/browser';

const provider = await createBrowserHashtreeFipsProvider({
  deviceSecretKey,
  relays,
  localStore,
});

workerClient.setP2PProvider(provider);

// Shut down the provider before discarding the worker client.
await provider.stop();

The discovery scope is configurable for isolated deployments, but applications should normally stay on fips-overlay-v1 so they share the generic FIPS transit fabric rather than creating an application-specific discovery fabric.