Files

Christian Nennemann 2e081ead8e chore: rename quicproquo → quicprochat in docs, Docker, CI, and packaging

Rename all project references from quicproquo/qpq to quicprochat/qpc
across documentation, Docker configuration, CI workflows, packaging
scripts, operational configs, and build tooling.

- Docker: crate paths, binary names, user/group, data dirs, env vars
- CI: workflow crate references, binary names, artifact names
- Docs: all markdown files under docs/, SDK READMEs, book.toml
- Packaging: OpenWrt Makefile, init script, UCI config (file renames)
- Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team
- Operations: Prometheus config, alert rules, Grafana dashboard
- Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths
- Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md

2026-03-21 19:14:06 +01:00

2.2 KiB

Raw Blame History

@quicprochat/client

TypeScript SDK for quicprochat -- an E2E encrypted group messenger built on MLS (RFC 9420), hybrid post-quantum key exchange (X25519 + ML-KEM-768), and sealed sender envelopes.

Features

WASM-powered crypto -- Ed25519 signatures, hybrid KEM, sealed sender, message padding, safety numbers -- all compiled from the Rust quicprochat-core crate via wasm-pack.
High-level client API -- QpqClient wraps transport + crypto into a type-safe interface for resolving users, creating channels, and exchanging messages.
Offline mode -- All crypto operations work without a server connection. Use QpqClient.offline() for key generation, signing, encryption, etc.
Transport abstraction -- Pluggable Transport interface with a built-in WebSocketTransport for browser environments.

Quick start

import { QpqClient } from "@quicprochat/client";

// Crypto-only (no server needed)
const client = await QpqClient.offline();
const alice = client.generateIdentity();
const bob = client.generateIdentity();
const safetyNumber = client.computeSafetyNumber(alice.publicKey, bob.publicKey);
console.log("Safety number:", safetyNumber);

// Sign and verify
const msg = new TextEncoder().encode("hello");
const sig = client.sign(alice.seed, msg);
console.log("Valid:", client.verify(alice.publicKey, msg, sig));

Server connection

The native qpc server speaks Cap'n Proto RPC over QUIC/TCP with Noise_XX. Browsers cannot open raw TCP sockets, so a WebSocket bridge proxy is required for full server connectivity:

const client = await QpqClient.connect({ addr: "wss://bridge.example.com" });
const peerKey = await client.resolveUser("bob");
const channel = await client.createChannel(peerKey);

Building

npm install
npm run build    # compiles to dist/

Project structure

src/
  index.ts       -- public API exports
  client.ts      -- QpqClient class (high-level API)
  transport.ts   -- Transport interface + WebSocket implementation
  crypto.ts      -- WASM crypto wrapper
  types.ts       -- TypeScript type definitions
pkg/             -- WASM output (built by wasm-pack)
demo/            -- Browser demo page

2.2 KiB Raw Blame History