@did-btcr2/aggregation 0.1.0

package/dist/esm/fallback-spend.js

@@ -0,0 +1,132 @@
+/**
+ * Fallback spend builder for aggregate beacon outputs.
+ *
+ * An aggregate beacon UTXO is a Taproot output whose key path is the cohort's
+ * n-of-n MuSig2 aggregate key and whose script path carries a k-of-n fallback
+ * leaf (`p2tr_ms` CHECKSIGADD) plus a CSV recovery leaf (see
+ * {@link ./recovery-policy.ts} and ADR 042). When the optimistic n-of-n key path
+ * stalls (a missing or defecting signer), the cohort can still push the SAME
+ * announcement transaction through the fallback leaf with any k members'
+ * signatures, instead of abandoning the round or waiting out the recovery
+ * timelock.
+ *
+ * Unlike the MuSig2 key path, the fallback is a plain k-of-n script-path spend:
+ * each signer produces a standalone BIP-340 signature over the script-path
+ * sighash (no nonce round), and the coordinator assembles k of them into the
+ * witness. The coordinator never holds a participant secret - it injects the
+ * collected signatures and finalizes.
+ *
+ * This module is pure with respect to the network: it takes the beacon
+ * transaction, the cohort and recovery parameters, the spent output, and the
+ * collected signatures, and returns a finalized {@link Transaction}.
+ * Broadcasting is the caller's concern.
+ */
+import { getNetwork } from '@did-btcr2/bitcoin';
+import { schnorr } from '@noble/curves/secp256k1.js';
+import { SigHash, p2tr } from '@scure/btc-signer';
+import { keyAggExport, keyAggregate, sortKeys } from '@scure/btc-signer/musig2';
+import { AggregationCohortError } from './errors.js';
+import { DEFAULT_FUNDING_MODEL, TAPROOT_LEAF_VERSION, buildFallbackLeaf, buildRecoveryLeaves, resolveFallbackThreshold, tapLeafHash, } from './recovery-policy.js';
+function bytesEqual(a, b) {
+    return a.length === b.length && a.every((x, i) => x === b[i]);
+}
+/**
+ * Compute the BIP-341 script-path sighash a cohort member must sign to authorize
+ * the fallback spend. The leaf is the k-of-n fallback leaf; signers produce a
+ * standalone BIP-340 signature over this digest with SIGHASH_DEFAULT.
+ */
+export function fallbackSighash(tx, inputIndex, prevOutScript, prevOutValue, fallbackLeafScript) {
+    return tx.preimageWitnessV1(inputIndex, [prevOutScript], SigHash.DEFAULT, [prevOutValue], undefined, fallbackLeafScript, TAPROOT_LEAF_VERSION);
+}
+/**
+ * Assemble and finalize a k-of-n fallback spend of an aggregate beacon UTXO.
+ *
+ * Reconstructs the funded Taproot output (MuSig2 internal key + fallback/recovery
+ * script tree), verifies each collected signature against the script-path
+ * sighash and a cohort key, injects exactly k distinct valid signatures into the
+ * fallback leaf, and finalizes the witness. The returned transaction is the same
+ * announcement the optimistic path would have produced, signed via the script
+ * path instead of the key path.
+ *
+ * @throws {AggregationCohortError} when there are no cohort keys, the spent
+ * script does not match the reconstructed tree output, or fewer than k valid
+ * distinct signatures were supplied.
+ */
+export function buildFallbackSpend(params) {
+    const { pendingTx, cohortKeys, recoveryKey, recoverySequence, fundingModel, network, prevOutScript, prevOutValue, signatures, } = params;
+    const inputIndex = params.inputIndex ?? 0;
+    if (cohortKeys.length === 0) {
+        throw new AggregationCohortError('Cannot build fallback spend: no cohort keys.', 'NO_COHORT_KEYS');
+    }
+    // Resolve k the same way the cohort did, so the reconstructed leaf matches.
+    const fallbackThreshold = resolveFallbackThreshold(params.fallbackThreshold, cohortKeys.length);
+    // Reconstruct the funded output the same way the cohort derived its address.
+    const internalKey = keyAggExport(keyAggregate(sortKeys(cohortKeys)));
+    const leaves = buildRecoveryLeaves(fundingModel ?? DEFAULT_FUNDING_MODEL, {
+        recoveryKey, recoverySequence, cohortKeys, fallbackThreshold,
+    });
+    const net = getNetwork(network);
+    // allowUnknownOutputs: the CSV recovery leaf is a custom script (see cohort.ts).
+    const payment = p2tr(internalKey, leaves, net, true);
+    // The output we are spending must be the cohort's funded beacon output; if the
+    // reconstructed tree script differs, the witness would not match the chain.
+    if (!bytesEqual(payment.script, prevOutScript)) {
+        throw new AggregationCohortError('Reconstructed beacon output script does not match the spent prevout script.', 'PREVOUT_SCRIPT_MISMATCH');
+    }
+    const fallbackLeaf = buildFallbackLeaf({ cohortKeys, fallbackThreshold });
+    // Locate the fallback leaf's tapLeafScript entry: each entry is
+    // [controlBlock, script || leafVersion]; strip the trailing version byte to
+    // compare the script.
+    const leafEntry = payment.tapLeafScript?.find(([, scriptVer]) => {
+        const script = scriptVer.slice(0, scriptVer.length - 1);
+        return bytesEqual(script, fallbackLeaf);
+    });
+    if (!leafEntry) {
+        throw new AggregationCohortError('Could not locate the fallback leaf in the reconstructed beacon output.', 'FALLBACK_LEAF_NOT_FOUND');
+    }
+    // Validate the collected signatures against the script-path sighash. The leaf
+    // is keyed by x-only cohort keys, so a valid signature must verify against one
+    // of them. Keep only distinct, valid signatures (first occurrence per key).
+    const cohortXOnly = sortKeys(cohortKeys).map(k => k.slice(1));
+    const tx = pendingTx;
+    const sighash = fallbackSighash(tx, inputIndex, prevOutScript, prevOutValue, fallbackLeaf);
+    const leafHash = tapLeafHash(fallbackLeaf);
+    const accepted = new Map(); // x-only hex to signature
+    for (const { pubKey, signature } of signatures) {
+        if (pubKey.length !== 32 || signature.length !== 64)
+            continue;
+        const isCohortKey = cohortXOnly.some(k => bytesEqual(k, pubKey));
+        if (!isCohortKey)
+            continue;
+        const hex = Array.from(pubKey, b => b.toString(16).padStart(2, '0')).join('');
+        if (accepted.has(hex))
+            continue;
+        let ok = false;
+        try {
+            ok = schnorr.verify(signature, sighash, pubKey);
+        }
+        catch {
+            ok = false;
+        }
+        if (ok)
+            accepted.set(hex, signature);
+    }
+    if (accepted.size < fallbackThreshold) {
+        throw new AggregationCohortError(`Not enough valid fallback signatures: have ${accepted.size}, need ${fallbackThreshold}.`, 'NOT_ENOUGH_FALLBACK_SIGNATURES', { have: accepted.size, need: fallbackThreshold });
+    }
+    // A k-of-n CHECKSIGADD leaf demands EXACTLY k satisfied signatures (the final
+    // <k> NUMEQUAL fails if the running count differs), so inject exactly k.
+    const chosen = cohortXOnly
+        .filter(k => accepted.has(Array.from(k, b => b.toString(16).padStart(2, '0')).join('')))
+        .slice(0, fallbackThreshold);
+    tx.updateInput(inputIndex, {
+        tapLeafScript: [leafEntry],
+        tapScriptSig: chosen.map(pubKey => {
+            const hex = Array.from(pubKey, b => b.toString(16).padStart(2, '0')).join('');
+            return [{ pubKey, leafHash }, accepted.get(hex)];
+        }),
+    });
+    tx.finalize();
+    return tx;
+}
+//# sourceMappingURL=fallback-spend.js.map

