@plane31/blind-relay 0.0.0-stage → 0.1.2

package/dist/bytes.js

@@ -0,0 +1,200 @@
+/**
+ * Fixed-width big-endian encoding, protocol section 3.
+ * u64 values are BigInt end to end; nothing is ever rounded through a double.
+ */
+import { KavachError } from "./errors.js";
+export const MAX_DOCUMENT_BYTES = 16_384;
+export const MAX_PAYLOAD_BYTES = 4_096;
+const U32_MAX = 0xffff_ffff;
+const U64_MAX = (1n << 64n) - 1n;
+const NAME_RULE = /^[A-Za-z0-9_-]{1,64}$/;
+export function concat(...parts) {
+    let length = 0;
+    for (const part of parts)
+        length += part.length;
+    const out = new Uint8Array(length);
+    let offset = 0;
+    for (const part of parts) {
+        out.set(part, offset);
+        offset += part.length;
+    }
+    return out;
+}
+export function u8(value) {
+    if (!Number.isInteger(value) || value < 0 || value > 0xff)
+        throw new RangeError("u8 out of range");
+    return Uint8Array.of(value);
+}
+export function u16(value) {
+    if (!Number.isInteger(value) || value < 0 || value > 0xffff)
+        throw new RangeError("u16 out of range");
+    return Uint8Array.of(value >>> 8, value & 0xff);
+}
+export function u32(value) {
+    if (!Number.isInteger(value) || value < 0 || value > U32_MAX)
+        throw new RangeError("u32 out of range");
+    const out = new Uint8Array(4);
+    new DataView(out.buffer).setUint32(0, value, false);
+    return out;
+}
+export function u64(value) {
+    if (typeof value !== "bigint" || value < 0n || value > U64_MAX)
+        throw new RangeError("u64 out of range");
+    const out = new Uint8Array(8);
+    new DataView(out.buffer).setBigUint64(0, value, false);
+    return out;
+}
+export function i32(value) {
+    if (!Number.isInteger(value) || value < -0x8000_0000 || value > 0x7fff_ffff)
+        throw new RangeError("i32 out of range");
+    const out = new Uint8Array(4);
+    new DataView(out.buffer).setInt32(0, value, false);
+    return out;
+}
+/** The `accountName` rule: 1 to 64 ASCII letters, digits, underscore or hyphen, case-sensitive. */
+export function isValidName(name) {
+    return NAME_RULE.test(name);
+}
+/** `B(name)`: u8 byte length followed by the ASCII bytes. */
+export function encodeName(name) {
+    if (!isValidName(name))
+        throw new KavachError("MALFORMED", "encodeName", "account name violates the name rule");
+    const bytes = new Uint8Array(name.length);
+    for (let i = 0; i < name.length; i++)
+        bytes[i] = name.charCodeAt(i);
+    return concat(u8(bytes.length), bytes);
+}
+export function equalBytes(a, b) {
+    if (a.length !== b.length)
+        return false;
+    let diff = 0;
+    for (let i = 0; i < a.length; i++)
+        diff |= (a[i] ?? 0) ^ (b[i] ?? 0);
+    return diff === 0;
+}
+export function isAllZero(bytes) {
+    let acc = 0;
+    for (const b of bytes)
+        acc |= b;
+    return acc === 0;
+}
+const HEX = /^[0-9a-f]*$/i;
+export function toHex(bytes) {
+    let s = "";
+    for (const b of bytes)
+        s += b.toString(16).padStart(2, "0");
+    return s;
+}
+export function fromHex(hex) {
+    if (hex.length % 2 !== 0 || !HEX.test(hex))
+        throw new RangeError("bad hex");
+    const out = new Uint8Array(hex.length / 2);
+    for (let i = 0; i < out.length; i++)
+        out[i] = Number.parseInt(hex.slice(2 * i, 2 * i + 2), 16);
+    return out;
+}
+/** Compare two byte strings lexicographically, as the strict sort orders in section 3 require. */
+export function compareBytes(a, b) {
+    const n = Math.min(a.length, b.length);
+    for (let i = 0; i < n; i++) {
+        const d = (a[i] ?? 0) - (b[i] ?? 0);
+        if (d !== 0)
+            return d;
+    }
+    return a.length - b.length;
+}
+/**
+ * A bounded reader. Every take is checked against the end; `end()` refuses trailing bytes.
+ * All failures are `MALFORMED`, which is what the codec reports before any cryptography.
+ */
+export class Reader {
+    data;
+    stage;
+    offset = 0;
+    constructor(data, stage = "parse") {
+        this.data = data;
+        this.stage = stage;
+    }
+    get position() {
+        return this.offset;
+    }
+    get remaining() {
+        return this.data.length - this.offset;
+    }
+    take(n) {
+        if (!Number.isInteger(n) || n < 0 || this.offset + n > this.data.length) {
+            throw new KavachError("MALFORMED", this.stage, "truncated");
+        }
+        const out = this.data.slice(this.offset, this.offset + n);
+        this.offset += n;
+        return out;
+    }
+    u8() {
+        return this.take(1)[0] ?? 0;
+    }
+    u16() {
+        const b = this.take(2);
+        return ((b[0] ?? 0) << 8) | (b[1] ?? 0);
+    }
+    u32() {
+        const b = this.take(4);
+        return new DataView(b.buffer, b.byteOffset, 4).getUint32(0, false);
+    }
+    u64() {
+        const b = this.take(8);
+        return new DataView(b.buffer, b.byteOffset, 8).getBigUint64(0, false);
+    }
+    i32() {
+        const b = this.take(4);
+        return new DataView(b.buffer, b.byteOffset, 4).getInt32(0, false);
+    }
+    /** `B(name)`, enforcing the name rule. */
+    name() {
+        const n = this.u8();
+        const bytes = this.take(n);
+        let text = "";
+        for (const b of bytes)
+            text += String.fromCharCode(b);
+        if (!isValidName(text))
+            throw new KavachError("MALFORMED", this.stage, "bad account name");
+        return text;
+    }
+    /** The bytes consumed so far, for AAD and body hashing. */
+    consumed() {
+        return this.data.slice(0, this.offset);
+    }
+    end() {
+        if (this.offset !== this.data.length)
+            throw new KavachError("MALFORMED", this.stage, "trailing bytes");
+    }
+}
+/** An append-only writer for building bodies. */
+export class Writer {
+    parts = [];
+    bytes(value) {
+        this.parts.push(value);
+        return this;
+    }
+    u8(value) {
+        return this.bytes(u8(value));
+    }
+    u16(value) {
+        return this.bytes(u16(value));
+    }
+    u32(value) {
+        return this.bytes(u32(value));
+    }
+    u64(value) {
+        return this.bytes(u64(value));
+    }
+    i32(value) {
+        return this.bytes(i32(value));
+    }
+    name(value) {
+        return this.bytes(encodeName(value));
+    }
+    finish() {
+        return concat(...this.parts);
+    }
+}
+//# sourceMappingURL=bytes.js.map

