@did-btcr2/method 0.26.0 → 0.27.0

package/src/core/beacon/aggregation/communication/adapter/did-comm.ts

@@ -1,148 +0,0 @@
-import { NotImplementedError } from '@did-btcr2/common';
-import type { RawSchnorrKeyPair} from '@did-btcr2/keypair';
-import { SchnorrKeyPair, Secp256k1SecretKey } from '@did-btcr2/keypair';
-import { Identifier } from '../../../../identifier.js';
-import type { AggregateBeaconMessageType } from '../../cohort/messages/index.js';
-import type { BaseMessage } from '../../cohort/messages/base.js';
-import type { CommunicationService, MessageHandler, ServiceAdapterConfig, ServiceAdapterIdentity } from '../service.js';
-
-/**
- * DidCommAdapterConfig is a configuration class for the DidCommAdapter.
- * It holds the necessary parameters to connect to Nostr relays and manage keys.
- * @class DidCommAdapterConfig
- * @implements {ServiceAdapterConfig}
- * @type {DidCommAdapterConfig}
- */
-export class DidCommAdapterConfig implements ServiceAdapterConfig {
-  public keys: RawSchnorrKeyPair;
-  public components: {
-    idType: string;
-    version: number;
-    network: string;
-  };
-  public did: string;
-  public coordinatorDids: string[];
-
-  /**
-   * Constructs a new DidCommAdapterConfig instance.
-   * @param {Partial<ServiceAdapterConfig>} [config] Optional configuration parameters to initialize the adapter.
-   * @constructor
-   * @type {DidCommAdapterConfig}
-   */
-  constructor(config?: Partial<ServiceAdapterConfig>) {
-    this.keys = config?.keys || SchnorrKeyPair.generate().raw,
-    this.components = config?.components || {
-      version : 1,
-      idType  : 'KEY',
-      network : 'mutinynet'
-    };
-    this.did = config?.did || Identifier.encode(this.keys.public, this.components);
-    this.coordinatorDids = config?.coordinatorDids || [];
-  }
-}
-
-/**
- * DidCommAdapter implements the CommunicationService interface for DidComm protocol.
- * It handles message sending, receiving, and identity generation using DidComm.
- * @class DidCommAdapter
- * @implements {CommunicationService}
- * @type {DidCommAdapter}
- */
-export class DidCommAdapter implements CommunicationService {
-  /**
-   * The name of the communication service.
-   * @type {string}
-   */
-  public name: string = 'didcomm';
-
-  /**
-   * The configuration for the DidComm adapter.
-   * @type {DidCommAdapterConfig}
-   */
-  public config: DidCommAdapterConfig;
-
-  /**
-   * A map of message handlers for different message types.
-   * @type {Map<string, MessageHandler>}
-   */
-  private handlers: Map<string, MessageHandler> = new Map();
-
-  /**
-   * Constructs a new DidCommAdapter instance with the provided configuration.
-   * @param {DidCommAdapterConfig} [config] The configuration for the Nostr adapter.
-   */
-  constructor(config: DidCommAdapterConfig = {} as DidCommAdapterConfig) {
-    this.config = new DidCommAdapterConfig(config);
-  }
-
-  /**
-   * Starts the DidComm service.
-   * @returns {void} Returns the DidCommAdapter instance for method chaining.
-   */
-  public start(): void {
-    throw new NotImplementedError('DidCommAdapter is not implemented. Use NostrAdapter instead.');
-  }
-
-  /**
-   * Sets the keys used for Nostr communication.
-   * @param {ServiceAdapterIdentity<NostrKeys>} keys The keys to set.
-   */
-  public setKeys(keys: ServiceAdapterIdentity<RawSchnorrKeyPair>): void {
-    this.config.keys = keys;
-  }
-
-  /**
-   * Registers a message handler for a specific message type.
-   * @param {string} messageType The type of message to handle.
-   * @param {MessageHandler} handler The handler function that processes the message.
-   */
-  public registerMessageHandler(messageType: string, handler: MessageHandler): void {
-    this.handlers.set(messageType, handler);
-  }
-
-  /**
-   * Sends a message to a recipient using the Nostr protocol.
-   * This method is a placeholder and should be implemented with actual Nostr message sending logic.
-   * @param {AggregateBeaconMessageType} _message The message to send, typically containing the content and metadata.
-   * @param {string} _recipient The public key or identifier of the recipient.
-   * @param {string} _sender The public key or identifier of the sender.
-   * @returns {Promise<void>} A promise that resolves when the message is sent.
-   */
-  public async sendMessage(
-    _message: AggregateBeaconMessageType | BaseMessage,
-    _recipient: string,
-    _sender: string
-  ): Promise<void | Promise<string>[]> {
-    throw new NotImplementedError('DidCommAdapter.start() is not implemented. Use NostrAdapter instead.');
-  }
-
-  /**
-   * Generates a DidComm identity.
-   * @param {RawKeyPair} [keys] Optional keys to use for identity generation.
-   * @returns {ServiceAdapterConfig} The generated DidComm identity configuration.
-   */
-  public generateIdentity(keys?: RawSchnorrKeyPair): ServiceAdapterConfig {
-    if(!keys) {
-      this.config.keys.secret = Secp256k1SecretKey.random();
-      this.config.keys.public = Secp256k1SecretKey.getPublicKey(this.config.keys.secret).compressed;
-      this.config.did = Identifier.encode(this.config.keys.public,
-        {
-          idType       : this.config.components.idType  || 'KEY',
-          version      : this.config.components.version || 1,
-          network      : this.config.components.network || 'regtest',
-        }
-      );
-      return this.config as ServiceAdapterConfig;
-    }
-
-    this.config.keys = keys;
-    this.config.did = Identifier.encode(this.config.keys.public,
-      {
-        idType       : this.config.components.idType  || 'KEY',
-        version      : this.config.components.version || 1,
-        network      : this.config.components.network || 'regtest',
-      }
-    );
-    return this.config as ServiceAdapterConfig;
-  }
-}