package/dist/esm/fallback-spend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fallback-spend.js","sourceRoot":"","sources":["../../src/fallback-spend.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAmD9B,SAAS,UAAU,CAAC,CAAa,EAAE,CAAa;IAC9C,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,EAAe,EACf,UAAkB,EAClB,aAAyB,EACzB,YAAoB,EACpB,kBAA8B;IAE9B,OAAO,EAAE,CAAC,iBAAiB,CACzB,UAAU,EACV,CAAE,aAAa,CAAE,EACjB,OAAO,CAAC,OAAO,EACf,CAAE,YAAY,CAAE,EAChB,SAAS,EACT,kBAAkB,EAClB,oBAAoB,CACrB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAA2B;IAC5D,MAAM,EACJ,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,EACpD,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,UAAU,GAC/D,GAAG,MAAM,CAAC;IACX,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;IAE1C,IAAG,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,sBAAsB,CAC9B,8CAA8C,EAC9C,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,MAAM,CAAC,iBAAiB,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAEhG,6EAA6E;IAC7E,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACrE,MAAM,MAAM,GAAG,mBAAmB,CAAC,YAAY,IAAI,qBAAqB,EAAE;QACxE,WAAW,EAAE,gBAAgB,EAAE,UAAU,EAAE,iBAAiB;KAC7D,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,iFAAiF;IACjF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAErD,+EAA+E;IAC/E,4EAA4E;IAC5E,IAAG,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,sBAAsB,CAC9B,6EAA6E,EAC7E,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,iBAAiB,CAAC,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC1E,gEAAgE;IAChE,4EAA4E;IAC5E,sBAAsB;IACtB,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAE,AAAD,EAAG,SAAS,CAAE,EAAE,EAAE;QAChE,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,OAAO,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IACH,IAAG,CAAC,SAAS,EAAE,CAAC;QACd,MAAM,IAAI,sBAAsB,CAC9B,wEAAwE,EACxE,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,+EAA+E;IAC/E,4EAA4E;IAC5E,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,MAAM,EAAE,GAAG,SAAS,CAAC;IACrB,MAAM,OAAO,GAAG,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;IAE3F,MAAM,QAAQ,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAsB,CAAC,CAAC,0BAA0B;IAC1E,KAAI,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,UAAU,EAAE,CAAC;QAC9C,IAAG,MAAM,CAAC,MAAM,KAAK,EAAE,IAAI,SAAS,CAAC,MAAM,KAAK,EAAE;YAAE,SAAS;QAC7D,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACjE,IAAG,CAAC,WAAW;YAAE,SAAS;QAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9E,IAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,SAAS;QAC/B,IAAI,EAAE,GAAG,KAAK,CAAC;QACf,IAAI,CAAC;YAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC;YAAC,EAAE,GAAG,KAAK,CAAC;QAAC,CAAC;QAC9E,IAAG,EAAE;YAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,IAAG,QAAQ,CAAC,IAAI,GAAG,iBAAiB,EAAE,CAAC;QACrC,MAAM,IAAI,sBAAsB,CAC9B,8CAA8C,QAAQ,CAAC,IAAI,UAAU,iBAAiB,GAAG,EACzF,gCAAgC,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,CACnF,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,yEAAyE;IACzE,MAAM,MAAM,GAAG,WAAW;SACvB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;SACvF,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAE/B,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE;QACzB,aAAa,EAAG,CAAE,SAAS,CAAE;QAC7B,YAAY,EAAI,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAClC,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9E,OAAO,CAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAE,CAAE,CAAC;QACtD,CAAC,CAAC;KACH,CAAC,CAAC;IACH,EAAE,CAAC,QAAQ,EAAE,CAAC;IACd,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,21 @@
+// State machines + core data
+export * from './service.js';
+export * from './participant.js';
+export * from './signer.js';
+export * from './conditions.js';
+export * from './recovery-policy.js';
+export * from './recovery-spend.js';
+export * from './fallback-spend.js';
+export * from './cohort.js';
+export * from './signing-session.js';
+export * from './phases.js';
+export * from './errors.js';
+export * from './beacon-strategy.js';
+export * from './logger.js';
+// Messages
+export * from './messages/index.js';
+// Transport
+export * from './transport/index.js';
+// Runner facades
+export * from './runner/index.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,6BAA6B;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAE5B,WAAW;AACX,cAAc,qBAAqB,CAAC;AAEpC,YAAY;AACZ,cAAc,sBAAsB,CAAC;AAErC,iBAAiB;AACjB,cAAc,mBAAmB,CAAC"}