package/dist/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../src/bytes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC;AACvC,MAAM,OAAO,GAAG,WAAW,CAAC;AAC5B,MAAM,OAAO,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;AACjC,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAE1C,MAAM,UAAU,MAAM,CAAC,GAAG,KAA4B;IACpD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;IAChD,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtB,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;IACxB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,EAAE,CAAC,KAAa;IAC9B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI;QAAE,MAAM,IAAI,UAAU,CAAC,iBAAiB,CAAC,CAAC;IACnG,OAAO,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAa;IAC/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,MAAM;QAAE,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACtG,OAAO,UAAU,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAa;IAC/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,OAAO;QAAE,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACvG,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACpD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAa;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,OAAO;QAAE,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACzG,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACvD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAa;IAC/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,WAAW,IAAI,KAAK,GAAG,WAAW;QAAE,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACtH,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACnD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,mGAAmG;AACnG,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,qCAAqC,CAAC,CAAC;IAChH,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,CAAa,EAAE,CAAa;IACrD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxC,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,OAAO,IAAI,KAAK,CAAC,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,CAAC,IAAI,KAAK;QAAE,GAAG,IAAI,CAAC,CAAC;IAChC,OAAO,GAAG,KAAK,CAAC,CAAC;AACnB,CAAC;AAED,MAAM,GAAG,GAAG,cAAc,CAAC;AAE3B,MAAM,UAAU,KAAK,CAAC,KAAiB;IACrC,IAAI,CAAC,GAAG,EAAE,CAAC;IACX,KAAK,MAAM,CAAC,IAAI,KAAK;QAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5D,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC;IAC5E,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/F,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,YAAY,CAAC,CAAa,EAAE,CAAa;IACvD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,MAAM;IAIE;IACA;IAJX,MAAM,GAAG,CAAC,CAAC;IAEnB,YACmB,IAAgB,EAChB,QAAQ,OAAO;QADf,SAAI,GAAJ,IAAI,CAAY;QAChB,UAAK,GAAL,KAAK,CAAU;IAC/B,CAAC;IAEJ,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,CAAS;QACZ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACxE,MAAM,IAAI,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACjB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,EAAE;QACA,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,GAAG;QACD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,GAAG;QACD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAED,GAAG;QACD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED,GAAG;QACD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED,0CAA0C;IAC1C,IAAI;QACF,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,KAAK,MAAM,CAAC,IAAI,KAAK;YAAE,IAAI,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;QAC3F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2DAA2D;IAC3D,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,GAAG;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;IACzG,CAAC;CACF;AAED,iDAAiD;AACjD,MAAM,OAAO,MAAM;IACA,KAAK,GAAiB,EAAE,CAAC;IAE1C,KAAK,CAAC,KAAiB;QACrB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,EAAE,CAAC,KAAa;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,CAAC,KAAa;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,MAAM;QACJ,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;CACF"}

