@did-btcr2/method 0.14.6 → 0.15.0

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,EAML,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAIL,SAAS,EAEV,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAU,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAM7E;;;;;;;;;;GAUG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC,uFAAuF;IACvF,OAAc,UAAU,EAAE,MAAM,CAAW;IAE3C;;;;;;;;;;;;;;;;;OAiBG;WACiB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IA0BzE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,kBAAkB,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAwC5H;;;;;;;;;;;;;;;;;;;;;;;;;;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,GAAG,CAAC;IAuDhB;;;;;;;;;;;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":"AAAA,OAAO,EAML,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAIL,SAAS,EAEV,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAU,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAM7E;;;;;;;;;;GAUG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC,uFAAuF;IACvF,OAAc,UAAU,EAAE,MAAM,CAAW;IAE3C;;;;;;;;;;;;;;;;;OAiBG;WACiB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IA0BzE;;;;;;;;;;;;;;;;;;;;;;;;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,GAAG,CAAC;IAuDhB;;;;;;;;;;;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"}

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

@@ -1,21 +1,21 @@
-import { BitcoinNetworkNames, UnixTimestamp } from '@did-btcr2/common';
+import { BitcoinCoreRpcClient } from '@did-btcr2/bitcoin';
+import { UnixTimestamp } from '@did-btcr2/common';
 import { DidResolutionOptions as IDidResolutionOptions } from '@web5/dids';
