@did-btcr2/method 0.18.1 → 0.20.0

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

@@ -1,32 +1,7 @@
 import { KeyBytes, Maybe } from '@did-btcr2/common';
 import { networks } from 'bitcoinjs-lib';
-import { BeaconService, BeaconServiceAddress } from '../../interfaces/beacon.js';
 import { DidDocument } from '../../utils/did-document.js';
-export interface GenerateBeaconParams {
-    identifier: string;
-    publicKey: KeyBytes;
-    network: networks.Network;
-    type: string;
-}
-/**
- * Required parameters for generating Beacon Services.
- * @interface GenerateBitcoinAddrsParams
- * @type {GenerateBitcoinAddrsParams}
- */
-export interface GenerateBitcoinAddrsParams {
-    publicKey: KeyBytes;
-    network: networks.Network;
-}
-/**
- * Required parameters for generating Beacon Services.
- * @interface GenerateBeaconServicesParams
- * @type {GenerateBeaconServicesParams}
- */
-export interface GenerateBeaconServicesParams {
-    publicKey: KeyBytes;
-    network: networks.Network;
-    beaconType: string;
-}
+import { BeaconService } from './interfaces.js';
 /**
  * Static class of utility functions for the Beacon Service
  * @class BeaconUtils
@@ -54,98 +29,45 @@ export declare class BeaconUtils {
      */
     static getBeaconServices(didDocument: DidDocument): BeaconService[];
     /**
-     * Generate all 3 Beacon Service Endpoints for a given public key.
-     * @param {GenerateBitcoinAddrsParams} params Required parameters for generating Beacon Services.
-     * @param {KeyBytes} params.publicKey Public key bytes used to generate the beacon object serviceEndpoint.
-     * @param {Network} params.network Bitcoin network interface from bitcoinlib-js.
+     * Create the 3 default Beacon Service Endpoints for a given `k` (public-key-based) identifier.
+     * @param {string} did The DID for which to create the beacon services.
      * @returns {Array<Array<string>>} 2D Array of bitcoin addresses (p2pkh, p2wpkh, p2tr).
      * @throws {DidMethodError} if the bitcoin address is invalid.
      */
-    static generateBeaconAddresses({ identifier, publicKey, network }: {
-        identifier: string;
-        publicKey: KeyBytes;
-        network: networks.Network;
-    }): Array<Array<string>>;
+    static createBeaconServices(did: string, beaconType: string): Array<BeaconService>;
     /**
      * Generate a set of Beacon Services for a given public key.
-     * @param {GenerateBeaconServicesParams} params Required parameters for generating Beacon Services.
-     * @param {KeyBytes} params.publicKey Public key bytes used to generate the beacon object serviceEndpoint.
-     * @param {Network} params.network Bitcoin network interface from bitcoinlib-js.
-     * @param {string} params.beaconType The type of beacon service to create.
-     * @param {string} params.addressType The type of address to create (p2pkh, p2wpkh, p2tr).
+     * @param {string} did The did for the beacon service.
+     * @param {string} addressType The type of bitcoin address to generate (p2pkh, p2wpkh, p2tr).
+     * @param {string} beaconType The type of beacon service to create.
      * @returns {BeaconService} A BeaconService object.
      * @throws {DidMethodError} if the bitcoin address is invalid.
      */
-    static generateBeaconService({ id, publicKey: pubkey, network, addressType, type }: {
-        id: string;
-        publicKey: KeyBytes;
-        network: networks.Network;
-        addressType: 'p2pkh' | 'p2wpkh' | 'p2tr';
-        type: string;
-    }): BeaconService;
+    static createBeaconService(did: string, addressType: 'p2pkh' | 'p2wpkh' | 'p2tr', beaconType: string): BeaconService;
     /**
-     * Generate a custom Beacon Service.
-     * @param {GenerateBeaconServicesParams} params Required parameters for generating Beacon Services.
-     * @returns
+     * Generate three default Beacon Service Endpoints for a given `k` (public-key-based) identifier.
+     * @param {string} did The DID for which to create the beacon services.
+     * @returns {Array<Array<string>>} 2D Array of bitcoin addresses (p2pkh, p2wpkh, p2tr).
+     * @throws {DidMethodError} if the bitcoin address is invalid.
      */
