@did-btcr2/method 0.18.0 → 0.19.0

package/src/interfaces/beacon.ts

@@ -1,137 +0,0 @@
-import { RawTransactionRest, RawTransactionV2 } from '@did-btcr2/bitcoin';
-import { DidUpdatePayload, UnixTimestamp } from '@did-btcr2/common';
-import { DidServiceEndpoint, DidService as IDidService } from '@web5/dids';
-import { SidecarData, SignalsMetadata } from '../utils/types.js';
-
-/**
- * Beacon interface
- * @interface IBeacon
- * @type {IBeacon}
- */
-export interface IBeacon {
-    /**
-     * A unique identifier for the Beacon
-     * @type {string}
-     */
-    id: string;
-
-    /**
-     * The type of the Beacon
-     * @type {string}
-     */
-    type: string;
-
-    /**
-     * The service endpoint of the Beacon
-     * @type {string}
-     */
-    serviceEndpoint: DidServiceEndpoint;
-
-    /**
-     * Returns the Beacon Service object
-     * @type {BeaconService}
-     */
-    service: BeaconService;
-
-    /**
-     * Generates a Beacon Signal Transaction
-     * @param {string} didUpdatePayload The DID update payload
-     * @returns {BeaconSignal} The Beacon Signal
-     */
-    generateSignal(didUpdatePayload: string): BeaconSignal;
-
-    /**
-     * Processes a Beacon Signal.
-     * @param {RawTransactionV2} signal The raw transaction
-     * @param {SidecarData} signalsMetadata The signals metadata from the sidecar data
-     * @returns {Promise<DidUpdatePayload | undefined>} The DID update payload
-     */
-    processSignal(signal: RawTransactionV2, signalsMetadata: SignalsMetadata): Promise<DidUpdatePayload | undefined>;
-
-
-    /**
-     * Broadcasts a signal.
-     * @param {DidUpdatePayload} didUpdatePayload The DID update payload.
-     * @returns {Promise<SignalMetadata>} The signal metadata.
-     */
-    broadcastSignal(didUpdatePayload: DidUpdatePayload): Promise<SignalsMetadata>;
-}
-
-export interface BeaconService extends IDidService {
-    serviceEndpoint: DidServiceEndpoint;
-    casType?: string;
-}
-
-export interface BeaconServiceAddress extends BeaconService {
-    address: string;
-}
-export interface BeaconSignal {
-  beaconId: string;
-  beaconType: string;
-  beaconAddress: string;
-  tx: RawTransactionRest | RawTransactionV2;
-  blockheight: number;
-  blocktime: UnixTimestamp;
-}
-
-/**
- * Implements {@link https://dcdpr.github.io/did-btcr2/#update-beacons | 5. Beacons}.
- * Beacons are the mechanism by which a DID controller announces an update to their DID document by broadcasting an
- * attestation to this update onto the public Bitcoin network. Beacons are identified by a Bitcoin address and emit
- * Beacon Signals by broadcasting a valid Bitcoin transaction that spends from this Beacon address. These transactions
- * include attestations to a set of didUpdatePayloads, either in the form of Content Identifiers (CIDs) or Sparse Merkle
- * Tree (SMT) roots. Beacons are included as a service in DID documents, with the Service Endpoint identifying a Bitcoin
- * address to watch for Beacon Signals. All Beacon Signals broadcast from this Beacon MUST be processed as part of
- * resolution (see Read). The type of the Beacon service in the DID document defines how Beacon Signals SHOULD be
- * processed.
- * did:btcr2 supports different Beacon Types, with each type defining a set of algorithms for:
- *  1. How a Beacon can be established and added as a service to a DID document.
- *  2. How attestations to DID updates are broadcast within Beacon Signals.
- *  3. How a resolver processes a Beacon Signal, identifying, verifying, and applying the authorized mutations to a
- *     DID document for a specific DID.
- * This is an extendable mechanism, such that in the future new Beacon Types could be added. It would be up to the
- * resolver to determine if the Beacon Type is a mechanism they support and are willing to trust. If they are unable to
- * support a Beacon Type and a DID they are resolving uses that type then the DID MUST be treated as invalid.
- * The current, active Beacons of a DID document are specified in the document’s service property. By updating the DID
- * document, a DID controller can change the set of Beacons they can use to broadcast updates to their DID document over
- * time. Resolution of a DID MUST process signals from all Beacons identified in the latest DID document and apply them
- * in order determined by the version specified by the didUpdatePayload.
- * All resolvers of did:btcr2 DIDs MUST support the core Beacon Types defined in this specification.
- *
- * @abstract
- * @class Beacon
- * @type {Beacon}
- */
-export abstract class Beacon implements IBeacon {
-  public id: string;
-  public type: string;
-  public serviceEndpoint: DidServiceEndpoint;
-  public sidecar?: SidecarData;
-
-  constructor({ id, type, serviceEndpoint }: BeaconService, sidecar?: SidecarData) {
-    this.id = id;
-    this.type = type;
-    this.serviceEndpoint = serviceEndpoint;
-    this.sidecar = sidecar;
-  }
-
-  /**
-   * Returns the Beacon Service object.
-   */
-  abstract get service(): BeaconService;
-
-  /**
-   * Generates a Beacon Signal (implemented by subclasses).
-   */
-  abstract generateSignal(didUpdatePayload: string): BeaconSignal;
-
-  /**
-   * Processes a Beacon Signal (implemented by subclasses).
-   */
-  abstract processSignal(signal: RawTransactionRest | RawTransactionV2, signalsMetadata: SignalsMetadata): Promise<DidUpdatePayload | undefined>
-
-  /**
-   * Broadcasts a Beacon Signal (implemented by subclasses).
-   */
-  abstract broadcastSignal(didUpdatePayload: DidUpdatePayload): Promise<SignalsMetadata>;
-}