package/dist/esm/logger.js

@@ -0,0 +1,15 @@
+/** Console-backed logger. Default for runners and transports. */
+export const CONSOLE_LOGGER = {
+    debug: (msg, ...args) => console.debug(msg, ...args),
+    info: (msg, ...args) => console.info(msg, ...args),
+    warn: (msg, ...args) => console.warn(msg, ...args),
+    error: (msg, ...args) => console.error(msg, ...args),
+};
+/** No-op logger. Useful for tests and production environments with own logging pipeline. */
+export const SILENT_LOGGER = {
+    debug: () => { },
+    info: () => { },
+    warn: () => { },
+    error: () => { },
+};
+//# sourceMappingURL=logger.js.map

package/dist/esm/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAkBA,iEAAiE;AACjE,MAAM,CAAC,MAAM,cAAc,GAAW;IACpC,KAAK,EAAG,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IACrD,IAAI,EAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IACpD,IAAI,EAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IACpD,KAAK,EAAG,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;CACtD,CAAC;AAEF,4FAA4F;AAC5F,MAAM,CAAC,MAAM,aAAa,GAAW;IACnC,KAAK,EAAG,GAAG,EAAE,GAAE,CAAC;IAChB,IAAI,EAAI,GAAG,EAAE,GAAE,CAAC;IAChB,IAAI,EAAI,GAAG,EAAE,GAAE,CAAC;IAChB,KAAK,EAAG,GAAG,EAAE,GAAE,CAAC;CACjB,CAAC"}

package/dist/esm/messages/base.js

