@did-btcr2/method 0.20.0 → 0.23.0

package/src/core/beacon/aggregation/session/index.ts

@@ -188,7 +188,7 @@ export class BeaconCohortSigningSession implements SigningSession {
         `Missing ${missing} nonce contributions. ` +
         `Received ${this.cohort?.participants.length} of ${this.nonceContributions.size} nonce contributions. ` +
         `Current status: ${this.status}`,
-        'NONCE_CONTRIBUTION_ERROR', this.json()
+        'NONCE_CONTRIBUTION_ERROR', this.toJSON()
       );
     }
     const sortedPubkeys = musig2.sortKeys(this.cohort.cohortKeys);
@@ -267,8 +267,20 @@ export class BeaconCohortSigningSession implements SigningSession {
    * Converts the signing session instance to a JSON object representation.
    * @returns {BeaconCohortSigningSession} The JSON object representation of the signing session.
    */
-  public json(): BeaconCohortSigningSession {
-    return Object.fromEntries(Object.entries(this)) as BeaconCohortSigningSession;
+  public toJSON(): Partial<BeaconCohortSigningSession> {
+    return {
+      id                 : this.id,
+      cohort             : this.cohort,
+      pendingTx          : this.pendingTx,
+      nonceContributions : this.nonceContributions,
+      aggregatedNonce    : this.aggregatedNonce,
+      partialSignatures  : this.partialSignatures,
+      signature          : this.signature,
+      status             : this.status,
+      processedRequests  : this.processedRequests,
+      nonceSecrets       : this.nonceSecrets,
+      musig2Session      : this.musig2Session
+    };
   }
 
   /**

package/src/core/beacon/beacon.ts

@@ -1,5 +1,5 @@
 import { KeyBytes } from '@did-btcr2/common';
-import { BitcoinNetworkConnection } from '../../../../bitcoin/dist/types/bitcoin.js';
+import { BitcoinConnection } from '@did-btcr2/bitcoin';
 import { SignedBTCR2Update } from '../../../../cryptosuite/dist/types/data-integrity-proof/interface.js';
 import { SidecarData } from '../types.js';
 import { BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
@@ -47,12 +47,12 @@ export abstract class Beacon {
    * Used during the update path.
    * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
    * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
-   * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+   * @param {BitcoinConnection} bitcoin The Bitcoin network connection.
    * @returns {Promise<SignedBTCR2Update>} The signed update that was broadcast.
    */
   abstract broadcastSignal(
     signedUpdate: SignedBTCR2Update,
     secretKey: KeyBytes,
-    bitcoin: BitcoinNetworkConnection
+    bitcoin: BitcoinConnection
   ): Promise<SignedBTCR2Update>;
 }

package/src/core/beacon/cas-beacon.ts

@@ -1,4 +1,4 @@
-import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { BitcoinConnection } from '@did-btcr2/bitcoin';
 import { KeyBytes } from '@did-btcr2/common';
 import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { SidecarData } from '../types.js';
@@ -39,14 +39,14 @@ export class CASBeacon extends Beacon {
    * Broadcast CAS Beacon signal to the Bitcoin network.
    * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
    * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
-   * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+   * @param {BitcoinConnection} bitcoin The Bitcoin network connection.
    * @return {Promise<SignedBTCR2Update>} The signed update that was broadcasted.
    * @throws {CASBeaconError} if broadcasting fails.
    */
   async broadcastSignal(
     signedUpdate: SignedBTCR2Update,
     secretKey: KeyBytes,
-    bitcoin: BitcoinNetworkConnection
+    bitcoin: BitcoinConnection
   ): Promise<SignedBTCR2Update> {
     throw new CASBeaconError('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, {signedUpdate, secretKey, bitcoin});
   }

package/src/core/beacon/signal-discovery.ts

@@ -1,5 +1,5 @@
 import {
-  BitcoinNetworkConnection,
+  BitcoinConnection,
   BlockV3,
   GENESIS_TX_ID,
   RawTransactionV2,
@@ -21,23 +21,23 @@ export class BeaconSignalDiscovery {
    * Retrieves the beacon signals for the given array of BeaconService objects
    * using an 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
+   * @param {BitcoinConnection} bitcoin Bitcoin network connection to use for REST calls
    * @returns {Promise<Map<BeaconService, Array<BeaconSignal>>>} Map of beacon service to its discovered signals
    */
   static async indexer(
     beaconServices: Array<BeaconService>,
-    bitcoin: BitcoinNetworkConnection
+    bitcoin: BitcoinConnection
   ): Promise<Map<BeaconService, Array<BeaconSignal>>> {
     const beaconServiceSignals = new Map<BeaconService, Array<BeaconSignal>>();
 
     // Fetch the current block count once before the loop
-    const currentBlockCount = await bitcoin.network.rest.block.count();
+    const currentBlockCount = await bitcoin.rest.block.count();
 
     // Iterate over each beacon
     for (const beaconService of beaconServices) {
       beaconServiceSignals.set(beaconService, []);
       // Get the transactions for the beacon address via REST
-      const beaconSignals = await bitcoin.network.rest.address.getTxs(
+      const beaconSignals = await bitcoin.rest.address.getTxs(
         beaconService.serviceEndpoint as string
       );
 
@@ -104,12 +104,12 @@ export class BeaconSignalDiscovery {
   /**
    * 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.
+   * @param {BitcoinConnection} bitcoin Bitcoin network connection to use for RPC calls.
    * @returns {Promise<Map<BeaconService, Array<BeaconSignal>>>} Map of beacon service to its discovered signals.
    */
   static async fullnode(
     beaconServices: Array<BeaconService>,
-    bitcoin: BitcoinNetworkConnection
+    bitcoin: BitcoinConnection
   ): Promise<Map<BeaconService, Array<BeaconSignal>>> {
     const beaconServiceSignals = new Map<BeaconService, Array<BeaconSignal>>();
 
@@ -118,7 +118,7 @@ export class BeaconSignalDiscovery {
     }
 
     // Get the RPC connection from the bitcoin network
-    const rpc = bitcoin.network.rpc;
+    const rpc = bitcoin.rpc;
 
     // Ensure that the RPC connection is available
     if(!rpc) {
@@ -135,7 +135,7 @@ export class BeaconSignalDiscovery {
     let height = 0;
 
     // Opt into rpc connection to get the block data at the blockhash
-    let block = await bitcoin.network.rpc!.getBlock({ height }) as BlockV3;
+    let block = await bitcoin.rpc!.getBlock({ height }) as BlockV3;
 
     console.info(`Searching for beacon signals, please wait ...`);
     while (block.height <= targetHeight) {

package/src/core/beacon/singleton.ts

@@ -1,11 +1,9 @@
-import { AddressUtxo, BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
-import { INVALID_SIDECAR_DATA, KeyBytes, MISSING_UPDATE_DATA } from '@did-btcr2/common';
+import { AddressUtxo, BitcoinConnection } from '@did-btcr2/bitcoin';
+import { Canonicalization, INVALID_SIDECAR_DATA, KeyBytes, MISSING_UPDATE_DATA } from '@did-btcr2/common';
 import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { SchnorrKeyPair } from '@did-btcr2/keypair';
-import { Signer } from '@did-btcr2/kms';
 import { opcodes, Psbt, script } from 'bitcoinjs-lib';
 import { base58btc } from 'multiformats/bases/base58';
-import { canonicalization } from '../../did-btcr2.js';
 import { SidecarData } from '../types.js';
 import { Beacon } from './beacon.js';
 import { SingletonBeaconError } from './error.js';
@@ -15,7 +13,7 @@ import { BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
  * Implements {@link https://dcdpr.github.io/did-btcr2/terminology.html#singleton-beacon | Singleton Beacon}.
  * @class SingletonBeacon
  * @type {SingletonBeacon}
- * @extends {AggregateBeacon}
+ * @extends {Beacon}
  */
 export class SingletonBeacon extends Beacon {
 
@@ -56,10 +54,10 @@ export class SingletonBeacon extends Beacon {
         );
       }
 
-      // Canonicalize, hash and encode to base58 the signed update object found in sidecar or CAS
-      const encodedUpdate = canonicalization.process(signedUpdate, { encoding: 'base58' });
+      // Canonicalize, hash and encode to base58btc the signed update object found in sidecar or CAS
+      const encodedUpdate = Canonicalization.process(signedUpdate, { encoding: 'base58btc' });
 
-      // Encode the signal bytes hex string to base58
+      // Encode the signal bytes hex string to base58btc
       const signalBytes = base58btc.encode(Buffer.from(updateHash, 'hex'));
 
       // Check for mismatch between found sidecar/cas update hash and onchain beacon signal hash
@@ -82,20 +80,20 @@ export class SingletonBeacon extends Beacon {
    * Broadcasts a SingletonBeacon signal to the Bitcoin network.
    * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
    * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
-   * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+   * @param {BitcoinConnection} bitcoin The Bitcoin network connection.
    * @returns {Promise<SignedBTCR2Update>} The signed update that was broadcast.
    * @throws {SingletonBeaconError} if the bitcoin address is invalid or unfunded.
    */
   async broadcastSignal(
     signedUpdate: SignedBTCR2Update,
     secretKey: KeyBytes,
-    bitcoin: BitcoinNetworkConnection
+    bitcoin: BitcoinConnection
   ): Promise<SignedBTCR2Update> {
     // Convert the serviceEndpoint to a bitcoin address by removing the 'bitcoin:' prefix
     const bitcoinAddress = this.service.serviceEndpoint.replace('bitcoin:', '');
 
     // Query the Bitcoin network for UTXOs associated with the bitcoinAddress
-    const utxos = await bitcoin.network.rest.address.getUtxos(bitcoinAddress);
+    const utxos = await bitcoin.rest.address.getUtxos(bitcoinAddress);
 
     // If no utxos are found, throw an error indicating the address is unfunded.
     if(!utxos.length) {
@@ -119,13 +117,13 @@ export class SingletonBeacon extends Beacon {
     }
 
     // Get the previous tx to the utxo being spent
-    const prevTx = await bitcoin.network.rest.transaction.getHex(utxo.txid);
+    const prevTx = await bitcoin.rest.transaction.getHex(utxo.txid);
 
     // Canonicalize and hash the signed update for OP_RETURN output
-    const updateHash = canonicalization.canonicalhash(signedUpdate);
+    const updateHash = Canonicalization.andHash(signedUpdate);
 
     // Construct a spend transaction
-    const spendTx = new Psbt({ network: bitcoin.network.data })
+    const spendTx = new Psbt({ network: bitcoin.data })
       // Spend tx contains the utxo as its input
       .addInput({
         hash           : utxo.txid,
@@ -138,14 +136,12 @@ export class SingletonBeacon extends Beacon {
       // Add an OP_RETURN output containing the update hash
       .addOutput({ script: script.compile([opcodes.OP_RETURN, updateHash]), value: 0n });
 
-    // Construct a Schnorr key pair from the secret key
+    // Construct a key pair and PSBT signer from the secret key
     const keyPair = SchnorrKeyPair.fromSecret(secretKey);
-    if (!keyPair) {
-      throw new SingletonBeaconError('Key pair not found.', 'KEY_PAIR_NOT_FOUND', { secretKey });
-    }
-
-    // Construct a signer object from the key pair and bitcoin network
-    const signer = new Signer({ keyPair, network: bitcoin.network.name });
+    const signer = {
+      publicKey : keyPair.publicKey.compressed,
+      sign      : (hash: Uint8Array) => keyPair.secretKey.sign(hash, { scheme: 'ecdsa' }),
+    };
 
     // Sign 0th input, finalize extract to hex in prep for broadcast
     const signedTx = spendTx.signInput(0, signer)
@@ -154,8 +150,10 @@ export class SingletonBeacon extends Beacon {
       .toHex();
 
     // Broadcast spendTx to the Bitcoin network.
-    const txid = await bitcoin.network.rest.transaction.send(signedTx);
-    console.info(`Broadcasted Singleton Beacon signal with txid ${txid}`);
+    const txid = await bitcoin.rest.transaction.send(signedTx);
+
+    // Log the txid of the broadcasted transaction
+    console.info(`Singleton Beacon Signal Broadcasted with txid: ${txid}`);
 
     // Return the signed update
     return signedUpdate;

package/src/core/beacon/smt-beacon.ts

@@ -1,4 +1,4 @@
-import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { BitcoinConnection } from '@did-btcr2/bitcoin';
 import { KeyBytes } from '@did-btcr2/common';
 import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { SidecarData } from '../types.js';
@@ -39,14 +39,14 @@ export class SMTBeacon extends Beacon {
    * Broadcast CAS Beacon signal to the Bitcoin network.
    * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
    * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
-   * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+   * @param {BitcoinConnection} bitcoin The Bitcoin network connection.
    * @return {Promise<SignedBTCR2Update>} The signed update that was broadcasted.
    * @throws {SMTBeaconError} if broadcasting fails.
    */
   async broadcastSignal(
     signedUpdate: SignedBTCR2Update,
     secretKey: KeyBytes,
-    bitcoin: BitcoinNetworkConnection
+    bitcoin: BitcoinConnection
   ): Promise<SignedBTCR2Update> {
     throw new SMTBeaconError('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, {signedUpdate, secretKey, bitcoin});
   }

package/src/core/identifier.ts

@@ -1,24 +1,32 @@
-import { BitcoinNetworkNames, Bytes, IdentifierError, IdentifierTypes, INVALID_DID, METHOD_NOT_SUPPORTED } from '@did-btcr2/common';
+import { BitcoinNetworkNames, Bytes, DocumentBytes, IdentifierError, IdentifierTypes, INVALID_DID, KeyBytes, METHOD_NOT_SUPPORTED, SchnorrKeyPairObject } from '@did-btcr2/common';
 import { CompressedSecp256k1PublicKey, SchnorrKeyPair } from '@did-btcr2/keypair';
 import { bech32m } from '@scure/base';
+import { DidCreateOptions } from '../did-btcr2.js';
 
 /**
  * Components of a did:btcr2 identifier.
  * @interface DidComponents
+ * @extends {IdentifierComponents}
  * @property {string} hrp The human-readable part of the Bech32m encoding.
+ */
+export interface DidComponents extends IdentifierComponents {
+    hrp: string;
+};
+
+/**
+ * Components of a did:btcr2 identifier.
+ * @interface IdentifierComponents
  * @property {string} idType Identifier type (key or external).
  * @property {number} version Identifier version.
- * @property {string | number} network Bitcoin network name or number.
+ * @property {string} network Bitcoin network name or number.
  * @property {Bytes} genesisBytes Public key or an intermediate document bytes.
  */
-export interface DidComponents {
-    hrp: string;
+export interface IdentifierComponents {
     idType: string;
     version: number;
     network: string;
     genesisBytes: Bytes;
-};
-
+}
 /**
  * Implements {@link https://dcdpr.github.io/did-btcr2/#syntax | 3 Syntax}.
  * A did:btcr2 DID consists of a did:btcr2 prefix, followed by an id-bech32 value, which is a Bech32m encoding of:
@@ -41,20 +49,15 @@ export class Identifier {
    *    - a key-value representing a secp256k1 public key; or
    *    - a hash-value representing the hash of an initiating external DID document.
    *
-   * @param {DidComponents} params See {@link DidComponents} for details.
-   * @param {IdentifierTypes} params.idType Identifier type (key or external).
-   * @param {string} params.network Bitcoin network name.
-   * @param {number} params.version Identifier version.
-   * @param {KeyBytes | DocumentBytes} params.genesisBytes Public key or an intermediate document bytes.
+   * @param {KeyBytes | DocumentBytes} genesisBytes The genesis bytes (public key or document bytes).
+   * @param {DidCreateOptions} options The DID creation options.
    * @returns {string} The new did:btcr2 identifier.
    */
-  static encode({ idType, version, network, genesisBytes }: {
-    idType: string;
-    version: number;
-    network: string;
-    genesisBytes: Bytes;
-  }): string {
-    // 1. If idType is not a valid value per above, raise invalidDid error.
+  static encode(genesisBytes: KeyBytes | DocumentBytes, options: DidCreateOptions): string {
+    // Deconstruct the options
+    const { idType, version = 1, network } = options;
+
+    // If idType is not a valid value per above, raise invalidDid error.
     if (!(idType in IdentifierTypes)) {
       throw new IdentifierError('Expected "idType" to be "KEY" or "EXTERNAL"', INVALID_DID, {idType});
     }
@@ -275,16 +278,16 @@ export class Identifier {
    * Generates a new did:btcr2 identifier based on a newly generated key pair.
    * @returns {string} The new did:btcr2 identifier.
    */
-  static generate(): { keys: SchnorrKeyPair; identifier: { controller: string; id: string } } {
-    const keys = SchnorrKeyPair.generate();
-    const did = this.encode({
-      idType       : IdentifierTypes.KEY,
-      version      : 1,
-      network      : 'bitcoin',
-      genesisBytes : keys.publicKey.compressed
-    });
-
-    return { keys, identifier: { controller: did, id: '#initialKey'} };
+  static generate(): { keyPair: SchnorrKeyPairObject; did: string } {
+    const keyPair  = SchnorrKeyPair.generate();
+    const did = this.encode(keyPair.publicKey.compressed,
+      {
+        idType       : 'KEY',
+        version      : 1,
+        network      : 'regtest'
+      }
+    );
+    return { keyPair: keyPair.toJSON(), did };
   }
 
   /**

package/src/core/interfaces.ts

@@ -1,4 +1,4 @@
-import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { BitcoinConnection } from '@did-btcr2/bitcoin';
 import { DidResolutionOptions } from '@web5/dids';
 import { Sidecar } from './types.js';
 
@@ -44,7 +44,7 @@ export interface ResolutionOptions extends ResolutionOptionsCore {
    * Drivers for interacting with external systems, such as the Bitcoin network.
    */
   drivers?: {
-    bitcoin?: BitcoinNetworkConnection;
+    bitcoin?: BitcoinConnection;
   };
 }