docs: comprehensive update for sprints 1-9
Update README, ROADMAP, and mdBook to reflect all sprint deliverables: rich messaging, file transfer, disappearing messages, Go/TypeScript SDKs, C FFI, mesh networking (identity, store-and-forward, broadcast), and security hardening. Add 6 new mdBook guides (REPL reference, Go SDK, TypeScript SDK + browser demo, rich messaging, file transfer, mesh networking). Check off 16 completed ROADMAP items across phases 3-9.
This commit is contained in:
@@ -211,19 +211,47 @@ Auth version `0` is no longer supported; clients must send `version=1` and a val
|
||||
|
||||
## Method ordinal summary
|
||||
|
||||
| Ordinal | Method | Origin | Category |
|
||||
|---|---|---|---|
|
||||
| `@0` | `uploadKeyPackage` | AuthenticationService | Auth |
|
||||
| `@1` | `fetchKeyPackage` | AuthenticationService | Auth |
|
||||
| `@2` | `enqueue` | DeliveryService | Delivery |
|
||||
| `@3` | `fetch` | DeliveryService | Delivery |
|
||||
| `@4` | `fetchWait` | NodeService (new) | Delivery |
|
||||
| `@5` | `health` | NodeService (new) | Infrastructure |
|
||||
| `@6` | `uploadHybridKey` | NodeService (new) | Auth / PQ |
|
||||
| `@7` | `fetchHybridKey` | NodeService (new) | Auth / PQ |
|
||||
| Ordinal | Method | Category |
|
||||
|---|---|---|
|
||||
| `@0` | `uploadKeyPackage` | Auth |
|
||||
| `@1` | `fetchKeyPackage` | Auth |
|
||||
| `@2` | `enqueue` | Delivery |
|
||||
| `@3` | `fetch` | Delivery |
|
||||
| `@4` | `fetchWait` | Delivery |
|
||||
| `@5` | `health` | Infrastructure |
|
||||
| `@6` | `uploadHybridKey` | Auth / PQ |
|
||||
| `@7` | `fetchHybridKey` | Auth / PQ |
|
||||
| `@8` | `fetchHybridKeys` | Auth / PQ (batch) |
|
||||
| `@9` | `opaqueRegisterStart` | Auth / OPAQUE |
|
||||
| `@10` | `opaqueRegisterFinish` | Auth / OPAQUE |
|
||||
| `@11` | `opaqueLoginStart` | Auth / OPAQUE |
|
||||
| `@12` | `opaqueLoginFinish` | Auth / OPAQUE |
|
||||
| `@13` | `peek` | Delivery (non-destructive read) |
|
||||
| `@14` | `ack` | Delivery (acknowledge after peek) |
|
||||
| `@15` | `batchEnqueue` | Delivery (fan-out) |
|
||||
| `@16` | `createChannel` | Channels |
|
||||
| `@17` | `resolveUser` | Discovery |
|
||||
| `@18` | `resolveIdentity` | Discovery (reverse lookup) |
|
||||
| `@19` | `registerDevice` | Devices |
|
||||
| `@20` | `listDevices` | Devices |
|
||||
| `@21` | `uploadBlob` | File transfer |
|
||||
| `@22` | `downloadBlob` | File transfer |
|
||||
| `@23` | `deleteAccount` | Account management |
|
||||
| `@24` | `revokeDevice` | Devices |
|
||||
| `@25` | `publishEndpoint` | P2P discovery |
|
||||
| `@26` | `resolveEndpoint` | P2P discovery |
|
||||
|
||||
Ordinals are stable and must not be reused. New methods are appended with the next available ordinal. This is a fundamental Cap'n Proto schema evolution rule: removing a method does not free its ordinal.
|
||||
|
||||
### Notable additions since initial release
|
||||
|
||||
- **OPAQUE (@9-@12):** Password-authenticated key exchange. The password never leaves the client.
|
||||
- **Channels (@16):** `createChannel` returns `(channelId :Data, wasNew :Bool)` for 1:1 DM creation with deduplication.
|
||||
- **File transfer (@21-@22):** `uploadBlob` accepts 256 KB chunks with SHA-256 content addressing; `downloadBlob` retrieves chunks with hash verification. Max 50 MB.
|
||||
- **Account deletion (@23):** Transactional purge of all user data (user record, identity keys, key packages, hybrid keys, queued deliveries, channel memberships).
|
||||
- **TTL support:** `enqueue` and `batchEnqueue` accept an optional `ttlSecs` parameter for disappearing messages with server-side garbage collection.
|
||||
- **P2P discovery (@25-@26):** `publishEndpoint` and `resolveEndpoint` for iroh node address exchange.
|
||||
|
||||
---
|
||||
|
||||
## Schema evolution
|
||||
|
||||
Reference in New Issue
Block a user