@@ -0,0 +1,36 @@
+/**
+ * Current on-the-wire protocol version.
+ *
+ * Receivers reject messages with an unknown (mismatched) version. Bumping this
+ * requires coordinated updates across all participants and any intermediate
+ * relays that inspect message content.
+ */
+export const AGGREGATION_WIRE_VERSION = 1;
+export class BaseMessage {
+    type;
+    version;
+    to;
+    from;
+    body;
+    constructor({ type, version, to, from, body }) {
+        this.type = type;
+        this.version = version ?? AGGREGATION_WIRE_VERSION;
+        this.to = to;
+        this.from = from;
+        this.body = body;
+    }
+    /**
+     * Converts a BaseMessage to a JSON object.
+     * @returns {Base} The JSON representation of the BaseMessage.
+     */
+    toJSON() {
+        return {
+            type: this.type,
+            version: this.version,
+            to: this.to,
+            from: this.from,
+            body: this.body
+        };
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/esm/messages/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/messages/base.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AA0C1C,MAAM,OAAO,WAAW;IACf,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,EAAE,CAAU;IACZ,IAAI,CAAS;IACb,IAAI,CAAY;IAEvB,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAQ;QACjD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,wBAAwB,CAAC;QACnD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,OAAO;YACL,IAAI,EAAM,IAAI,CAAC,IAAI;YACnB,OAAO,EAAG,IAAI,CAAC,OAAO;YACtB,EAAE,EAAQ,IAAI,CAAC,EAAE;YACjB,IAAI,EAAM,IAAI,CAAC,IAAI;YACnB,IAAI,EAAM,IAAI,CAAC,IAAI;SACpB,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/messages/bodies.js

@@ -0,0 +1,149 @@
+/**
+ * Per-message-type body interfaces and a discriminated {@link AggregationMessage}
+ * union.
+ *
+ * {@link BaseBody} remains the superset-of-all-fields body type used by the
+ * raw {@link BaseMessage} class (see `base.ts`). The narrow interfaces here
+ * describe what each specific message type is *required* to carry and are
+ * exposed alongside type guards for consumers who want compile-time narrowing.
+ *
+ * Guards validate both `type` and the presence of required body fields so they
+ * are safe to use on messages that have round-tripped through JSON / a relay.
+ */
+import { KNOWN_FUNDING_MODELS } from '../conditions.js';
+import { MAX_RECOVERY_SEQUENCE } from '../recovery-policy.js';
+import { AGGREGATED_NONCE, AUTHORIZATION_REQUEST, COHORT_ADVERT, COHORT_OPT_IN, COHORT_OPT_IN_ACCEPT, COHORT_READY, DISTRIBUTE_AGGREGATED_DATA, FALLBACK_AUTHORIZATION_REQUEST, FALLBACK_SIGNATURE, NONCE_CONTRIBUTION, SIGNATURE_AUTHORIZATION, SUBMIT_NONINCLUDED, SUBMIT_UPDATE, VALIDATION_ACK, } from './constants.js';
+// ── Type guards ───────────────────────────────────────────────────────────
+// Each guard validates `type` plus required body fields so it's safe to use
+// on messages that have round-tripped through JSON / a relay.
+const hasStr = (b, k) => !!b && typeof b[k] === 'string';
+/** Present, an integer, and >= min. */
+const hasIntMin = (b, k, min) => {
+    const v = b ? b[k] : undefined;
+    return typeof v === 'number' && Number.isInteger(v) && v >= min;
+};
+/** Absent, or present as an integer >= min. */
+const optIntMin = (b, k, min) => {
+    const v = b ? b[k] : undefined;
+    return v === undefined || (typeof v === 'number' && Number.isInteger(v) && v >= min);
+};
+/** Present, an integer, and within [min, max] inclusive. */
+const intInRange = (b, k, min, max) => {
+    const v = b ? b[k] : undefined;
+    return typeof v === 'number' && Number.isInteger(v) && v >= min && v <= max;
+};
+/** Absent, or present as a string in the allowed set. */
+const optStrOneOf = (b, k, allowed) => {
+    const v = b ? b[k] : undefined;
+    return v === undefined || (typeof v === 'string' && allowed.includes(v));
+};
+const hasBool = (b, k) => !!b && typeof b[k] === 'boolean';
+const hasBytes = (b, k) => !!b && b[k] instanceof Uint8Array;
+const hasBytesArray = (b, k) => {
+    const v = b ? b[k] : undefined;
+    return Array.isArray(v) && v.every(x => x instanceof Uint8Array);
+};
+export function isCohortAdvertMessage(m) {
+    // Range-check the participant bounds so a malformed advert (missing or
+    // zero/negative minParticipants) is rejected rather than silently accepted as
+    // a zero-floor cohort. The service does the full cross-field validation at
+    // createCohort (see validateCohortConditions); here we guard the wire shape.
+    return m.type === COHORT_ADVERT
+        && hasStr(m.body, 'cohortId')
+        && hasIntMin(m.body, 'minParticipants', 1)
+        && optIntMin(m.body, 'maxParticipants', 1)
+        && hasStr(m.body, 'beaconType')
+        && hasStr(m.body, 'network')
+        // Recovery params are mandatory: a participant must see the recovery terms
+        // (key + timelock) before funding the beacon UTXO (ADR 042). recoverySequence
+        // is range-checked here because the participant funds based on the advert and
+        // does not separately run validateCohortConditions: an out-of-range value
+        // (e.g. one with the BIP-68 disable bit set) must be rejected before funding.
+        && hasStr(m.body, 'recoveryKey')
+        && intInRange(m.body, 'recoverySequence', 1, MAX_RECOVERY_SEQUENCE)
+        // fundingModel is optional on the wire (absent means the operator-funded
+        // default), but when present it must name a known model.
+        && optStrOneOf(m.body, 'fundingModel', KNOWN_FUNDING_MODELS)
+        // fallbackThreshold is optional (absent means n-1 at keygen); when present it
+        // must be a positive integer. The upper bound against the cohort size is
+        // checked when the participant recomputes the beacon address.
+        && optIntMin(m.body, 'fallbackThreshold', 1)
+        && hasBytes(m.body, 'communicationPk');
+}
+export function isCohortOptInMessage(m) {
+    return m.type === COHORT_OPT_IN
+        && hasStr(m.body, 'cohortId')
+        && hasBytes(m.body, 'participantPk')
+        && hasBytes(m.body, 'communicationPk');
+}
+export function isCohortOptInAcceptMessage(m) {
+    return m.type === COHORT_OPT_IN_ACCEPT && hasStr(m.body, 'cohortId');
+}
+export function isCohortReadyMessage(m) {
+    return m.type === COHORT_READY
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'beaconAddress')
+        && hasBytesArray(m.body, 'cohortKeys');
+}
+export function isSubmitUpdateMessage(m) {
+    return m.type === SUBMIT_UPDATE
+        && hasStr(m.body, 'cohortId')
+        && !!m.body && typeof m.body.signedUpdate === 'object';
+}
+export function isSubmitNonIncludedMessage(m) {
+    return m.type === SUBMIT_NONINCLUDED && hasStr(m.body, 'cohortId');
+}
+export function isDistributeAggregatedDataMessage(m) {
+    return m.type === DISTRIBUTE_AGGREGATED_DATA
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'beaconType')
+        && hasStr(m.body, 'signalBytesHex');
+}
+export function isValidationAckMessage(m) {
+    return m.type === VALIDATION_ACK
+        && hasStr(m.body, 'cohortId')
+        && hasBool(m.body, 'approved');
+}
+export function isAuthorizationRequestMessage(m) {
+    return m.type === AUTHORIZATION_REQUEST
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'sessionId')
+        && hasStr(m.body, 'pendingTx')
+        && hasStr(m.body, 'prevOutScriptHex')
+        && hasStr(m.body, 'prevOutValue');
+}
+export function isNonceContributionMessage(m) {
+    return m.type === NONCE_CONTRIBUTION
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'sessionId')
+        && hasBytes(m.body, 'nonceContribution');
+}
+export function isAggregatedNonceMessage(m) {
+    return m.type === AGGREGATED_NONCE
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'sessionId')
+        && hasBytes(m.body, 'aggregatedNonce');
+}
+export function isSignatureAuthorizationMessage(m) {
+    return m.type === SIGNATURE_AUTHORIZATION
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'sessionId')
+        && hasBytes(m.body, 'partialSignature');
+}
+export function isFallbackAuthorizationRequestMessage(m) {
+    return m.type === FALLBACK_AUTHORIZATION_REQUEST
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'sessionId')
+        && hasStr(m.body, 'pendingTx')
+        && hasStr(m.body, 'prevOutScriptHex')
+        && hasStr(m.body, 'prevOutValue')
+        && hasStr(m.body, 'fallbackLeafScriptHex');
+}
+export function isFallbackSignatureMessage(m) {
+    return m.type === FALLBACK_SIGNATURE
+        && hasStr(m.body, 'cohortId')
+        && hasStr(m.body, 'sessionId')
+        && hasBytes(m.body, 'signerPk')
+        && hasBytes(m.body, 'fallbackSignature');
+}
+//# sourceMappingURL=bodies.js.map