-    static generateBeaconServiceCustom({ id, publicKey: pubkey, network, addressType, type }: {
+    static generateBeaconServices({ id, publicKey, network, beaconType }: {
         id: string;
         publicKey: KeyBytes;
         network: networks.Network;
-        addressType: 'p2pkh' | 'p2wpkh' | 'p2tr';
-        type: string;
-    }): BeaconService;
-    /**
-     * Generate beacon services.
-     * @param {GenerateBeaconServicesParams} params Required parameters for generating Beacon Services.
-     * @param {string} params.network The name of the Bitcoin network to use.
-     * @param {Uint8Array} params.publicKey Byte array representation of a public key used to generate a new btcr2 key-id-type.
-     * @param {string} params.beaconType Optional beacon type to use (default: SingletonBeacon).
-     * @returns {DidService[]} Array of DidService objects.
-     */
-    static generateBeaconServices({ identifier, network, type, publicKey }: {
-        identifier: string;
-        publicKey: KeyBytes;
-        network: networks.Network;
-        type: string;
+        beaconType: string;
     }): Array<BeaconService>;
-    /**
-     * Generate a single beacon service.
-     * @param {GenerateBeaconParams} params Required parameters for generating a single Beacon Service.
-     * @param {string} params.identifier The identifier for the beacon service.
-     * @param {string} params.network The name of the Bitcoin network to use.
-     * @param {Uint8Array} params.publicKey Byte array representation of a public key used to generate a new btcr2 key-id-type.
-     * @param {string} params.type The type of beacon service to create.
-     * @returns {BeaconService} A BeaconService object.
-     * @throws {DidMethodError} if the bitcoin address is invalid.
-     */
-    static generateBeacon({ identifier, network, type, publicKey }: {
-        identifier: string;
-        publicKey: KeyBytes;
-        network: networks.Network;
-        type: string;
-    }): BeaconService;
-    /**
-     * Manufacture a pre-filled Beacon using the BeaconFactory.
-     * @param {BeaconServicesParams} params Required parameters for generating a single Beacon Service.
-     * @param {string} params.serviceId The type of service being created (#initialP2PKH, #initialP2WPKH, #initialP2TR).
-     * @param {string} params.beaconType The type of beacon service being created (SingletonBeacon, SMTAggregatorBeacon).
-     * @param {string} params.bitcoinAddress The bitcoin address to use for the service endpoint.
-     * @returns {BeaconService} One BeaconService object.
-     */
-    static manufactureBeacon(params: BeaconService): BeaconService;
     /**
      * Convert beacon service endpoints from BIP-21 URIs to addresses.
-     * @param {Array<BeaconService>} beacons The list of beacon services.
-     * @returns {Array<BeaconServiceAddress>} An array of beacon services with address: bitcoinAddress.
+     * @param {BeaconService} beacon The beacon service to parse.
+     * @returns {BeaconServiceAddress} The beacon service with the address field extracted from the serviceEndpoint.
      */
-    static toBeaconServiceAddress(beacons: Array<BeaconService>): Array<BeaconServiceAddress>;
+    static parseBeaconServiceEndpoint(beacon: BeaconService): BeaconService;
     /**
      * Create a map of address => beaconService with address field.
      * @param {Array<BeaconService>} beacons The list of beacon services.
-     * @returns {Map<string, BeaconServiceAddress>} A map of address => beaconService.
+     * @returns {Map<string, BeaconService>} A map of address => beaconService.
      */
-    static getBeaconServiceAddressMap(beacons: Array<BeaconService>): Map<string, BeaconServiceAddress>;
+    static getBeaconServicesMap(beacons: Array<BeaconService>): Map<string, BeaconService>;
     /**
      * Get the beacon service ids from a list of beacon services.
      * @param {DidDocument} didDocument The DID Document to extract the services from.

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;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/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,87 @@
+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;
+    };
+}
+/**
+ * {@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,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

@@ -0,0 +1,89 @@
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import { DidDocument } from '../utils/did-document.js';
+import { BeaconService, 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#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 {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
+     * @returns {Promise<Array<[SignedBTCR2Update, BlockMetadata]>>} The array of BTCR2 Signed Updates announced by the Beacon Signals.
+     */
+    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<[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 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 {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 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 {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 applyUpdate(currentDocument: DidDocument, update: SignedBTCR2Update): 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,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

@@ -0,0 +1,84 @@
+import { HexString } from '@did-btcr2/common';
+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 }
+ * 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<SignedBTCR2Update>;
+    /**
+     * 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 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.
+     */
+    updateMap: SingletonBeaconSidecarData;
+    /**
+     * Map of CAS Announcements by their hash bytes.
+     */
+    casMap: CASBeaconSidecarData;
+    /**
+     * Map of SMT Proofs by their ID.
+     */
+    smtMap: SMTBeaconSidecarData;
+};
+/**
+ * Union type for all Beacon Sidecar data structures.
+ */
+export type BeaconSidecarData = SingletonBeaconSidecarData | CASBeaconSidecarData | SMTBeaconSidecarData;

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,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

@@ -0,0 +1,51 @@
+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/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
+ * 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.
+ *
+ * @class Update
+ * @type {Update}
+ */
+export declare class Update {
+    /**
+     * 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 {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(sourceDocument: Btcr2DidDocument, patches: PatchOperation[], sourceVersionId: number): Promise<UnsignedBTCR2Update>;
+    /**
+     * 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.
+     *
+     * @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 sign(did: string, unsignedUpdate: UnsignedBTCR2Update, verificationMethod: DidVerificationMethod, secretKey: KeyBytes): Promise<SignedBTCR2Update>;
+    /**
+     * 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(beaconService: BeaconService, update: SignedBTCR2Update, secretKey: KeyBytes, bitcoin: BitcoinNetworkConnection): Promise<SignedBTCR2Update>;
+}

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,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"}