-import { BitcoinRpc } from '@did-btcr2/bitcoin';
 import { SidecarData } from '../types/crud.js';
 import { DidDocument } from '../utils/did-document.js';
 /**
  * Options for resolving a DID Document
  * @param {?number} versionId The versionId for resolving the DID Document
  * @param {?UnixTimestamp} versionTime The versionTime for resolving the DID Document
- * @param {?BitcoinRpc} rpc BitcoinRpc client connection
+ * @param {?BitcoinCoreRpcClient} rpc BitcoinCoreRpcClient client connection
  * @param {?SidecarData} sidecarData The sidecar data for resolving the DID Document
  */
 export interface DidResolutionOptions extends IDidResolutionOptions {
     versionId?: number;
     versionTime?: UnixTimestamp;
     sidecarData?: SidecarData;
-    network?: BitcoinNetworkNames;
-    rpc?: BitcoinRpc;
+    network?: string;
+    rpc?: BitcoinCoreRpcClient;
 }
 export interface Btc1RootCapability {
     '@context': string;

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

@@ -1 +1 @@
-{"version":3,"file":"crud.d.ts","sourceRoot":"","sources":["../../../src/interfaces/crud.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,oBAAoB,IAAI,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,GAAG,CAAC,EAAE,UAAU,CAAC;CAClB;AACD,MAAM,WAAW,kBAAkB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,oBAAoB;IACnC,uBAAuB,EAAE,WAAW,CAAC;IACrC,uBAAuB,EAAE,MAAM,GAAG,CAAC,CAAC;IACpC,gBAAgB,EAAE,MAAM,GAAG,CAAC,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC"}
+{"version":3,"file":"crud.d.ts","sourceRoot":"","sources":["../../../src/interfaces/crud.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,oBAAoB,IAAI,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,oBAAoB,CAAC;CAC5B;AACD,MAAM,WAAW,kBAAkB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,oBAAoB;IACnC,uBAAuB,EAAE,WAAW,CAAC;IACrC,uBAAuB,EAAE,MAAM,GAAG,CAAC,CAAC;IACpC,gBAAgB,EAAE,MAAM,GAAG,CAAC,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-btcr2/method",
-  "version": "0.14.6",
+  "version": "0.15.0",
   "type": "module",
   "description": "Javascript/TypeScript reference implementation of did:btcr2 method, a censorship resistant DID Method using the Bitcoin blockchain as a Verifiable Data Registry to announce changes to the DID document. Core package of the did-btcr2-js monorepo.",
   "main": "./dist/cjs/index.js",
@@ -64,6 +64,7 @@
     "bitcoin"
   ],
   "dependencies": {
+    "@bitcoinerlab/secp256k1": "^1.2.0",
     "@helia/strings": "^4.0.2",
     "@noble/curves": "^1.8.1",
     "@noble/hashes": "^1.5.0",
@@ -75,7 +76,6 @@
     "@web5/common": "^1.1.0",
     "@web5/crypto": "^1.0.6",
     "@web5/dids": "^1.2.0",
-    "bitcoin-core": "^5.0.0",
     "bitcoinjs-lib": "7.0.0-rc.0",
     "canonicalize": "^2.1.0",
     "dotenv": "^16.5.0",
@@ -83,10 +83,10 @@
     "multiformats": "^13.3.1",
     "nostr-tools": "^2.15.0",
     "tiny-secp256k1": "^2.2.3",
-    "@did-btcr2/keypair": "0.5.1",
-    "@did-btcr2/bitcoin": "0.1.2",
+    "@did-btcr2/bitcoin": "0.2.0",
     "@did-btcr2/common": "2.1.0",
-    "@did-btcr2/cryptosuite": "3.1.0"
+    "@did-btcr2/cryptosuite": "3.1.0",
+    "@did-btcr2/keypair": "0.5.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",

package/src/core/beacon/singleton.ts

@@ -1,4 +1,4 @@
-import { AddressUtxo, Bitcoin, RawTransactionRest, RawTransactionV2, TxOut, Vout } from '@did-btcr2/bitcoin';
+import { AddressUtxo, BitcoinNetworkConnection, RawTransactionRest, RawTransactionV2, TxOut, Vout } from '@did-btcr2/bitcoin';
 import { DidUpdatePayload, INVALID_SIDECAR_DATA, LATE_PUBLISHING_ERROR, SingletonBeaconError } from '@did-btcr2/common';
 import { opcodes, Psbt, script } from 'bitcoinjs-lib';
 import { base58btc } from 'multiformats/bases/base58';
@@ -8,7 +8,7 @@ import { BeaconSidecarData, Metadata, SignalsMetadata, SingletonSidecar } from '
 import { Appendix } from '../../utils/appendix.js';
 import { KeyManager, Signer } from '../key-manager/index.js';
 
-const bitcoin = new Bitcoin();
+const bitcoin = new BitcoinNetworkConnection();
 
 /**
  * Implements {@link https://dcdpr.github.io/did-btcr2/#singleton-beacon | 5.1 Singleton Beacon}.

package/src/core/crud/read.ts

@@ -1,7 +1,7 @@
 import {
-  Bitcoin,
-  BitcoinRest,
-  BitcoinRpc,
+  BitcoinCoreRpcClient,
+  BitcoinNetworkConnection,
+  BitcoinRestClient,
   BlockV3,
   GENESIS_TX_ID,
   getNetwork,
@@ -40,13 +40,13 @@ import { DidDocument } from '../../utils/did-document.js';
 import { BeaconFactory } from '../beacon/factory.js';
 
 export type FindNextSignalsRestParams = {
-  connection: BitcoinRest;
+  connection: BitcoinRestClient;
   beaconSignals: Array<BeaconSignal>;
   block: BlockV3;
   beacons: Array<BeaconServiceAddress>;
 }
 export type BeaconSignals = Array<BeaconSignal>;
-export type BitcoinClient = BitcoinRpc | BitcoinRest;
+export type BitcoinClient = BitcoinCoreRpcClient | BitcoinRestClient;
 
 export type NetworkVersion = {
   version?: string;
@@ -95,7 +95,7 @@ export interface TargetBlockheightParams {
   targetTime?: UnixTimestamp;
 }
 
-const bitcoin = new Bitcoin();
+const bitcoin = new BitcoinNetworkConnection();
 
 /**
  * Implements {@link https://dcdpr.github.io/did-btcr2/#read | 4.2 Read}.
@@ -331,7 +331,7 @@ export class Resolve {
     resolutionsOptions: DidResolutionOptions;
   }): Promise<DidDocument> {
     // Set the network from the options or default to mainnet
-    const network = resolutionsOptions.network ?? BitcoinNetworkNames.bitcoin;
+    const network = resolutionsOptions.network!;
 
     // 1. If resolutionOptions.versionId is not null, set targetVersionId to resolutionOptions.versionId.
     const targetVersionId = resolutionsOptions.versionId;
@@ -341,7 +341,7 @@ export class Resolve {
     const targetTime = resolutionsOptions.versionTime ?? new Date().toUnix();
 
     // 4. Set signalsMetadata to resolutionOptions.sidecarData.signalsMetadata.
-    const signalsMetadata = (resolutionsOptions.sidecarData as SidecarData).signalsMetadata;
+    const signalsMetadata = (resolutionsOptions.sidecarData as SidecarData)?.signalsMetadata ?? {};
 
     // 5. Set currentVersionId to 1
     const currentVersionId = 1;
@@ -399,7 +399,7 @@ export class Resolve {
    * @param {boolean} params.btc1UpdateHashHistory An array of SHA256 hashes of BTCR2 Updates ordered by version that are
    *    applied to the DID document in order to construct the contemporaryDIDDocument.
    * @param {SignalsMetadata} params.signalsMetadata See {@link SignalsMetadata} for details.
-   * @param {BitcoinNetworkNames} params.network The bitcoin network to connect to (mainnet, signet, testnet, regtest).
+   * @param {string} params.network The bitcoin network to connect to (mainnet, signet, testnet, regtest).
    * @returns {Promise<DidDocument>} The resolved DID Document object with a validated single, canonical history.
    */
   protected static async traverseBlockchainHistory({
@@ -421,7 +421,7 @@ export class Resolve {
     didDocumentHistory: DidDocument[];
     btc1UpdateHashHistory: string[];
     signalsMetadata: SignalsMetadata;
-    network: BitcoinNetworkNames;
+    network: string;
   }): Promise<DidDocument> {
     // 1. Set contemporaryHash to the SHA256 hash of the contemporaryDidDocument
     let contemporaryHash = await JSON.canonicalization.process(contemporaryDidDocument, 'base58');
@@ -552,15 +552,17 @@ export class Resolve {
    *
    * @public
    * @param {FindNextSignals} params The parameters for the findNextSignals operation.
-   * @param {number} params.blockheight The blockheight to start looking for beacon signals.
-   * @param {Array<BeaconService>} params.target The target blockheight at which to stop finding signals.
+   * @param {number} params.contemporaryBlockHeight The blockheight to start looking for beacon signals.
    * @param {Array<BeaconService>} params.beacons The beacons to look for in the block.
+   * @param {Array<BeaconService>} params.network The bitcoin network to connect to (mainnet, signet, testnet, regtest).
+   * @param {UnixTimestamp} params.targetTime The timestamp used to target specific historical states of a DID document.
+   *    Only Beacon Signals included in the Bitcoin blockchain before the targetTime are processed.
    * @returns {Promise<Array<BeaconSignal>>} An array of BeaconSignal objects with blockHeight and signals.
    */
-  public static async findNextSignals({ contemporaryBlockHeight, targetTime, beacons }: {
+  public static async findNextSignals({ contemporaryBlockHeight, targetTime, network, beacons }: {
     contemporaryBlockHeight: number;
     beacons: Array<BeaconServiceAddress>;
-    network: BitcoinNetworkNames;
+    network: string;
     targetTime: UnixTimestamp;
   }): Promise<Array<BeaconSignal>> {
     let height = contemporaryBlockHeight;
@@ -568,11 +570,23 @@ export class Resolve {
     // Create an default beaconSignal and beaconSignals array
     let beaconSignals: BeaconSignals = [];
 
-    if (bitcoin.network.rest) {
-      return await this.findSignalsRest({ beacons });
+    // Get the bitcoin network connection
+    bitcoin.setActiveNetwork(network);
+
+    // Opt into REST connection if available
+    if(bitcoin.network.rest) {
+      return await this.findSignalsRest(beacons);
+    }
+
+    // If no rest and no rpc connection is available, throw an error
+    if (!bitcoin.network.rpc) {
+      throw new ResolveError(
+        `No Bitcoin connection available, cannot find next signals`,
+        'NO_BITCOIN_CONNECTION'
+      );
     }
 
-    // Use connection to get the block data at the blockhash
+    // Opt into rpc connection to get the block data at the blockhash
     let block = await bitcoin.network.rpc.getBlock({ height }) as BlockV3;
 
     Logger.info(`Searching for signals, please wait ...`);
@@ -666,15 +680,10 @@ export class Resolve {
 
   /**
    * Helper method for the {@link findNextSignals | Find Next Signals} algorithm.
-   *
-   * @param params See {@link FindNextSignalsRestParams} for details.
-   * @param {BitcoinClient} params.connection The bitcoin connection to use.
-   * @param {Array<BeaconSignal>} params.beaconSignals The beacon signals to process.
-   * @param {BlockV3} params.block The block to process.
-   * @param {Array<BeaconService>} params.beacons The beacons to process.
+   * @param {Array<BeaconService>} beacons The beacons to process.
    * @returns {Promise<Array<BeaconSignal>>} The beacon signals found in the block.
    */
-  public static async findSignalsRest({ beacons }: { beacons: Array<BeaconService>; }): Promise<Array<BeaconSignal>> {
+  public static async findSignalsRest(beacons: Array<BeaconService>): Promise<Array<BeaconSignal>> {
     // Empty array of beaconSignals
     const beaconSignals = new Array<BeaconSignal>();
 

package/src/did-btcr2.ts

@@ -118,6 +118,9 @@ export class DidBtcr2 implements DidMethod {
       // 2. Set identifierComponents to a map of idType, version, network, and genesisBytes.
       const identifierComponents = Identifier.decode(identifier);
 
+      // Set the network based on the decoded identifier
+      resolutionsOptions.network ??= identifierComponents.network;
+
       // 3. Set initialDocument to the result of running the algorithm in Resolve Initial Document passing in the
       //    identifier, identifierComponents and resolutionOptions.
       const initialDocument = await Resolve.initialDocument({ identifier, identifierComponents, resolutionsOptions });

package/src/interfaces/crud.ts

@@ -1,6 +1,6 @@
-import { BitcoinNetworkNames, UnixTimestamp } from '@did-btcr2/common';
+import { BitcoinCoreRpcClient } from '@did-btcr2/bitcoin';
+import { UnixTimestamp } from '@did-btcr2/common';
 import { DidResolutionOptions as IDidResolutionOptions } from '@web5/dids';
-import { BitcoinRpc } from '@did-btcr2/bitcoin';
 import { SidecarData } from '../types/crud.js';
 import { DidDocument } from '../utils/did-document.js';
 
@@ -8,15 +8,15 @@ import { DidDocument } from '../utils/did-document.js';
  * Options for resolving a DID Document
  * @param {?number} versionId The versionId for resolving the DID Document
  * @param {?UnixTimestamp} versionTime The versionTime for resolving the DID Document
- * @param {?BitcoinRpc} rpc BitcoinRpc client connection
+ * @param {?BitcoinCoreRpcClient} rpc BitcoinCoreRpcClient client connection
  * @param {?SidecarData} sidecarData The sidecar data for resolving the DID Document
  */
 export interface DidResolutionOptions extends IDidResolutionOptions {
   versionId?: number
   versionTime?: UnixTimestamp;
   sidecarData?: SidecarData;
-  network?: BitcoinNetworkNames;
-  rpc?: BitcoinRpc;
+  network?: string;
+  rpc?: BitcoinCoreRpcClient;
 }
 export interface Btc1RootCapability {
     '@context': string;