package/dist/esm/messages/bodies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bodies.js","sourceRoot":"","sources":["../../../src/messages/bodies.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,0BAA0B,EAC1B,8BAA8B,EAC9B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,cAAc,GACf,MAAM,gBAAgB,CAAC;AAgJxB,6EAA6E;AAC7E,4EAA4E;AAC5E,8DAA8D;AAE9D,MAAM,MAAM,GAAG,CAAC,CAAU,EAAE,CAAS,EAAW,EAAE,CAChD,CAAC,CAAC,CAAC,IAAI,OAAQ,CAA6B,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;AAC/D,uCAAuC;AACvC,MAAM,SAAS,GAAG,CAAC,CAAU,EAAE,CAAS,EAAE,GAAW,EAAW,EAAE;IAChE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;AAClE,CAAC,CAAC;AACF,+CAA+C;AAC/C,MAAM,SAAS,GAAG,CAAC,CAAU,EAAE,CAAS,EAAE,GAAW,EAAW,EAAE;IAChE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;AACvF,CAAC,CAAC;AACF,4DAA4D;AAC5D,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,CAAS,EAAE,GAAW,EAAE,GAAW,EAAW,EAAE;IAC9E,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;AAC9E,CAAC,CAAC;AACF,yDAAyD;AACzD,MAAM,WAAW,GAAG,CAAC,CAAU,EAAE,CAAS,EAAE,OAA0B,EAAW,EAAE;IACjF,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3E,CAAC,CAAC;AACF,MAAM,OAAO,GAAG,CAAC,CAAU,EAAE,CAAS,EAAW,EAAE,CACjD,CAAC,CAAC,CAAC,IAAI,OAAQ,CAA6B,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;AAChE,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAE,CAAS,EAAW,EAAE,CAClD,CAAC,CAAC,CAAC,IAAK,CAA6B,CAAC,CAAC,CAAC,YAAY,UAAU,CAAC;AACjE,MAAM,aAAa,GAAG,CAAC,CAAU,EAAE,CAAS,EAAW,EAAE;IACvD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,UAAU,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,CAAc;IAClD,uEAAuE;IACvE,8EAA8E;IAC9E,2EAA2E;IAC3E,6EAA6E;IAC7E,OAAO,CAAC,CAAC,IAAI,KAAK,aAAa;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;WACvC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;WACvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC;WAC5B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC;QAC5B,2EAA2E;QAC3E,8EAA8E;QAC9E,8EAA8E;QAC9E,0EAA0E;QAC1E,8EAA8E;WAC3E,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC;WAC7B,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,EAAE,CAAC,EAAE,qBAAqB,CAAC;QACnE,yEAAyE;QACzE,yDAAyD;WACtD,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,EAAE,oBAAoB,CAAC;QAC5D,8EAA8E;QAC9E,yEAAyE;QACzE,8DAA8D;WAC3D,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC;WACzC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,CAAc;IACjD,OAAO,CAAC,CAAC,IAAI,KAAK,aAAa;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,eAAe,CAAC;WACjC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,CAAc;IACvD,OAAO,CAAC,CAAC,IAAI,KAAK,oBAAoB,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,CAAc;IACjD,OAAO,CAAC,CAAC,IAAI,KAAK,YAAY;WACzB,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,eAAe,CAAC;WAC/B,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,CAAc;IAClD,OAAO,CAAC,CAAC,IAAI,KAAK,aAAa;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,OAAQ,CAAC,CAAC,IAAgC,CAAC,YAAY,KAAK,QAAQ,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,CAAc;IACvD,OAAO,CAAC,CAAC,IAAI,KAAK,kBAAkB,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,CAAc;IAC9D,OAAO,CAAC,CAAC,IAAI,KAAK,0BAA0B;WACvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC;WAC5B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,CAAc;IACnD,OAAO,CAAC,CAAC,IAAI,KAAK,cAAc;WAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,CAAc;IAC1D,OAAO,CAAC,CAAC,IAAI,KAAK,qBAAqB;WAClC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC;WAClC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,CAAc;IACvD,OAAO,CAAC,CAAC,IAAI,KAAK,kBAAkB;WAC/B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,CAAc;IACrD,OAAO,CAAC,CAAC,IAAI,KAAK,gBAAgB;WAC7B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,CAAc;IAC5D,OAAO,CAAC,CAAC,IAAI,KAAK,uBAAuB;WACpC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,qCAAqC,CAAC,CAAc;IAClE,OAAO,CAAC,CAAC,IAAI,KAAK,8BAA8B;WAC3C,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC;WAClC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC;WAC9B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,CAAc;IACvD,OAAO,CAAC,CAAC,IAAI,KAAK,kBAAkB;WAC/B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC1B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC;WAC3B,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC;WAC5B,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;AAC7C,CAAC"}

