@did-btcr2/method 0.26.0 → 0.28.0

package/src/core/aggregation/runner/events.ts

@@ -0,0 +1,77 @@
+import type { CohortAdvert, PendingSigningRequest, PendingValidation } from '../participant.js';
+import type { AggregationResult, PendingOptIn } from '../service.js';
+
+/**
+ * AggregationServiceRunner events are emitted by the AggregationServiceRunner to signal important
+ * milestones and actions during the aggregation process. They can be listened to by external code
+ * to react to these events, such as logging, updating a UI, or triggering additional actions.
+ */
+export type AggregationServiceEvents = {
+  /** A cohort has been created and the advert message broadcast. */
+  'cohort-advertised': [{ cohortId: string }];
+
+  /** A participant has opted in. Fires before the accept decision callback. */
+  'opt-in-received': [PendingOptIn];
+
+  /** A participant has been accepted into the cohort. */
+  'participant-accepted': [{ participantDid: string }];
+
+  /** Keygen has been finalized — beacon address is now available. */
+  'keygen-complete': [{ cohortId: string; beaconAddress: string }];
+
+  /** A participant has submitted a signed update. */
+  'update-received': [{ participantDid: string }];
+
+  /** Aggregated data has been distributed to all participants for validation. */
+  'data-distributed': [{ cohortId: string }];
+
+  /** A participant has acknowledged validation (approved or rejected). */
+  'validation-received': [{ participantDid: string; approved: boolean }];
+
+  /** Signing has started — auth requests sent to participants. */
+  'signing-started': [{ sessionId: string }];
+
+  /** A participant has contributed their MuSig2 nonce. */
+  'nonce-received': [{ participantDid: string }];
+
+  /** Signing complete — final aggregated signature is ready to broadcast. */
+  'signing-complete': [AggregationResult];
+
+  /** A non-fatal error occurred. Fatal errors reject the run() promise. */
+  'error': [Error];
+};
+
+/**
+ * AggregationParticipantRunner events are emitted by the AggregationParticipantRunner to signal
+ * important milestones and actions during the participant's involvement in the aggregation process.
+ * They can be listened to by external code to react to these events, such as logging, updating a
+ * UI, or triggering additional actions.
+ */
+export type AggregationParticipantEvents = {
+  /** A new cohort advert was discovered. Fires before the shouldJoin filter. */
+  'cohort-discovered': [CohortAdvert];
+
+  /** Participant has opted in to a cohort. */
+  'cohort-joined': [{ cohortId: string }];
+
+  /** Cohort keygen is complete — beacon address is now available. */
+  'cohort-ready': [{ cohortId: string; beaconAddress: string }];
+
+  /** Participant has submitted their signed update. */
+  'update-submitted': [{ cohortId: string }];
+
+  /** Aggregated data has arrived for validation. Fires before the validate callback. */
+  'validation-requested': [PendingValidation];
+
+  /** Signing request has arrived. Fires before the sign approval callback. */
+  'signing-requested': [PendingSigningRequest];
+
+  /** Cohort signing is complete from this participant's perspective. */
+  'cohort-complete': [{ cohortId: string; beaconAddress: string }];
+
+  /** Cohort failed (rejected validation, signing error, etc.). */
+  'cohort-failed': [{ cohortId: string; reason: string }];
+
+  /** A non-fatal error occurred. */
+  'error': [Error];
+};

package/src/core/aggregation/runner/index.ts

@@ -0,0 +1,4 @@
+export * from './typed-emitter.js';
+export * from './events.js';
+export * from './service-runner.js';
+export * from './participant-runner.js';

package/src/core/aggregation/runner/participant-runner.ts

