@did-btcr2/method 0.18.1 → 0.19.0

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":"AAAA,OAAO,EAAkB,QAAQ,EAAE,KAAK,EAAe,MAAM,mBAAmB,CAAC;AAEjF,OAAO,EAAE,QAAQ,EAAY,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAEjF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAA;IACzB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;;;OAKG;WACW,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAOtD;;;;OAIG;WACW,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,OAAO;IAiBjE;;;;;OAKG;WACW,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,aAAa,EAAE;IAO1E;;;;;;;OAOG;WACW,uBAAuB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE;QACxE,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;KAC3B,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAmBxB;;;;;;;;;OASG;WACW,qBAAqB,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QACzF,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC1B,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;QACzC,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,aAAa;IAajB;;;;OAIG;WACW,2BAA2B,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QAC/F,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC1B,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;QACzC,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,aAAa;IAiBjB;;;;;;;OAOG;WACW,sBAAsB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;QAC7E,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,KAAK,CAAC,aAAa,CAAC;IAexB;;;;;;;;;OASG;WACW,cAAc,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;QACrE,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,aAAa;IAiBjB;;;;;;;OAOG;WACW,iBAAiB,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa;IAIrE;;;;OAIG;WACW,sBAAsB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,oBAAoB,CAAC;IAIhG;;;;OAIG;WACW,0BAA0B,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAK1G;;;;OAIG;WACW,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;CAGtE"}
+{"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"}

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

