993cf9ab7f
ARCHITECTURE.md covers the entire system with 13 Mermaid diagrams: - System overview (send/recv pipeline, relay SFU) - Crate dependency graph (8 crates + featherChat) - Wire formats (MediaHeader, MiniHeader, TrunkFrame, QualityReport, SignalMessage) - Quality profiles with adaptive switching thresholds - Cryptographic handshake sequence (X25519 + Ed25519) - Identity model (BIP39 seed → HKDF → Ed25519/X25519 → Fingerprint) - Relay modes (Room SFU, Forward, Probe) - Web bridge architecture (Browser ↔ WS ↔ QUIC) - FEC protection pipeline (RaptorQ + interleaving) - Telemetry stack (Prometheus → Grafana) - Session state machine - Audio processing detail (denoise → VAD → encode → FEC → encrypt) - Adaptive jitter buffer flow - Deployment topology (multi-region) - featherChat integration sequence README.md: quick start, feature list, documentation index, build instructions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
88 lines
3.0 KiB
Markdown
88 lines
3.0 KiB
Markdown
# WarzonePhone
|
|
|
|
Custom lossy VoIP protocol built in Rust. E2E encrypted, FEC-protected, adaptive quality, designed for hostile network conditions.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Build
|
|
cargo build --release
|
|
|
|
# Run relay
|
|
./target/release/wzp-relay --listen 0.0.0.0:4433
|
|
|
|
# Send a test tone
|
|
./target/release/wzp-client --send-tone 5 relay-addr:4433
|
|
|
|
# Web bridge (browser calls)
|
|
./target/release/wzp-web --port 8080 --relay 127.0.0.1:4433 --tls
|
|
# Open https://localhost:8080/room-name in two browser tabs
|
|
```
|
|
|
|
## Architecture
|
|
|
|
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the full system architecture with Mermaid diagrams covering:
|
|
|
|
- System overview and data flow
|
|
- Crate dependency graph (8 crates)
|
|
- Wire formats (MediaHeader, MiniHeader, TrunkFrame, SignalMessage)
|
|
- Cryptographic handshake (X25519 + Ed25519 + ChaCha20-Poly1305)
|
|
- Identity model (BIP39 seed, featherChat compatible)
|
|
- Quality profiles (GOOD/DEGRADED/CATASTROPHIC)
|
|
- FEC protection (RaptorQ with interleaving)
|
|
- Adaptive jitter buffer (NetEq-inspired)
|
|
- Telemetry stack (Prometheus + Grafana)
|
|
- Deployment topology
|
|
|
|
## Features
|
|
|
|
- **3 quality tiers**: Opus 24k (28.8 kbps) / Opus 6k (9 kbps) / Codec2 1200 (2.4 kbps)
|
|
- **RaptorQ FEC**: Recovers from 20-100% packet loss depending on tier
|
|
- **E2E encryption**: ChaCha20-Poly1305 with X25519 key exchange
|
|
- **Adaptive jitter buffer**: EMA-based playout delay tracking
|
|
- **Silence suppression**: VAD + comfort noise (~50% bandwidth savings)
|
|
- **ML noise removal**: RNNoise (nnnoiseless pure Rust port)
|
|
- **Mini-frames**: 67% header compression for steady-state packets
|
|
- **Trunking**: Multiplex sessions into batched datagrams
|
|
- **featherChat integration**: Shared BIP39 identity, token auth, call signaling
|
|
- **Prometheus metrics**: Relay, web bridge, inter-relay probes
|
|
- **Grafana dashboard**: Pre-built JSON with 18 panels
|
|
|
|
## Documentation
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [ARCHITECTURE.md](docs/ARCHITECTURE.md) | Full system architecture with diagrams |
|
|
| [TELEMETRY.md](docs/TELEMETRY.md) | Prometheus metrics specification |
|
|
| [INTEGRATION_TASKS.md](docs/INTEGRATION_TASKS.md) | featherChat integration tracker |
|
|
| [WZP-FC-SHARED-CRATES.md](docs/WZP-FC-SHARED-CRATES.md) | Shared crate strategy |
|
|
| [grafana-dashboard.json](docs/grafana-dashboard.json) | Importable Grafana dashboard |
|
|
|
|
## Binaries
|
|
|
|
| Binary | Description |
|
|
|--------|-------------|
|
|
| `wzp-relay` | Relay daemon (SFU room mode, forward mode, probes) |
|
|
| `wzp-client` | CLI client (send-tone, record, live mic, echo-test, drift-test, sweep) |
|
|
| `wzp-web` | Browser bridge (HTTPS + WebSocket + AudioWorklet) |
|
|
| `wzp-bench` | Component benchmarks |
|
|
|
|
## Linux Build
|
|
|
|
```bash
|
|
./scripts/build-linux.sh --prepare # Create Hetzner VM + install deps
|
|
./scripts/build-linux.sh --build # Build release binaries
|
|
./scripts/build-linux.sh --transfer # Download to target/linux-x86_64/
|
|
./scripts/build-linux.sh --destroy # Delete VM
|
|
```
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
cargo test --workspace # 272 tests
|
|
```
|
|
|
|
## License
|
|
|
|
MIT OR Apache-2.0
|