TypeScript SDK

@nymproject/sdk is the browser-side raw messaging SDK. It opens a Nym mixnet client in a Web Worker and exposes a message-passing API: send text or binary payloads to another Nym address, receive payloads via event subscriptions, optionally reply anonymously with SURBs.

┌──────────────────────────────────────────────────────────────┐
│  Your browser app (alice)                                    │
│       └─ Nym Mixnet Client (WASM, Web Worker)                │
│            └─ WebSocket to entry gateway                     │
│                 └─ Nym mixnet (entry → 3 mix layers → exit)  │
│                      └─ Peer MixnetClient (bob)              │
│                           └─ Your peer's app                 │
└──────────────────────────────────────────────────────────────┘

Both ends run a Nym client. Sphinx encryption protects every hop end-to-end; neither gateway nor any mix node can link sender to receiver. This is the end-to-end messaging path, where you control both sides.

For background on Sphinx, the mixnet exit model, and what the exit gateway can see, see Exit security.

Packages

Quick start

import { createNymMixnetClient } from '@nymproject/sdk-full-fat';
 
const nym = await createNymMixnetClient();
 
nym.events.subscribeToTextMessageReceivedEvent((e) => {
  console.log('Received:', e.args.payload);
});
 
await nym.client.start({
  clientId: crypto.randomUUID(),
  nymApiUrl: 'https://validator.nymtech.net/api',
  forceTls: true,
});
 
await nym.client.send({
  payload: { message: 'hello mixnet', mimeType: 'text/plain' },
  recipient: nym.client.selfAddress(),
});

For the full walkthrough including SURB replies and disconnect, see Quick Start.

Smart contracts

@nymproject/contract-clients (opens in a new tab) provides query and signing clients for every Nym smart contract on the Nyx chain (Mixnet, Coconut DKG, Vesting, Service Provider Directory, and more). It uses CosmJS (opens in a new tab) and the Nyx RPC endpoint, not the mixnet, so payloads are not routed through Sphinx.

See Smart Contracts for query and execute examples, and Cosmos Kit for wallet integration.

Where to go next