@did-btcr2/method 0.19.0 → 0.22.0

package/dist/cjs/core/update.js

@@ -1,13 +1,9 @@
-import { INVALID_DID_DOCUMENT, INVALID_DID_UPDATE, INVALID_PUBLIC_KEY_TYPE, JSONPatch, MethodError, NOT_FOUND, UpdateError } from '@did-btcr2/common';
+import { Canonicalization, INVALID_DID_UPDATE, JSONPatch, UpdateError } from '@did-btcr2/common';
 import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { CompressedSecp256k1PublicKey, SchnorrKeyPair, Secp256k1SecretKey } from '@did-btcr2/keypair';
-import { Kms } from '@did-btcr2/kms';
-import { canonicalization } from '../did-btcr2.js';
-import { Appendix } from '../utils/appendix.js';
 import { DidDocument } from '../utils/did-document.js';
-import { Identifier } from './identifier.js';
+import { BeaconFactory } from './beacon/factory.js';
 /**
- * Implements {@link https://dcdpr.github.io/did-btcr2/#update | 4.3 Update}.
+ * Implements {@link https://dcdpr.github.io/did-btcr2/operations/update.html | 7.3 Update}.
  *
  * An update to a did:btcr2 document is an invoked capability using the ZCAP-LD
  * data format, signed by a verificationMethod that has the authority to make
@@ -20,109 +16,62 @@ import { Identifier } from './identifier.js';
  */
 export class Update {
     /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#construct-did-update-payload | 4.3.1 Construct DID Update Payload}.
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-unsigned-update | 7.3.b Construct BTCR2 Unsigned Update}.
+     * This process constructs a BTCR2 Unsigned Update conformant to the spec template.
      *
-     * The Construct DID Update Payload algorithm applies the documentPatch to the sourceDocument and verifies the
-     * resulting targetDocument is a conformant DID document. It takes in a Identifier, sourceDocument,
-     * sourceVersionId, and documentPatch objects. It returns an unsigned DID Update Payload.
-     *
-     * @param {ConstructPayloadParams} params See  {@link ConstructPayloadParams} for more details.
-     * @param {string} params.identifier The did-btcr2 identifier to use for verification.
-     * @param {DidDocument} params.sourceDocument The source document to be updated.
-     * @param {string} params.sourceVersionId The versionId of the source document.
-     * @param {DidDocumentPatch} params.patch The JSON patch to be applied to the source document.
-     * @returns {Promise<BTCR2SignedUpdate>} The constructed BTCR2SignedUpdate object.
-     * @throws {MethodError} InvalidDid if sourceDocument.id does not match identifier.
+     * @param {Btcr2DidDocument} sourceDocument The source DID document to be updated.
+     * @param {PatchOperation[]} patches The array of JSON Patch operations to apply to the sourceDocument.
+     * @param {number} sourceVersionId The version ID of the source document.
+     * @returns {Promise<SignedBTCR2Update>} The constructed SignedBTCR2Update object.
+     * @throws {UpdateError} InvalidDid if sourceDocument.id does not match identifier.
      */