package/dist/circle.d.ts

@@ -0,0 +1,59 @@
+import { type CircleSnapshot, type Parsed } from "./codec.js";
+export type CircleStatus = "requested" | "member" | "left" | "quarantined" | "closed";
+/** What the SDK persists per circle it has pinned. */
+export interface CircleState {
+    readonly circleId: Uint8Array;
+    readonly ownerIdentityId: Uint8Array;
+    /** 0n until the first verified snapshot. */
+    readonly revision: bigint;
+    readonly bodyHash: Uint8Array | undefined;
+    readonly snapshot: Uint8Array | undefined;
+    readonly members: readonly Uint8Array[];
+    readonly enabled: boolean;
+    readonly status: CircleStatus;
+    /** When the current snapshot was verified, for showing its age. */
+    readonly verifiedAt: bigint;
+}
+export type SnapshotOutcome = {
+    readonly outcome: "ACCEPTED";
+    readonly state: CircleState;
+    readonly snapshot: Parsed<CircleSnapshot>;
+} | {
+    readonly outcome: "DUPLICATE";
+    readonly state: CircleState;
+};
+export declare function newCircleId(): Uint8Array;
+export declare function pinCircle(circleId: Uint8Array, ownerIdentityId: Uint8Array, enabled: boolean, status?: CircleStatus): CircleState;
+/**
+ * Accept a snapshot for a pinned circle under the pinned owner's account key.
+ * A lower revision is `ROLLBACK`; the same revision with the same body is a duplicate and with a
+ * different valid body is `EQUIVOCATION`, which quarantines the circle. Membership status comes
+ * from the snapshot: the account is a member when it is listed and waiting when it is not.
+ */
+export declare function acceptSnapshot(state: CircleState, wire: Uint8Array, ownerAccountKey: Uint8Array, selfIdentityId: Uint8Array, now: bigint): SnapshotOutcome;
+/** Two different account keys for one account name among resolved members is a forgery attempt. */
+export declare function checkMemberResolution(resolved: ReadonlyMap<string, {
+    accountName: string;
+    accountKey: Uint8Array;
+}>): void;
+export interface OwnerKeys {
+    readonly identityId: Uint8Array;
+    readonly accountSecretKey: Uint8Array;
+}
+/** Revision 1 with the owner as sole member. */
+export declare function createCircleSnapshot(owner: OwnerKeys, circleId: Uint8Array): Uint8Array;
+export type MembershipChange = {
+    readonly admit: Uint8Array;
+} | {
+    readonly remove: Uint8Array;
+} | {
+    readonly close: true;
+};
+/**
+ * The successor snapshot from trusted local state plus one change. Returns `undefined` when the
+ * change is already reflected (approval of an admitted account is idempotent).
+ */
+export declare function successorSnapshot(state: CircleState, change: MembershipChange, owner: OwnerKeys): Uint8Array | undefined;
+/** The owner's restored device signs revision plus one over the current snapshot; the revision never resets. */
+export declare function isOwner(state: CircleState, selfIdentityId: Uint8Array): boolean;
+//# sourceMappingURL=circle.d.ts.map

