@did-btcr2/method 0.19.0 → 0.20.0

package/dist/types/core/beacon/smt-beacon.d.ts

@@ -1,48 +1,36 @@
 import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
-import { HexString } from '@did-btcr2/common';
-import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { KeyBytes } from '@did-btcr2/common';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { SidecarData } from '../types.js';
-import { AggregateBeacon, BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
+import { Beacon } from './beacon.js';
+import { BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
 /**
- * TODO: Finish implementation
  * Implements {@link https://dcdpr.github.io/did-btcr2/terminology.html#smt-beacon | SMTBeacon}.
  * @class SMTBeacon
  * @type {SMTBeacon}
- * @extends {AggregateBeacon}
+ * @extends {Beacon}
  */
-export declare class SMTBeacon extends AggregateBeacon {
+export declare class SMTBeacon extends Beacon {
     /**
-     * Creates an instance of SingletonBeacon.
+     * Creates an instance of SMTBeacon.
      * @param {BeaconService} service The Beacon service.
-     * @param {Array<BeaconSignal>} signals The SingletonBeacon sidecar data.
-     * @param {SidecarData} sidecar The sidecar data.
      */
-    constructor(service: BeaconService, signals: Array<BeaconSignal>, sidecar: SidecarData, bitcoin?: BitcoinNetworkConnection);
+    constructor(service: BeaconService);
     /**
-     * Static, convenience method for establishing a SMTBeacon object.
-     * @param {string} service The Beacon service.
-     * @param {SidecarData} sidecar The sidecar data.
-     * @returns {SingletonBeacon} The Singleton Beacon.
+     * Implements {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-smt-beacon | 7.2.e.1 Process SMT Beacon}.
+     * @param {Array<BeaconSignal>} signals The array of Beacon Signals to process.
+     * @param {SidecarData} sidecar The sidecar data associated with the SMT Beacon.
+     * @returns {Promise<Array<[SignedBTCR2Update, BlockMetadata]>>} The processed signals.
+     * @throws {SMTBeaconError} if processing fails.
      */
-    static establish(service: BeaconService, signals: Array<BeaconSignal>, sidecar: SidecarData): SMTBeacon;
+    processSignals(signals: Array<BeaconSignal>, sidecar: SidecarData): Promise<Array<[SignedBTCR2Update, BlockMetadata]>>;
     /**
-     * TODO: Figure out if this is necessary or not.
-     * @param {HexString} updateHash The hash of the BTCR2 update to generate the signal for.
-     * @returns {BeaconSignal} The generated signal.
-     * @throws {MethodError} if the signal is invalid.
+     * Broadcast CAS Beacon signal to the Bitcoin network.
+     * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
+     * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
+     * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+     * @return {Promise<SignedBTCR2Update>} The signed update that was broadcasted.
+     * @throws {SMTBeaconError} if broadcasting fails.
      */
-    generateSignal(updateHash: HexString): BeaconSignal;
-    /**
-     * Process SMTBeacon signals.
-     * @returns {Promise<Array<BTCR2SignedUpdate>>} The processed signed update or undefined.
-     * @throws {MethodError} if the signal processing fails.
-     */
-    processSignals(): Promise<Array<[BTCR2SignedUpdate, BlockMetadata]>>;
-    /**
-     * Broadcast a SMTBeacon signal.
-     * @param {HexString} updateHash The hash of the BTCR2 update to broadcast.
-     * @returns {Promise<SignalsMetadata>} The result of the broadcast.
-     * @throws {MethodError} if the broadcast fails.
-     */
-    broadcastSignal(updateHash: HexString): Promise<HexString>;
+    broadcastSignal(signedUpdate: SignedBTCR2Update, secretKey: KeyBytes, bitcoin: BitcoinNetworkConnection): Promise<SignedBTCR2Update>;
 }

package/dist/types/core/beacon/smt-beacon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"smt-beacon.d.ts","sourceRoot":"","sources":["../../../../src/core/beacon/smt-beacon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAe,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE9F;;;;;;GAMG;AACH,qBAAa,SAAU,SAAQ,eAAe;IAC5C;;;;;OAKG;gBAED,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,EAC5B,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE,wBAAwB;IAKpC;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,WAAW,GAAG,SAAS;IAIvG;;;;;OAKG;IACH,cAAc,CAAC,UAAU,EAAE,SAAS,GAAG,YAAY;IAInD;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IAK1E;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;CAIjE"}
+{"version":3,"file":"smt-beacon.d.ts","sourceRoot":"","sources":["../../../../src/core/beacon/smt-beacon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE7E;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACnC;;;OAGG;gBACS,OAAO,EAAE,aAAa;IAIlC;;;;;;OAMG;IACH,cAAc,CACZ,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,EAC5B,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IAIrD;;;;;;;OAOG;IACG,eAAe,CACnB,YAAY,EAAE,iBAAiB,EAC/B,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,iBAAiB,CAAC;CAG9B"}

package/dist/types/core/beacon/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/core/beacon/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,QAAQ,EAAE,KAAK,EAAe,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAY,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAO/C;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,OAAO;IAiB1D;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,aAAa,EAAE;IAKnE;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC;IAelF;;;;;;;OAOG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa;IAqBpH;;;;;OAKG;IACH,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE;QACpE,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC1B,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,KAAK,CAAC,aAAa,CAAC;IAkCxB;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa;IAIvE;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC;IAQtF;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;CAG/D"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/core/beacon/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,QAAQ,EAAE,KAAK,EAAe,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAY,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAO/C;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,OAAO;IAc1D;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,aAAa,EAAE;IAKnE;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC;IAiBlF;;;;;;;OAOG;IACH,MAAM,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa;IAsBpH;;;;;OAKG;IACH,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE;QACpE,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC1B,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,KAAK,CAAC,aAAa,CAAC;IAoCxB;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa;IAIvE;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC;IAQtF;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;CAG/D"}

package/dist/types/core/interfaces.d.ts

@@ -38,16 +38,9 @@ export interface ResolutionOptions extends ResolutionOptionsCore {
     /**
      * Drivers for interacting with external systems, such as the Bitcoin network.
      */
-    drivers: {
+    drivers?: {
         bitcoin?: BitcoinNetworkConnection;
     };
-    /**
-     * Flag to signal a full blockchain search for beacon signals from genesis
-     * block to chain tip during resolution, instead of using an indexer.
-     * @type {boolean}
-     * @default false
-     */
-    fullBlockchainTraversal?: boolean;
 }
 /**
  * {@link https://dcdpr.github.io/did-btcr2/terminology.html#smt-proof | SMT Proof}

package/dist/types/core/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../src/core/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;IAC9D;;OAEG;IACH,OAAO,EAAE;QACP,OAAO,CAAC,EAAE,wBAAwB,CAAC;KACpC,CAAC;IAEF;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../src/core/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,wBAAwB,CAAC;KACpC,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB"}

package/dist/types/core/resolve.d.ts

@@ -1,7 +1,7 @@
 import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
-import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { DidDocument } from '../utils/did-document.js';
-import { BeaconService, BeaconSignal, BlockMetadata } from './beacon/interfaces.js';
+import { BeaconService, BlockMetadata } from './beacon/interfaces.js';
 import { DidComponents } from './identifier.js';
 import { Sidecar, SidecarData } from './types.js';
 /**
@@ -23,22 +23,6 @@ export interface DidResolutionResponse {
  * @type {Resolve}
  */
 export declare class Resolve {
-    /**
-     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-sidecar-data | Process Sidecar Data}
-     * @param {Sidecar} sidecar The sidecar data to process.
-     * @returns {SidecarData} The processed sidecar data containing maps of updates, CAS announcements, and SMT proofs.
-     */
-    static processSidecarData(sidecar?: Sidecar): SidecarData;
-    /**
-     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#establish-current-document | 7.2.d Establish current_document}.
-     * Resolution begins by creating an Initial Did Document called current_document (Current DID Document).
-     * The current_document is iteratively patched with BTCR2 Signed Updates announced by Authorized Beacon Signals.
-     * @param {DidComponents} didComponents The decoded components of the did.
-     * @param {GenesisDocument} genesisDocument The genesis document for resolving the DID Document.
-     * @returns {Promise<DidDocument>} The resolved DID Document object.
-     * @throws {DidError} if the DID hrp is invalid, no sidecarData passed and hrp = "x".
-     */
-    static establishCurrentDocument(didComponents: DidComponents, genesisDocument?: object): Promise<DidDocument>;
     /**
      * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#if-genesis_bytes-is-a-secp256k1-public-key | 7.2.d.1 if genesis bytes is a secp256k1 Public Key}.
      * @param {DidComponents} didComponents The decoded components of the did.
@@ -50,56 +34,56 @@ export declare class Resolve {
      * @param {DidComponents} didComponents BTCR2 DID components used to resolve the DID Document
      * @param {GenesisDocument} genesisDocument The genesis document for resolving the DID Document.
      * @returns {Promise<DidDocument>} The resolved DID Document object
-     * @throws {MethodError} InvalidDidDocument if not conformant to DID Core v1.1
+     * @throws {ResolveError} InvalidDidDocument if not conformant to DID Core v1.1
      */
     static external(didComponents: DidComponents, genesisDocument: object): Promise<DidDocument>;
+    /**
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-sidecar-data | Process Sidecar Data}
+     * @param {Sidecar} sidecar The sidecar data to process.
+     * @returns {ProcessedSidecar} The processed sidecar data containing maps of updates, CAS announcements, and SMT proofs.
+     */
+    static sidecarData(sidecar?: Sidecar): SidecarData;
+    /**
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#establish-current-document | 7.2.d Establish current_document}.
+     * Resolution begins by creating an Initial Did Document called current_document (Current DID Document).
+     * The current_document is iteratively patched with BTCR2 Signed Updates announced by Authorized Beacon Signals.
+     * @param {DidComponents} didComponents The decoded components of the did.
+     * @param {GenesisDocument} genesisDocument The genesis document for resolving the DID Document.
+     * @returns {Promise<DidDocument>} The resolved DID Document object.
+     * @throws {ResolveError} if the DID hrp is invalid, no sidecarData passed and hrp = "x".
+     */
+    static currentDocument(didComponents: DidComponents, genesisDocument?: object): Promise<DidDocument>;
     /**
      * Finds uses the beacon services in the currentDocument to scan for onchain Beacon Signals (transactions) containing
      * Signal Bytes (last output in OP_RETURN transaction).
      * @param {Array<BeaconService>} beaconServices The array of BeaconService objects to search for signals.
      * @param {SidecarData} sidecarData The sidecar data containing maps of updates, CAS announcements, and SMT proofs.
      * @param {BitcoinNetworkConnection} bitcoin The bitcoin network connection used to fetch beacon signals
-     * @param {boolean} [fullBlockchainTraversal=false] Whether to perform a full blockchain traversal or use an indexer
-     * @returns {Promise<Array<[BTCR2SignedUpdate, BlockMetadata]>>} The array of BTCR2 Signed Updates announced by the Beacon Signals.
+     * @returns {Promise<Array<[SignedBTCR2Update, BlockMetadata]>>} The array of BTCR2 Signed Updates announced by the Beacon Signals.
      */
-    static processBeaconSignals(beaconServices: Array<BeaconService>, sidecarData: SidecarData, bitcoin: BitcoinNetworkConnection, fullBlockchainTraversal?: boolean): Promise<Array<[BTCR2SignedUpdate, BlockMetadata]>>;
+    static beaconSignals(beaconServices: Array<BeaconService>, sidecarData: SidecarData, bitcoin: BitcoinNetworkConnection): Promise<Array<[SignedBTCR2Update, BlockMetadata]>>;
     /**
      * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-updates | 7.2.f Process updates Array}.
      * @param {DidDocument} currentDocument The current DID Document to apply the updates to.
-     * @param {Array<[BTCR2SignedUpdate, BlockMetadata]>} unsortedUpdates The unsorted array of BTCR2 Signed Updates and their associated Block Metadata.
+     * @param {Array<[SignedBTCR2Update, BlockMetadata]>} unsortedUpdates The unsorted array of BTCR2 Signed Updates and their associated Block Metadata.
      * @param {string} [versionTime] The optional version time to limit updates to.
      * @param {string} [versionId] The optional version id to limit updates to.
      * @returns {Promise<DidResolutionResponse>} The updated DID Document, number of confirmations, and version id.
      */
-    static processUpdatesArray(currentDocument: DidDocument, unsortedUpdates: Array<[BTCR2SignedUpdate, BlockMetadata]>, versionTime?: string, versionId?: string): Promise<DidResolutionResponse>;
-    /**
-     * Retrieves the beacon signals for the given array of BeaconService objects
-     * using a esplora/electrs REST API connection via a bitcoin I/O driver.
-     * @param {Array<BeaconService>} beaconServices Array of BeaconService objects to retrieve signals for
-     * @param {BitcoinNetworkConnection} bitcoin Bitcoin network connection to use for REST calls
-     * @returns {Promise<Array<BeaconSignal>>} Promise resolving to an array of BeaconSignal objects
-     */
-    static queryBlockchainIndexer(beaconServices: Array<BeaconService>, bitcoin: BitcoinNetworkConnection): Promise<Map<BeaconService, Array<BeaconSignal>>>;
-    /**
-     * Traverse the full blockchain from genesis to chain top looking for beacon signals.
-     * @param {Array<BeaconService>} beaconServices Array of BeaconService objects to search for signals.
-     * @param {BitcoinNetworkConnection} bitcoin Bitcoin network connection to use for RPC calls.
-     * @returns {Promise<Array<BeaconSignal>>} Promise resolving to an array of BeaconSignal objects.
-     */
-    static traverseFullBlockchain(beaconServices: Array<BeaconService>, bitcoin: BitcoinNetworkConnection): Promise<Map<BeaconService, Array<BeaconSignal>>>;
+    static updates(currentDocument: DidDocument, unsortedUpdates: Array<[SignedBTCR2Update, BlockMetadata]>, versionTime?: string, versionId?: string): Promise<DidResolutionResponse>;
     /**
      * Implements subsection {@link https://dcdpr.github.io/did-btcr2/#confirm-duplicate-update | 7.2.f.1 Confirm Duplicate Update}.
      * This step confirms that an update with a lower-than-expected targetVersionId is a true duplicate.
-     * @param {BTCR2SignedUpdate} update The BTCR2 Signed Update to confirm as a duplicate.
+     * @param {SignedBTCR2Update} update The BTCR2 Signed Update to confirm as a duplicate.
      * @returns {void} Does not return a value, but throws an error if the update is not a valid duplicate.
      */
-    static confirmDuplicateUpdate(update: BTCR2SignedUpdate, updateHashHistory: string[]): void;
+    static confirmDuplicate(update: SignedBTCR2Update, updateHashHistory: string[]): void;
     /**
      * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#apply-update | 7.2.f.3 Apply Update}.
      * @param {DidDocument} currentDocument The current DID Document to apply the update to.
-     * @param {BTCR2SignedUpdate} update The BTCR2 Signed Update to apply.
+     * @param {SignedBTCR2Update} update The BTCR2 Signed Update to apply.
      * @returns {Promise<DidDocument>} The updated DID Document after applying the update.
      * @throws {ResolveError} If the update is invalid or cannot be applied.
      */
-    static applyDidUpdate(currentDocument: DidDocument, update: BTCR2SignedUpdate): Promise<DidDocument>;
+    static applyUpdate(currentDocument: DidDocument, update: SignedBTCR2Update): Promise<DidDocument>;
 }

package/dist/types/core/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../../src/core/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EAMzB,MAAM,oBAAoB,CAAC;AAc5B,OAAO,EAGL,iBAAiB,EAGlB,MAAM,wBAAwB,CAAC;AAKhC,OAAO,EAAE,WAAW,EAAwB,MAAM,0BAA0B,CAAC;AAE7E,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEpF,OAAO,EAAE,aAAa,EAAc,MAAM,iBAAiB,CAAC;AAE5D,OAAO,EAAmB,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,eAAe,EAAE,WAAW,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,qBAAa,OAAO;IAClB;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,OAAO,GAAE,OAAuB,GAAG,WAAW;IAyBxE;;;;;;;;OAQG;WACU,wBAAwB,CACnC,aAAa,EAAE,aAAa,EAC5B,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,WAAW,CAAC;IA+BvB;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,WAAW;IA+B/D;;;;;;OAMG;WACU,QAAQ,CACnB,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,WAAW,CAAC;IA2BvB;;;;;;;;OAQG;WACU,oBAAoB,CAC/B,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,EACpC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,wBAAwB,EACjC,uBAAuB,CAAC,EAAE,OAAO,GAChC,OAAO,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IAuBrD;;;;;;;OAOG;WACU,mBAAmB,CAC9B,eAAe,EAAE,WAAW,EAC5B,eAAe,EAAE,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,EAC1D,WAAW,CAAC,EAAE,MAAM,EACpB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,qBAAqB,CAAC;IAmGjC;;;;;;OAMG;WACU,sBAAsB,CACjC,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,EACpC,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAyEnD;;;;;OAKG;WACU,sBAAsB,CACjC,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,EACpC,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IA0InD;;;;;OAKG;IACH,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,IAAI;IAmB3F;;;;;;OAMG;WACU,cAAc,CACzB,eAAe,EAAE,WAAW,EAC5B,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,WAAW,CAAC;CAsFxB"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../../src/core/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EAEzB,MAAM,oBAAoB,CAAC;AAa5B,OAAO,EAIL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAKhC,OAAO,EAAE,WAAW,EAAwB,MAAM,0BAA0B,CAAC;AAE7E,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGtE,OAAO,EAAE,aAAa,EAAc,MAAM,iBAAiB,CAAC;AAE5D,OAAO,EAAmB,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,eAAe,EAAE,WAAW,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,qBAAa,OAAO;IAClB;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,WAAW;IA+B/D;;;;;;OAMG;WACU,QAAQ,CACnB,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,WAAW,CAAC;IA2BvB;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,GAAE,OAAuB,GAAG,WAAW;IAyBjE;;;;;;;;OAQG;WAEU,eAAe,CAC1B,aAAa,EAAE,aAAa,EAC5B,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,WAAW,CAAC;IA+BvB;;;;;;;OAOG;WACU,aAAa,CACxB,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,EACpC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IAmBrD;;;;;;;OAOG;WACU,OAAO,CAClB,eAAe,EAAE,WAAW,EAC5B,eAAe,EAAE,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,EAC1D,WAAW,CAAC,EAAE,MAAM,EACpB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,qBAAqB,CAAC;IAmGjC;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,IAAI;IAmBrF;;;;;;OAMG;WACU,WAAW,CACtB,eAAe,EAAE,WAAW,EAC5B,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,WAAW,CAAC;CAiFxB"}

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

@@ -1,5 +1,5 @@
 import { HexString } from '@did-btcr2/common';
-import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { SMTProof } from './interfaces.js';
 /**
  * {@link https://dcdpr.github.io/did-btcr2/data-structures.html#cas-announcement | CAS Announcement }
@@ -37,7 +37,7 @@ export type Sidecar = {
      * Optional array of BTCR2 Signed Updates. Required if the DID being resolved
      * has ever had a published BTCR2 Update.
      */
-    updates?: Array<BTCR2SignedUpdate>;
+    updates?: Array<SignedBTCR2Update>;
     /**
      * Optional array of CAS Announcements. Required if the DID being reslved has
      * used a CAS Beacon to publish a BTCR2 Update.
@@ -49,23 +49,36 @@ export type Sidecar = {
      */
     smtProofs?: Array<SMTProof>;
 };
+/**
+ * The Sidecar data structure used for Singleton Beacons.
+ */
+export type SingletonBeaconSidecarData = Map<HexString, SignedBTCR2Update>;
+/**
+ * The Sidecar data structure used for CAS Beacons.
+ */
+export type CASBeaconSidecarData = Map<HexString, CASAnnouncement>;
+/**
+ * The Sidecar data structure used for SMT Beacons.
+ */
+export type SMTBeaconSidecarData = Map<string, SMTProof>;
 /**
  * The Sidecar data structure post-processing used for resolution.
  */
 export type SidecarData = {
     /**
      * Map of BTCR2 Signed Updates by their hash bytes.
-     * @type {Map<HexString, BTCR2SignedUpdate>}
      */
-    updateMap: Map<HexString, BTCR2SignedUpdate>;
+    updateMap: SingletonBeaconSidecarData;
     /**
      * Map of CAS Announcements by their hash bytes.
-     * @type {Map<HexString, CASAnnouncement>}
      */
-    casMap: Map<HexString, CASAnnouncement>;
+    casMap: CASBeaconSidecarData;
     /**
      * Map of SMT Proofs by their ID.
-     * @type {Map<string, SMTProof>}
      */
-    smtMap: Map<string, SMTProof>;
+    smtMap: SMTBeaconSidecarData;
 };
+/**
+ * Union type for all Beacon Sidecar data structures.
+ */
+export type BeaconSidecarData = SingletonBeaconSidecarData | CASBeaconSidecarData | SMTBeaconSidecarData;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IAC7C;;;OAGG;IACH,MAAM,EAAE,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IACxC;;;OAGG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CAC/B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;AAC3E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;AACnE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,0BAA0B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,0BAA0B,GAAG,oBAAoB,GAAG,oBAAoB,CAAC"}

package/dist/types/core/update.d.ts

@@ -1,24 +1,10 @@
-import { PatchOperation } from '@did-btcr2/common';
-import { BTCR2SignedUpdate, BTCR2UnsignedUpdate } from '@did-btcr2/cryptosuite';
-import { DidDocument, DidVerificationMethod } from '../utils/did-document.js';
-import { SidecarData } from './types.js';
-export interface ConstructUpdateParams {
-    identifier: string;
-    sourceDocument: DidDocument;
-    sourceVersionId: number;
-    patch: PatchOperation[];
-}
-export interface UpdateParams extends ConstructUpdateParams {
-    verificationMethodId: string;
-    beaconIds: string[];
-}
-export type InvokePayloadParams = {
-    identifier: string;
-    BTCR2SignedUpdate: BTCR2SignedUpdate;
-    verificationMethod: DidVerificationMethod;
-};
+import { KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { SignedBTCR2Update, UnsignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import { Btcr2DidDocument, DidVerificationMethod } from '../utils/did-document.js';
+import { BeaconService } from './beacon/interfaces.js';
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
 /**
- * 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
@@ -31,64 +17,35 @@ export type InvokePayloadParams = {
  */
 export declare class Update {
     /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#construct-did-update-payload | 4.3.1 Construct DID Update Payload}.
-     *
-     * 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.
+     * 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.
      *
-     * @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 construct({ identifier, sourceDocument, sourceVersionId, patch, }: {
-        identifier: string;
-        sourceDocument: DidDocument;
-        sourceVersionId: number;
-        patch: PatchOperation[];
-    }): Promise<BTCR2UnsignedUpdate>;
+    static construct(sourceDocument: Btcr2DidDocument, patches: PatchOperation[], sourceVersionId: number): Promise<UnsignedBTCR2Update>;
     /**
-     * {@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 invoke({ identifier, unsignedUpdate, verificationMethod }: {
-        identifier: string;
-        unsignedUpdate: BTCR2UnsignedUpdate;
-        verificationMethod: DidVerificationMethod;
-    }): Promise<BTCR2SignedUpdate>;
+    static sign(did: string, unsignedUpdate: UnsignedBTCR2Update, verificationMethod: DidVerificationMethod, secretKey: KeyBytes): Promise<SignedBTCR2Update>;
     /**
-     * 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 announce({ sourceDocument, beaconIds, signedUpdate }: {
-        sourceDocument: DidDocument;
-        beaconIds: string[];
-        signedUpdate: BTCR2SignedUpdate;
-    }): Promise<SidecarData>;
+    static announce(beaconService: BeaconService, update: SignedBTCR2Update, secretKey: KeyBytes, bitcoin: BitcoinNetworkConnection): Promise<SignedBTCR2Update>;
 }

package/dist/types/core/update.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAwC,MAAM,wBAAwB,CAAC;AAMtH,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAG9E,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,qBAAqB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,WAAW,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAa,SAAQ,qBAAqB;IACvD,oBAAoB,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,kBAAkB,EAAE,qBAAqB,CAAC;CAC3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAAC,EAC5B,UAAU,EACV,cAAc,EACd,eAAe,EACf,KAAK,GACN,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,WAAW,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,KAAK,EAAE,cAAc,EAAE,CAAC;KACzB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiDhC;;;;;;;;;;;;;;OAcG;WACiB,MAAM,CAAC,EACzB,UAAU,EACV,cAAc,EACd,kBAAkB,EACnB,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,mBAAmB,CAAC;QACpC,kBAAkB,EAAE,qBAAqB,CAAC;KAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA6E9B;;;;;;;;;;;;;;OAcG;WACiB,QAAQ,CAAC,EAC3B,cAAc,EACd,SAAS,EACT,YAAY,EACb,EAAE;QACD,cAAc,EAAE,WAAW,CAAC;QAC5B,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,YAAY,EAAE,iBAAiB,CAAC;KACjC,GAAG,OAAO,CAAC,WAAW,CAAC;CAiDzB"}
+{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,EACR,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAGL,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,gBAAgB,EAAe,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEhG,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB;;;;;;;;;OASG;WACU,SAAS,CACpB,cAAc,EAAE,gBAAgB,EAChC,OAAO,EAAE,cAAc,EAAE,EACzB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,mBAAmB,CAAC;IAoC/B;;;;;;;;;OASG;WACU,IAAI,CACf,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,mBAAmB,EACnC,kBAAkB,EAAE,qBAAqB,EACzC,SAAS,EAAE,QAAQ,GAClB,OAAO,CAAC,iBAAiB,CAAC;IAgC7B;;;;;;;;OAQG;WACU,QAAQ,CACnB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,iBAAiB,CAAC;CAU9B"}

package/dist/types/did-btcr2.d.ts

@@ -1,8 +1,9 @@
-import { Canonicalization, DocumentBytes, KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { Canonicalization, DocumentBytes, HexString, KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { DidMethod, DidResolutionResult } from '@web5/dids';
 import { ResolutionOptions } from './core/interfaces.js';
-import { SidecarData } from './core/types.js';
-import { DidDocument, DidVerificationMethod } from './utils/did-document.js';
+import { Btcr2DidDocument, DidVerificationMethod } from './utils/did-document.js';
 export declare const canonicalization: Canonicalization;
 export type Btcr2Identifier = string;
 export interface DidCreateOptions {
@@ -27,7 +28,9 @@ export interface DidCreateOptions {
  * @implements {DidMethod}
  */
 export declare class DidBtcr2 implements DidMethod {
-    /** @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: string;
     /**
      * Implements section {@link https://dcdpr.github.io/did-btcr2/operations/create.html | 7.1 Create}.
@@ -42,7 +45,7 @@ export declare class DidBtcr2 implements DidMethod {
      */
     static create(genesisBytes: KeyBytes | DocumentBytes, options?: DidCreateOptions): Promise<Btcr2Identifier>;
     /**
-     * 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.
      *
@@ -51,14 +54,10 @@ export declare class DidBtcr2 implements DidMethod {
      * 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(
@@ -68,49 +67,43 @@ export declare class DidBtcr2 implements DidMethod {
      */
     static resolve(did: string, resolutionOptions?: ResolutionOptions): Promise<DidResolutionResult>;
     /**
-     * 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 update(params: {
-        identifier: string;
-        sourceDocument: DidDocument;
+    static update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }: {
+        sourceDocument: Btcr2DidDocument;
+        patches: PatchOperation[];
         sourceVersionId: number;
-        patch: PatchOperation[];
         verificationMethodId: string;
-        beaconIds: string[];
-    }): Promise<SidecarData>;
+        beaconId: string;
+        signingMaterial?: KeyBytes | HexString;
+        bitcoin?: BitcoinNetworkConnection;
+    }): Promise<SignedBTCR2Update>;
     /**
      * 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.
      */
-    static getSigningMethod(didDocument: DidDocument, methodId?: string): DidVerificationMethod;
+    static getSigningMethod(didDocument: Btcr2DidDocument, methodId?: string): DidVerificationMethod;
 }

package/dist/types/did-btcr2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"did-btcr2.d.ts","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,aAAa,EAGb,QAAQ,EAIR,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAIL,SAAS,EACT,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAG7E,eAAO,MAAM,gBAAgB,kBAAyB,CAAC;AAEvD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,KAAK,GAAG,UAAU,CAAC;IAC3B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC,uFAAuF;IACvF,MAAM,CAAC,UAAU,EAAE,MAAM,CAAW;IAEpC;;;;;;;;;;OAUG;WACU,MAAM,CACjB,YAAY,EAAE,QAAQ,GAAG,aAAa,EACtC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,eAAe,CAAC;IAe3B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,iBAAiB,GAAE,iBAAiC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqGrH;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CAAC,MAAM,EAAE;QACjC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,WAAW,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,KAAK,EAAE,cAAc,EAAE,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;KACrB,GAAG,OAAO,CAAC,WAAW,CAAC;IAuDxB;;;;;;;;;OASG;WACW,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAG,QAAQ,CAAC,EAAE,MAAM,GAAG,qBAAqB;CA0BpG"}
+{"version":3,"file":"did-btcr2.d.ts","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,SAAS,EAIT,QAAQ,EAIR,cAAc,EAGf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAIL,SAAS,EACT,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAMpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAIzD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGlF,eAAO,MAAM,gBAAgB,kBAAyB,CAAC;AAEvD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,KAAK,GAAG,UAAU,CAAC;IAC3B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAW;IAEpC;;;;;;;;;;OAUG;WACU,MAAM,CACjB,YAAY,EAAE,QAAQ,GAAG,aAAa,EACtC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,eAAe,CAAC;IAe3B;;;;;;;;;;;;;;;;;;;;OAoBG;WACU,OAAO,CAClB,GAAG,EAAE,MAAM,EACX,iBAAiB,GAAE,iBAAmC,GACrD,OAAO,CAAC,mBAAmB,CAAC;IA0G/B;;;;;;;;;;;;;;;;;;;OAmBG;WACU,MAAM,CAAC,EAClB,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,OAAO,GACR,EAAE;QACD,cAAc,EAAE,gBAAgB,CAAC;QACjC,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,eAAe,EAAE,MAAM,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QACvC,OAAO,CAAC,EAAE,wBAAwB,CAAC;KACpC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+E9B;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,EAAG,QAAQ,CAAC,EAAE,MAAM,GAAG,qBAAqB;CA0BlG"}