@did-btcr2/method 0.26.0 → 0.28.0

package/dist/esm/core/updater.js

@@ -0,0 +1,269 @@
+var _a;
+import { canonicalHash, INVALID_DID_UPDATE, JSONPatch, UpdateError } from '@did-btcr2/common';
+import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
+import { DidDocument } from '../utils/did-document.js';
+import { BeaconFactory } from './beacon/factory.js';
+/**
+ * Internal phases of the Updater state machine.
+ * @internal
+ */
+var UpdaterPhase;
+(function (UpdaterPhase) {
+    UpdaterPhase["Construct"] = "Construct";
+    UpdaterPhase["Sign"] = "Sign";
+    UpdaterPhase["Fund"] = "Fund";
+    UpdaterPhase["Broadcast"] = "Broadcast";
+    UpdaterPhase["Complete"] = "Complete";
+})(UpdaterPhase || (UpdaterPhase = {}));
+/**
+ * Sans-I/O state machine for did:btcr2 updates — the counterpart to {@link Resolver}.
+ *
+ * Created by {@link DidBtcr2.update} (the factory). The caller drives the update by
+ * repeatedly calling {@link advance} and {@link provide}:
+ *
+ * ```typescript
+ * const updater = DidBtcr2.update({ sourceDocument, patches, ... });
+ * let state = updater.advance();
+ *
+ * while(state.status === 'action-required') {
+ *   for(const need of state.needs) {
+ *     switch(need.kind) {
+ *       case 'NeedSigningKey':
+ *         updater.provide(need, secretKeyBytes);
+ *         break;
+ *       case 'NeedFunding':
+ *         // Check UTXOs at need.beaconAddress, fund if needed
+ *         updater.provide(need);
+ *         break;
+ *       case 'NeedBroadcast':
+ *         await Updater.announce(need.beaconService, need.signedUpdate, secretKey, bitcoin);
+ *         updater.provide(need);
+ *         break;
+ *     }
+ *   }
+ *   state = updater.advance();
+ * }
+ *
+ * const { signedUpdate } = state.result;
+ * ```
+ *
+ * The Updater performs **zero I/O**. All external work (signing with a KMS or raw
+ * key, funding checks, Bitcoin transaction construction, broadcast) flows through
+ * the advance/provide protocol. This mirrors the {@link Resolver} pattern and makes
+ * the update path transport-agnostic and KMS-ready.
+ *
+ * The class also exposes static utility methods ({@link construct}, {@link sign},
+ * {@link announce}) for callers that need direct access to individual update steps
+ * outside the state machine (e.g., test vector generation scripts).
+ *
+ * @class Updater
+ */
+export class Updater {
+    #phase = UpdaterPhase.Construct;
+    #sourceDocument;
+    #patches;
+    #sourceVersionId;
+    #verificationMethod;
+    #beaconService;
+    #unsignedUpdate = null;
+    #signedUpdate = null;
+    /**
+     * @internal — Use {@link DidBtcr2.update} to create instances.
+     */
+    constructor(params) {
+        this.#sourceDocument = params.sourceDocument;
+        this.#patches = params.patches;
+        this.#sourceVersionId = params.sourceVersionId;
+        this.#verificationMethod = params.verificationMethod;
+        this.#beaconService = params.beaconService;
+    }
+    // ─── Public static utility methods ─────────────────────────────────────────
+    // Used by generate-vector.ts and other scripts that need direct access to
+    // individual update steps outside the state machine flow.
+    /**
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-unsigned-update | 7.3.b Construct BTCR2 Unsigned Update}.
+     *
+     * @param {Btcr2DidDocument} sourceDocument The source DID document to be updated.
+     * @param {PatchOperation[]} patches The JSON Patch operations to apply.
+     * @param {number} sourceVersionId The version ID of the source document.
+     * @returns {UnsignedBTCR2Update} The constructed UnsignedBTCR2Update object.
+     * @throws {UpdateError} If the target document fails DID Core validation.
+     */
+    static construct(sourceDocument, patches, sourceVersionId) {
+        const unsignedUpdate = {
+            '@context': [
+                'https://w3id.org/security/v2',
+                'https://w3id.org/zcap/v1',
+                'https://w3id.org/json-ld-patch/v1',
+                'https://btcr2.dev/context/v1'
+            ],
+            patch: patches,
+            targetHash: '',
+            targetVersionId: sourceVersionId + 1,
+            sourceHash: canonicalHash(sourceDocument),
+        };
+        const targetDocument = JSONPatch.apply(sourceDocument, patches);
+        try {
+            DidDocument.isValid(targetDocument);
+        }
+        catch (error) {
+            throw new UpdateError('Error validating targetDocument: ' + (error instanceof Error ? error.message : String(error)), INVALID_DID_UPDATE, targetDocument);
+        }
+        unsignedUpdate.targetHash = canonicalHash(targetDocument);
+        return unsignedUpdate;
+    }
+    /**
+     * Implements subsection {@link http://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-signed-update | 7.3.c Construct BTCR2 Signed Update }.
+     *
+     * @param {string} did The did-btcr2 identifier to derive the root capability from.
+     * @param {UnsignedBTCR2Update} unsignedUpdate The unsigned update to sign.
+     * @param {DidVerificationMethod} verificationMethod The verification method for signing.
+     * @param {KeyBytes} secretKey The secret key bytes.
+     * @returns {SignedBTCR2Update} The signed update with a Data Integrity proof.
+     */
+    static sign(did, unsignedUpdate, verificationMethod, secretKey) {
+        const controller = verificationMethod.controller;
+        const id = verificationMethod.id.slice(verificationMethod.id.indexOf('#'));
+        const multikey = SchnorrMultikey.fromSecretKey(id, controller, secretKey);
+        const config = {
+            '@context': [
+                'https://w3id.org/security/v2',
+                'https://w3id.org/zcap/v1',
+                'https://w3id.org/json-ld-patch/v1',
+                'https://btcr2.dev/context/v1'
+            ],
+            cryptosuite: 'bip340-jcs-2025',
+            type: 'DataIntegrityProof',
+            verificationMethod: verificationMethod.id,
+            proofPurpose: 'capabilityInvocation',
+            capability: `urn:zcap:root:${encodeURIComponent(did)}`,
+            capabilityAction: 'Write',
+        };
+        const diproof = multikey.toCryptosuite().toDataIntegrityProof();
+        return diproof.addProof(unsignedUpdate, config);
+    }
+    /**
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#announce-did-update | 7.3.d Announce DID Update}.
+     * Announces a signed update to the Bitcoin blockchain via the specified beacon.
+     *
+     * @param {BeaconService} beaconService The beacon service to broadcast through.
+     * @param {SignedBTCR2Update} update The signed update to announce.
+     * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
+     * @param {BitcoinConnection} bitcoin The Bitcoin network connection.
+     * @returns {Promise<SignedBTCR2Update>} The signed update that was broadcast.
+     */
+    static async announce(beaconService, update, secretKey, bitcoin) {
+        const beacon = BeaconFactory.establish(beaconService);
+        return beacon.broadcastSignal(update, secretKey, bitcoin);
+    }
+    // ─── Private instance wrappers ─────────────────────────────────────────────
+    // Delegate to the public statics with bound instance fields for cleaner
+    // advance/provide code.
+    #construct() {
+        return _a.construct(this.#sourceDocument, this.#patches, this.#sourceVersionId);
+    }
+    #sign(secretKey) {
+        return _a.sign(this.#sourceDocument.id, this.#unsignedUpdate, this.#verificationMethod, secretKey);
+    }
+    // ─── State machine ─────────────────────────────────────────────────────────
+    /**
+     * Advance the state machine. Returns either:
+     * - `{ status: 'action-required', needs }` — caller must provide data via {@link provide}
+     * - `{ status: 'complete', result }` — update is signed and broadcast
+     */
+    advance() {
+        while (true) {
+            switch (this.#phase) {
+                // Phase: Construct
+                // Build the unsigned update from source doc + patches. Pure, synchronous.
+                case UpdaterPhase.Construct: {
+                    this.#unsignedUpdate = this.#construct();
+                    this.#phase = UpdaterPhase.Sign;
+                    continue;
+                }
+                // Phase: Sign
+                // Emit NeedSigningKey — the caller supplies the secret key (or a KMS signature).
+                case UpdaterPhase.Sign: {
+                    return {
+                        status: 'action-required',
+                        needs: [{
+                                kind: 'NeedSigningKey',
+                                verificationMethodId: this.#verificationMethod.id,
+                                unsignedUpdate: this.#unsignedUpdate,
+                            }],
+                    };
+                }
+                // Phase: Fund
+                // Emit NeedFunding with the beacon address. The caller checks UTXOs,
+                // funds the address if needed, and provides to continue.
+                case UpdaterPhase.Fund: {
+                    const beaconAddress = this.#beaconService.serviceEndpoint.replace('bitcoin:', '');
+                    return {
+                        status: 'action-required',
+                        needs: [{
+                                kind: 'NeedFunding',
+                                beaconAddress,
+                                beaconService: this.#beaconService,
+                            }],
+                    };
+                }
+                // Phase: Broadcast
+                // Emit NeedBroadcast with the signed update + beacon service. The caller performs
+                // the actual on-chain announcement (or hands off to the aggregation protocol).
+                case UpdaterPhase.Broadcast: {
+                    return {
+                        status: 'action-required',
+                        needs: [{
+                                kind: 'NeedBroadcast',
+                                beaconService: this.#beaconService,
+                                signedUpdate: this.#signedUpdate,
+                            }],
+                    };
+                }
+                // Phase: Complete
+                case UpdaterPhase.Complete: {
+                    return {
+                        status: 'complete',
+                        result: { signedUpdate: this.#signedUpdate },
+                    };
+                }
+            }
+        }
+    }
+    provide(need, data) {
+        switch (need.kind) {
+            case 'NeedSigningKey': {
+                if (this.#phase !== UpdaterPhase.Sign) {
+                    throw new UpdateError(`Cannot provide NeedSigningKey: updater phase is ${this.#phase}, expected Sign.`, INVALID_DID_UPDATE, { phase: this.#phase });
+                }
+                if (!data) {
+                    throw new UpdateError('NeedSigningKey requires secret key bytes.', INVALID_DID_UPDATE);
+                }
+                if (!this.#unsignedUpdate) {
+                    throw new UpdateError('Internal error: unsigned update missing in Sign phase.', INVALID_DID_UPDATE);
+                }
+                this.#signedUpdate = this.#sign(data);
+                this.#phase = UpdaterPhase.Fund;
+                break;
+            }
+            case 'NeedFunding': {
+                if (this.#phase !== UpdaterPhase.Fund) {
+                    throw new UpdateError(`Cannot provide NeedFunding: updater phase is ${this.#phase}, expected Fund.`, INVALID_DID_UPDATE, { phase: this.#phase });
+                }
+                // Caller has confirmed funding (or it was already funded). Continue.
+                this.#phase = UpdaterPhase.Broadcast;
+                break;
+            }
+            case 'NeedBroadcast': {
+                if (this.#phase !== UpdaterPhase.Broadcast) {
+                    throw new UpdateError(`Cannot provide NeedBroadcast: updater phase is ${this.#phase}, expected Broadcast.`, INVALID_DID_UPDATE, { phase: this.#phase });
+                }
+                // Caller has broadcast externally. Transition to Complete.
+                this.#phase = UpdaterPhase.Complete;
+                break;
+            }
+        }
+    }
+}
+_a = Updater;
+//# sourceMappingURL=updater.js.map

package/dist/esm/core/updater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updater.js","sourceRoot":"","sources":["../../../src/core/updater.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC9F,OAAO,EAAE,eAAe,EAA8E,MAAM,wBAAwB,CAAC;AACrI,OAAO,EAAE,WAAW,EAAqD,MAAM,0BAA0B,CAAC;AAC1G,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAuEpD;;;GAGG;AACH,IAAK,YAMJ;AAND,WAAK,YAAY;IACf,uCAAuB,CAAA;IACvB,6BAAkB,CAAA;IAClB,6BAAkB,CAAA;IAClB,uCAAuB,CAAA;IACvB,qCAAsB,CAAA;AACxB,CAAC,EANI,YAAY,KAAZ,YAAY,QAMhB;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,OAAO,OAAO;IAClB,MAAM,GAAiB,YAAY,CAAC,SAAS,CAAC;IACrC,eAAe,CAAmB;IAClC,QAAQ,CAAmB;IAC3B,gBAAgB,CAAS;IACzB,mBAAmB,CAAwB;IAC3C,cAAc,CAAgB;IAEvC,eAAe,GAA+B,IAAI,CAAC;IACnD,aAAa,GAA6B,IAAI,CAAC;IAE/C;;OAEG;IACH,YAAY,MAAqB;QAC/B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,kBAAkB,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED,8EAA8E;IAC9E,0EAA0E;IAC1E,0DAA0D;IAE1D;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CACd,cAAgC,EAChC,OAAyB,EACzB,eAAuB;QAEvB,MAAM,cAAc,GAAwB;YAC1C,UAAU,EAAQ;gBAChB,8BAA8B;gBAC9B,0BAA0B;gBAC1B,mCAAmC;gBACnC,8BAA8B;aAC/B;YACD,KAAK,EAAa,OAAO;YACzB,UAAU,EAAQ,EAAE;YACpB,eAAe,EAAG,eAAe,GAAG,CAAC;YACrC,UAAU,EAAQ,aAAa,CAAC,cAAc,CAAC;SAChD,CAAC;QAEF,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,CAAC;YACH,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,WAAW,CACnB,mCAAmC,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAC9F,kBAAkB,EAAE,cAAc,CACnC,CAAC;QACJ,CAAC;QAED,cAAc,CAAC,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;QAC1D,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CACT,GAAW,EACX,cAAmC,EACnC,kBAAyC,EACzC,SAAmB;QAEnB,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC;QACjD,MAAM,EAAE,GAAG,kBAAkB,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,eAAe,CAAC,aAAa,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QAE1E,MAAM,MAAM,GAAwB;YAClC,UAAU,EAAG;gBACX,8BAA8B;gBAC9B,0BAA0B;gBAC1B,mCAAmC;gBACnC,8BAA8B;aAC/B;YACD,WAAW,EAAU,iBAAiB;YACtC,IAAI,EAAiB,oBAAoB;YACzC,kBAAkB,EAAG,kBAAkB,CAAC,EAAE;YAC1C,YAAY,EAAS,sBAAsB;YAC3C,UAAU,EAAW,iBAAiB,kBAAkB,CAAC,GAAG,CAAC,EAAE;YAC/D,gBAAgB,EAAK,OAAO;SAC7B,CAAC;QAEF,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAChE,OAAO,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,aAA4B,EAC5B,MAAyB,EACzB,SAAmB,EACnB,OAA0B;QAE1B,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,8EAA8E;IAC9E,wEAAwE;IACxE,wBAAwB;IAExB,UAAU;QACR,OAAO,EAAO,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACvF,CAAC;IAED,KAAK,CAAC,SAAmB;QACvB,OAAO,EAAO,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,IAAI,CAAC,eAAgB,EAAE,IAAI,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;IAC3G,CAAC;IAED,8EAA8E;IAE9E;;;;OAIG;IACH,OAAO;QACL,OAAM,IAAI,EAAE,CAAC;YACX,QAAO,IAAI,CAAC,MAAM,EAAE,CAAC;gBAEnB,mBAAmB;gBACnB,0EAA0E;gBAC1E,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC5B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;oBACzC,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC;oBAChC,SAAS;gBACX,CAAC;gBAED,cAAc;gBACd,iFAAiF;gBACjF,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;oBACvB,OAAO;wBACL,MAAM,EAAG,iBAAiB;wBAC1B,KAAK,EAAI,CAAC;gCACR,IAAI,EAAmB,gBAAgB;gCACvC,oBAAoB,EAAG,IAAI,CAAC,mBAAmB,CAAC,EAAE;gCAClD,cAAc,EAAS,IAAI,CAAC,eAAgB;6BAC7C,CAAC;qBACH,CAAC;gBACJ,CAAC;gBAED,cAAc;gBACd,qEAAqE;gBACrE,yDAAyD;gBACzD,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;oBACvB,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;oBAClF,OAAO;wBACL,MAAM,EAAG,iBAAiB;wBAC1B,KAAK,EAAI,CAAC;gCACR,IAAI,EAAa,aAAa;gCAC9B,aAAa;gCACb,aAAa,EAAI,IAAI,CAAC,cAAc;6BACrC,CAAC;qBACH,CAAC;gBACJ,CAAC;gBAED,mBAAmB;gBACnB,kFAAkF;gBAClF,+EAA+E;gBAC/E,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC5B,OAAO;wBACL,MAAM,EAAG,iBAAiB;wBAC1B,KAAK,EAAI,CAAC;gCACR,IAAI,EAAY,eAAe;gCAC/B,aAAa,EAAG,IAAI,CAAC,cAAc;gCACnC,YAAY,EAAI,IAAI,CAAC,aAAc;6BACpC,CAAC;qBACH,CAAC;gBACJ,CAAC;gBAED,kBAAkB;gBAClB,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAC3B,OAAO;wBACL,MAAM,EAAG,UAAU;wBACnB,MAAM,EAAG,EAAE,YAAY,EAAE,IAAI,CAAC,aAAc,EAAE;qBAC/C,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAYD,OAAO,CAAC,IAAqB,EAAE,IAAe;QAC5C,QAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,IAAG,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;oBACrC,MAAM,IAAI,WAAW,CACnB,mDAAmD,IAAI,CAAC,MAAM,kBAAkB,EAChF,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAC3C,CAAC;gBACJ,CAAC;gBACD,IAAG,CAAC,IAAI,EAAE,CAAC;oBACT,MAAM,IAAI,WAAW,CACnB,2CAA2C,EAC3C,kBAAkB,CACnB,CAAC;gBACJ,CAAC;gBACD,IAAG,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;oBACzB,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,kBAAkB,CACnB,CAAC;gBACJ,CAAC;gBACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACtC,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC;gBAChC,MAAM;YACR,CAAC;YAED,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,IAAG,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;oBACrC,MAAM,IAAI,WAAW,CACnB,gDAAgD,IAAI,CAAC,MAAM,kBAAkB,EAC7E,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAC3C,CAAC;gBACJ,CAAC;gBACD,qEAAqE;gBACrE,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC;gBACrC,MAAM;YACR,CAAC;YAED,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,IAAG,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;oBAC1C,MAAM,IAAI,WAAW,CACnB,kDAAkD,IAAI,CAAC,MAAM,uBAAuB,EACpF,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAC3C,CAAC;gBACJ,CAAC;gBACD,2DAA2D;gBAC3D,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC;gBACpC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/esm/did-btcr2.js

@@ -1,11 +1,10 @@
 import { IdentifierHrp, INVALID_DID_DOCUMENT, INVALID_DID_UPDATE, METHOD_NOT_SUPPORTED, MethodError, UpdateError } from '@did-btcr2/common';
 import { Did, DidError, DidErrorCode } from '@web5/dids';
 import * as ecc from '@bitcoinerlab/secp256k1';
-import { hexToBytes } from '@noble/hashes/utils';
 import { initEccLib } from 'bitcoinjs-lib';
 import { Identifier } from './core/identifier.js';
 import { Resolver } from './core/resolver.js';
-import { Update } from './core/update.js';
+import { Updater } from './core/updater.js';
 import { Appendix } from './utils/appendix.js';
 /** Initialize secp256k1 ECC library */
 initEccLib(ecc);
@@ -92,34 +91,29 @@ export class DidBtcr2 {
         });
     }
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#read | 7.3 Update}.
-     * See specification for the {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process | Resolve Process}.
-     * See {@link Update | Update (class)} for class implementation.
+     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#update | 7.3 Update}.
      *
-     * BTCR2 DID documents can be updated by anchoring BTCR2 Updates to Bitcoin transactions. These transactions MAY be
-     * published to the Bitcoin network. Any property in the DID document may be updated except the id. Doing so would
-     * invalidate the DID document.
-     * @param params An object containing the parameters for the update operation.
+     * Factory method that validates the update parameters and returns a sans-I/O
+     * {@link Updater} state machine. The caller drives the updater through its
+     * phases (Construct → Sign → Broadcast → Complete) by calling `advance()` and
+     * `provide()`. The method package performs **zero I/O** — signing key retrieval
+     * (or KMS delegation) and the on-chain broadcast are the caller's responsibility.
+     *
+     * For a fully-wired version with Bitcoin broadcast and key handling, see
+     * `DidMethodApi.update()` in `@did-btcr2/api`.
+     *
+     * @param params Update construction parameters.
      * @param {Btcr2DidDocument} params.sourceDocument The DID document being updated.
-     * @param {PatchOperation[]} params.patches The array of JSON Patch operations to apply to the sourceDocument.
-     * @param {string} params.sourceVersionId The version ID before applying the update.
-     * @param {string} params.verificationMethodId The verificationMethod ID to sign the update with.
-     * @param {string} params.beaconId The beacon ID associated with the update.
-     * @param {KeyBytes | HexString} [params.signingMaterial] Optional signing material (key bytes or hex string).
-     * @param {BitcoinConnection} [params.bitcoin] Optional Bitcoin network connection for announcing the update. If not provided, a default connection will be initialized.
-     * @return {Promise<SignedBTCR2Update>} Promise resolving to the signed BTCR2 update.
-     * @throws {UpdateError} if no verificationMethod, verificationMethod type is not `Multikey` or the publicKeyMultibase
-     * header is not `zQ3s`
+     * @param {PatchOperation[]} params.patches The JSON Patch operations to apply.
+     * @param {number} params.sourceVersionId The version ID before applying the update.
+     * @param {string} params.verificationMethodId The verification method ID to sign with.
+     * @param {string} params.beaconId The beacon service ID to broadcast through.
+     * @returns {Updater} A sans-I/O state machine for driving the update.
+     * @throws {UpdateError} If the verification method is not authorized, not found,
+     *   not of type `Multikey`, or does not have a `zQ3s` publicKeyMultibase prefix.
+     *   Also throws if the beacon service is not found.
      */
-    static async update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }) {
-        // If no signingMaterial provided, throw an UpdateError with INVALID_DID_UPDATE.
-        if (!signingMaterial) {
-            throw new UpdateError('Missing signing material for update', INVALID_DID_UPDATE, { signingMaterial });
-        }
-        // Convert signingMaterial to bytes if it's a hex string
-        const secretKey = typeof signingMaterial === 'string'
-            ? hexToBytes(signingMaterial)
-            : signingMaterial;
+    static update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, }) {
         // Validate that the verificationMethodId is authorized for capabilityInvocation
         if (!sourceDocument.capabilityInvocation?.some(vr => vr === verificationMethodId)) {
             throw new UpdateError('Invalid verificationMethodId: not authorized for capabilityInvocation', INVALID_DID_DOCUMENT, sourceDocument);
@@ -138,28 +132,22 @@ export class DidBtcr2 {
         if (verificationMethod.publicKeyMultibase?.slice(0, 4) !== 'zQ3s') {
             throw new UpdateError('Invalid verificationMethodId: publicKeyMultibase prefix must start with "zQ3s"', INVALID_DID_DOCUMENT, verificationMethod);
         }
-        // Construct an unsigned update following the BTCR2 Update construction algorithm
-        const update = Update.construct(sourceDocument, patches, sourceVersionId);
-        // Sign the unsigned update using the specified verification method
-        const signed = Update.sign(sourceDocument.id, update, verificationMethod, secretKey);
-        // Filter sourceDocument services to get beaconServices matching beaconIds
+        // Find the beacon service matching the given beaconId
         const beaconService = sourceDocument.service
             .filter((service) => service.id === beaconId)
             .filter((service) => !!service)
             .shift();
-        // If no matching beacon service found, throw an UpdateError with INVALID_DID_UPDATE.
         if (!beaconService) {
             throw new UpdateError('No beacon service found for provided beaconId', INVALID_DID_UPDATE, { sourceDocument, beaconId });
         }
-        // Require an explicit bitcoin connection — no silent env-var fallback
-        if (!bitcoin) {
-            throw new UpdateError('Bitcoin connection required for update. Pass a configured `bitcoin` parameter '
-                + 'or use DidBtcr2Api which injects it automatically.', INVALID_DID_UPDATE, { beaconId });
-        }
-        // Announce the signed update to the blockchain using the specified beacon(s)
-        await Update.announce(beaconService, signed, secretKey, bitcoin);
-        // Return signed update if announced successfully
-        return signed;
+        // Return a sans-I/O state machine the caller will drive
+        return new Updater({
+            sourceDocument,
+            patches,
+            sourceVersionId,
+            verificationMethod,
+            beaconService,
+        });
     }
     /**
      * Given the W3C DID Document of a `did:btcr2` identifier, return the signing verification method that will be used

package/dist/esm/did-btcr2.js.map

@@ -1 +1 @@
-{"version":3,"file":"did-btcr2.js","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EACL,GAAG,EACH,QAAQ,EACR,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,GAAG,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAY/C,uCAAuC;AACvC,UAAU,CAAC,GAAG,CAAC,CAAC;AAEhB;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,UAAU,GAAW,OAAO,CAAC;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,YAAsC,EAAE,OAA0B;QAC9E,8FAA8F;QAC9F,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAEnE,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,oBAAoB,EAAE,OAAO,CAC9B,CAAC;QACJ,CAAC;QAED,qCAAqC;QACrC,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,OAAO,CACZ,GAAW,EACX,oBAAuC,EAAE;QAEzC,gCAAgC;QAChC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEpE,0EAA0E;QAC1E,0EAA0E;QAC1E,gDAAgD;QAChD,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,KAAK,aAAa,CAAC,CAAC;YAC3D,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC;QAET,oCAAoC;QACpC,OAAO,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE;YAC/D,SAAS,EAAS,iBAAiB,CAAC,SAAS;YAC7C,WAAW,EAAO,iBAAiB,CAAC,WAAW;YAC/C,eAAe,EAAG,iBAAiB,CAAC,OAAO,EAAE,eAAe;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAClB,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,OAAO,GASR;QACC,gFAAgF;QAChF,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,WAAW,CACnB,qCAAqC,EACrC,kBAAkB,EAAE,EAAC,eAAe,EAAC,CACtC,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,MAAM,SAAS,GAAG,OAAO,eAAe,KAAK,QAAQ;YACnD,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC;YAC7B,CAAC,CAAC,eAAe,CAAC;QAEpB,gFAAgF;QAChF,IAAG,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,oBAAoB,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,WAAW,CACnB,uEAAuE,EACvE,oBAAoB,EAAE,cAAc,CACrC,CAAC;QACJ,CAAC;QAED,gEAAgE;QAChE,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QAEvF,+DAA+D;QAC/D,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,WAAW,CACnB,0DAA0D,EAC1D,oBAAoB,EAAE,EAAC,cAAc,EAAE,oBAAoB,EAAC,CAC7D,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,IAAI,kBAAkB,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,WAAW,CACnB,wEAAwE,EACxE,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,mDAAmD;QACnD,IAAI,kBAAkB,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YAClE,MAAM,IAAI,WAAW,CACnB,gFAAgF,EAChF,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,iFAAiF;QACjF,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;QAE1E,mEAAmE;QACnE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,SAAS,CAAC,CAAC;QAErF,0EAA0E;QAC1E,MAAM,aAAa,GAAG,cAAc,CAAC,OAAO;aACzC,MAAM,CAAC,CAAC,OAAsB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC;aAC3D,MAAM,CAAC,CAAC,OAAsB,EAA4B,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACvE,KAAK,EAAE,CAAC;QAEX,qFAAqF;QACrF,IAAG,CAAC,aAAa,EAAE,CAAC;YAClB,MAAM,IAAI,WAAW,CACnB,+CAA+C,EAC/C,kBAAkB,EAAE,EAAC,cAAc,EAAE,QAAQ,EAAC,CAC/C,CAAC;QACJ,CAAC;QACD,sEAAsE;QACtE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,WAAW,CACnB,gFAAgF;kBAC9E,oDAAoD,EACtD,kBAAkB,EAAE,EAAE,QAAQ,EAAE,CACjC,CAAC;QACJ,CAAC;QAED,6EAA6E;QAC7E,MAAM,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAEjE,iDAAiD;QACjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAA6B,EAAG,QAAiB;QACvE,qEAAqE;QACrE,QAAQ,KAAK,aAAa,CAAC;QAE3B,sCAAsC;QACtC,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC5C,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YACtD,MAAM,IAAI,WAAW,CAAC,yBAAyB,SAAS,CAAC,MAAM,EAAE,EAAE,oBAAoB,EAAE,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3H,CAAC;QAED,2FAA2F;QAC3F,kEAAkE;QAClE,MAAM,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAC7D,CAAC,EAAyB,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC;eACvG,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CACpE,CAAC;QAEF,qDAAqD;QACrD,IAAI,CAAC,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,aAAa,EAC1B,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QACD,OAAO,kBAA2C,CAAC;IACrD,CAAC"}
+{"version":3,"file":"did-btcr2.js","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,GAAG,EACH,QAAQ,EACR,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,GAAG,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAY/C,uCAAuC;AACvC,UAAU,CAAC,GAAG,CAAC,CAAC;AAEhB;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,UAAU,GAAW,OAAO,CAAC;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,YAAsC,EAAE,OAA0B;QAC9E,8FAA8F;QAC9F,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAEnE,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,oBAAoB,EAAE,OAAO,CAC9B,CAAC;QACJ,CAAC;QAED,qCAAqC;QACrC,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,OAAO,CACZ,GAAW,EACX,oBAAuC,EAAE;QAEzC,gCAAgC;QAChC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEpE,0EAA0E;QAC1E,0EAA0E;QAC1E,gDAAgD;QAChD,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,KAAK,aAAa,CAAC,CAAC;YAC3D,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC;QAET,oCAAoC;QACpC,OAAO,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE;YAC/D,SAAS,EAAS,iBAAiB,CAAC,SAAS;YAC7C,WAAW,EAAO,iBAAiB,CAAC,WAAW;YAC/C,eAAe,EAAG,iBAAiB,CAAC,OAAO,EAAE,eAAe;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,MAAM,CAAC,EACZ,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,GAOT;QACC,gFAAgF;QAChF,IAAG,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,oBAAoB,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,WAAW,CACnB,uEAAuE,EACvE,oBAAoB,EAAE,cAAc,CACrC,CAAC;QACJ,CAAC;QAED,gEAAgE;QAChE,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QAEvF,+DAA+D;QAC/D,IAAG,CAAC,kBAAkB,EAAE,CAAC;YACvB,MAAM,IAAI,WAAW,CACnB,0DAA0D,EAC1D,oBAAoB,EAAE,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAC/D,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,IAAG,kBAAkB,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC1C,MAAM,IAAI,WAAW,CACnB,wEAAwE,EACxE,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,mDAAmD;QACnD,IAAG,kBAAkB,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YACjE,MAAM,IAAI,WAAW,CACnB,gFAAgF,EAChF,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,sDAAsD;QACtD,MAAM,aAAa,GAAG,cAAc,CAAC,OAAO;aACzC,MAAM,CAAC,CAAC,OAAsB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC;aAC3D,MAAM,CAAC,CAAC,OAAsB,EAA4B,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACvE,KAAK,EAAE,CAAC;QAEX,IAAG,CAAC,aAAa,EAAE,CAAC;YAClB,MAAM,IAAI,WAAW,CACnB,+CAA+C,EAC/C,kBAAkB,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,CACjD,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,OAAO,IAAI,OAAO,CAAC;YACjB,cAAc;YACd,OAAO;YACP,eAAe;YACf,kBAAkB;YAClB,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAA6B,EAAG,QAAiB;QACvE,qEAAqE;QACrE,QAAQ,KAAK,aAAa,CAAC;QAE3B,sCAAsC;QACtC,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC5C,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YACtD,MAAM,IAAI,WAAW,CAAC,yBAAyB,SAAS,CAAC,MAAM,EAAE,EAAE,oBAAoB,EAAE,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3H,CAAC;QAED,2FAA2F;QAC3F,kEAAkE;QAClE,MAAM,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAC7D,CAAC,EAAyB,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC;eACvG,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CACpE,CAAC;QAEF,qDAAqD;QACrD,IAAI,CAAC,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,aAAa,EAC1B,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QACD,OAAO,kBAA2C,CAAC;IACrD,CAAC"}

package/dist/esm/index.js

@@ -1,43 +1,34 @@
-export * from './core/beacon/aggregation/cohort/index.js';
-export * from './core/beacon/aggregation/cohort/status.js';
-export * from './core/beacon/aggregation/cohort/messages/base.js';
-export * from './core/beacon/aggregation/cohort/messages/constants.js';
-export * from './core/beacon/aggregation/cohort/messages/index.js';
-export * from './core/beacon/aggregation/cohort/messages/keygen//subscribe.js';
-export * from './core/beacon/aggregation/cohort/messages/keygen/cohort-advert.js';
-export * from './core/beacon/aggregation/cohort/messages/keygen/cohort-ready.js';
-export * from './core/beacon/aggregation/cohort/messages/keygen/opt-in-accept.js';
-export * from './core/beacon/aggregation/cohort/messages/keygen/opt-in.js';
-export * from './core/beacon/aggregation/cohort/messages/sign/aggregated-nonce.js';
-export * from './core/beacon/aggregation/cohort/messages/sign/authorization-request.js';
-export * from './core/beacon/aggregation/cohort/messages/sign/nonce-contribution.js';
-export * from './core/beacon/aggregation/cohort/messages/sign/request-signature.js';
-export * from './core/beacon/aggregation/cohort/messages/sign/signature-authorization.js';
-export * from './core/beacon/aggregation/communication/adapter/did-comm.js';
-export * from './core/beacon/aggregation/communication/adapter/nostr.js';
-export * from './core/beacon/aggregation/communication/error.js';
-export * from './core/beacon/aggregation/communication/factory.js';
-export * from './core/beacon/aggregation/communication/service.js';
-export * from './core/beacon/aggregation/coordinator.js';
-export * from './core/beacon/aggregation/participant.js';
-export * from './core/beacon/aggregation/session/index.js';
-export * from './core/beacon/aggregation/session/status.js';
+// Aggregation
+export * from './core/aggregation/service.js';
+export * from './core/aggregation/participant.js';
+export * from './core/aggregation/cohort.js';
+export * from './core/aggregation/signing-session.js';
+export * from './core/aggregation/phases.js';
+export * from './core/aggregation/errors.js';
+export * from './core/aggregation/messages/index.js';
+export * from './core/aggregation/transport/index.js';
+export * from './core/aggregation/runner/index.js';
+// Beacons
 export * from './core/beacon/beacon.js';
 export * from './core/beacon/cas-beacon.js';
 export * from './core/beacon/error.js';
 export * from './core/beacon/factory.js';
+export * from './core/beacon/fee-estimator.js';
 export * from './core/beacon/interfaces.js';
 export * from './core/beacon/signal-discovery.js';
 export * from './core/beacon/singleton-beacon.js';
 export * from './core/beacon/smt-beacon.js';
 export * from './core/beacon/utils.js';
+// Core
 export * from './core/identifier.js';
 export * from './core/interfaces.js';
 export * from './core/resolver.js';
 export * from './core/types.js';
-export * from './core/update.js';
+export * from './core/updater.js';
+// Utils
 export * from './utils/appendix.js';
 export * from './utils/did-document-builder.js';
 export * from './utils/did-document.js';
+// Facade
 export * from './did-btcr2.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAE3D,cAAc,mDAAmD,CAAC;AAClE,cAAc,wDAAwD,CAAC;AACvE,cAAc,oDAAoD,CAAC;AACnE,cAAc,gEAAgE,CAAC;AAC/E,cAAc,mEAAmE,CAAC;AAClF,cAAc,kEAAkE,CAAC;AACjF,cAAc,mEAAmE,CAAC;AAClF,cAAc,4DAA4D,CAAC;AAC3E,cAAc,oEAAoE,CAAC;AACnF,cAAc,yEAAyE,CAAC;AACxF,cAAc,sEAAsE,CAAC;AACrF,cAAc,qEAAqE,CAAC;AACpF,cAAc,2EAA2E,CAAC;AAE1F,cAAc,6DAA6D,CAAC;AAC5E,cAAc,0DAA0D,CAAC;AAEzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AAEnE,cAAc,0CAA0C,CAAC;AACzD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAE5D,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAEvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AAExC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC;AAEnD,UAAU;AACV,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAEvC,OAAO;AACP,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,QAAQ;AACR,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AAExC,SAAS;AACT,cAAc,gBAAgB,CAAC"}

package/dist/types/core/aggregation/cohort.d.ts

@@ -0,0 +1,94 @@
+import type { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import type { SerializedSMTProof } from '@did-btcr2/smt';
+import type { CASAnnouncement } from '../types.js';
+export type AggregationCohortParams = {
+    id?: string;
+    serviceDid?: string;
+    minParticipants?: number;
+    network: string;
+    beaconType?: string;
+};
+/**
+ * Represents an Aggregation Cohort — a set of Aggregation Participants who
+ * submitted cryptographic material to an Aggregation Service to coordinate
+ * signing of a shared n-of-n MuSig2 Bitcoin transaction.
+ *
+ * This is a pure data class — it holds cohort state and provides computation
+ * helpers (key aggregation, CAS Announcement building, SMT tree building).
+ * It performs no I/O and emits no messages. Both AggregationService and
+ * AggregationParticipant create their own AggregationCohort instances to
+ * track their respective views of the cohort state.
+ *
+ * @class AggregationCohort
+ */
+export declare class AggregationCohort {
+    #private;
+    /** Unique identifier for the cohort. */
+    id: string;
+    /** DID of the Aggregation Service managing this cohort. */
+    serviceDid: string;
+    /** Minimum number of participants required to finalize the cohort. */
+    minParticipants: number;
+    /** Network on which the cohort operates (mainnet, mutinynet, etc.). */
+    network: string;
+    /** Type of beacon used in the cohort: 'CASBeacon' or 'SMTBeacon'. */
+    beaconType: string;
+    /** List of participant DIDs that have been accepted into the cohort. */
+    participants: Array<string>;
+    /** Taproot tweak (BIP-341 key-path-only). */
+    trMerkleRoot: Uint8Array;
+    /** The n-of-n MuSig2 Taproot beacon address. */
+    beaconAddress: string;
+    /** Pending DID updates submitted by participants, keyed by DID. */
+    pendingUpdates: Map<string, SignedBTCR2Update>;
+    /** CAS Beacon Announcement Map (DID → updateHash), set by buildCASAnnouncement(). */
+    casAnnouncement?: CASAnnouncement;
+    /** Per-participant SMT proofs, set by buildSMTTree(). */
+    smtProofs?: Map<string, SerializedSMTProof>;
+    /** Signal bytes (32 bytes) for OP_RETURN: SHA-256 of CAS announcement OR SMT root. */
+    signalBytes?: Uint8Array;
+    /** Set of participant DIDs that have approved the aggregated data. */
+    validationAcks: Set<string>;
+    /** Set of participant DIDs that have rejected the aggregated data. */
+    validationRejections: Set<string>;
+    constructor({ id, minParticipants, serviceDid, network, beaconType }: AggregationCohortParams);
+    /** Sorted cohort keys (sorted on assignment per BIP-327). */
+    get cohortKeys(): Array<Uint8Array>;
+    set cohortKeys(keys: Array<Uint8Array>);
+    /**
+     * Computes the n-of-n MuSig2 Taproot beacon address from cohort keys.
+     * Sets `trMerkleRoot` to the BIP-341 key-path-only tweak.
+     */
+    computeBeaconAddress(): string;
+    /**
+     * Validates that the participant's key is in the cohort and the beacon address
+     * matches the locally-computed one. Used by participants to verify cohort ready
+     * messages from the service.
+     */
+    validateMembership(participantPkHex: string, cohortKeysHex: Array<string>, expectedBeaconAddress: string): void;
+    addUpdate(participantDid: string, signedUpdate: SignedBTCR2Update): void;
+    hasAllUpdates(): boolean;
+    /**
+     * Builds a CAS Announcement Map from collected updates.
+     * Maps each participant DID → base64url canonical hash of their signed update.
+     * Computes signal bytes as SHA-256 of canonicalized announcement.
+     */
+    buildCASAnnouncement(): CASAnnouncement;
+    /**
+     * Builds an SMT tree from collected updates.
+     * Each entry uses a random 32-byte nonce + canonicalized signed update bytes.
+     * Stores per-participant proofs and the SMT root as signalBytes.
+     */
+    buildSMTTree(): Map<string, SerializedSMTProof>;
+    addValidation(participantDid: string, approved: boolean): void;
+    /**
+     * True when every participant has either approved or rejected the aggregated data.
+     */
+    hasAllValidationResponses(): boolean;
+    /**
+     * True when all participants approved. Note: differs from {@link hasAllValidationResponses} —
+     * this returns false if any participant rejected, even if all responses are in.
+     */
+    isFullyValidated(): boolean;
+}
+//# sourceMappingURL=cohort.d.ts.map

package/dist/types/core/aggregation/cohort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cohort.d.ts","sourceRoot":"","sources":["../../../../src/core/aggregation/cohort.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAa,MAAM,gBAAgB,CAAC;AAKpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnD,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,iBAAiB;;IAC5B,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IAEnB,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;IAExB,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAC;IAEhB,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IAEnB,wEAAwE;IACxE,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAM;IAKjC,6CAA6C;IAC7C,YAAY,EAAE,UAAU,CAAoB;IAE5C,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAM;IAE3B,mEAAmE;IACnE,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAa;IAE3D,qFAAqF;IACrF,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,yDAAyD;IACzD,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAE5C,sFAAsF;IACtF,WAAW,CAAC,EAAE,UAAU,CAAC;IAEzB,sEAAsE;IACtE,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IAExC,sEAAsE;IACtE,oBAAoB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;gBAElC,EAAE,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,uBAAuB;IAQ7F,6DAA6D;IAC7D,IAAI,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,CAElC;IAED,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,EAErC;IAED;;;OAGG;IACI,oBAAoB,IAAI,MAAM;IAyBrC;;;;OAIG;IACI,kBAAkB,CACvB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,EAC5B,qBAAqB,EAAE,MAAM,GAC5B,IAAI;IAiBA,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,iBAAiB,GAAG,IAAI;IAUxE,aAAa,IAAI,OAAO;IAI/B;;;;OAIG;IACI,oBAAoB,IAAI,eAAe;IAgB9C;;;;OAIG;IACI,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC;IA4B/C,aAAa,CAAC,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI;IAcrE;;OAEG;IACI,yBAAyB,IAAI,OAAO;IAI3C;;;OAGG;IACI,gBAAgB,IAAI,OAAO;CAInC"}

package/dist/types/core/aggregation/errors.d.ts

@@ -0,0 +1,14 @@
+import { MethodError } from '@did-btcr2/common';
+export declare class AggregationServiceError extends MethodError {
+    constructor(message: string, type?: string, data?: Record<string, any>);
+}
+export declare class AggregationParticipantError extends MethodError {
+    constructor(message: string, type?: string, data?: Record<string, any>);
+}
+export declare class AggregationCohortError extends MethodError {
+    constructor(message: string, type?: string, data?: Record<string, any>);
+}
+export declare class SigningSessionError extends MethodError {
+    constructor(message: string, type?: string, data?: Record<string, any>);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/types/core/aggregation/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../src/core/aggregation/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,qBAAa,uBAAwB,SAAQ,WAAW;gBAC1C,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAkC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGlG;AAED,qBAAa,2BAA4B,SAAQ,WAAW;gBAC9C,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAsC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGtG;AAED,qBAAa,sBAAuB,SAAQ,WAAW;gBACzC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAiC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGjG;AAED,qBAAa,mBAAoB,SAAQ,WAAW;gBACtC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAA8B,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAG9F"}

package/dist/types/core/{beacon/aggregation/cohort → aggregation}/messages/base.d.ts

@@ -1,4 +1,3 @@
-export declare const MESSAGE_PREFIX = "https://btcr2.tools/";
 export type BaseBody = {
     cohortId: string;
     cohortSize?: number;
@@ -11,8 +10,15 @@ export type BaseBody = {
     nonceContribution?: Uint8Array;
     partialSignature?: Uint8Array;
     pendingTx?: string;
+    prevOutValue?: string;
+    communicationPk?: Uint8Array;
     beaconType?: string;
     data?: string;
+    signedUpdate?: Record<string, unknown>;
+    casAnnouncement?: Record<string, string>;
+    smtProof?: Record<string, unknown>;
+    signalBytesHex?: string;
+    approved?: boolean;
 };
 export type Base = {
     type: string;

package/dist/types/core/aggregation/messages/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../../src/core/aggregation/messages/base.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,iBAAiB,CAAC,EAAE,UAAU,CAAC;IAC/B,gBAAgB,CAAC,EAAE,UAAU,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,qBAAa,WAAW;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;gBAEX,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI;IAO1C;;;OAGG;IACI,MAAM,IAAI,IAAI;CAQtB"}