package/dist/circle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circle.d.ts","sourceRoot":"","sources":["../src/circle.ts"],"names":[],"mappings":"AAOA,OAAO,EAAiE,KAAK,cAAc,EAAE,KAAK,MAAM,EAAE,MAAM,YAAY,CAAC;AAI7H,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,GAAG,aAAa,GAAG,QAAQ,CAAC;AAEtF,sDAAsD;AACtD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC;IACrC,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,mEAAmE;IACnE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,eAAe,GACvB;IAAE,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,CAAC,CAAA;CAAE,GACxG;IAAE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAA;CAAE,CAAC;AAEnE,wBAAgB,WAAW,IAAI,UAAU,CAExC;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAE,YAA0B,GAAG,WAAW,CAE9I;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,eAAe,CAwB1J;AAED,mGAAmG;AACnG,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,GAAG,IAAI,CAU1H;AAID,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,gBAAgB,EAAE,UAAU,CAAC;CACvC;AAED,gDAAgD;AAChD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU,CAEvF;AAED,MAAM,MAAM,gBAAgB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAA;CAAE,CAAC;AAE3H;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS,CAkBxH;AAED,gHAAgH;AAChH,wBAAgB,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,GAAG,OAAO,CAE/E"}

package/dist/circle.js

@@ -0,0 +1,105 @@
+/**
+ * Circle membership and owner approval (protocol section 6).
+ *
+ * Membership is one owner-signed snapshot. Join and leave requests are host state with no
+ * signature; the owner builds every successor from trusted local state plus one change.
+ */
+import { compareBytes, equalBytes, toHex } from "./bytes.js";
+import { DocumentType, buildCircleSnapshot, expectType, verifyDocument } from "./codec.js";
+import { randomBytes } from "./crypto.js";
+import { KavachError } from "./errors.js";
+export function newCircleId() {
+    return randomBytes(16);
+}
+export function pinCircle(circleId, ownerIdentityId, enabled, status = "requested") {
+    return { circleId, ownerIdentityId, revision: 0n, bodyHash: undefined, snapshot: undefined, members: [], enabled, status, verifiedAt: 0n };
+}
+/**
+ * Accept a snapshot for a pinned circle under the pinned owner's account key.
+ * A lower revision is `ROLLBACK`; the same revision with the same body is a duplicate and with a
+ * different valid body is `EQUIVOCATION`, which quarantines the circle. Membership status comes
+ * from the snapshot: the account is a member when it is listed and waiting when it is not.
+ */
+export function acceptSnapshot(state, wire, ownerAccountKey, selfIdentityId, now) {
+    const stage = "acceptSnapshot";
+    const doc = expectType(verifyDocument(wire, ownerAccountKey), DocumentType.CircleSnapshot, stage);
+    if (!equalBytes(doc.circleId, state.circleId) || !equalBytes(doc.ownerIdentityId, state.ownerIdentityId)) {
+        throw new KavachError("MALFORMED", stage, "snapshot is for another circle or owner");
+    }
+    if (doc.revision < state.revision)
+        throw new KavachError("ROLLBACK", stage);
+    if (doc.revision === state.revision) {
+        if (state.bodyHash && equalBytes(doc.bodyHash, state.bodyHash))
+            return { outcome: "DUPLICATE", state };
+        throw new KavachError("EQUIVOCATION", stage, "two snapshots at one revision");
+    }
+    // A member that is no longer listed has been removed, whether by a removal or a closure; the
+    // two are indistinguishable to a member and mean the same thing locally. Only the owner's own
+    // explicit close sets "closed".
+    const listed = doc.members.some((m) => equalBytes(m, selfIdentityId));
+    let status = state.status;
+    if (state.status === "quarantined")
+        status = "quarantined";
+    else if (listed)
+        status = "member";
+    else if (state.status === "member")
+        status = "left";
+    return {
+        outcome: "ACCEPTED",
+        snapshot: doc,
+        state: { ...state, revision: doc.revision, bodyHash: doc.bodyHash, snapshot: wire, members: doc.members, status, verifiedAt: now }
+    };
+}
+/** Two different account keys for one account name among resolved members is a forgery attempt. */
+export function checkMemberResolution(resolved) {
+    const byName = new Map();
+    for (const [iid, r] of resolved) {
+        const seen = byName.get(r.accountName);
+        if (seen !== undefined && seen !== toHex(r.accountKey)) {
+            throw new KavachError("EQUIVOCATION", "resolveMembers", `two keys for ${r.accountName}`);
+        }
+        byName.set(r.accountName, toHex(r.accountKey));
+        void iid;
+    }
+}
+/** Revision 1 with the owner as sole member. */
+export function createCircleSnapshot(owner, circleId) {
+    return buildCircleSnapshot({ circleId, ownerIdentityId: owner.identityId, revision: 1n, members: [owner.identityId] }, owner.accountSecretKey);
+}
+/**
+ * The successor snapshot from trusted local state plus one change. Returns `undefined` when the
+ * change is already reflected (approval of an admitted account is idempotent).
+ */
+export function successorSnapshot(state, change, owner) {
+    if (!equalBytes(state.ownerIdentityId, owner.identityId))
+        throw new KavachError("NOT_AUTHORIZED", "successorSnapshot", "not the owner");
+    if (state.status === "closed")
+        throw new KavachError("NOT_AUTHORIZED", "successorSnapshot", "circle closed");
+    let members;
+    if ("admit" in change) {
+        if (state.members.some((m) => equalBytes(m, change.admit)))
+            return undefined;
+        members = [...state.members, change.admit];
+        if (members.length > 100)
+            throw new KavachError("RECIPIENT_LIMIT", "successorSnapshot");
+    }
+    else if ("remove" in change) {
+        if (equalBytes(change.remove, owner.identityId))
+            throw new KavachError("NOT_AUTHORIZED", "successorSnapshot", "the owner cannot leave without closing");
+        if (!state.members.some((m) => equalBytes(m, change.remove)))
+            return undefined;
+        members = state.members.filter((m) => !equalBytes(m, change.remove));
+    }
+    else {
+        members = [owner.identityId];
+        if (state.members.length === 1)
+            return undefined;
+    }
+    members.sort(compareBytes);
+    return buildCircleSnapshot({ circleId: state.circleId, ownerIdentityId: owner.identityId, revision: state.revision + 1n, members }, owner.accountSecretKey);
+}
+/** The owner's restored device signs revision plus one over the current snapshot; the revision never resets. */
+export function isOwner(state, selfIdentityId) {
+    return equalBytes(state.ownerIdentityId, selfIdentityId);
+}
+//# sourceMappingURL=circle.js.map