package/dist/esm/messages/constants.js

@@ -0,0 +1,37 @@
+/**
+ * Message type URLs for the did:btcr2 Aggregate Beacon protocol.
+ *
+ * Naming follows the spec (https://dcdpr.github.io/did-btcr2/beacons/aggregate-beacons.html):
+ * - Step 1 (Cohort Formation): COHORT_ADVERT, COHORT_OPT_IN, COHORT_OPT_IN_ACCEPT, COHORT_READY
+ * - Step 2 (Update Submission): SUBMIT_UPDATE
+ * - Step 3 (Aggregate & Validate): DISTRIBUTE_AGGREGATED_DATA, VALIDATION_ACK
+ * - Step 4 (Sign & Broadcast): AUTHORIZATION_REQUEST, NONCE_CONTRIBUTION,
+ *   AGGREGATED_NONCE, SIGNATURE_AUTHORIZATION
+ * - Step 4 fallback (k-of-n script path, ADR 042): FALLBACK_AUTHORIZATION_REQUEST,
+ *   FALLBACK_SIGNATURE
+ */
+export const AGGREGATION_MESSAGE_PREFIX = 'https://btcr2.dev/aggregation';
+// Step 1: Cohort Formation
+export const COHORT_ADVERT = `${AGGREGATION_MESSAGE_PREFIX}/keygen/cohort_advert`;
+export const COHORT_OPT_IN = `${AGGREGATION_MESSAGE_PREFIX}/keygen/cohort_opt_in`;
+export const COHORT_OPT_IN_ACCEPT = `${AGGREGATION_MESSAGE_PREFIX}/keygen/cohort_opt_in_accept`;
+export const COHORT_READY = `${AGGREGATION_MESSAGE_PREFIX}/keygen/cohort_ready`;
+// Step 2 + 3: Update Submission, Aggregation, Validation
+export const SUBMIT_UPDATE = `${AGGREGATION_MESSAGE_PREFIX}/update/submit_update`;
+/** A member with no update this round declines explicitly (cooperative non-inclusion). */
+export const SUBMIT_NONINCLUDED = `${AGGREGATION_MESSAGE_PREFIX}/update/submit_nonincluded`;
+export const DISTRIBUTE_AGGREGATED_DATA = `${AGGREGATION_MESSAGE_PREFIX}/update/distribute_aggregated_data`;
+export const VALIDATION_ACK = `${AGGREGATION_MESSAGE_PREFIX}/update/validation_ack`;
+// Step 4: Signing
+export const AUTHORIZATION_REQUEST = `${AGGREGATION_MESSAGE_PREFIX}/sign/authorization_request`;
+export const NONCE_CONTRIBUTION = `${AGGREGATION_MESSAGE_PREFIX}/sign/nonce_contribution`;
+export const AGGREGATED_NONCE = `${AGGREGATION_MESSAGE_PREFIX}/sign/aggregated_nonce`;
+export const SIGNATURE_AUTHORIZATION = `${AGGREGATION_MESSAGE_PREFIX}/sign/signature_authorization`;
+// Step 4 fallback: k-of-n script-path signing when the optimistic n-of-n key
+// path stalls (graceful liveness, ADR 042). A single standalone BIP-340
+// signature per member, no nonce round.
+/** Service asks members to sign the fallback (k-of-n) script path of the beacon tx. */
+export const FALLBACK_AUTHORIZATION_REQUEST = `${AGGREGATION_MESSAGE_PREFIX}/sign/fallback_authorization_request`;
+/** A member returns a standalone BIP-340 signature over the fallback script-path sighash. */
+export const FALLBACK_SIGNATURE = `${AGGREGATION_MESSAGE_PREFIX}/sign/fallback_signature`;
+//# sourceMappingURL=constants.js.map

package/dist/esm/messages/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/messages/constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,+BAA+B,CAAC;AAE1E,2BAA2B;AAC3B,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,0BAA0B,uBAAuB,CAAC;AAClF,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,0BAA0B,uBAAuB,CAAC;AAClF,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,0BAA0B,8BAA8B,CAAC;AAChG,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,0BAA0B,sBAAsB,CAAC;AAEhF,yDAAyD;AACzD,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,0BAA0B,uBAAuB,CAAC;AAClF,0FAA0F;AAC1F,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,0BAA0B,4BAA4B,CAAC;AAC5F,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,0BAA0B,oCAAoC,CAAC;AAC5G,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,0BAA0B,wBAAwB,CAAC;AAEpF,kBAAkB;AAClB,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,0BAA0B,6BAA6B,CAAC;AAChG,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,0BAA0B,0BAA0B,CAAC;AAC1F,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,0BAA0B,wBAAwB,CAAC;AACtF,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,0BAA0B,+BAA+B,CAAC;AAEpG,6EAA6E;AAC7E,wEAAwE;AACxE,wCAAwC;AACxC,uFAAuF;AACvF,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,0BAA0B,sCAAsC,CAAC;AAClH,6FAA6F;AAC7F,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,0BAA0B,0BAA0B,CAAC"}