@@ -1 +1 @@
-{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../../../src/core/identifier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,EAAmE,MAAM,mBAAmB,CAAC;AAChI,OAAO,EAAgC,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGlF;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,KAAK,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,UAAU;IACrB;;;;;;;;;;;;;;;;OAgBG;WACW,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE;QAC/D,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,KAAK,CAAC;KACrB,GAAG,MAAM;IAuFV;;;;;;;OAOG;WACW,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IA8HvD;;;OAGG;WACW,QAAQ,IAAI;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,UAAU,EAAE;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE;IAYlG;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;CAQ5C"}
+{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../../../src/core/identifier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,EAAuE,MAAM,mBAAmB,CAAC;AACpI,OAAO,EAAgC,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGlF;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,KAAK,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,UAAU;IACrB;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE;QACxD,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,KAAK,CAAC;KACrB,GAAG,MAAM;IAoFV;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IA8HhD;;;OAGG;IACH,MAAM,CAAC,QAAQ,IAAI;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,UAAU,EAAE;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE;IAY3F;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;CAQ5C"}

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

@@ -0,0 +1,94 @@
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { DidResolutionOptions } from '@web5/dids';
+import { Sidecar } from './types.js';
+export interface RootCapability {
+    '@context': string;
+    id: string;
+    controller: string;
+    invocationTarget: string;
+}
+/**
+ * See {@link https://dcdpr.github.io/did-btcr2/data-structures.html#resolution-options-example-panel-show | Resolution Options}
+ * for data structure details.
+ */
+export interface ResolutionOptionsCore extends DidResolutionOptions {
+    /**
+     * Optional ASCII string representation of the specific version of a DID document
+     * to be resolved.
+     */
+    versionId?: string;
+    /**
+     * Optional XML Datetime normalized to UTC without sub-second decimal precision.
+     * The DID document to be resolved is the most recent version of the DID document
+     * that was valid for the DID before the specified versionTime.
+     */
+    versionTime?: string;
+    /**
+     * Data transmitted via {@link https://dcdpr.github.io/did-btcr2/data-structures.html#sidecar-data-example-panel-show | Sidecar (data structure)}.
+     * Includes Singleton beacon updates, CAS announcements, and SMT proofs.
+     */
+    sidecar?: Sidecar;
+}
+/**
+ * Full set of resolution options for the did:btcr2 method. See {@link ResolutionOptionsCore}
+ * for the resolution options defined by the specification.
+ * @extends ResolutionOptionsCore
+ */
+export interface ResolutionOptions extends ResolutionOptionsCore {
+    /**
+     * Drivers for interacting with external systems, such as the Bitcoin network.
+     */
+    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}
+ * a set of SHA-256 hashes for nodes in a Sparse Merkle Tree that together form
+ * a path from a leaf in the tree to the Merkle root, proving that the leaf is in the tree.
+ * See {@link https://dcdpr.github.io/did-btcr2/data-structures.html#smt-proof | SMT Proof (data structure)}.
+ *
+ * @example
+ * ```json
+ * {
+ *   "id": "<< Hexadecimal of Root Hash >>",
+ *   "nonce": "<< Hexadecimal of Nonce 1101 >>",
+ *   "updateId": "<< Hexadecimal of hash(Data Block 1101) >>",
+ *   "collapsed": "<< Hexadecimal of 0001 >>",
+ *   "hashes": [
+ *     "<< Hexadecimal of Hash 1110 >>",
+ *     "<< Hexadecimal of Hash 1001 >>",
+ *     "<< Hexadecimal of Hash 0 >>"
+ *   ]
+ * }
+ * ```
+ */
+export interface SMTProof {
+    /**
+     * The SHA-256 hash of the root node of the Sparse Merkle Tree.
+     */
+    id: string;
+    /**
+     * Optional 256-bit nonce generated for each update. MUST be encoded as a string using the "base64url" [RFC4648] encoding.
+     */
+    nonce?: string;
+    /**
+     * Optional BTCR2 Signed Update (data structure) hashed with the JSON Document Hashing algorithm.
+     */
+    updateId?: string;
+    /**
+     * Bitmap of zero nodes within the path (see: collapsed leaves).
+     */
+    collapsed: string;
+    /**
+     * Array of SHA-256 hashes representing the sibling SMT nodes from the leaf, containing the SHA-256 hash of the BTCR2 Signed Update or the “zero identity”, to the root.
+     */
+    hashes: string[];
+}

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

@@ -0,0 +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"}

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

@@ -0,0 +1,105 @@
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { DidDocument } from '../utils/did-document.js';
+import { BeaconService, BeaconSignal, BlockMetadata } from './beacon/interfaces.js';
+import { DidComponents } from './identifier.js';
+import { Sidecar, SidecarData } from './types.js';
+/**
+ * The response object for DID Resolution.
+ */
+export interface DidResolutionResponse {
+    currentDocument: DidDocument;
+    confirmations: number;
+    versionId: string;
+    updated: string;
+}
+/**
+ * Implements {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html | 7.2 Resolve}.
+ * Resolving a did:btcr2 identifier iteratively builds a DID document by applying BTCR2 Updates
+ * to an Initial DID Document that have been committed to the Bitcoin blockchain by Authorized
+ * Beacon Signals. The Initial DID Document is either deterministically created from the DID or
+ * provided by Sidecar Data.
+ * @class Resolve
+ * @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.
+     * @returns {DidDocument} The resolved DID Document object.
+     */
+    static deterministic(didComponents: DidComponents): DidDocument;
+    /**
+     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#if-genesis_bytes-is-a-sha-256-hash | 7.2.d.2 if genesis_bytes is a SHA-256 Hash}.
+     * @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
+     */
+    static external(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.
+     */
+    static processBeaconSignals(beaconServices: Array<BeaconService>, sidecarData: SidecarData, bitcoin: BitcoinNetworkConnection, fullBlockchainTraversal?: boolean): Promise<Array<[BTCR2SignedUpdate, 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 {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>>>;
+    /**
+     * 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.
+     * @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;
+    /**
+     * 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.
+     * @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>;
+}

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

@@ -0,0 +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"}

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

@@ -0,0 +1,71 @@
+import { HexString } from '@did-btcr2/common';
+import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { SMTProof } from './interfaces.js';
+/**
+ * {@link https://dcdpr.github.io/did-btcr2/data-structures.html#cas-announcement | CAS Announcement }
+ * a data structure that maps DIDs to BTCR2 Signed Update hashes. All BTCR2 Signed
+ * Updates (data structure) MUST be hashed with the JSON Document Hashing algorithm.
+ * The concrete representation of this data structure will be published to a CAS.
+ * @example
+ * ```json
+ * {
+ *   "did:btcr2:k1q5pa5tq86fzrl0ez32nh8e0ks4tzzkxnnmn8tdvxk04ahzt70u09dag02h0cp": "a4ayc_80_OGda4BO_1o_V0etpOqiLx1JwB5S3beHW0s",
+ *   "did:btcr2:x1qhjw6jnhwcyu5wau4x0cpwvz74c3g82c3uaehqpaf7lzfgmnwsd7spmmf54": "1HNeOiZeFu7gP1lxi5tdAwGcB9i2xR-Q2jpmbuwTqzU",
+ *   "did:btcr2:k1qgp5h79scv4sfqkzak5g6y89dsy3cq0pd2nussu2cm3zjfhn4ekwrucc4q7t7": "TgdAhWK-24tgzgXB3s_jrRa3IjCWfeAfZAt-Rym0n84"
+ * }
+ * ```
+ */
+export type CASAnnouncement = {
+    [key: string]: string;
+};
+/**
+ * See {@link https://dcdpr.github.io/did-btcr2/terminology.html#sidecar | Sidecar }
+ * for more details about the sidecar mechanism. See {@link https://dcdpr.github.io/did-btcr2/data-structures.html#sidecar-data | Sidecar Data}
+ * for more details about the data structure.
+ */
+export type Sidecar = {
+    /**
+     * The context string "https://btcr2.dev/context/v1"
+     */
+    '@context'?: string;
+    /**
+     * Optional Genesis Did Document. Required when resolving did:btcr2 identifiers
+     * with `x` HRP.D
+     */
+    genesisDocument?: object;
+    /**
+     * Optional array of BTCR2 Signed Updates. Required if the DID being resolved
+     * has ever had a published BTCR2 Update.
+     */
+    updates?: Array<BTCR2SignedUpdate>;
+    /**
+     * Optional array of CAS Announcements. Required if the DID being reslved has
+     * used a CAS Beacon to publish a BTCR2 Update.
+     */
+    casUpdates?: Array<CASAnnouncement>;
+    /**
+     * Optional array of SMT Proofs. Required if the DID being resolved has used
+     * an SMT Beacon to publish a BTCR2 Update.
+     */
+    smtProofs?: Array<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>;
+    /**
+     * Map of CAS Announcements by their hash bytes.
+     * @type {Map<HexString, CASAnnouncement>}
+     */
+    casMap: Map<HexString, CASAnnouncement>;
+    /**
+     * Map of SMT Proofs by their ID.
+     * @type {Map<string, SMTProof>}
+     */
+    smtMap: Map<string, SMTProof>;
+};

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

@@ -0,0 +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"}

package/dist/types/core/{crud/update.d.ts → update.d.ts}

@@ -1,6 +1,7 @@
-import { DidUpdateInvocation, DidUpdatePayload, PatchOperation } from '@did-btcr2/common';
-import { DidDocument, DidVerificationMethod } from '../../utils/did-document.js';
-import { SignalsMetadata } from '../../utils/types.js';
+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;
@@ -13,7 +14,7 @@ export interface UpdateParams extends ConstructUpdateParams {
 }
 export type InvokePayloadParams = {
     identifier: string;
-    didUpdatePayload: DidUpdatePayload;
+    BTCR2SignedUpdate: BTCR2SignedUpdate;
     verificationMethod: DidVerificationMethod;
 };
 /**
@@ -41,7 +42,7 @@ export declare class Update {
      * @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<DidUpdatePayload>} The constructed DidUpdatePayload object.
+     * @returns {Promise<BTCR2SignedUpdate>} The constructed BTCR2SignedUpdate object.
      * @throws {MethodError} InvalidDid if sourceDocument.id does not match identifier.
      */
     static construct({ identifier, sourceDocument, sourceVersionId, patch, }: {
@@ -49,45 +50,45 @@ export declare class Update {
         sourceDocument: DidDocument;
         sourceVersionId: number;
         patch: PatchOperation[];
-    }): Promise<DidUpdatePayload>;
+    }): Promise<BTCR2UnsignedUpdate>;
     /**
      * {@link https://dcdpr.github.io/did-btcr2/#invoke-did-update-payload | 4.3.2 Invoke DID Update Payload}.
      *
-     * The Invoke DID Update Payload algorithm takes in a Identifier, an unsigned didUpdatePayload, and a
+     * 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 {DidUpdatePayload} params.didUpdatePayload The updatePayload object to be signed
+     * @param {BTCR2SignedUpdate} params.BTCR2SignedUpdate The updatePayload object to be signed
      * @param {DidVerificationMethod} params.verificationMethod The verificationMethod object to be used for signing
-     * @returns {DidUpdateInvocation} Did update payload secured with a proof => DidUpdateInvocation
+     * @returns {BTCR2SignedUpdate} Did update payload secured with a proof => BTCR2SignedUpdate
      * @throws {MethodError} if the privateKeyBytes are invalid
      */
-    static invoke({ identifier, didUpdatePayload, verificationMethod }: {
+    static invoke({ identifier, unsignedUpdate, verificationMethod }: {
         identifier: string;
-        didUpdatePayload: DidUpdatePayload;
+        unsignedUpdate: BTCR2UnsignedUpdate;
         verificationMethod: DidVerificationMethod;
-    }): Promise<DidUpdateInvocation>;
+    }): Promise<BTCR2SignedUpdate>;
     /**
      * 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 didUpdateInvocation. It returns an array of signalsMetadata, containing the necessary
-     * data to validate the Beacon Signal against the didUpdateInvocation.
+     * 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 didUpdatePayload object to be signed
-     * @param {DidUpdateInvocation} params.didUpdatePayload The verificationMethod object to be used for signing
-     * @returns {SignalsMetadata} The signalsMetadata object containing data to validate the Beacon Signal
+     * @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
      */
-    static announce({ sourceDocument, beaconIds, didUpdateInvocation }: {
+    static announce({ sourceDocument, beaconIds, signedUpdate }: {
         sourceDocument: DidDocument;
         beaconIds: string[];
-        didUpdateInvocation: DidUpdateInvocation;
-    }): Promise<SignalsMetadata>;
+        signedUpdate: BTCR2SignedUpdate;
+    }): Promise<SidecarData>;
 }

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

@@ -0,0 +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"}

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

@@ -1,11 +1,13 @@
-import { DocumentBytes, KeyBytes, PatchOperation } from '@did-btcr2/common';
-import type { DidResolutionResult } from '@web5/dids';
-import { DidMethod } from '@web5/dids';
-import { DidResolutionOptions } from './interfaces/crud.js';
+import { Canonicalization, DocumentBytes, KeyBytes, PatchOperation } from '@did-btcr2/common';
+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 { SignalsMetadata } from './utils/types.js';
+export declare const canonicalization: Canonicalization;
 export type Btcr2Identifier = string;
 export interface DidCreateOptions {
+    /** Type of identifier to create (key or external) */
+    idType: 'KEY' | 'EXTERNAL';
     /** DID BTCR2 Version Number */
     version?: number;
     /** Bitcoin Network */
@@ -13,10 +15,12 @@ export interface DidCreateOptions {
 }
 /**
  * Implements {@link https://dcdpr.github.io/did-btcr2 | did:btcr2 DID Method Specification}.
- * did:btcr2 is a censorship resistant DID Method using the Bitcoin blockchain as a Verifiable Data Registry to announce
- * changes to the DID document. It improves on prior work by allowing: zero-cost off-chain DID creation; aggregated
- * updates for scalable on-chain update costs; long-term identifiers that can support frequent updates; private
- * communication of the DID document; private DID resolution; and non-repudiation appropriate for serious contracts.
+ * did:btcr2 is a censorship-resistant Decentralized Identifier (DID) method using
+ * the Bitcoin blockchain as a Verifiable Data Registry to announce changes to the
+ * DID document. It supports zero-cost off-chain DID creation; aggregated updates
+ * for scalable on-chain update costs; long-term identifiers that can support
+ * frequent updates; private communication of the DID document; private DID resolution;
+ * and non-repudiation.
  *
  * @class DidBtcr2
  * @type {DidBtcr2}
@@ -26,54 +30,43 @@ export declare class DidBtcr2 implements DidMethod {
     /** @type {string} Name of the DID method, as defined in the DID BTCR2 specification */
     static methodName: string;
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#create | 4.1 Create}.
-     * See {@link Create} for implementation details.
-     *
-     * A did:btcr2 identifier and associated DID document can either be created deterministically from a cryptographic
-     * seed, or it can be created from an arbitrary genesis intermediate DID document representation. In both cases,
-     * DID creation can be undertaken in an offline manner, i.e., the DID controller does not need to interact with the
-     * Bitcoin network to create their DID.
-     * @param {CreateParams} params See {@link CreateParams} for details.
-     * @param {IdType} params.idType Type of identifier to create (key or external).
-     * @param {KeyBytes} params.pubKeyBytes Public key byte array used to create a btcr2 "key" identifier.
-     * @param {IntermediateDocument} params.intermediateDocument DID Document used to create a btcr2 "external" identifier.
-     * @param {DidCreateOptions} params.options See {@link DidCreateOptions} for create options.
-     * @param {number} params.options.version Version number of the btcr2 method.
-     * @param {string} params.options.network Bitcoin network name (mainnet, testnet, signet, regtest).
-     * @returns {Promise<CreateResponse>} Promise resolving to a CreateResponse object.
-     * @throws {DidBtcr2Error} if any of the checks fail
+     * Implements section {@link https://dcdpr.github.io/did-btcr2/operations/create.html | 7.1 Create}.
+     * @param {KeyBytes | DocumentBytes} genesisBytes The bytes used to create the genesis document for a did:btcr2 identifier.
+     * This can be either the bytes of the genesis document itself or the bytes of a key that will be used to create the genesis document.
+     * @param {DidCreateOptions} options Options for creating the identifier, including the idType (key or external), version, and network.
+     * @param {string} options.idType The type of identifier to create, either 'KEY' or 'EXTERNAL'. Defaults to 'KEY'.
+     * @param {number} options.version The version number of the did:btcr2 specification to use for creating the identifier. Defaults to 1.
+     * @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
      */
-    static create(params: {
-        idType: 'KEY' | 'EXTERNAL';
-        genesisBytes: KeyBytes | DocumentBytes;
-        options?: DidCreateOptions;
-    }): Promise<Btcr2Identifier>;
+    static create(genesisBytes: KeyBytes | DocumentBytes, options?: DidCreateOptions): Promise<Btcr2Identifier>;
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#read | 7.2 Read}.
-     * See {@link Resolve} for implementation details.
+     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#read | 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.
      *
-     * The Read operation is an algorithm consisting of a series of subroutine algorithms executed by a resolver after a
-     * resolution request identifying a specific did:btcr2 identifier is received from a client at Resolution Time. The
-     * request MUST always contain the resolutionOptions object containing additional information to be used in resolution.
-     * This object MAY be empty. See the DID Resolution specification for further details about the DID Resolution Options
-     * object. The resolver then attempts to resolve the DID document of the identifier at a specific Target Time. The
-     * Target Time is either provided in resolutionOptions or is set to the Resolution Time of the request.
+     * Resolving a did:btcr2 identifier iteratively builds a DID document by applying
+     * BTCR2 Updates to an Initial DID Document that have been committed to the Bitcoin
+     * blockchain by Authorized Beacon Signals. The Initial DID Document is either
+     * deterministically created from the DID or provided by Sidecar Data.
      *
-     * @param {string} identifier a valid did:btcr2 identifier to be resolved
-     * @param {DidResolutionOptions} [resolutionsOptions] see {@link https://www.w3.org/TR/did-1.0/#did-resolution-options | DidResolutionOptions}
-     * @param {number} options.versionId the version of the identifier and/or DID document
-     * @param {number} options.versionTime a timestamp used during resolution as a bound for when to stop resolving
-     * @param {DidDocument} options.sidecarData data necessary for resolving a DID
-     * @param {string} options.network Bitcoin network name (mainnet, testnet, signet, regtest).
-     * @returns {DidResolutionResult} Promise resolving to a DID Resolution Result containing the `targetDocument`
+     * @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
+     * @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
      * @example
      * ```ts
-     * const resolution = await DidBtcr2.resolve('did:btcr2:k1q0dygyp3gz969tp46dychzy4q78c2k3js68kvyr0shanzg67jnuez2cfplh')
+     * const resolution = await DidBtcr2.resolve(
+     *  'did:btcr2:k1q0dygyp3gz969tp46dychzy4q78c2k3js68kvyr0shanzg67jnuez2cfplh'
+     * )
      * ```
      */
-    static resolve(identifier: string, resolutionsOptions?: DidResolutionOptions): Promise<DidResolutionResult>;
+    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.
@@ -89,7 +82,7 @@ export declare class DidBtcr2 implements DidMethod {
      * 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, CIDAggregateBeacon, and SMTAggregateBeacon.
+     * Types SingletonBeacon, CASBeacon, and SMTBeacon.
      *
      * @param {UpdateParams} params Required parameters for the update operation.
      * @param {string} params.identifier The btcr2 identifier to be updated.
@@ -108,21 +101,16 @@ export declare class DidBtcr2 implements DidMethod {
         patch: PatchOperation[];
         verificationMethodId: string;
         beaconIds: string[];
-    }): Promise<SignalsMetadata>;
+    }): Promise<SidecarData>;
     /**
      * 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; methodId?: string; }} params Parameters for the `getSigningMethod` method.
-     * @param {DidDocument} params.didDocument DID Document to get the verification method from.
-     * @param {string} params.methodId Optional ID of the verification method to use for signing.
+     * @param {DidDocument} 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, methodId }: {
-        didDocument: DidDocument;
-        methodId?: string;
-    }): DidVerificationMethod;
+    static getSigningMethod(didDocument: DidDocument, 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":"AAAA,OAAO,EACL,aAAa,EAEb,QAAQ,EAGR,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAIL,SAAS,EAEV,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAInD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD;;;;;;;;;;GAUG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC,uFAAuF;IACvF,OAAc,UAAU,EAAE,MAAM,CAAW;IAE3C;;;;;;;;;;;;;;;;;OAiBG;WACiB,MAAM,CAAC,MAAM,EAAE;QACjC,MAAM,EAAE,KAAK,GAAG,UAAU,CAAC;QAC3B,YAAY,EAAE,QAAQ,GAAG,aAAa,CAAC;QACvC,OAAO,CAAC,EAAE,gBAAgB,CAAC;KAC5B,GAAG,OAAO,CAAC,eAAe,CAAC;IAa5B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,kBAAkB,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2C5H;;;;;;;;;;;;;;;;;;;;;;;;;;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,eAAe,CAAC;IAuD5B;;;;;;;;;;;OAWG;WACW,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE;QACxD,WAAW,EAAE,WAAW,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,qBAAqB;CA0B1B"}
+{"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"}