@did-btcr2/method 0.19.0 → 0.22.0

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

@@ -1,67 +1,53 @@
 import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
-import { HexString, MethodError } from '@did-btcr2/common';
+import { KeyBytes } from '@did-btcr2/common';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { SidecarData } from '../types.js';
-import { AggregateBeacon, BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
-import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { Beacon } from './beacon.js';
+import { CASBeaconError } from './error.js';
+import { BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
 
 /**
  * Implements {@link https://dcdpr.github.io/did-btcr2/terminology.html#cas-beacon | CAS Beacon}.
- *
  * @class CASBeacon
  * @type {CASBeacon}
- * @extends {AggregateBeacon}
+ * @extends {Beacon}
  */
-export class CASBeacon extends AggregateBeacon {
+export class CASBeacon extends Beacon {
   /**
    * Creates an instance of CASBeacon.
    * @param {BeaconService} service The service of the Beacon.
-   * @param {?BeaconSidecarData} [sidecar] The sidecar data of the Beacon.
    */
-  constructor(
-    service: BeaconService,
-    signals: Array<BeaconSignal>,
-    sidecar: SidecarData,
-    bitcoin?: BitcoinNetworkConnection
-  ) {
-    super({ ...service, type: 'CASBeacon' }, signals, sidecar, bitcoin);
-  }
-
-  /**
-   * Establish a CASBeacon instance based on the provided service and sidecar data.
-   * @param {BeaconService} service - The beacon service configuration.
-   * @param {SidecarData} sidecar - The sidecar data.
-   * @returns {CASBeacon} The established CASBeacon instance.
-   */
-  static establish(service: BeaconService, signals: Array<BeaconSignal>, sidecar: SidecarData): CASBeacon {
-    return new CASBeacon(service, signals, sidecar);
-  }
-
-  /**
-   * TODO: Figure out if this is necessary or not.
-   * @param {HexString} updateHash The hash of the update to generate the signal for.
-   * @returns {BeaconSignal} The generated signal.
-   * @throws {MethodError} if the signal is invalid.
-   */
-  generateSignal(updateHash: HexString): BeaconSignal {
-    throw new Error('Method not implemented.' + updateHash);
+  constructor(service: BeaconService) {
+    super({ ...service, type: 'CASBeacon' });
   }
 
   /**
    * Implements {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-cas-beacon | 7.2.e.1 Process CAS Beacon}.
-   * @returns {Promise<BTCR2SignedUpdate | undefined>} The processed signed update or undefined.
-   * @throws {MethodError} if the signal processing fails.
+   * @param {Array<BeaconSignal>} signals The array of Beacon Signals to process.
+   * @param {SidecarData} sidecar The sidecar data associated with the CAS Beacon.
+   * @returns {Promise<Array<[SignedBTCR2Update, BlockMetadata]>>} The processed signals.
+   * @throws {CASBeaconError} if processing fails.
    */
-  processSignals(): Promise<Array<[BTCR2SignedUpdate, BlockMetadata]>> {
-    throw new MethodError('Method not implemented.', `METHOD_NOT_IMPLEMENTED`);
+  processSignals(
+    signals: Array<BeaconSignal>,
+    sidecar: SidecarData
+  ): Promise<Array<[SignedBTCR2Update, BlockMetadata]>> {
+    throw new CASBeaconError('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, { signals, sidecar });
   }
 
   /**
-   * TODO: Finish implementation
-   * @param {HexString} updateHash The hash of the update to broadcast.
-   * @returns {Promise<{ spentTx: string; signedUpdate: BTCR2SignedUpdate }>} The result of the broadcast.
-   * @throws {MethodError} if the broadcast fails.
+   * Broadcast CAS Beacon signal to the Bitcoin network.
+   * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
+   * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
+   * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+   * @return {Promise<SignedBTCR2Update>} The signed update that was broadcasted.
+   * @throws {CASBeaconError} if broadcasting fails.
    */
-  async broadcastSignal(updateHash: HexString): Promise<HexString> {
-    throw new MethodError('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, {updateHash});
+  async broadcastSignal(
+    signedUpdate: SignedBTCR2Update,
+    secretKey: KeyBytes,
+    bitcoin: BitcoinNetworkConnection
+  ): Promise<SignedBTCR2Update> {
+    throw new CASBeaconError('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, {signedUpdate, secretKey, bitcoin});
   }
 }

package/src/core/beacon/error.ts

@@ -18,7 +18,6 @@ export class BeaconParticipantError extends MethodError {
   }
 }
 
-
 export class SingletonBeaconError extends MethodError {
   constructor(message: string, type: string = 'SingletonBeaconError', data?: Record<string, any>) {
     super(message, type, data);
@@ -31,14 +30,14 @@ export class AggregateBeaconError extends MethodError {
   }
 }
 
-export class CIDAggregateBeaconError extends MethodError {
-  constructor(message: string, type: string = 'CIDAggregateBeaconError', data?: Record<string, any>) {
+export class CASBeaconError extends MethodError {
+  constructor(message: string, type: string = 'CASBeaconError', data?: Record<string, any>) {
     super(message, type, data);
   }
 }
 
-export class SMTAggregateBeaconError extends MethodError {
-  constructor(message: string, type: string = 'SMTAggregateBeaconError', data?: Record<string, any>) {
+export class SMTBeaconError extends MethodError {
+  constructor(message: string, type: string = 'SMTBeaconError', data?: Record<string, any>) {
     super(message, type, data);
   }
-}
+}

package/src/core/beacon/factory.ts

@@ -1,7 +1,7 @@
 import { MethodError } from '@did-btcr2/common';
-import { SidecarData } from '../types.js';
+import { Beacon } from './beacon.js';
 import { CASBeacon } from './cas-beacon.js';
-import { AggregateBeacon, BeaconService, BeaconSignal } from './interfaces.js';
+import { BeaconService } from './interfaces.js';
 import { SingletonBeacon } from './singleton.js';
 import { SMTBeacon } from './smt-beacon.js';
 
@@ -13,19 +13,17 @@ import { SMTBeacon } from './smt-beacon.js';
 export class BeaconFactory {
   /**
    * Establish a Beacon instance based on the provided service and optional sidecar data.
-   * @param {BeaconService} service - The beacon service configuration.
-   * @param {Array<BeaconSignal>} signals - The array of beacon signals.
-   * @param {SidecarData} sidecar - The sidecar data associated with the beacon.
+   * @param {BeaconService} service The beacon service configuration.
    * @returns {Beacon} The established Beacon instance.
    */
-  static establish(service: BeaconService, signals: Array<BeaconSignal>, sidecar: SidecarData): AggregateBeacon {
+  static establish(service: BeaconService): Beacon {
     switch (service.type) {
       case 'SingletonBeacon':
-        return new SingletonBeacon(service, signals, sidecar);
+        return new SingletonBeacon(service);
       case 'CASBeacon':
-        return new CASBeacon(service, signals, sidecar);
+        return new CASBeacon(service);
       case 'SMTBeacon':
-        return new SMTBeacon(service, signals, sidecar);
+        return new SMTBeacon(service);
       default:
         throw new MethodError('Invalid Beacon Type', 'INVALID_BEACON_ERROR', service);
     }

package/src/core/beacon/interfaces.ts

@@ -1,15 +1,14 @@
-import { BitcoinNetworkConnection, RawTransactionRest, RawTransactionV2 } from '@did-btcr2/bitcoin';
-import { HexString, UnixTimestamp } from '@did-btcr2/common';
-import { DidServiceEndpoint, DidService as IDidService } from '@web5/dids';
-import { SidecarData } from '../types.js';
-import { BTCR2SignedUpdate } from '@did-btcr2/cryptosuite';
+import { RawTransactionRest, RawTransactionV2 } from '@did-btcr2/bitcoin';
+import { UnixTimestamp } from '@did-btcr2/common';
+import { DidServiceEndpoint, DidService } from '@web5/dids';
 
 /**
- * Represents a Beacon Service, which extends the DID Service with a service endpoint.
+ * Represents a Beacon Service, which extends a W3C DID Service by setting serviceEndpoint
+ * as a single DidServiceEndpoint.
  * @interface BeaconService
- * @extends IDidService
+ * @extends DidService
  */
-export interface BeaconService extends IDidService {
+export interface BeaconService extends DidService {
     serviceEndpoint: DidServiceEndpoint;
 }
 
@@ -65,60 +64,4 @@ export interface BeaconSignal {
    * Metadata about the block containing the Beacon Signal.
    */
   blockMetadata: BlockMetadata;
-}
-
-/**
- * Abstract class representing an AggregateBeacon.
- * @abstract
- * @class AggregateBeacon
- * @type {AggregateBeacon}
- */
-export abstract class AggregateBeacon {
-  /**
-   * The Beacon service object parsed from the DID Document.
-   */
-  service: BeaconService;
-
-  /**
-   * The array of Beacon Signals associated with this Beacon service.
-   */
-  signals: Array<BeaconSignal>;
-
-  /**
-   * The sidecar data associated with this Beacon service.
-   * TODO: Make this more specific to Beacon type.
-   */
-  sidecar: SidecarData;
-
-  /**
-   * The Bitcoin network connection associated with this Beacon service.
-   */
-  bitcoin: BitcoinNetworkConnection;
-
-  constructor(
-    service: BeaconService,
-    signals: Array<BeaconSignal>,
-    sidecar: SidecarData,
-    bitcoin?: BitcoinNetworkConnection
-  ) {
-    this.service = service;
-    this.signals = signals;
-    this.sidecar = sidecar;
-    this.bitcoin = bitcoin!;
-  }
-
-  /**
-   * Generates an unsigned update in a Beacon Signal (implemented by subclasses).
-   */
-  abstract generateSignal(updateHash: HexString): BeaconSignal;
-
-  /**
-   * Processes a Beacon Signal (implemented by subclasses).
-   */
-  abstract processSignals(): Promise<Array<[BTCR2SignedUpdate, BlockMetadata]>>;
-
-  /**
-   * Broadcasts a signed update in a Beacon Signal (implemented by subclasses).
-   */
-  abstract broadcastSignal(updateHash: HexString): Promise<HexString>;
 }

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

@@ -0,0 +1,237 @@
+import {
+  BitcoinNetworkConnection,
+  BlockV3,
+  GENESIS_TX_ID,
+  RawTransactionV2,
+  TXIN_WITNESS_COINBASE
+} from '@did-btcr2/bitcoin';
+import { ResolveError } from '@did-btcr2/common';
+import { BeaconService, BeaconSignal } from './interfaces.js';
+import { BeaconUtils } from './utils.js';
+
+/**
+ * Static utility class for discovering Beacon Signals on the Bitcoin blockchain.
+ * Extracted from {@link Resolve} for single-responsibility and independent testability.
+ *
+ * @class BeaconSignalDiscovery
+ */
+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
+   * @returns {Promise<Map<BeaconService, Array<BeaconSignal>>>} Map of beacon service to its discovered signals
+   */
+  static async indexer(
+    beaconServices: Array<BeaconService>,
+    bitcoin: BitcoinNetworkConnection
+  ): 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();
+
+    // 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(
+        beaconService.serviceEndpoint as string
+      );
+
+      // If no signals are found, continue
+      if (!beaconSignals || !beaconSignals.length) {
+        continue;
+      }
+
+      // Iterate over each signal
+      for (const beaconSignal of beaconSignals) {
+        // Get the last vout in the transaction
+        const signalVout = beaconSignal.vout.slice(-1)[0];
+
+        /**
+         * Look for OP_RETURN in last vout scriptpubkey_asm
+         * Vout (rest) format:
+         * {
+         *  scriptpubkey: '6a20570f177c65e64fb5cf61180b664cdddf09ab76153c2b192e22006e5b22a3917a',
+         *  scriptpubkey_asm: 'OP_RETURN OP_PUSHBYTES_32 570f177c65e64fb5cf61180b664cdddf09ab76153c2b192e22006e5b22a3917a',
+         *  scriptpubkey_type: 'op_return',
+         *  value: 0
+         * }
+         */
+        if(!signalVout || !signalVout.scriptpubkey_asm.includes('OP_RETURN')) {
+          continue;
+        }
+
+        // Construct output map for easier access
+        const outputMap = new Map<string, string | number>(Object.entries(signalVout));
+
+        // Grab the signal vout scriptpubkey
+        const signalVoutScriptPubkey = outputMap.get('scriptpubkey_asm') as string;
+
+        // If the signal vout scriptpubkey does not exist, continue to next signal
+        if(!signalVoutScriptPubkey){
+          continue;
+        }
+
+        // Extract hex string hash of the signal bytes from the scriptpubkey
+        const updateHash = signalVoutScriptPubkey.split(' ').slice(-1)[0];
+        if(!updateHash) {
+          continue;
+        }
+
+        // Use the pre-fetched block count instead of calling per-signal
+        const confirmations = currentBlockCount - beaconSignal.status.block_height + 1;
+
+        // Push the beacon signal object to the signals array for the beacon service
+        beaconServiceSignals.get(beaconService)?.push({
+          tx            : beaconSignal,
+          signalBytes   : updateHash,
+          blockMetadata : {
+            confirmations,
+            height : beaconSignal.status.block_height,
+            time   : beaconSignal.status.block_time,
+          }
+        });
+      }
+    }
+
+    return beaconServiceSignals;
+  }
+
+  /**
+   * 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<Map<BeaconService, Array<BeaconSignal>>>} Map of beacon service to its discovered signals.
+   */
+  static async fullnode(
+    beaconServices: Array<BeaconService>,
+    bitcoin: BitcoinNetworkConnection
+  ): Promise<Map<BeaconService, Array<BeaconSignal>>> {
+    const beaconServiceSignals = new Map<BeaconService, Array<BeaconSignal>>();
+
+    for(const beaconService of beaconServices) {
+      beaconServiceSignals.set(beaconService, []);
+    }
+
+    // Get the RPC connection from the bitcoin network
+    const rpc = bitcoin.network.rpc;
+
+    // Ensure that the RPC connection is available
+    if(!rpc) {
+      throw new ResolveError('RPC connection is not available', 'RPC_CONNECTION_ERROR', bitcoin);
+    }
+
+    // Get the current block height once before the loop
+    const targetHeight = await rpc.getBlockCount();
+
+    // Hoist the beacon services map before the loop
+    const beaconServicesMap = BeaconUtils.getBeaconServicesMap(beaconServices);
+
+    // Set genesis height
+    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;
+
+    console.info(`Searching for beacon signals, please wait ...`);
+    while (block.height <= targetHeight) {
+      // Iterate over each transaction in the block
+      for (const tx of block.tx) {
+        // If the txid is a coinbase, continue ...
+        if (tx.txid === GENESIS_TX_ID) {
+          continue;
+        }
+
+        // Iterate over each input in the transaction
+        for (const vin of tx.vin) {
+
+          // If the vin is a coinbase transaction, continue ...
+          if (vin.coinbase) {
+            continue;
+          }
+
+          // If the vin txinwitness contains a coinbase did, continue ...
+          if (vin.txinwitness && vin.txinwitness.length === 1 && vin.txinwitness[0] === TXIN_WITNESS_COINBASE) {
+            continue;
+          }
+
+          // If the txid from the vin is undefined, continue ...
+          if (!vin.txid) {
+            continue;
+          }
+
+          // If the vout from the vin is undefined, continue ...
+          if (vin.vout === undefined) {
+            continue;
+          }
+
+          // Get the previous output transaction data
+          const prevout = await rpc.getRawTransaction(vin.txid, 2) as RawTransactionV2;
+
+          // If the previous output vout at the vin.vout index is undefined, continue ...
+          if (!prevout.vout[vin.vout]) {
+            continue;
+          }
+
+          // Get the address from the scriptPubKey from the prevvout
+          const scriptPubKey = prevout.vout[vin.vout].scriptPubKey;
+
+          // If the scriptPubKey.address is undefined, continue ...
+          if (!scriptPubKey.address) {
+            continue;
+          }
+
+          // Use the hoisted beaconServicesMap instead of rebuilding per-vin
+          const beaconService = beaconServicesMap.get(scriptPubKey.address);
+          if (!beaconService) {
+            continue;
+          }
+
+          // Look for 'OP_RETURN' in the scriptPubKey asm
+          const txVoutScriptPubkeyAsm = prevout.vout[vin.vout].scriptPubKey.asm;
+          if(!txVoutScriptPubkeyAsm.includes('OP_RETURN')) {
+            continue;
+          }
+
+          // Log the found txid and beacon
+          console.info(`Tx ${tx.txid} contains beacon service address ${scriptPubKey.address} and OP_RETURN!`, tx);
+
+          // Extract hex string hash of the signal bytes from the scriptpubkey
+          const updateHash = txVoutScriptPubkeyAsm.split(' ').slice(-1)[0];
+          if(!updateHash) {
+            continue;
+          }
+
+          // Push the beacon signal object to the beacon signals array for that beacon service
+          beaconServiceSignals.get(beaconService)?.push({
+            tx,
+            signalBytes   : updateHash,
+            blockMetadata : {
+              height        : block.height,
+              time          : block.time,
+              confirmations : block.confirmations
+            }
+          });
+        };
+      }
+
+      // Increment the height
+      height += 1;
+
+      // Use pre-fetched targetHeight instead of calling rpc.getBlockCount() every iteration
+      if(height > targetHeight) {
+        console.info(`Chain tip reached ${height}, breaking ...`);
+        break;
+      }
+
+      // Reset the block var to the next block data
+      block = await rpc.getBlock({ height }) as BlockV3;
+    }
+
+    return beaconServiceSignals;
+  }
+}