package/dist/esm/messages/factories.js

@@ -0,0 +1,139 @@
+import { BaseMessage } from './base.js';
+import { AGGREGATED_NONCE, AUTHORIZATION_REQUEST, COHORT_ADVERT, COHORT_OPT_IN, COHORT_OPT_IN_ACCEPT, COHORT_READY, DISTRIBUTE_AGGREGATED_DATA, FALLBACK_AUTHORIZATION_REQUEST, FALLBACK_SIGNATURE, NONCE_CONTRIBUTION, SIGNATURE_AUTHORIZATION, SUBMIT_NONINCLUDED, SUBMIT_UPDATE, VALIDATION_ACK, } from './constants.js';
+/**
+ * Factory function for creating a Cohort Advert message, which is used to announce the formation of
+ * a new cohort and invite participants to join.
+ * @param {CohortAdvertMessage} fields - The fields required to create a Cohort Advert message.
+ * @returns {BaseMessage} The created Cohort Advert message.
+ */
+export function createCohortAdvertMessage(fields) {
+    const { from, ...body } = fields;
+    return new BaseMessage({ type: COHORT_ADVERT, from, body });
+}
+/**
+ * Factory function for creating a Cohort Opt-In message, which is sent by a participant to express
+ * interest in joining a cohort.
+ * @param {CohortOptInMessage} fields - The fields required to create a Cohort Opt-In message, which
+ * is sent by a participant to express interest in joining a cohort.
+ * @returns {BaseMessage} The created Cohort Opt-In message.
+ */
+export function createCohortOptInMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: COHORT_OPT_IN, from, to, body });
+}
+export function createCohortOptInAcceptMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: COHORT_OPT_IN_ACCEPT, from, to, body });
+}
+export function createCohortReadyMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: COHORT_READY, from, to, body });
+}
+/**
+ * Factory function for creating a Submit Update message, which is sent by a participant to submit
+ * their signed update for aggregation.
+ * @param {SubmitUpdateMessage} fields - The fields required to create a Submit Update message,
+ * which is sent by a participant to submit their signed update for aggregation.
+ * @returns {BaseMessage} The created Submit Update message.
+ */
+export function createSubmitUpdateMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: SUBMIT_UPDATE, from, to, body });
+}
+/**
+ * Factory for a Submit Non-Included message: a member declares it has no update
+ * this round (cooperative non-inclusion). Membership is proven by the signed
+ * envelope, so the body carries only the cohortId.
+ */
+export function createSubmitNonIncludedMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: SUBMIT_NONINCLUDED, from, to, body });
+}
+/**
+ * Factory function for creating a Distribute Aggregated Data message, which is sent by the
+ * aggregator to distribute the aggregated data to participants for validation.
+ * @param {DistributeAggregatedDataMessage} fields - The fields required to create a Distribute
+ * Aggregated Data message, which is sent by the aggregator to distribute the aggregated data to
+ * participants for validation.
+ * @returns {BaseMessage} The created Distribute Aggregated Data message.
+ */
+export function createDistributeAggregatedDataMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: DISTRIBUTE_AGGREGATED_DATA, from, to, body });
+}
+/**
+ * Factory function for creating a Validation Acknowledgment message, which is sent by a participant
+ * to acknowledge.
+ * @param {ValidationAckMessage} fields - The fields required to create a Validation Acknowledgment
+ * message, which is sent by a participant to acknowledge the validation of the aggregated data.
+ * @returns {BaseMessage} The created Validation Acknowledgment message.
+ */
+export function createValidationAckMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: VALIDATION_ACK, from, to, body });
+}
+/**
+ * Factory function for creating an Authorization Request message, which is sent by a participant to
+ * request authorization for their signature.
+ * @param {AuthorizationRequestMessage} fields - The fields required to create an Authorization
+ * Request message, which is sent by a participant to request authorization for their signature.
+ * @returns {BaseMessage} The created Authorization Request message.
+ */
+export function createAuthorizationRequestMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: AUTHORIZATION_REQUEST, from, to, body });
+}
+/**
+ * Factory function for creating a Nonce Contribution message, which is sent by a participant to
+ * contribute their nonce for the signature aggregation process.
+ * @param {NonceContributionMessage} fields - The fields required to create a Nonce Contribution
+ * message, which is sent by a participant to contribute their nonce for the signature aggregation
+ * process.
+ * @returns {BaseMessage} The created Nonce Contribution message.
+ */
+export function createNonceContributionMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: NONCE_CONTRIBUTION, from, to, body });
+}
+/**
+ * Factory function for creating an Aggregated Nonce message, which is sent by the aggregator to
+ * distribute the aggregated nonce to participants for the signature aggregation process.
+ * @param {AggregatedNonceMessage} fields - The fields required to create an Aggregated Nonce
+ * message, which is sent by the aggregator to distribute the aggregated nonce to participants for
+ * the signature aggregation process.
+ * @returns {BaseMessage} The created Aggregated Nonce message.
+ */
+export function createAggregatedNonceMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: AGGREGATED_NONCE, from, to, body });
+}
+/**
+ * Factory function for creating a Signature Authorization message, which is sent by a participant
+ * to authorize their partial signature for the signature aggregation process.
+ * @param {SignatureAuthorizationMessage} fields - The fields required to create a Signature
+ * Authorization message, which is sent by a participant to authorize their partial signature for
+ * the signature aggregation process.
+ * @returns {BaseMessage} The created Signature Authorization message.
+ */
+export function createSignatureAuthorizationMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: SIGNATURE_AUTHORIZATION, from, to, body });
+}
+/**
+ * Factory for a Fallback Authorization Request: the service asks members to
+ * authorize the k-of-n script-path spend of the beacon transaction when the
+ * optimistic n-of-n key path stalls (ADR 042).
+ */
+export function createFallbackAuthorizationRequestMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: FALLBACK_AUTHORIZATION_REQUEST, from, to, body });
+}
+/**
+ * Factory for a Fallback Signature: a member's standalone BIP-340 signature over
+ * the fallback script-path sighash (no nonce round).
+ */
+export function createFallbackSignatureMessage(fields) {
+    const { from, to, ...body } = fields;
+    return new BaseMessage({ type: FALLBACK_SIGNATURE, from, to, body });
+}
+//# sourceMappingURL=factories.js.map