@@ -0,0 +1,364 @@
+import type { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import type { SchnorrKeyPair } from '@did-btcr2/keypair';
+import type { BaseMessage } from '../messages/base.js';
+import {
+  AGGREGATED_NONCE,
+  AUTHORIZATION_REQUEST,
+  COHORT_ADVERT,
+  COHORT_OPT_IN_ACCEPT,
+  COHORT_READY,
+  DISTRIBUTE_AGGREGATED_DATA,
+} from '../messages/constants.js';
+import type {
+  CohortAdvert,
+  PendingSigningRequest,
+  PendingValidation} from '../participant.js';
+import {
+  AggregationParticipant
+} from '../participant.js';
+import { ParticipantCohortPhase } from '../phases.js';
+import type { Transport } from '../transport/transport.js';
+import type { AggregationParticipantEvents } from './events.js';
+import { TypedEventEmitter } from './typed-emitter.js';
+
+/** Decision callback: filter discovered cohorts. Default rejects all. */
+export type ShouldJoin = (advert: CohortAdvert) => Promise<boolean>;
+
+/** Data callback: provide a signed BTCR2 update for a joined cohort. */
+export type OnProvideUpdate = (info: {
+  cohortId: string;
+  beaconAddress: string;
+}) => Promise<SignedBTCR2Update>;
+
+/** Decision callback: approve or reject aggregated data. */
+export type OnValidateData = (info: PendingValidation) => Promise<{ approved: boolean }>;
+
+/** Decision callback: approve or reject signing. */
+export type OnApproveSigning = (info: PendingSigningRequest) => Promise<{ approved: boolean }>;
+
+export interface AggregationParticipantRunnerOptions {
+  /** Underlying transport. */
+  transport: Transport;
+
+  /** Participant identity. */
+  did: string;
+  keys: SchnorrKeyPair;
+
+  /**
+   * Filter discovered cohorts. Returns true to join, false to skip.
+   * Default: rejects all cohorts (caller MUST override or no cohorts will be joined).
+   */
+  shouldJoin?: ShouldJoin;
+
+  /**
+   * Provide a signed BTCR2 update for the cohort.
+   * REQUIRED — no sensible default.
+   */
+  onProvideUpdate: OnProvideUpdate;
+
+  /**
+   * Approve or reject aggregated data.
+   * Default: approve if validation matches the submitted update's hash.
+   */
+  onValidateData?: OnValidateData;
+
+  /**
+   * Approve or reject the signing request.
+   * Default: approve.
+   */
+  onApproveSigning?: OnApproveSigning;
+}
+
+/**
+ * High-level facade for an Aggregation Participant.
+ *
+ * Long-running listener: waits for cohort adverts, applies the `shouldJoin`
+ * filter, and drives each accepted cohort through the full protocol to
+ * completion in parallel.
+ *
+ * @example
+ * ```typescript
+ * const transport = new NostrTransport({ relays: [RELAY] });
+ * transport.registerActor(myDid, myKeys);
+ *
+ * const runner = new AggregationParticipantRunner({
+ *   transport,
+ *   did: myDid,
+ *   keys: myKeys,
+ *   shouldJoin: async (advert) => advert.beaconType === 'CASBeacon',
+ *   onProvideUpdate: async ({ beaconAddress }) => {
+<<<<<<< Updated upstream
+ *     return Update.sign(myDid, unsigned, vm, secretKey);
+=======
+ *     return Updater.sign(myDid, unsigned, vm, secretKey);
+>>>>>>> Stashed changes
+ *   },
+ * });
+ *
+ * runner.on('cohort-complete', ({ beaconAddress }) => {
+ *   console.log(`Add to DID document: bitcoin:${beaconAddress}`);
+ * });
+ *
+ * await runner.start();
+ * ```
+ *
+ * For full manual control, drop down to the underlying state machine via
+ * `runner.session`. The state machine has no transport coupling and exposes
+ * every protocol decision as an explicit method.
+ *
+ * @class AggregationParticipantRunner
+ * @extends TypedEventEmitter<AggregationParticipantEvents>
+ */
+export class AggregationParticipantRunner extends TypedEventEmitter<AggregationParticipantEvents> {
+  /** Direct access to the underlying state machine for advanced use. */
+  readonly session: AggregationParticipant;
+
+  readonly #transport: Transport;
+  readonly #did: string;
+  readonly #shouldJoin: ShouldJoin;
+  readonly #onProvideUpdate: OnProvideUpdate;
+  readonly #onValidateData: OnValidateData;
+  readonly #onApproveSigning: OnApproveSigning;
+
+  #handlersRegistered = false;
+  #stopped = false;
+
+  constructor(options: AggregationParticipantRunnerOptions) {
+    super();
+    this.#transport = options.transport;
+    this.#did = options.did;
+    this.#shouldJoin = options.shouldJoin ?? (async () => false);
+    this.#onProvideUpdate = options.onProvideUpdate;
+    this.#onValidateData = options.onValidateData ?? (async (info) => ({ approved: info.matches }));
+    this.#onApproveSigning = options.onApproveSigning ?? (async () => ({ approved: true }));
+
+    this.session = new AggregationParticipant({ did: options.did, keys: options.keys });
+  }
+
+  /**
+   * Start listening for cohorts. The runner stays active until {@link stop}
+   * is called or the underlying transport disconnects.
+   */
+  async start(): Promise<void> {
+    this.#registerHandlers();
+  }
+
+  /** Stop the runner. Does not unregister transport handlers. */
+  stop(): void {
+    this.#stopped = true;
+  }
+
+  /**
+   * Single-shot helper: start, join the first cohort that passes `shouldJoin`,
+   * drive it to completion, and resolve. Convenient for tests and demos.
+   */
+  static async joinFirst(
+    options: AggregationParticipantRunnerOptions
+  ): Promise<{ cohortId: string; beaconAddress: string }> {
+    return new Promise((resolve, reject) => {
+      const runner = new AggregationParticipantRunner(options);
+      runner.once('cohort-complete', (info) => {
+        runner.stop();
+        resolve(info);
+      });
+      runner.on('error', reject);
+      runner.start().catch(reject);
+    });
+  }
+
+  /**
+   * Internal: handler registration with the transport. Idempotent and safe to call multiple times,
+   * but only registers handlers once.
+   */
+  #registerHandlers(): void {
+    if (this.#handlersRegistered) return;
+    this.#handlersRegistered = true;
+
+    this.#transport.registerMessageHandler(this.#did, COHORT_ADVERT, this.#handleAdvert.bind(this));
+    this.#transport.registerMessageHandler(this.#did, COHORT_OPT_IN_ACCEPT, this.#handleOptInAccept.bind(this));
+    this.#transport.registerMessageHandler(this.#did, COHORT_READY, this.#handleCohortReady.bind(this));
+    this.#transport.registerMessageHandler(this.#did, DISTRIBUTE_AGGREGATED_DATA, this.#handleDistributeData.bind(this));
+    this.#transport.registerMessageHandler(this.#did, AUTHORIZATION_REQUEST, this.#handleAuthorizationRequest.bind(this));
+    this.#transport.registerMessageHandler(this.#did, AGGREGATED_NONCE, this.#handleAggregatedNonce.bind(this));
+  }
+
+  /**
+   * Internal: handler for cohort adverts. Applies the `shouldJoin` filter and joins if approved.
+   * @param {BaseMessage} msg - The received cohort advert message.
+   * @returns {Promise<void>} Resolves when processing is complete.
+   */
+  async #handleAdvert(msg: BaseMessage): Promise<void> {
+    if (this.#stopped) return;
+    try {
+      this.session.receive(msg);
+
+      const advert = this.session.discoveredCohorts.get(msg.body?.cohortId ?? '');
+      if (!advert) return;
+      this.emit('cohort-discovered', advert);
+
+      // Register the service's communication key for encrypted message routing
+      if (advert.serviceCommunicationPk) {
+        this.#transport.registerPeer(advert.serviceDid, advert.serviceCommunicationPk);
+      }
+
+      const join = await this.#shouldJoin(advert);
+      if (!join) return;
+
+      await this.#sendAll(this.session.joinCohort(advert.cohortId));
+      this.emit('cohort-joined', { cohortId: advert.cohortId });
+    } catch (err) {
+      this.emit('error', err as Error);
+    }
+  }
+
+  /**
+   * Internal: handler for opt-in accept messages. Updates the session state accordingly.
+   * @param {BaseMessage} msg - The received opt-in accept message.
+   */
+  #handleOptInAccept(msg: BaseMessage): void {
+    if (this.#stopped) return;
+    try {
+      this.session.receive(msg);
+    } catch (err) {
+      this.emit('error', err as Error);
+    }
+  }
+
+  /**
+   * Internal: handler for cohort ready messages. Updates the session state, emits a 'cohort-ready'
+   * event, and triggers the update submission flow via the `onProvideUpdate` callback.
+   * @param {BaseMessage} msg - The received cohort ready message.
+   * @returns {Promise<void>} Resolves when processing is complete.
+    */
+  async #handleCohortReady(msg: BaseMessage): Promise<void> {
+    if (this.#stopped) return;
+    try {
+      this.session.receive(msg);
+
+      const cohortId = msg.body?.cohortId;
+      if (!cohortId) return;
+
+      const info = this.session.joinedCohorts.get(cohortId);
+      if (!info) return;
+      this.emit('cohort-ready', { cohortId, beaconAddress: info.beaconAddress });
+
+      // Construct the signed update via caller callback and submit
+      const signedUpdate = await this.#onProvideUpdate({
+        cohortId,
+        beaconAddress : info.beaconAddress,
+      });
+      await this.#sendAll(this.session.submitUpdate(cohortId, signedUpdate));
+      this.emit('update-submitted', { cohortId });
+    } catch (err) {
+      this.emit('error', err as Error);
+    }
+  }
+
+  /**
+   * Internal: handler for distribute aggregated data messages. Updates the session state, emits a
+   * 'validation-requested' event, and triggers the validation decision flow via the `onValidateData`
+   * callback. Depending on the decision, sends an approval or rejection message.
+   * @param {BaseMessage} msg - The received distribute aggregated data message.
+   * @returns {Promise<void>} Resolves when processing is complete.
+   * @throws {Error} If an error occurs during message processing or callback execution.
+   */
+  async #handleDistributeData(msg: BaseMessage): Promise<void> {
+    if (this.#stopped) return;
+    try {
+      this.session.receive(msg);
+
+      const cohortId = msg.body?.cohortId;
+      if (!cohortId) return;
+
+      const validation = this.session.pendingValidations.get(cohortId);
+      if (!validation) return;
+      this.emit('validation-requested', validation);
+
+      const decision = await this.#onValidateData(validation);
+      if (decision.approved) {
+        await this.#sendAll(this.session.approveValidation(cohortId));
+      } else {
+        await this.#sendAll(this.session.rejectValidation(cohortId));
+        this.emit('cohort-failed', { cohortId, reason: 'Validation rejected by participant' });
+      }
+    } catch (err) {
+      this.emit('error', err as Error);
+    }
+  }
+
+  /**
+   * Internal: handler for authorization request messages. Updates the session state, emits a
+   * 'signing-requested' event, and triggers the signing approval flow via the `onApproveSigning`
+   * callback. Depending on the decision, sends a nonce approval message or emits a 'cohort-failed'
+   * event.
+   * @param {BaseMessage} msg - The received authorization request message.
+   * @returns {Promise<void>} Resolves when processing is complete.
+   * @throws {Error} If an error occurs during message processing or callback execution.
+   */
+  async #handleAuthorizationRequest(msg: BaseMessage): Promise<void> {
+    if (this.#stopped) return;
+    try {
+      this.session.receive(msg);
+
+      const cohortId = msg.body?.cohortId;
+      if (!cohortId) return;
+
+      const req = this.session.pendingSigningRequests.get(cohortId);
+      if (!req) return;
+      this.emit('signing-requested', req);
+
+      const decision = await this.#onApproveSigning(req);
+      if (!decision.approved) {
+        this.emit('cohort-failed', { cohortId, reason: 'Signing rejected by participant' });
+        return;
+      }
+
+      await this.#sendAll(this.session.approveNonce(cohortId));
+    } catch (err) {
+      this.emit('error', err as Error);
+    }
+  }
+
+  /**
+   * Internal: handler for aggregated nonce messages. Updates the session state, triggers partial
+   * signature generation, and sends the partial signature to the aggregator. If the cohort reaches
+   * completion after processing the nonce, emits a 'cohort-complete' event.
+   * @param {BaseMessage} msg - The received aggregated nonce message.
+   * @returns {Promise<void>} Resolves when processing is complete.
+   * @throws {Error} If an error occurs during message processing or partial signature generation.
+   */
+  async #handleAggregatedNonce(msg: BaseMessage): Promise<void> {
+    if (this.#stopped) return;
+    try {
+      this.session.receive(msg);
+
+      const cohortId = msg.body?.cohortId;
+      if (!cohortId) return;
+
+      await this.#sendAll(this.session.generatePartialSignature(cohortId));
+
+      // Check if we've reached completion
+      if (this.session.getCohortPhase(cohortId) === ParticipantCohortPhase.Complete) {
+        const info = this.session.joinedCohorts.get(cohortId);
+        if (info) {
+          this.emit('cohort-complete', { cohortId, beaconAddress: info.beaconAddress });
+        }
+      }
+    } catch (err) {
+      this.emit('error', err as Error);
+    }
+  }
+
+  /**
+   * Internal: send helper to ensure messages are sent sequentially. This is important for protocol
+   * correctness, as some transports may not guarantee message order if sent in parallel.
+   * @param {BaseMessage[]} msgs - The messages to send.
+   * @returns {Promise<void>} Resolves when all messages have been sent.
+   * @throws {Error} If an error occurs during message sending.
+   */
+  async #sendAll(msgs: BaseMessage[]): Promise<void> {
+    for (const m of msgs) {
+      await this.#transport.sendMessage(m, this.#did, m.to);
+    }
+  }
+}