package/src/core/beacon/aggregation/communication/adapter/nostr.ts

@@ -1,323 +0,0 @@
-// TODO: Finish nostr adapter implementation. Rethink patterns used.
-
-import type { Did } from '@did-btcr2/common';
-import type { RawSchnorrKeyPair} from '@did-btcr2/keypair';
-import { CompressedSecp256k1PublicKey, SchnorrKeyPair, Secp256k1SecretKey } from '@did-btcr2/keypair';
-import { bytesToHex } from '@noble/hashes/utils';
-import { nonceGen } from '@scure/btc-signer/musig2';
-import type { Event, EventTemplate, Filter} from 'nostr-tools';
-import { finalizeEvent, nip44, SimplePool } from 'nostr-tools';
-import { Identifier } from '../../../../identifier.js';
-import {
-  BEACON_COHORT_ADVERT,
-  BEACON_COHORT_AGGREGATED_NONCE,
-  BEACON_COHORT_AUTHORIZATION_REQUEST,
-  BEACON_COHORT_NONCE_CONTRIBUTION,
-  BEACON_COHORT_OPT_IN,
-  BEACON_COHORT_OPT_IN_ACCEPT,
-  BEACON_COHORT_READY,
-  BEACON_COHORT_REQUEST_SIGNATURE,
-  BEACON_COHORT_SIGNATURE_AUTHORIZATION
-} from '../../cohort/messages/constants.js';
-import type { AggregateBeaconMessageType } from '../../cohort/messages/index.js';
-import { AggregateBeaconMessage } from '../../cohort/messages/index.js';
-import type { BaseMessage } from '../../cohort/messages/base.js';
-import { CommunicationAdapterError } from '../error.js';
-import type { CommunicationService, MessageHandler, ServiceAdapter, ServiceAdapterConfig, ServiceAdapterIdentity } from '../service.js';
-
-/**
- * TODO: Determine set of default Nostr relays to use.
- * DEFAULT_NOSTR_RELAYS provides a list of default Nostr relay URLs for communication.
- * These relays are used to connect to the Nostr network for sending and receiving messages.
- * @constant {Array<string>} DEFAULT_NOSTR_RELAYS
- */
-export const DEFAULT_NOSTR_RELAYS = [
-  'wss://relay.damus.io',
-  // 'wss://nos.lol',
-  // 'wss://relay.snort.social',
-  // 'wss://nostr-pub.wellorder.net',
-];
-
-/**
- * NostrAdapterConfig defines the configuration structure for the Nostr communication adapter.
- * It includes relay URLs, key pairs, and components for identity generation.
- * @interface NostrAdapterConfig
- * @type {NostrAdapterConfig}
- */
-export interface NostrAdapterConfig {
-  keys: RawSchnorrKeyPair;
-  did?: string;
-  components: {
-    idType?: string;
-    version?: number;
-    network?: string;
-  };
-  relays: string[];
-  [key: string]: any;
-}
-
-/**
- * NostrAdapter implements the CommunicationService interface for Nostr protocol communication.
- * It provides methods for starting the service, sending messages, and handling incoming events.
- * @class NostrAdapter
- * @type {NostrAdapter}
- * @implements {CommunicationService}
- */
-export class NostrAdapter implements CommunicationService {
-  /**
-   * The name of the NostrAdapter service.
-   * @type {string}
-   */
-  name: string = 'nostr';
-
-  /**
-   * The configuration for the NostrAdapter.
-   * @type {NostrAdapterConfig}
-   */
-  config: NostrAdapterConfig;
-
-  /**
-   * A map of message handlers for different message types.
-   * @type {Map<string, MessageHandler>}
-   */
-  #handlers: Map<string, MessageHandler> = new Map();
-
-  /**
-   * The SimplePool instance for managing Nostr subscriptions.
-   * @type {SimplePool}
-   */
-  pool?: SimplePool;
-
-  /**
-   * Constructs a new NostrAdapter instance with the given configuration.
-   * @param {NostrAdapterConfig} config - The configuration for the NostrAdapter.
-   * If no configuration is provided, a new key pair is generated and default relays are used.
-   * @constructor
-   */
-  constructor(config: NostrAdapterConfig = { keys: {} as RawSchnorrKeyPair, components: {}, relays: DEFAULT_NOSTR_RELAYS }) {
-    this.config = config;
-    this.config.keys = this.config.keys || SchnorrKeyPair.generate().raw;
-    this.config.did = config.did || Identifier.encode(this.config.keys.public!, {
-      idType       : config.components.idType  || 'KEY',
-      version      : config.components.version || 1,
-      network      : config.components.network || 'signet'
-    });
-  }
-
-  /**
-   * Sets the keys for the NostrAdapter.
-   * @param {ServiceAdapterIdentity<RawSchnorrKeyPair>} keys - The key pair to set.
-   */
-  public setKeys(keys: ServiceAdapterIdentity<RawSchnorrKeyPair>): void {
-    this.config.keys = keys;
-  }
-
-
-  /**
-   * TODO: Complete this method. Figure out best subscription patterns.
-   * Starts the Nostr communication service by subscribing to relays.
-   * @returns {ServiceAdapter<NostrAdapter>} Returns the NostrAdapter instance for method chaining.
-   */
-  public start(): ServiceAdapter<NostrAdapter> {
-    this.pool = new SimplePool();
-
-    this.pool.subscribe(this.config.relays, { kinds: [1] } as Filter, {
-      onclose : (reasons: string[]) => console.log('Subscription to kind 1 closed', reasons),
-      onevent : this.onEvent.bind(this),
-    });
-
-    // this.pool.subscribe(this.config.relays, { kinds: [1059] } as Filter, {
-    //   onclose : (reasons: string[]) => console.log('Subscription to kind 1059 closed for reasons:', reasons),
-    //   onevent : this.onEvent.bind(this),
-    //   oneose  : () => { Logger.info('EOSE kinds 1059'); }
-    // });
-
-    return this;
-  }
-
-
-  /**
-   * TODO: Complete this method. Figure out best way to filter incoming nostr events.
-   * Handles incoming Nostr events and dispatches them to the appropriate message handler.
-   * @param {Event} event The Nostr event received from the relay.
-   */
-  private async onEvent(event: Event): Promise<void> {
-    // Logger.debug('nostr.onEvent: event.tags', event.tags);
-    // Dispatch the event to the registered handler
-    const ptags = event.tags.filter(([name, _]) => name === 'p') ?? [];
-    // Logger.debug('nostr.onEvent: event.tags.find => ptags', ptags);
-
-    for(const [p, pk] of ptags ){
-      if(pk === 'b71d3052dcdc8ba4564388948b655b58aaa7f37497ef1fc98829f9191adc8f85') {
-        console.debug('nostr.onEvent: event.tags.find => p, pk', p, pk);
-      }
-    }
-    // if(!type && !value) {
-    //   // Logger.warn(`Event ${event.id} does not have a valid tag, skipping handler dispatch.`);
-    //   return;
-    // }
-    // Logger.debug('nostr.onEvent: event.tags.find => type, value', type, value);
-
-    // Logger.debug('nostr.onEvent: event', event);
-    // Logger.debug('nostr.onEvent: event.tags', event.tags);
-
-    // if(event.kind === 1 && !AggregateBeaconMessage.isKeyGenMessageValue(value)) {
-    //   Logger.warn(`Event ${event.id} is not a key generation message type: ${value}, skipping handler dispatch.`);
-    //   return;
-    // }
-
-    // if(event.kind === 1059 && !AggregateBeaconMessage.isSignMessageValue(value)) {
-    //   Logger.warn(`Event ${event.id} has an invalid title tag: ${value}, skipping handler dispatch.`);
-    //   return;
-    // }
-
-    // const handler = this.handlers.get(value);
-    // if (!handler) {
-    //   Logger.warn(`No handler found for message with tag value: ${value}`);
-    //   return;
-    // }
-
-    // await handler(event);
-  }
-
-  /**
-   * Registers a message handler for a specific message type.
-   * @param {string} messageType The type of message to handle.
-   * @param {MessageHandler} handler The handler function that processes the message.
-   */
-  public registerMessageHandler(messageType: string, handler: MessageHandler): void {
-    this.#handlers.set(messageType, handler);
-  }
-
-
-  /**
-   * TODO: Clean up and complete this method.
-   * Sends a message to a recipient using the Nostr protocol.
-   * This method is a placeholder and should be implemented with actual Nostr message sending logic.
-   * @param {AggregateBeaconMessageType} message The message to send, typically containing the content and metadata.
-   * @param {Did} from The identifier of the sender.
-   * @param {Did} [to] The identifier of the recipient.
-   * @returns {Promise<void>} A promise that resolves when the message is sent.
-   */
-  public async sendMessage(message: AggregateBeaconMessageType | BaseMessage, from: Did, to?: Did): Promise<void | Promise<string>[]> {
-    // Check if the sender and recipient DIDs are valid identifiers
-    if(
-      [from, to]
-        .filter(did => !!did)
-        .every(did => !Identifier.isValid(did!))
-    ) {
-      console.error(`Invalid identifiers: sender ${from}, recipient ${to}`);
-      throw new CommunicationAdapterError(
-        `Invalid identifiers: sender ${from}, recipient ${to}`,
-        'SEND_MESSAGE_ERROR', { adapter: this.name }
-      );
-    }
-    // Decode the sender and recipient DIDs to get their genesis bytes in hex
-    const sender = new CompressedSecp256k1PublicKey(Identifier.decode(from).genesisBytes);
-    console.info(`Sending message from ${sender}:`, message);
-
-    // if(message.type === BEACON_COHORT_SUBSCRIBE_ACCEPT) {
-    //   this.config.coordinatorDids.push(recipient);
-    // }
-
-    const tags = [['p', bytesToHex(sender.x)]];
-    if(to) {
-      const recipient = new CompressedSecp256k1PublicKey(Identifier.decode(to).genesisBytes);
-      tags.push(['p', bytesToHex(recipient.x)]);
-    }
-    const { type } = message as any ?? {};
-    if(!type) {
-      console.error('Message type is undefined:', message);
-      throw new CommunicationAdapterError(
-        'Message type is undefined',
-        'SEND_MESSAGE_ERROR', { adapter: this.name }
-      );
-    }
-
-    if(AggregateBeaconMessage.isKeyGenMessageValue(type)) {
-      switch(type) {
-        case BEACON_COHORT_ADVERT:
-          console.info('Add tag', ['BEACON_COHORT_ADVERT', type]);
-          break;
-        case BEACON_COHORT_OPT_IN:
-          console.info('Add tag', ['BEACON_COHORT_OPT_IN', type]);
-          break;
-        case BEACON_COHORT_OPT_IN_ACCEPT:
-          console.info('Add tag', ['BEACON_COHORT_OPT_IN_ACCEPT', type]);
-          break;
-        case BEACON_COHORT_READY:
-          console.info('Add tag', ['BEACON_COHORT_READY', type]);
-          break;
-      }
-      const event = finalizeEvent({
-        kind       : 1,
-        created_at : Math.floor(Date.now() / 1000),
-        tags,
-        content    : JSON.stringify(message)
-      } as EventTemplate, this.config.keys.secret!);
-      console.info(`Sending message kind 1 event ...`, event);
-      return this.pool?.publish(this.config.relays, event);
-    }
-
-    if(AggregateBeaconMessage.isSignMessageValue(type)) {
-      switch(type) {
-        case BEACON_COHORT_REQUEST_SIGNATURE:
-          console.info('Add tag', ['BEACON_COHORT_REQUEST_SIGNATURE', type]);
-          break;
-        case BEACON_COHORT_AUTHORIZATION_REQUEST:
-          console.info('Add tag', ['BEACON_COHORT_AUTHORIZATION_REQUEST', type]);
-          break;
-        case BEACON_COHORT_NONCE_CONTRIBUTION:
-          console.info('Add tag', ['BEACON_COHORT_NONCE_CONTRIBUTION', type]);
-          break;
-        case BEACON_COHORT_AGGREGATED_NONCE:
-          console.info('Add tag', ['BEACON_COHORT_AGGREGATED_NONCE', type]);
-          break;
-        case BEACON_COHORT_SIGNATURE_AUTHORIZATION:
-          console.info('Add tag', ['BEACON_COHORT_SIGNATURE_AUTHORIZATION', type]);
-          break;
-      }
-      const { publicKey, secretKey } = SchnorrKeyPair.generate();
-      const content = nip44.encrypt(JSON.stringify(message), secretKey.bytes, nonceGen(publicKey.x).public);
-      console.debug('NostrAdapter content:', content);
-
-      const event = finalizeEvent({ content, tags, kind: 1059 } as EventTemplate, this.config.keys.secret!);
-      console.debug('NostrAdapter event:', event);
-
-      return this.pool?.publish(this.config.relays, event);
-    }
-
-    console.error(`Unsupported message type: ${type}`);
-  }
-
-  /**
-   * TODO: Determine if this method is needed.
-   * Generates a Nostr identity using the Secp256k1SecretKey and Identifier classes.
-   * @param {RawSchnorrKeyPair} [keys] Optional keys to use for identity generation.
-   * @returns {ServiceAdapterConfig} The generated Nostr identity configuration.
-   */
-  public generateIdentity(keys?: RawSchnorrKeyPair): ServiceAdapterConfig {
-    if(!keys) {
-      this.config.keys.secret = Secp256k1SecretKey.random();
-      this.config.keys.public = Secp256k1SecretKey.getPublicKey(this.config.keys.secret).compressed;
-      this.config.did = Identifier.encode(this.config.keys.public,
-        {
-          idType       : this.config.components.idType  || 'KEY',
-          version      : this.config.components.version || 1,
-          network      : this.config.components.network || 'signet',
-        }
-      );
-      return this.config as ServiceAdapterConfig;
-    }
-
-    this.config.keys = keys;
-    this.config.did = Identifier.encode(this.config.keys.public,
-      {
-        idType       : this.config.components.idType  || 'KEY',
-        version      : this.config.components.version || 1,
-        network      : this.config.components.network || 'signet',
-      }
-    );
-    return this.config as ServiceAdapterConfig;
-  }
-}