package/src/interfaces/crud.ts

@@ -1,33 +0,0 @@
-import { UnixTimestamp } from '@did-btcr2/common';
-import { DidResolutionOptions as IDidResolutionOptions } from '@web5/dids';
-import { DidDocument } from '../utils/did-document.js';
-import { SidecarData } from '../utils/types.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 {?SidecarData} sidecarData The sidecar data for resolving the DID Document
- */
-export interface DidResolutionOptions extends IDidResolutionOptions {
-  versionId?: number
-  versionTime?: UnixTimestamp;
-  sidecarData?: SidecarData;
-  network?: string;
-}
-export interface RootCapability {
-    '@context': string;
-    id: string;
-    controller: string;
-    invocationTarget: string;
-}
-export interface ReadBlockchainParams {
-  contemporaryDidDocument: DidDocument;
-  contemporaryBlockHeight: number | 1;
-  currentVersionId: number | 1;
-  targetVersionId?: number;
-  targetBlockHeight: number;
-  updateHashHistory: string[];
-  sidecarData?: SidecarData;
-  options?: DidResolutionOptions;
-}

package/src/utils/types.ts

@@ -1,41 +0,0 @@
-import { DidUpdatePayload, ProofBytes } from '@did-btcr2/common';
-import { BeaconService } from '../interfaces/beacon.js';
-import { DidDocument } from './did-document.js';
-import { BlockV3 } from '@did-btcr2/bitcoin';
-
-export type FindNextSignals = {
-  block: BlockV3;
-  beacons: BeaconService[]
-};
-export type Metadata = {
-  didUpdate: DidUpdatePayload;
-  proofs?: string;
-};
-export type SignalSidecarData = Metadata;
-export interface Sidecar {
-  did: string;
-}
-export type SignalsMetadata = { [signalId: string]: Metadata; };
-export interface SingletonSidecar extends Sidecar {
-  signalsMetadata: SignalsMetadata;
-}
-export interface CIDAggregateSidecar extends Sidecar {
-  initialDocument: DidDocument;
-  signalsMetadata: SignalsMetadata;
-  cidUpdates: Array<string>;
-}
-export interface SMTAggregateSidecar extends Sidecar {
-  initialDocument: DidDocument;
-  signalsMetadata: SignalsMetadata;
-  smtProof: ProofBytes;
-}
-export type BeaconSidecarData<T> =
-  T extends 'SingletonBeacon' ? SingletonSidecar :
-  T extends 'CIDAggregateBeacon' ? CIDAggregateSidecar :
-  T extends 'SMTAggregateBeacon' ? SMTAggregateSidecar :
-  T;
-export type SidecarData = BeaconSidecarData<SingletonSidecar | CIDAggregateSidecar | SMTAggregateSidecar>;
-export type GetSigningMethodParams = {
-  didDocument: DidDocument;
-  methodId?: string;
-};