package/dist/esm/messages/factories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factories.js","sourceRoot":"","sources":["../../../src/messages/factories.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,0BAA0B,EAC1B,8BAA8B,EAC9B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,cAAc,GACf,MAAM,gBAAgB,CAAC;AAiCxB;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAA2B;IACnE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACjC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAA0B;IACjE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,MAAgC;IAC7E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAA0B;IACjE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACjE,CAAC;AAcD;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAA2B;IACnE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAClE,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,MAAgC;IAC7E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAwBD;;;;;;;GAOG;AACH,MAAM,UAAU,qCAAqC,CACnD,MAAuC;IAEvC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAA4B;IACrE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACnE,CAAC;AAuCD;;;;;;GAMG;AACH,MAAM,UAAU,iCAAiC,CAAC,MAAmC;IACnF,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B,CAAC,MAAgC;IAC7E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAA8B;IACzE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CAAC,MAAqC;IACvF,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,CAAC;AAqBD;;;;GAIG;AACH,MAAM,UAAU,yCAAyC,CAAC,MAA2C;IACnG,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACnF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAAC,MAAgC;IAC7E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC"}

package/dist/esm/messages/guards.js

@@ -0,0 +1,40 @@
+import { AGGREGATED_NONCE, AUTHORIZATION_REQUEST, COHORT_ADVERT, COHORT_OPT_IN, COHORT_OPT_IN_ACCEPT, COHORT_READY, DISTRIBUTE_AGGREGATED_DATA, FALLBACK_AUTHORIZATION_REQUEST, FALLBACK_SIGNATURE, NONCE_CONTRIBUTION, SIGNATURE_AUTHORIZATION, SUBMIT_NONINCLUDED, SUBMIT_UPDATE, VALIDATION_ACK, } from './constants.js';
+const KEYGEN_VALUES = new Set([
+    COHORT_ADVERT,
+    COHORT_OPT_IN,
+    COHORT_OPT_IN_ACCEPT,
+    COHORT_READY,
+]);
+const UPDATE_VALUES = new Set([
+    SUBMIT_UPDATE,
+    SUBMIT_NONINCLUDED,
+    DISTRIBUTE_AGGREGATED_DATA,
+    VALIDATION_ACK,
+]);
+const SIGN_VALUES = new Set([
+    AUTHORIZATION_REQUEST,
+    NONCE_CONTRIBUTION,
+    AGGREGATED_NONCE,
+    SIGNATURE_AUTHORIZATION,
+    FALLBACK_AUTHORIZATION_REQUEST,
+    FALLBACK_SIGNATURE,
+]);
+/**
+ * Checks if the provided type is a valid aggregation message type.
+ */
+export function isAggregationMessageType(type) {
+    return KEYGEN_VALUES.has(type) || UPDATE_VALUES.has(type) || SIGN_VALUES.has(type);
+}
+/** Checks if the message type belongs to the keygen phase. */
+export function isKeygenMessageType(type) {
+    return KEYGEN_VALUES.has(type);
+}
+/** Checks if the message type belongs to the update phase. */
+export function isUpdateMessageType(type) {
+    return UPDATE_VALUES.has(type);
+}
+/** Checks if the message type belongs to the signing phase. */
+export function isSignMessageType(type) {
+    return SIGN_VALUES.has(type);
+}
+//# sourceMappingURL=guards.js.map

package/dist/esm/messages/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../../src/messages/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,0BAA0B,EAC1B,8BAA8B,EAC9B,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,cAAc,GACf,MAAM,gBAAgB,CAAC;AAExB,MAAM,aAAa,GAAgB,IAAI,GAAG,CAAC;IACzC,aAAa;IACb,aAAa;IACb,oBAAoB;IACpB,YAAY;CACb,CAAC,CAAC;AAEH,MAAM,aAAa,GAAgB,IAAI,GAAG,CAAC;IACzC,aAAa;IACb,kBAAkB;IAClB,0BAA0B;IAC1B,cAAc;CACf,CAAC,CAAC;AAEH,MAAM,WAAW,GAAgB,IAAI,GAAG,CAAC;IACvC,qBAAqB;IACrB,kBAAkB;IAClB,gBAAgB;IAChB,uBAAuB;IACvB,8BAA8B;IAC9B,kBAAkB;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACrF,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,OAAO,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC"}

package/dist/esm/messages/index.js

@@ -0,0 +1,6 @@
+export * from './base.js';
+export * from './bodies.js';
+export * from './constants.js';
+export * from './factories.js';
+export * from './guards.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/messages/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/messages/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}