package/dist/circle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circle.js","sourceRoot":"","sources":["../src/circle.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,cAAc,EAAoC,MAAM,YAAY,CAAC;AAC7H,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAuB1C,MAAM,UAAU,WAAW;IACzB,OAAO,WAAW,CAAC,EAAE,CAAC,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,QAAoB,EAAE,eAA2B,EAAE,OAAgB,EAAE,SAAuB,WAAW;IAC/H,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;AAC7I,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAkB,EAAE,IAAgB,EAAE,eAA2B,EAAE,cAA0B,EAAE,GAAW;IACvI,MAAM,KAAK,GAAG,gBAAgB,CAAC;IAC/B,MAAM,GAAG,GAAG,UAAU,CAAiB,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,YAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAClH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QACzG,MAAM,IAAI,WAAW,CAAC,WAAW,EAAE,KAAK,EAAE,yCAAyC,CAAC,CAAC;IACvF,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ;QAAE,MAAM,IAAI,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC5E,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,QAAQ,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;QACvG,MAAM,IAAI,WAAW,CAAC,cAAc,EAAE,KAAK,EAAE,+BAA+B,CAAC,CAAC;IAChF,CAAC;IACD,6FAA6F;IAC7F,8FAA8F;IAC9F,gCAAgC;IAChC,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;IACtE,IAAI,MAAM,GAAiB,KAAK,CAAC,MAAM,CAAC;IACxC,IAAI,KAAK,CAAC,MAAM,KAAK,aAAa;QAAE,MAAM,GAAG,aAAa,CAAC;SACtD,IAAI,MAAM;QAAE,MAAM,GAAG,QAAQ,CAAC;SAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ;QAAE,MAAM,GAAG,MAAM,CAAC;IACpD,OAAO;QACL,OAAO,EAAE,UAAU;QACnB,QAAQ,EAAE,GAAG;QACb,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE;KACnI,CAAC;AACJ,CAAC;AAED,mGAAmG;AACnG,MAAM,UAAU,qBAAqB,CAAC,QAA8E;IAClH,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QACvC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,WAAW,CAAC,cAAc,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3F,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/C,KAAK,GAAG,CAAC;IACX,CAAC;AACH,CAAC;AASD,gDAAgD;AAChD,MAAM,UAAU,oBAAoB,CAAC,KAAgB,EAAE,QAAoB;IACzE,OAAO,mBAAmB,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;AACjJ,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAkB,EAAE,MAAwB,EAAE,KAAgB;IAC9F,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,UAAU,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAC;IACxI,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAC;IAC7G,IAAI,OAAqB,CAAC;IAC1B,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7E,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,OAAO,CAAC,MAAM,GAAG,GAAG;YAAE,MAAM,IAAI,WAAW,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;IAC1F,CAAC;SAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;QAC9B,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,wCAAwC,CAAC,CAAC;QACxJ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QAC/E,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACvE,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;IACnD,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3B,OAAO,mBAAmB,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAC9J,CAAC;AAED,gHAAgH;AAChH,MAAM,UAAU,OAAO,CAAC,KAAkB,EAAE,cAA0B;IACpE,OAAO,UAAU,CAAC,KAAK,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;AAC3D,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,234 @@
+import { type CircleState } from "./circle.js";
+import { type RecordKind } from "./codec.js";
+import { type ErrorCode } from "./errors.js";
+import { type HistoryEntry, type HistoryPage, type HistoryQuery, type Newest, type ReceiveResult } from "./inbox.js";
+import { type EnqueueOptions, type OutboxCounts } from "./outbox.js";
+export type { EnqueueOptions } from "./outbox.js";
+/** The durable record a hand-over produced; `duplicate` when an idempotency key matched an earlier one. */
+export interface EnqueueResult {
+    readonly recordId: Uint8Array;
+    readonly duplicate: boolean;
+}
+import { type ResetTrustConfig } from "./reset.js";
+import type { SecretStore, Store } from "./store.js";
+import type { Transport } from "./transport.js";
+import { type ProviderStatusResult, type RecoveryProvider } from "./vault.js";
+/** The types of the client's queries and of `receive`, defined with the inbox. */
+export type { HistoryEntry, HistoryPage, HistoryQuery, Newest, ReceiveResult } from "./inbox.js";
+export type ClientStatus = "fresh" | "ready" | "locked" | "accountRecoveryRequired" | "activationPending" | "retired" | "paused" | "quarantined";
+export type PauseReason = "sync" | "rotation" | "metadata" | "limit";
+export interface ClientState {
+    readonly status: ClientStatus;
+    readonly paused: PauseReason | undefined;
+    readonly identityId: Uint8Array | undefined;
+    readonly certificateHash: Uint8Array | undefined;
+    readonly generation: bigint | undefined;
+    readonly outbox: number;
+    /** Authors whose current epoch has not yet reached this device. */
+    readonly waitingFor: readonly Uint8Array[];
+    readonly circles: readonly CircleSummary[];
+}
+/** Diagnostics: where the protocol stands on this device. Never a secret or a plaintext. */
+export interface Inspection {
+    readonly identityId: Uint8Array | undefined;
+    readonly certificateHash: Uint8Array | undefined;
+    readonly generation: bigint | undefined;
+    readonly desiredRevision: bigint;
+    readonly paused: PauseReason | undefined;
+    readonly activeEpoch: number | undefined;
+    /** An epoch prepared or committed that is not active yet. */
+    readonly pendingEpoch: number | undefined;
+    readonly outbox: OutboxCounts;
+    readonly vault: {
+        readonly revision: bigint;
+        readonly pending: boolean;
+        readonly dirty: boolean;
+    } | undefined;
+}
+export interface CircleSummary {
+    readonly circleId: Uint8Array;
+    readonly ownerIdentityId: Uint8Array;
+    readonly revision: bigint;
+    readonly members: readonly Uint8Array[];
+    readonly enabled: boolean;
+    readonly status: CircleState["status"];
+    readonly snapshotAgeMs: bigint;
+    readonly owned: boolean;
+}
+export type ClientEvent = {
+    kind: "deviceChanged";
+    identityId: Uint8Array;
+    generation: bigint;
+}
+/** After a rotation, or when a sent record's acceptance is in doubt: the app may resend its current state of each kind with a slot. */
+ | {
+    kind: "refresh";
+    reason: string;
+} | {
+    kind: "cancelled";
+    recordId: Uint8Array;
+    reason: string;
+} | {
+    kind: "queued";
+    recordId: Uint8Array;
+    recordKind: RecordKind;
+} | {
+    kind: "accepted";
+    recordId: Uint8Array;
+}
+/** A record was stored, received or the device's own; `tookSlot` when it became the author's newest of its kind. */
+ | {
+    kind: "recordStored";
+    recordKind: RecordKind;
+    authorIdentityId: Uint8Array;
+    recordId: Uint8Array;
+    tookSlot: boolean;
+} | {
+    kind: "waiting";
+    identityId: Uint8Array;
+} | {
+    kind: "joinRequests";
+    circleId: Uint8Array;
+    accountNames: readonly string[];
+} | {
+    kind: "circleChanged";
+    circleId: Uint8Array;
+    revision: bigint;
+    status: CircleState["status"];
+} | {
+    kind: "accountKeyChanged";
+    accountName: string;
+    quarantined: boolean;
+} | {
+    kind: "securityError";
+    code: string;
+    detail: string;
+} | {
+    kind: "stateChanged";
+    state: ClientState;
+};
+export interface OpenOptions {
+    readonly accountName: string;
+    readonly retentionPolicy: unknown;
+    readonly recoveryProvider: RecoveryProvider;
+    readonly resetTrust: ResetTrustConfig;
+    readonly secretStore: SecretStore;
+    readonly store: Store;
+    readonly transport: Transport;
+    readonly now?: () => bigint;
+    /** Called when a subscriber throws. Listeners are isolated from the protocol and from each other either way. */
+    readonly onListenerError?: (error: unknown, event: ClientEvent) => void;
+}
+export interface Client {
+    readonly accountName: string;
+    getState(): Promise<ClientState>;
+    subscribe(listener: (event: ClientEvent) => void): () => void;
+    initializeAccount(): Promise<{
+        identityId: Uint8Array;
+    }>;
+    recoveryStatus(): Promise<ProviderStatusResult>;
+    recoveryCode(): Promise<string>;
+    restoreAccount(recoveryCode?: string): Promise<{
+        identityId: Uint8Array;
+        generation: bigint;
+    }>;
+    /** A durable outbound record of a declared kind; the payload is the product's bytes, never read by the SDK. */
+    enqueue(kind: RecordKind, payload: Uint8Array, options?: EnqueueOptions): Promise<EnqueueResult>;
+    /** One synchronisation; `options.catchUp` bounds how much of a backlog this call reads (`SyncReport.inbox.hasMore` says when to call again). */
+    sync(options?: SyncOptions): Promise<SyncReport>;
+    receive(wire: Uint8Array): Promise<ReceiveResult>;
+    /** The first page of `historyPage`, as a list. */
+    history(query?: HistoryQuery): Promise<HistoryEntry[]>;
+    /** One page of history in time order with a cursor for the next; served from the index. */
+    historyPage(query?: HistoryQuery): Promise<HistoryPage>;
+    /** The newest history entry for an author or kind, own records and superseded ones included. */
+    newestEntry(query?: Pick<HistoryQuery, "authorIdentityId" | "kind">): Promise<HistoryEntry | undefined>;
+    /** The newest record of a kind from an author's current device, self included; `undefined` when none or expired. */
+    newest(identityId: Uint8Array, kind: RecordKind): Promise<Newest | undefined>;
+    inspect(): Promise<Inspection>;
+    readonly circles: {
+        create(): Promise<{
+            circleId: Uint8Array;
+        }>;
+        requestJoin(circleId: Uint8Array, ownerIdentityId: Uint8Array, options?: {
+            shareOnApproval?: boolean;
+        }): Promise<void>;
+        approve(circleId: Uint8Array, accountName: string): Promise<{
+            revision: bigint;
+        }>;
+        remove(circleId: Uint8Array, memberIdentityId: Uint8Array): Promise<{
+            revision: bigint;
+        }>;
+        leave(circleId: Uint8Array): Promise<void>;
+        setEnabled(circleId: Uint8Array, enabled: boolean): Promise<void>;
+        closeCircle(circleId: Uint8Array): Promise<void>;
+        list(): Promise<readonly CircleSummary[]>;
+    };
+    resetAccount(options: {
+        confirmed: true;
+        reauthProof?: Uint8Array;
+    }): Promise<{
+        identityId: Uint8Array;
+    }>;
+    close(): Promise<void>;
+}
+export interface SyncOptions {
+    /**
+     * The inbox budget of this sync, shared by every stream: at most this many records
+     * (default 500) and this many milliseconds of reading (default 5,000) before the sync stops
+     * and reports `inbox.hasMore`, so a long backlog never holds a wake-up open. Each stream reads
+     * at least one page.
+     */
+    readonly catchUp?: {
+        readonly maxRecords?: number;
+        readonly maxMs?: number;
+    };
+}
+export declare const DEFAULT_CATCH_UP: {
+    readonly maxRecords: 500;
+    readonly maxMs: 5000;
+};
+export interface SyncReport {
+    metadata: {
+        certificates: number;
+        snapshots: number;
+        rotations: number;
+        quarantined: number;
+        resets: number;
+    };
+    epoch: "unchanged" | "prepared" | "paused" | "pending";
+    outbox: {
+        sent: number;
+        accepted: number;
+        cancelled: number;
+        unknown: number;
+        retry: number;
+    };
+    /** `hasMore`: a stream still has records on the relay that this sync's budget did not reach; sync again soon. */
+    inbox: {
+        streams: number;
+        stored: number;
+        keyPending: number;
+        invalid: number;
+        acked: number;
+        hasMore: boolean;
+    };
+    purged: number;
+    errors: SyncError[];
+}
+/** One failure a sync worked around: which step, the protocol code and stage, and whether the same step may succeed later unchanged. */
+export interface SyncError {
+    readonly operation: string;
+    readonly code: ErrorCode | "ACTIVATION_PENDING" | "UNEXPECTED";
+    readonly stage: string;
+    readonly retryable: boolean;
+    /**
+     * On an `inbox` entry: the stream whose download or processing failed and its author, so the
+     * host can tell which sender is affected. Identifying metadata (protocol section 14): keep it
+     * local or pseudonymise it before logging.
+     */
+    readonly streamId?: Uint8Array;
+    readonly authorIdentityId?: Uint8Array;
+}
+export declare function open(options: OpenOptions): Promise<Client>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAOA,OAAO,EAA0G,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AACvJ,OAAO,EAAkF,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7H,OAAO,EAA8B,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAGzE,OAAO,EAA2I,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,MAAM,EAAmB,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAC/Q,OAAO,EAA0D,KAAK,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAC7H,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,2GAA2G;AAC3G,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED,OAAO,EAAc,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE/D,OAAO,KAAK,EAA8B,WAAW,EAAE,KAAK,EAAgB,MAAM,YAAY,CAAC;AAE/F,OAAO,KAAK,EAAS,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAuG,KAAK,oBAAoB,EAAE,KAAK,gBAAgB,EAAmB,MAAM,YAAY,CAAC;AAEpM,kFAAkF;AAClF,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAqBjG,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,yBAAyB,GAAG,mBAAmB,GAAG,SAAS,GAAG,QAAQ,GAAG,aAAa,CAAC;AACjJ,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;AAErE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,eAAe,EAAE,UAAU,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,mEAAmE;IACnE,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAC3C,QAAQ,CAAC,OAAO,EAAE,SAAS,aAAa,EAAE,CAAC;CAC5C;AAED,4FAA4F;AAC5F,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,eAAe,EAAE,UAAU,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,6DAA6D;IAC7D,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,CAAC;CAC/G;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC;IACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,UAAU,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE;AACvE,uIAAuI;GACrI;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAA;CAAE;AAC5C,oHAAoH;GAClH;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,UAAU,EAAE,UAAU,CAAC;IAAC,gBAAgB,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,GACvH;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAC;IAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAC/E;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAA;CAAE,GAChG;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,CAAC;AAEjD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAC5C,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;IACtC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IAC5B,gHAAgH;IAChH,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;CACzE;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACjC,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAC9D,iBAAiB,IAAI,OAAO,CAAC;QAAE,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC,CAAC;IACzD,cAAc,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAChD,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,cAAc,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/F,+GAA+G;IAC/G,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjG,gJAAgJ;IAChJ,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjD,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAClD,kDAAkD;IAClD,OAAO,CAAC,KAAK,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACvD,2FAA2F;IAC3F,WAAW,CAAC,KAAK,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACxD,gGAAgG;IAChG,WAAW,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,kBAAkB,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IACxG,oHAAoH;IACpH,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC9E,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE;QAChB,MAAM,IAAI,OAAO,CAAC;YAAE,QAAQ,EAAE,UAAU,CAAA;SAAE,CAAC,CAAC;QAC5C,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE;YAAE,eAAe,CAAC,EAAE,OAAO,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACvH,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAClF,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,GAAG,OAAO,CAAC;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAC1F,KAAK,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAClE,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,IAAI,OAAO,CAAC,SAAS,aAAa,EAAE,CAAC,CAAC;KAC3C,CAAC;IACF,YAAY,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,IAAI,CAAC;QAAC,WAAW,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC,CAAC;IAC1G,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9E;AAED,eAAO,MAAM,gBAAgB;;;CAA6C,CAAC;AAE3E,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9G,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvD,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9F,iHAAiH;IACjH,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IACjH,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,wIAAwI;AACxI,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,oBAAoB,GAAG,YAAY,CAAC;IAC/D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC;CACxC;AAQD,wBAAsB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAMhE"}