package/src/core/beacon/aggregation/communication/error.ts

@@ -1,13 +0,0 @@
-import { MethodError } from '@did-btcr2/common';
-
-export class CommunicationServiceError extends MethodError {
-  constructor(message: string, type: string = 'CommunicationServiceError', data?: Record<string, any>) {
-    super(message, type, data);
-  }
-}
-
-export class CommunicationAdapterError extends MethodError {
-  constructor(message: string, type: string = 'CommunicationAdapterError', data?: Record<string, any>) {
-    super(message, type, data);
-  }
-}

package/src/core/beacon/aggregation/communication/factory.ts

@@ -1,25 +0,0 @@
-import { NotImplementedError } from '@did-btcr2/common';
-import { NostrAdapter } from './adapter/nostr.js';
-import { CommunicationServiceError } from './error.js';
-import type { CommunicationService, Service } from './service.js';
-
-/**
- * Communication Factory pattern to create Communication Service instances.
- * @class CommunicationFactory
- * @type {CommunicationFactory}
- */
-export class CommunicationFactory {
-  static establish(service: Service): CommunicationService {
-    switch (service.type) {
-      case 'nostr':
-        return new NostrAdapter();
-      case 'didcomm':
-        throw new NotImplementedError('DID Comm service not implemented yet.');
-      default:
-        throw new CommunicationServiceError(
-          `Invalid service type ${service.type}`,
-          'INVALID_BEACON_ERROR', { service }
-        );
-    }
-  }
-}