-    static async construct({ identifier, sourceDocument, sourceVersionId, patch, }) {
-        // 1. Check that sourceDocument.id equals identifier else MUST raise invalidDIDUpdate error.
-        if (sourceDocument.id !== identifier) {
-            throw new UpdateError('Identifier mismatch: sourceDocument.id !== identifier', INVALID_DID_UPDATE, { sourceDocument, identifier });
-        }
-        // 2. Initialize an unsigned update.
+    static async construct(sourceDocument, patches, sourceVersionId) {
+        // Initialize an unsigned update conformant to btcr2 spec.
         const unsignedUpdate = {
-            // 3. Set BTCR2SignedUpdate.@context to the following list
             '@context': [
                 'https://w3id.org/security/v2',
                 'https://w3id.org/zcap/v1',
                 'https://w3id.org/json-ld-patch/v1',
                 'https://btcr2.dev/context/v1'
             ],
-            // 4. Set BTCR2SignedUpdate.patch to documentPatch.
-            patch,
+            patch: patches,
             targetHash: '',
-            targetVersionId: 0,
-            sourceHash: '',
+            targetVersionId: sourceVersionId + 1,
+            sourceHash: Canonicalization.process(sourceDocument, { encoding: 'base58' }),
         };
-        // 5. Set targetDocument to the result of applying the documentPatch to the sourceDocument, following the JSON Patch
-        //    specification.
-        const targetDocument = JSONPatch.apply(sourceDocument, patch);
-        // 6. Validate targetDocument is a conformant DID document, else MUST raise invalidDIDUpdate error.
-        DidDocument.validate(targetDocument);
-        // 7. Set sourceHashBytes to the result of passing sourceDocument into the JSON Canonicalization and Hash algorithm.
-        // 8. Set BTCR2SignedUpdate.sourceHash to the base58-btc Multibase encoding of sourceHashBytes.
-        unsignedUpdate.sourceHash = (canonicalization.process(sourceDocument, { encoding: 'base58' })).slice(1);
-        // TODO: Question - is base58btc the correct encoding scheme?
-        // 9. Set targetHashBytes to the result of passing targetDocument into the JSON Canonicalization and Hash algorithm.
-        // 10. Set BTCR2SignedUpdate.targetHash to the base58-btc Multibase encoding of targetHashBytes.
-        unsignedUpdate.targetHash = (canonicalization.process(targetDocument, { encoding: 'base58' })).slice(1);
-        // 11. Set BTCR2SignedUpdate.targetVersionId to sourceVersionId + 1.
-        unsignedUpdate.targetVersionId = sourceVersionId + 1;
-        // 12. Return updatePayload.
+        // Apply all JSON patches to sourceDocument.
+        const targetDocument = JSONPatch.apply(sourceDocument, patches);
+        try {
+            // Ensure the targetDocument is conformant to DID Core v1.1.
+            DidDocument.isValid(targetDocument);
+        }
+        catch (error) {
+            // If validation fails, throw an UpdateError with INVALID_DID_UPDATE.
+            throw new UpdateError('Error validating targetDocument: ' + (error instanceof Error ? error.message : String(error)), INVALID_DID_UPDATE, targetDocument);
+        }
+        // Set the targetHash by canonicalizing the targetDocument and encoding it in base58.
+        unsignedUpdate.targetHash = Canonicalization.process(targetDocument, { encoding: 'base58' });
+        // Return unsignedUpdate.
         return unsignedUpdate;
     }
     /**
-     * {@link https://dcdpr.github.io/did-btcr2/#invoke-did-update-payload | 4.3.2 Invoke DID Update Payload}.
+     * Implements subsection {@link http://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-signed-update | 7.3.c Construct BTCR2 Signed Update }.
+     * This process constructs a BTCR2 Signed Update from a BTCR2 Unsigned Update.
      *
-     * The Invoke DID Update Payload algorithm takes in a Identifier, an unsigned BTCR2SignedUpdate, and a
-     * verificationMethod. It retrieves the privateKeyBytes for the verificationMethod and adds a capability invocation in
-     * the form of a Data Integrity proof following the Authorization Capabilities (ZCAP-LD) and VC Data Integrity
-     * specifications. It returns the invoked DID Update Payload.
-     *
-     * @param {InvokePayloadParams} params Required params for calling the invokePayload method
-     * @param {string} params.identifier The did-btcr2 identifier to derive the root capability from
-     * @param {BTCR2SignedUpdate} params.BTCR2SignedUpdate The updatePayload object to be signed
-     * @param {DidVerificationMethod} params.verificationMethod The verificationMethod object to be used for signing
-     * @returns {BTCR2SignedUpdate} Did update payload secured with a proof => BTCR2SignedUpdate
-     * @throws {MethodError} if the privateKeyBytes are invalid
+     * @param {string} did The did-btcr2 identifier to derive the root capability from
+     * @param {UnsignedBTCR2Update} unsignedUpdate The updatePayload object to be signed
+     * @param {DidVerificationMethod} verificationMethod The verificationMethod object to be used for signing
+     * @returns {SignedBTCR2Update} Did update payload secured with a proof => SignedBTCR2Update
+     * @throws {UpdateError} if the privateKeyBytes are invalid
      */
-    static async invoke({ identifier, unsignedUpdate, verificationMethod }) {
-        // Deconstruct the verificationMethod
-        const { id: fullId, controller, publicKeyMultibase, secretKeyMultibase } = verificationMethod;
-        // Validate the verificationMethod
-        if (!publicKeyMultibase) {
-            throw new MethodError('Invalid publicKeyMultibase: cannot be undefined', INVALID_PUBLIC_KEY_TYPE, verificationMethod);
-        }
-        // 1. Set privateKeyBytes to the result of retrieving the private key bytes
-        // associated with the verificationMethod value.
-        // 1.1 Let id be the fragment portion of verificationMethod.id.
-        const id = fullId.slice(fullId.indexOf('#'));
-        // 1.2 Retrieve the key pair from the KMS or from the secretKeyMultibase
-        const components = Identifier.decode(id);
-        const keyUri = new CompressedSecp256k1PublicKey(components.genesisBytes).hex;
-        const keys = secretKeyMultibase
-            ? new SchnorrKeyPair({ secretKey: Secp256k1SecretKey.decode(secretKeyMultibase) })
-            : Kms.getKey(keyUri);
-        if (!keys) {
-            throw new MethodError('No privateKey found in kms or vm', NOT_FOUND, verificationMethod);
-        }
-        // 1.3 Set multikey to the result of passing verificationMethod and privateKeyBytes into the Multikey Creation algorithm.
-        const multikey = SchnorrMultikey.create({ id, controller, keys });
-        // 1.4 If the privateKey is not found, throw an error
-        if (!multikey) {
-            throw new MethodError('Failed to create multikey from verification method', 'MULTKEY_CREATE_FAILED', verificationMethod);
-        }
-        // 2. Set rootCapability to the result of passing Identifier into the Derive Root Capability from did:btcr2
-        //    Identifier algorithm.
-        const rootCapability = Appendix.deriveRootCapability(identifier);
-        const cryptosuite = 'bip340-jcs-2025';
-        // 3. Initialize proofOptions to an empty object.
-        // 4. Set proofOptions.type to DataIntegrityProof.
-        // 5. Set proofOptions.cryptosuite to schnorr-secp256k1-jcs-2025.
-        // 6. Set proofOptions.verificationMethod to verificationMethod.id.
-        // 7. Set proofOptions.proofPurpose to capabilityInvocation.
-        // 8. Set proofOptions.capability to rootCapability.id.
-        // 9. Set proofOptions.capabilityAction to Write.
+    static async sign(did, unsignedUpdate, verificationMethod, secretKey) {
+        // Parse the controller from the verificationMethod
+        const controller = verificationMethod.controller;
+        // Parse the fragment from the vmId
+        const id = verificationMethod.id.slice(verificationMethod.id.indexOf('#'));
+        // Construct a Schnorr Multikey
+        const multikey = SchnorrMultikey.fromSecretKey(id, controller, secretKey);
+        // Define the Data Integrity proof config
         const config = {
             '@context': [
                 'https://w3id.org/security/v2',
@@ -130,75 +79,34 @@ export class Update {
                 'https://w3id.org/json-ld-patch/v1',
                 'https://btcr2.dev/context/v1'
             ],
-            cryptosuite,
+            cryptosuite: 'bip340-jcs-2025',
             type: 'DataIntegrityProof',
-            verificationMethod: fullId,
+            verificationMethod: verificationMethod.id,
             proofPurpose: 'capabilityInvocation',
-            capability: rootCapability.id,
+            capability: `urn:zcap:root:${encodeURIComponent(did)}`,
             capabilityAction: 'Write',
         };
-        // 10. Set cryptosuite to the result of executing the Cryptosuite Instantiation algorithm from the BIP340 Data
-        //     Integrity specification passing in proofOptions.
+        // Go from multikey => cryptosuite => diproof
         const diproof = multikey.toCryptosuite().toDataIntegrityProof();
-        // 12. Set BTCR2SignedUpdate to the result of executing the Add Proof algorithm from VC Data Integrity passing
-        //     BTCR2SignedUpdate as the input document, cryptosuite, and the set of proofOptions.
-        // 13. Return BTCR2SignedUpdate.
-        return await diproof.addProof(unsignedUpdate, config);
+        // Use the config to add a proof to the unsigned update
+        return diproof.addProof(unsignedUpdate, config);
     }
     /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#announce-did-update | 4.3.3 Announce DID Update}.
-     *
-     * The Announce DID Update algorithm retrieves beaconServices from the sourceDocument and calls the Broadcast DID
-     * Update algorithm corresponding to the type of the Beacon. It takes in a Identifier, sourceDocument, an array of
-     * beaconIds, and a BTCR2SignedUpdate. It returns an array of signalsMetadata, containing the necessary
-     * data to validate the Beacon Signal against the BTCR2SignedUpdate.
-     *
-     * @param {AnnounceUpdatePayloadParams} params Required params for calling the announcePayload method
-     * @param {DidDocument} params.sourceDocument The did-btcr2 did document to derive the root capability from
-     * @param {string[]} params.beaconIds The BTCR2SignedUpdate object to be signed
-     * @param {BTCR2SignedUpdate} params.BTCR2SignedUpdate The verificationMethod object to be used for signing
-     * @returns {BTCR2SignedUpdate} The BTCR2SignedUpdate object containing data to validate the Beacon Signal
-     * @throws {MethodError} if the beaconService type is invalid
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#announce-did-update | 7.3.d Announce DID Update}.
+     * BTCR2 Signed Updates are announced to the Bitcoin blockchain depending on the Beacon Type.
+     * @param {BeaconService} beaconService The BeaconService object representing the funded beacon to announce the update to.
+     * @param {SignedBTCR2Update} update The signed update object to be announced.
+     * @param {KeyBytes} secretKey The private key used to sign the update for announcement.
+     * @returns {SignedBTCR2Update} The SignedBTCR2Update object containing data to validate the Beacon Signal
+     * @throws {UpdateError} if the beaconService type is invalid
      */
-    static async announce({ sourceDocument, beaconIds, signedUpdate }) {
-        // 1. Set beaconServices to an empty array.
-        const beaconServices = [];
-        // 2. sidecarData to an empty array.
-        let sidecarData;
-        // 3. For beaconId in beaconIds:
-        for (const beaconId of beaconIds) {
-            //    3.1 Find the beacon services in the sourceDocument
-            const beaconService = sourceDocument.service.find((s) => s.id === beaconId);
-            //    3.2 If no beaconService MUST throw beaconNotFound error.
-            if (!beaconService) {
-                throw new MethodError('Not found: sourceDocument does not contain beaconId', INVALID_DID_DOCUMENT, { beaconId });
-            }
-            //    3.3 Push beaconService to beaconServices.
-            beaconServices.push(beaconService);
-        }
-        // 4. For beaconService in beaconServices:
-        for (const beaconService of beaconServices) {
-            // 4.1 Set signalMetadata to null.
-            // 4.2 If beaconService.type == SingletonBeacon:
-            //    4.2.1 Set signalMetadata to the result of passing beaconService and BTCR2SignedUpdate to the Broadcast
-            //          Singleton Beacon Signal algorithm.
-            // 4.3 Else If beaconService.type == CASBeacon:
-            //    4.3.1 Set signalMetadata to the result of passing Identifier, beaconService and BTCR2SignedUpdate to
-            //          the Broadcast CIDAggregate Beacon Signal algorithm.
-            // 4.4 Else If beaconService.type == SMTBeacon:
-            //    4.4.1 Set signalMetadata to the result of passing Identifier, beaconService and BTCR2SignedUpdate to
-            //          the Broadcast SMTAggregate Beacon Signal algorithm.
-            // 4.5 Else:
-            //    4.5.1 MUST throw invalidBeacon error.
-            // const beacon = BeaconFactory.establish(beaconService);
-            // sidecarData = await beacon.broadcastSignal(signedUpdate);
-            console.log('TODO: refactor this code', signedUpdate, beaconService);
-        }
-        if (!sidecarData) {
-            throw new MethodError('Invalid beacon: no sidecarData found', INVALID_DID_DOCUMENT, { beaconServices });
-        }
+    static async announce(beaconService, update, secretKey, bitcoin) {
+        // Establish a beacon object
+        const beacon = BeaconFactory.establish(beaconService);
+        // Broadcast the update
+        const result = await beacon.broadcastSignal(update, secretKey, bitcoin);
         // Return the sidecarData
-        return sidecarData;
+        return result;
     }
 }
 //# sourceMappingURL=update.js.map

package/dist/cjs/core/update.js.map

@@ -1 +1 @@
-{"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,uBAAuB,EACvB,SAAS,EACT,WAAW,EACX,SAAS,EAET,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAA+D,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACtH,OAAO,EAAE,4BAA4B,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACtG,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAyB,MAAM,0BAA0B,CAAC;AAE9E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAqB7C;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,MAAM;IACjB;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAC5B,UAAU,EACV,cAAc,EACd,eAAe,EACf,KAAK,GAMN;QAEC,4FAA4F;QAC5F,IAAI,cAAc,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;YACrC,MAAM,IAAI,WAAW,CACnB,uDAAuD,EACvD,kBAAkB,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,CACnD,CAAC;QACJ,CAAC;QAED,oCAAoC;QACpC,MAAM,cAAc,GAAwB;YAC5C,0DAA0D;YACxD,UAAU,EAAQ;gBAChB,8BAA8B;gBAC9B,0BAA0B;gBAC1B,mCAAmC;gBACnC,8BAA8B;aAC/B;YACD,mDAAmD;YACnD,KAAK;YACL,UAAU,EAAQ,EAAE;YACpB,eAAe,EAAG,CAAC;YACnB,UAAU,EAAQ,EAAE;SACrB,CAAC;QAEF,oHAAoH;QACpH,oBAAoB;QACpB,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAgB,CAAC;QAE7E,mGAAmG;QACnG,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAErC,oHAAoH;QACpH,+FAA+F;QAC/F,cAAc,CAAC,UAAU,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxG,6DAA6D;QAE7D,oHAAoH;QACpH,gGAAgG;QAChG,cAAc,CAAC,UAAU,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAExG,oEAAoE;QACpE,cAAc,CAAC,eAAe,GAAG,eAAe,GAAG,CAAC,CAAC;QAErD,4BAA4B;QAC5B,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EACzB,UAAU,EACV,cAAc,EACd,kBAAkB,EAKnB;QACC,qCAAqC;QACrC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,CAAC;QAE9F,kCAAkC;QAClC,IAAG,CAAC,kBAAkB,EAAE,CAAC;YACvB,MAAM,IAAI,WAAW,CACnB,iDAAiD,EACjD,uBAAuB,EAAE,kBAAkB,CAC5C,CAAC;QACJ,CAAC;QAED,2EAA2E;QAC3E,gDAAgD;QAChD,+DAA+D;QAC/D,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAE7C,wEAAwE;QACxE,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,4BAA4B,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC;QAC7E,MAAM,IAAI,GAAG,kBAAkB;YAC7B,CAAC,CAAC,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,kBAAkB,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClF,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,WAAW,CACnB,kCAAkC,EAClC,SAAS,EAAE,kBAAkB,CAC9B,CAAC;QACJ,CAAC;QAED,yHAAyH;QACzH,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAElE,qDAAqD;QACrD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,WAAW,CACnB,oDAAoD,EACpD,uBAAuB,EAAE,kBAAkB,CAC5C,CAAC;QACJ,CAAC;QAED,2GAA2G;QAC3G,2BAA2B;QAC3B,MAAM,cAAc,GAAG,QAAQ,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,MAAM,WAAW,GAAG,iBAAiB,CAAC;QACtC,iDAAiD;QACjD,kDAAkD;QAClD,iEAAiE;QACjE,mEAAmE;QACnE,4DAA4D;QAC5D,uDAAuD;QACvD,iDAAiD;QACjD,MAAM,MAAM,GAAwB;YAClC,UAAU,EAAG;gBACX,8BAA8B;gBAC9B,0BAA0B;gBAC1B,mCAAmC;gBACnC,8BAA8B;aAC/B;YACD,WAAW;YACX,IAAI,EAAiB,oBAAoB;YACzC,kBAAkB,EAAG,MAAM;YAC3B,YAAY,EAAS,sBAAsB;YAC3C,UAAU,EAAW,cAAc,CAAC,EAAE;YACtC,gBAAgB,EAAK,OAAO;SAC7B,CAAC;QAEF,8GAA8G;QAC9G,uDAAuD;QACvD,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAEhE,8GAA8G;QAC9G,yFAAyF;QACzF,gCAAgC;QAChC,OAAO,MAAM,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAC3B,cAAc,EACd,SAAS,EACT,YAAY,EAKb;QACC,2CAA2C;QAC3C,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,oCAAoC;QACpC,IAAI,WAAoC,CAAC;QAEzC,gCAAgC;QAChC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,wDAAwD;YACxD,MAAM,aAAa,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;YAExF,8DAA8D;YAC9D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,WAAW,CAAC,qDAAqD,EAAE,oBAAoB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnH,CAAC;YAED,+CAA+C;YAC/C,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACrC,CAAC;QAED,0CAA0C;QAC1C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,kCAAkC;YAClC,gDAAgD;YAChD,4GAA4G;YAC5G,8CAA8C;YAC9C,+CAA+C;YAC/C,0GAA0G;YAC1G,+DAA+D;YAC/D,+CAA+C;YAC/C,0GAA0G;YAC1G,+DAA+D;YAC/D,YAAY;YACZ,2CAA2C;YAC3C,yDAAyD;YACzD,4DAA4D;YAC5D,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;QACvE,CAAC;QACD,IAAG,CAAC,WAAW,EAAE,CAAC;YAChB,MAAM,IAAI,WAAW,CACnB,sCAAsC,EACtC,oBAAoB,EAAE,EAAE,cAAc,EAAE,CACzC,CAAC;QACJ,CAAC;QAED,yBAAyB;QACzB,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,EAGT,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,eAAe,EAGhB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAoB,WAAW,EAAyB,MAAM,0BAA0B,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIpD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,MAAM;IACjB;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,SAAS,CACpB,cAAgC,EAChC,OAAyB,EACzB,eAAuB;QAEvB,0DAA0D;QAC1D,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,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;SACnF,CAAC;QAEF,4CAA4C;QAC5C,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,CAAC;YACH,4DAA4D;YAC5D,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qEAAqE;YACrE,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,qFAAqF;QACrF,cAAc,CAAC,UAAU,GAAG,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE7F,yBAAyB;QACzB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,GAAW,EACX,cAAmC,EACnC,kBAAyC,EACzC,SAAmB;QAEnB,mDAAmD;QACnD,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC;QACjD,mCAAmC;QACnC,MAAM,EAAE,GAAG,kBAAkB,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3E,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,eAAe,CAAC,aAAa,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QAE1E,yCAAyC;QACzC,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,6CAA6C;QAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAEhE,uDAAuD;QACvD,OAAO,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,aAA4B,EAC5B,MAAyB,EACzB,SAAmB,EACnB,OAAiC;QAEjC,4BAA4B;QAC5B,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAEtD,uBAAuB;QACvB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExE,yBAAyB;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/cjs/did-btcr2.js

@@ -1,5 +1,5 @@
 import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
-import { Canonicalization, IdentifierHrp, INVALID_DID_DOCUMENT, METHOD_NOT_SUPPORTED, MethodError, MISSING_UPDATE_DATA, ResolveError } from '@did-btcr2/common';
+import { IdentifierHrp, INVALID_DID_DOCUMENT, INVALID_DID_UPDATE, METHOD_NOT_SUPPORTED, MethodError, MISSING_UPDATE_DATA, ResolveError, UpdateError } from '@did-btcr2/common';
 import { Did, DidError, DidErrorCode, EMPTY_DID_RESOLUTION_RESULT } from '@web5/dids';
 import { initEccLib } from 'bitcoinjs-lib';
 import * as tinysecp from 'tiny-secp256k1';
@@ -8,9 +8,7 @@ import { Identifier } from './core/identifier.js';
 import { Resolve } from './core/resolve.js';
 import { Update } from './core/update.js';
 import { Appendix } from './utils/appendix.js';
-// TODO: convert to API driver
-export const canonicalization = new Canonicalization();
-// TODO: convert to API driver
+// TODO: convert to API driver?
 /** Initialize tiny secp256k1 */
 initEccLib(tinysecp);
 /**
@@ -27,7 +25,9 @@ initEccLib(tinysecp);
  * @implements {DidMethod}
  */
 export class DidBtcr2 {
-    /** @type {string} Name of the DID method, as defined in the DID BTCR2 specification */
+    /**
+     * Name of the DID method, as defined in the DID BTCR2 specification
+     */
     static methodName = 'btcr2';
     /**
      * Implements section {@link https://dcdpr.github.io/did-btcr2/operations/create.html | 7.1 Create}.
@@ -39,8 +39,13 @@ export class DidBtcr2 {
      * @param {string} options.network The Bitcoin network to use for the identifier, e.g. 'bitcoin', 'testnet', etc. Defaults to 'bitcoin'.
      * @returns {Promise<Btcr2Identifier>} Promise resolving to a Btcr2Identifier string.
      * @throws {MethodError} if any of the checks fail
+     * @example
+     * ```ts
+     * const genesisBytes = SchnorrKeyPair.generate().publicKey.compressed;
+     * const did = DidBtcr2.create(genesisBytes, { idType: 'KEY', network: 'regtest' });
+     * ```
      */
-    static async create(genesisBytes, options) {
+    static create(genesisBytes, options) {
         // Deconstruct the idType, version and network from the options, setting defaults if not given
         const { idType, version = 1, network = 'bitcoin' } = options || {};
         if (!idType) {
@@ -50,7 +55,7 @@ export class DidBtcr2 {
         return Identifier.encode({ idType, genesisBytes, version, network });
     }
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#read | 7.2 Resolve}.
+     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html | 7.2 Resolve}.
      * See specification for the {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process | Resolve Process}.
      * See {@link Resolve | Resolve (class)} for class implementation.
      *
@@ -59,31 +64,29 @@ export class DidBtcr2 {
      * blockchain by Authorized Beacon Signals. The Initial DID Document is either
      * deterministically created from the DID or provided by Sidecar Data.
      *
-     * @param {string} did a valid did:btcr2 identifier to be resolved
-     * @param {ResolutionOptions} resolutionOptions see {@link https://www.w3.org/TR/did-1.0/#did-resolution-options | ResolutionOptions}
-     * @param {number} resolutionOptions.versionId optional version of the identifier and/or DID document
-     * @param {number} resolutionOptions.versionTime optional timestamp used during resolution as a bound for when to stop resolving
-     * @param {DidDocument} resolutionOptions.sidecar optional data necessary for resolving a DID
+     * @param {string} did The did:btcr2 identifier to be resolved.
+     * @param {ResolutionOptions} resolutionOptions Options used during the resolution process.
      * @returns {Promise<DidResolutionResult>} Promise resolving to a DID Resolution Result containing the `targetDocument`
-     * @throws {Error} if the resolution fails for any reason
-     * @throws {DidError} InvalidDid if the identifier is invalid
+     * @throws {ResolveError} If the resolution process fails at any step.
      * @example
      * ```ts
      * const resolution = await DidBtcr2.resolve(
-     *  'did:btcr2:k1q0dygyp3gz969tp46dychzy4q78c2k3js68kvyr0shanzg67jnuez2cfplh'
+     *  'did:btcr2:k1qgpr45cheptyjekl3cex80xfnkwhxnlclecwwf92gvdjrszm2uwhzlcxu5xte'
      * )
      * ```
      */
-    static async resolve(did, resolutionOptions = { drivers: {} }) {
+    static async resolve(did, resolutionOptions = {}) {
         try {
+            // Set versionId from resolutionOptions
+            const versionId = resolutionOptions.versionId;
             // Initialize an empty DID Resolution Result
             const didResolutionResult = {
                 '@context': 'https://w3id.org/did-resolution/v1',
                 didResolutionMetadata: { contentType: 'application/ld+json' },
                 didDocumentMetadata: {
+                    versionId,
                     deactivated: false,
                     updated: undefined,
-                    versionId: resolutionOptions.versionId,
                     confirmations: undefined,
                 },
                 didDocument: null,
@@ -91,45 +94,49 @@ export class DidBtcr2 {
             // Decode the did to be resolved
             const didComponents = Identifier.decode(did);
             // Process sidecar if provided
-            const sidecarData = Resolve.processSidecarData(resolutionOptions.sidecar);
-            // Establish a connection to a bitcoin network
-            if (!resolutionOptions.drivers.bitcoin) {
-                resolutionOptions.drivers.bitcoin = new BitcoinNetworkConnection();
-                // Set the network based on the decoded identifier
-                resolutionOptions.drivers.bitcoin.setActiveNetwork(didComponents.network);
-            }
+            const sidecarData = Resolve.sidecarData(resolutionOptions.sidecar);
             // Parse the genesis document from the resolution options if provided
             const genesisDocument = resolutionOptions.sidecar?.genesisDocument;
             // Since genesisDocument is optional, check if it exists
             if (!genesisDocument) {
                 // If no genesisDocument and x HRP, throw MISSING_UPDATE_DATA error
                 if (didComponents.hrp === IdentifierHrp.x)
-                    throw new ResolveError('External resolution requires genesisDocument', MISSING_UPDATE_DATA, { resolutionOptions });
+                    throw new ResolveError('External resolution requires genesisDocument', MISSING_UPDATE_DATA, resolutionOptions);
             }
             // Establish the current document
-            const currentDocument = await Resolve.establishCurrentDocument(didComponents, genesisDocument);
+            const currentDocument = await Resolve.currentDocument(didComponents, genesisDocument);
             // Extract all Beacon services from the current DID Document
             const beaconServices = currentDocument.service
                 .filter(BeaconUtils.isBeaconService)
                 .map(BeaconUtils.parseBeaconServiceEndpoint);
+            // Check if bitcoin driver provided
+            if (!resolutionOptions?.drivers?.bitcoin) {
+                // If not, initialize default drivers
+                resolutionOptions.drivers = resolutionOptions.drivers || {};
+                // Set bitcoin driver to default BitcoinNetworkConnection
+                resolutionOptions.drivers.bitcoin = new BitcoinNetworkConnection();
+                // Set the network based on the decoded identifier
+                resolutionOptions.drivers.bitcoin.setActiveNetwork(didComponents.network);
+            }
+            // Get the bitcoin driver from the resolution options
+            const bitcoin = resolutionOptions.drivers.bitcoin;
             // Process the Beacon Signals to get the required updates
-            const unsortedUpdates = await Resolve.processBeaconSignals(beaconServices, sidecarData, resolutionOptions.drivers.bitcoin, resolutionOptions.fullBlockchainTraversal);
+            const unsortedUpdates = await Resolve.beaconSignals(beaconServices, sidecarData, bitcoin);
             // If no updates found, return the current document
             if (!unsortedUpdates.length) {
-                // Set the current document in the didResolutionResult
+                // Set the didDocument in didResolutionResult based on currentDocument
                 didResolutionResult.didDocument = currentDocument;
-                // Set the deactivated status in the didDocumentMetadata
+                // Set other required fields in the didResolutionResult
                 didResolutionResult.didDocumentMetadata.deactivated = !!currentDocument.deactivated;
+                didResolutionResult.didDocumentMetadata.versionId = versionId ?? '1';
                 // Return the didResolutionResult early
                 return didResolutionResult;
             }
             // Process the updates to apply updates to bring the current DID Document to its more current state
-            const result = await Resolve.processUpdatesArray(currentDocument, unsortedUpdates, resolutionOptions.versionTime, resolutionOptions.versionId);
+            const result = await Resolve.updates(currentDocument, unsortedUpdates, resolutionOptions.versionTime, versionId);
             // Set all of the required fields in the didResolutionResult
-            didResolutionResult.didDocument = result.currentDocument;
-            didResolutionResult.didDocumentMetadata.confirmations = result.confirmations;
-            didResolutionResult.didDocumentMetadata.versionId = result.versionId;
-            didResolutionResult.didDocumentMetadata.deactivated = !!result.currentDocument.deactivated;
+            didResolutionResult.didDocument = result.didDocument;
+            didResolutionResult.didDocumentMetadata = result.metadata;
             // Return didResolutionResult;
             return didResolutionResult;
         }
@@ -149,77 +156,79 @@ export class DidBtcr2 {
         }
     }
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#update | 4.3 Update}.
-     * See {@link Update} for implementation details.
-     *
-     * An update to a did:btcr2 document is an invoked capability using the ZCAP-LD data format, signed by a
-     * verificationMethod that has the authority to make the update as specified in the previous DID document. Capability
-     * invocations for updates MUST be authorized using Data Integrity following the bip340-jcs-2025
-     * cryptosuite with a proofPurpose of capabilityInvocation.
-     *
-     * The Update algorithm takes as inputs a Identifier, sourceDocument, sourceVersionId, documentPatch, a
-     * verificationMethodId and an array of beaconIds. The sourceDocument is the DID document being updated. The
-     * documentPatch is a JSON Patch object containing a set of transformations to be applied to the sourceDocument.
-     * The result of these transformations MUST produce a DID document conformant to the DID Core specification. The
-     * verificationMethodId is an identifier for a verificationMethod within the sourceDocument. The verificationMethod
-     * identified MUST be a BIP340 Multikey. The beaconIds MUST identify service endpoints with one of the three Beacon
-     * Types SingletonBeacon, CASBeacon, and SMTBeacon.
+     * 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.
      *
-     * @param {UpdateParams} params Required parameters for the update operation.
-     * @param {string} params.identifier The btcr2 identifier to be updated.
-     * @param {DidDocument} params.sourceDocument The DID document being updated.
-     * @param {string} params.sourceVersionId The versionId of the source document.
-     * @param {PatchOperation} params.documentPatch The JSON patch to be applied to the source document.
-     * @param {string} params.verificationMethodId The verificationMethod ID to sign the update
-     * @param {string[]} params.beaconIds The beacon IDs to announce the update
-     * @returns {Promise<void>} Promise resolving to void
-     * @throws {MethodError} if the verificationMethod type is not `Multikey` or the publicKeyMultibase header is not `zQ3s`
+     * 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.
+     * @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 {BitcoinNetworkConnection} [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`
      */
-    static async update(params) {
-        // Deconstruct the params
-        const { identifier, sourceDocument, sourceVersionId, patch, verificationMethodId: methodId, beaconIds, } = params;
-        // 1. Set unsignedUpdate to the result of passing Identifier, sourceDocument,
-        //    sourceVersionId, and documentPatch into the Construct DID Update
-        //    Payload algorithm.
-        const unsignedUpdate = await Update.construct({
-            identifier,
-            sourceDocument,
-            sourceVersionId,
-            patch,
-        });
-        // 2. Set verificationMethod to the result of retrieving the verificationMethod
-        //    from sourceDocument using the verificationMethodId.
-        const verificationMethod = this.getSigningMethod(sourceDocument, methodId);
+    static async update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }) {
+        // TODO: provide KMS as alternative
+        // 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'
+            ? Buffer.from(signingMaterial, 'hex')
+            : signingMaterial;
+        // 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);
+        }
+        // Get the verification method to be used for signing the update
+        const verificationMethod = this.getSigningMethod(sourceDocument, verificationMethodId);
         // Validate the verificationMethod exists in the sourceDocument
         if (!verificationMethod) {
-            throw new MethodError('Verification method not found in did document', INVALID_DID_DOCUMENT, sourceDocument);
+            throw new UpdateError('Invalid verificationMethod: not found in source document', INVALID_DID_DOCUMENT, { sourceDocument, verificationMethodId });
         }
-        // 3. Validate the verificationMethod is a BIP340 Multikey:
-        //    3.1 verificationMethod.type == Multikey
+        // Validate the verificationMethod is of type 'Multikey'
         if (verificationMethod.type !== 'Multikey') {
-            throw new MethodError('Invalid type: must be type "Multikey"', INVALID_DID_DOCUMENT, verificationMethod);
+            throw new UpdateError('Invalid verificationMethod: verificationMethod.type must be "Multikey"', INVALID_DID_DOCUMENT, verificationMethod);
+        }
+        // Validate the publicKeyMultibase prefix is 'zQ3s'
+        if (verificationMethod.publicKeyMultibase?.slice(0, 4) !== 'zQ3s') {
+            throw new UpdateError('Invalid verificationMethodId: publicKeyMultibase prefix must start with "zQ3s"', INVALID_DID_DOCUMENT, verificationMethod);
         }
-        //    3.2 verificationMethod.publicKeyMultibase[4] == zQ3s
-        const mbasePrefix = verificationMethod.publicKeyMultibase?.slice(0, 4);
-        if (mbasePrefix !== 'zQ3s') {
-            throw new MethodError(`Invalid publicKeyMultibase prefix ${mbasePrefix}`, INVALID_DID_DOCUMENT, verificationMethod);
+        // Construct an unsigned update following the BTCR2 Update construction algorithm
+        const update = await Update.construct(sourceDocument, patches, sourceVersionId);
+        // Sign the unsigned update using the specified verification method
+        const signed = await Update.sign(sourceDocument.id, update, verificationMethod, secretKey);
+        // Filter sourceDocument services to get beaconServices matching beaconIds
+        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 });
         }
-        // 4. Set didUpdateInvocation to the result of passing Identifier, unsignedUpdate as didUpdatePayload, and
-        //    verificationMethod to the Invoke DID Update Payload algorithm.
-        const signedUpdate = await Update.invoke({ identifier, verificationMethod, unsignedUpdate });
-        // 5. Set signalsMetadata to the result of passing Identifier, sourceDocument, beaconIds and didUpdateInvocation
-        //    to the Announce DID Update algorithm.
-        const signalsMetadata = await Update.announce({ sourceDocument, beaconIds, signedUpdate });
-        // 6. Return signalsMetadata. It is up to implementations to ensure that the signalsMetadata is persisted.
-        return signalsMetadata;
-        // TODO: Should we be applying the patch, producing a target did document and returning it?
+        // If no bitcoin network connection provided, initialize default
+        bitcoin ??= new BitcoinNetworkConnection();
+        // 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;
     }
     /**
      * Given the W3C DID Document of a `did:btcr2` identifier, return the signing verification method that will be used
      * for signing messages and credentials. If given, the `methodId` parameter is used to select the
      * verification method. If not given, the Identity Key's verification method with an ID fragment
      * of '#initialKey' is used.
-     * @param {DidDocument} didDocument The DID Document of the `did:btcr2` identifier.
+     * @param {Btcr2DidDocument} didDocument The DID Document of the `did:btcr2` identifier.
      * @param {string} [methodId] Optional verification method ID to be used for signing.
      * @returns {DidVerificationMethod} Promise resolving to the {@link DidVerificationMethod} object used for signing.
      * @throws {DidError} if the parsed did method does not match `btcr2` or signing method could not be determined.