Files

Christian Nennemann cbb76af6b1 docs(sdk): add comprehensive SDK documentation and wire format reference

Covers all official SDKs (Rust, Go, Python, TypeScript, C FFI),
the v2 wire format with method ID tables, authentication flow,
and a build-your-own-SDK guide with implementation checklist.

2026-03-04 20:55:24 +01:00

2.9 KiB

Raw Blame History

quicproquo SDK Documentation

This guide covers how to build clients for the quicproquo E2E encrypted messenger using the official SDKs or by implementing your own.

Official SDKs

Language	Location	Transport	Status
Rust	`crates/quicproquo-client`	QUIC + Cap'n Proto	Production
Go	`sdks/go/`	QUIC + Cap'n Proto	Production
TypeScript	`sdks/typescript/`	WebSocket bridge + WASM crypto	Production
Python	`sdks/python/`	QUIC + Protobuf (v2) / Rust FFI	Production
C	`crates/quicproquo-ffi/`	Rust FFI (synchronous)	Production
Swift	`sdks/swift/`	C FFI wrapper	In progress
Kotlin	`sdks/kotlin/`	JNI + C FFI	In progress
Java	`sdks/java/`	JNI + C FFI	In progress
Ruby	`sdks/ruby/`	FFI gem	In progress

Documentation

Wire Format -- v2 QUIC + Protobuf wire protocol
Rust SDK -- Native Rust client
Go SDK -- Go client with QUIC transport
Python SDK -- Python client (async QUIC + sync FFI)
TypeScript SDK -- Browser/Node.js client with WASM crypto
C FFI -- C bindings for language integrations
Build Your Own SDK -- Guide for implementing a new language SDK

Architecture Overview

  Client SDK                     Server
  ─────────                     ──────
  ┌──────────┐   QUIC/TLS 1.3   ┌──────────┐
  │ App code │ ◄──────────────► │ RPC      │
  │          │   v2 wire frames  │ dispatch │
  │ SDK API  │                   │          │
  │          │   [method_id:u16] │ handlers │
  │ Proto    │   [req_id:u32]    │          │
  │ encode/  │   [len:u32]       │ storage  │
  │ decode   │   [protobuf]      │          │
  │          │                   │          │
  │ QUIC     │                   │ QUIC     │
  │ transport│                   │ listener │
  └──────────┘                   └──────────┘

Each RPC call opens a new QUIC bidirectional stream. The request and response use the same 10-byte framing header followed by a protobuf payload.

Quick Start

Choose an SDK for your language
Connect to the server over QUIC (or WebSocket bridge for browsers)
Authenticate with OPAQUE (register or login)
Upload MLS key packages for E2E encryption
Send and receive encrypted messages

Canonical Schemas

Protobuf (v2): proto/qpq/v1/*.proto -- 14 service definitions
Cap'n Proto (v1): schemas/*.capnp -- legacy RPC interface

The protobuf schemas in proto/qpq/v1/ are the canonical API contract for the v2 protocol. New SDKs should implement against these definitions.

2.9 KiB Raw Blame History