package/src/core/beacon/aggregation/communication/service.ts

@@ -1,42 +0,0 @@
-import type { AggregateBeaconMessageType } from '../cohort/messages/index.js';
-import type { BaseMessage } from '../cohort/messages/base.js';
-import type { RawSchnorrKeyPair } from '@did-btcr2/keypair';
-
-/**
- * ServiceAdapterConfig defines the configuration structure for the Nostr communication service.
- * It includes relay URLs, key pairs, and components for identity generation.
- * @interface ServiceAdapterConfig
- * @extends {Record<string, any>}
- * @type {ServiceAdapterConfig}
- */
-export interface ServiceAdapterConfig extends Record<string, any> {
-  keys: ServiceAdapterIdentity<any>;
-  did: string;
-}
-
-export type SyncMessageHandler = (msg: any) => void;
-export type AsyncMessageHandler = (msg: any) => Promise<void>;
-export type MessageHandler = SyncMessageHandler | AsyncMessageHandler;
-
-export type CommunicationServiceType = 'nostr' | 'didcomm';
-export type ServiceAdapterConfigType<T extends ServiceAdapterConfig> = T;
-export interface Service {
-  type: CommunicationServiceType;
-  keys: ServiceAdapterIdentity<RawSchnorrKeyPair>;
-  did: string;
-  name?: string;
-}
-export type ServiceAdapter<T extends CommunicationService> = T;
-export type ServiceAdapterIdentity<T extends RawSchnorrKeyPair> = T;
-export interface CommunicationService {
-  name: string;
-  start(): void;
-  setKeys(keys: ServiceAdapterIdentity<RawSchnorrKeyPair>): void;
-  registerMessageHandler(messageType: string, handler: MessageHandler): void;
-  sendMessage(
-    message: AggregateBeaconMessageType | BaseMessage,
-    sender: string,
-    recipient?: string
-  ): Promise<void | Promise<string>[]>;
-  generateIdentity(keys?: RawSchnorrKeyPair): ServiceAdapterConfigType<ServiceAdapterConfig>;
-}