@did-btcr2/method 0.18.1 → 0.20.0

package/src/core/resolve.ts

@@ -0,0 +1,463 @@
+import {
+  BitcoinNetworkConnection,
+  getNetwork
+} from '@did-btcr2/bitcoin';
+import {
+  DateUtils,
+  IdentifierHrp,
+  INVALID_DID,
+  INVALID_DID_DOCUMENT,
+  INVALID_DID_UPDATE,
+  JSONPatch,
+  JSONUtils,
+  LATE_PUBLISHING_ERROR,
+  MISSING_UPDATE_DATA,
+  ResolveError
+} from '@did-btcr2/common';
+import {
+  BIP340Cryptosuite,
+  BIP340DataIntegrityProof,
+  SchnorrMultikey,
+  SignedBTCR2Update,
+  UnsignedBTCR2Update
+} from '@did-btcr2/cryptosuite';
+import { CompressedSecp256k1PublicKey } from '@did-btcr2/keypair';
+import { bytesToHex } from '@noble/hashes/utils';
+import { canonicalization, DidBtcr2 } from '../did-btcr2.js';
+import { Appendix } from '../utils/appendix.js';
+import { DidDocument, ID_PLACEHOLDER_VALUE } from '../utils/did-document.js';
+import { BeaconFactory } from './beacon/factory.js';
+import { BeaconService, BlockMetadata } from './beacon/interfaces.js';
+import { BeaconSignalDiscovery } from './beacon/signal-discovery.js';
+import { BeaconUtils } from './beacon/utils.js';
+import { DidComponents, Identifier } from './identifier.js';
+import { SMTProof } from './interfaces.js';
+import { CASAnnouncement, Sidecar, SidecarData } from './types.js';
+
+/**
+ * The response object for DID Resolution.
+ */
+export interface DidResolutionResponse {
+  currentDocument: DidDocument;
+  confirmations: number;
+  versionId: string;
+  updated: string;
+}
+
+/**
+ * Implements {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html | 7.2 Resolve}.
+ * Resolving a did:btcr2 identifier iteratively builds a DID document by applying BTCR2 Updates
+ * to an Initial DID Document that have been committed to the Bitcoin blockchain by Authorized
+ * Beacon Signals. The Initial DID Document is either deterministically created from the DID or
+ * provided by Sidecar Data.
+ * @class Resolve
+ * @type {Resolve}
+ */
+export class Resolve {
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#if-genesis_bytes-is-a-secp256k1-public-key | 7.2.d.1 if genesis bytes is a secp256k1 Public Key}.
+   * @param {DidComponents} didComponents The decoded components of the did.
+   * @returns {DidDocument} The resolved DID Document object.
+   */
+  static deterministic(didComponents: DidComponents): DidDocument {
+    // Encode the did from the didComponents
+    const did = Identifier.encode(didComponents);
+
+    // Deconstruct the bytes from the given components
+    const { genesisBytes } = didComponents;
+
+    // Construct a new CompressedSecp256k1PublicKey and deconstruct the publicKey and publicKeyMultibase
+    const { multibase: publicKeyMultibase } = new CompressedSecp256k1PublicKey(genesisBytes);
+
+    // Generate the service field for the DID Document
+    const service = BeaconUtils.generateBeaconServices({
+      id         : did,
+      publicKey  : genesisBytes,
+      network    : getNetwork(didComponents.network),
+      beaconType : 'SingletonBeacon'
+    });
+
+    return new DidDocument({
+      id                 : did,
+      controller         : [did],
+      verificationMethod : [{
+        id                 : `${did}#initialKey`,
+        type               : 'Multikey',
+        controller         : did,
+        publicKeyMultibase : publicKeyMultibase.encoded
+      }],
+      service
+    });
+  }
+
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#if-genesis_bytes-is-a-sha-256-hash | 7.2.d.2 if genesis_bytes is a SHA-256 Hash}.
+   * @param {DidComponents} didComponents BTCR2 DID components used to resolve the DID Document
+   * @param {GenesisDocument} genesisDocument The genesis document for resolving the DID Document.
+   * @returns {Promise<DidDocument>} The resolved DID Document object
+   * @throws {ResolveError} InvalidDidDocument if not conformant to DID Core v1.1
+   */
+  static async external(
+    didComponents: DidComponents,
+    genesisDocument: object,
+  ): Promise<DidDocument> {
+    // Canonicalize and sha256 hash the currentDocument
+    const hashBytes = canonicalization.process(genesisDocument, { encoding: 'hex' });
+
+    // Compare the genesisBytes to the hashBytes
+    const genesisBytes = bytesToHex(didComponents.genesisBytes);
+
+    // If the genesisBytes do not match the hashBytes, throw an error
+    if (genesisBytes !== hashBytes) {
+      throw new ResolveError(
+        `Initial document mismatch: genesisBytes ${genesisBytes} !== hashBytes ${hashBytes}`,
+        INVALID_DID_DOCUMENT, { genesisBytes, hashBytes }
+      );
+    }
+
+    // Encode the did from the didComponents
+    const did = Identifier.encode(didComponents);
+
+    // Replace the placeholder did with the did throughout the currentDocument.
+    const currentDocument = JSON.parse(
+      JSON.stringify(genesisDocument).replaceAll(ID_PLACEHOLDER_VALUE, did)
+    );
+
+    // Return a W3C conformant DID Document
+    return new DidDocument(currentDocument);
+  }
+
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-sidecar-data | Process Sidecar Data}
+   * @param {Sidecar} sidecar The sidecar data to process.
+   * @returns {ProcessedSidecar} The processed sidecar data containing maps of updates, CAS announcements, and SMT proofs.
+   */
+  static sidecarData(sidecar: Sidecar = {} as Sidecar): SidecarData {
+    // BTCR2 Signed Updates map
+    const updateMap = new Map<string, SignedBTCR2Update>();
+    if(sidecar.updates?.length)
+      for(const update of sidecar.updates) {
+        updateMap.set(canonicalization.process(update, { encoding: 'hex' }), update);
+      }
+
+    // CAS Announcements map
+    const casMap = new Map<string, CASAnnouncement>();
+    if(sidecar.casUpdates?.length)
+      for(const update of sidecar.casUpdates) {
+        casMap.set(canonicalization.process(update, { encoding: 'hex' }), update);
+      }
+
+    // SMT Proofs map
+    const smtMap = new Map<string, SMTProof>();
+    if(sidecar.smtProofs?.length)
+      for(const proof of sidecar.smtProofs) {
+        smtMap.set(proof.id, proof);
+      }
+
+    return { updateMap, casMap, smtMap };
+  }
+
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#establish-current-document | 7.2.d Establish current_document}.
+   * Resolution begins by creating an Initial Did Document called current_document (Current DID Document).
+   * The current_document is iteratively patched with BTCR2 Signed Updates announced by Authorized Beacon Signals.
+   * @param {DidComponents} didComponents The decoded components of the did.
+   * @param {GenesisDocument} genesisDocument The genesis document for resolving the DID Document.
+   * @returns {Promise<DidDocument>} The resolved DID Document object.
+   * @throws {ResolveError} if the DID hrp is invalid, no sidecarData passed and hrp = "x".
+   */
+
+  static async currentDocument(
+    didComponents: DidComponents,
+    genesisDocument?: object,
+  ): Promise<DidDocument> {
+    // Deconstruct the hrp from the components
+    const { hrp, genesisBytes } = didComponents;
+
+    // If hrp `x`, perform external resolution
+    if (hrp === IdentifierHrp.x) {
+      if(!genesisDocument)
+        throw new ResolveError(
+          'External resolution requires genesisDocument',
+          MISSING_UPDATE_DATA, { didComponents }
+        );
+      return await this.external(didComponents, genesisDocument);
+    }
+
+    // Check for hrp `k`
+    if(hrp === IdentifierHrp.k){
+      // Validate genesis bytes as a compressed secp256k1 public key
+      if(!CompressedSecp256k1PublicKey.isValid(genesisBytes)) {
+        throw new ResolveError(
+          'Deterministic resolution requires valid secp256k1 public key',
+          INVALID_DID, { genesisBytes }
+        );
+      }
+      // Perform deterministic resolution
+      return this.deterministic(didComponents);
+    }
+
+    // Else, throw an error for unsupported hrp
+    throw new ResolveError(`Unsupported DID hrp ${hrp}`, INVALID_DID, { hrp });
+  }
+
+  /**
+   * Finds uses the beacon services in the currentDocument to scan for onchain Beacon Signals (transactions) containing
+   * Signal Bytes (last output in OP_RETURN transaction).
+   * @param {Array<BeaconService>} beaconServices The array of BeaconService objects to search for signals.
+   * @param {SidecarData} sidecarData The sidecar data containing maps of updates, CAS announcements, and SMT proofs.
+   * @param {BitcoinNetworkConnection} bitcoin The bitcoin network connection used to fetch beacon signals
+   * @returns {Promise<Array<[SignedBTCR2Update, BlockMetadata]>>} The array of BTCR2 Signed Updates announced by the Beacon Signals.
+   */
+  static async beaconSignals(
+    beaconServices: Array<BeaconService>,
+    sidecarData: SidecarData,
+    bitcoin: BitcoinNetworkConnection
+  ): Promise<Array<[SignedBTCR2Update, BlockMetadata]>> {
+    // Discover Beacon Signals via indexer server (esplora/electrs) or full node
+    const beaconServicesSignals = bitcoin.network.rest
+      ? await BeaconSignalDiscovery.indexer(beaconServices, bitcoin)
+      : await BeaconSignalDiscovery.fullnode(beaconServices, bitcoin);
+
+    // Process each beacon's signals in parallel
+    const promises = Array.from(beaconServicesSignals.entries()).map(
+      async ([service, signals]) => {
+        // Skip beacons with no signals
+        if (!signals.length) return [];
+        // Establish a typed beacon and process its signals
+        return BeaconFactory.establish(service).processSignals(signals, sidecarData);
+      }
+    );
+
+    return (await Promise.all(promises)).flat();
+  }
+
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-updates | 7.2.f Process updates Array}.
+   * @param {DidDocument} currentDocument The current DID Document to apply the updates to.
+   * @param {Array<[SignedBTCR2Update, BlockMetadata]>} unsortedUpdates The unsorted array of BTCR2 Signed Updates and their associated Block Metadata.
+   * @param {string} [versionTime] The optional version time to limit updates to.
+   * @param {string} [versionId] The optional version id to limit updates to.
+   * @returns {Promise<DidResolutionResponse>} The updated DID Document, number of confirmations, and version id.
+   */
+  static async updates(
+    currentDocument: DidDocument,
+    unsortedUpdates: Array<[SignedBTCR2Update, BlockMetadata]>,
+    versionTime?: string,
+    versionId?: string
+  ): Promise<DidResolutionResponse> {
+    // Start the version number being processed at 1
+    let currentVersionId = 1;
+
+    // Initialize an empty array to hold the update hashes
+    const updateHashHistory: string[] = [];
+
+    // 1. Sort updates by targetVersionId (ascending), using blockheight as tie-breaker
+    const updates = unsortedUpdates.sort(([upd0, blk0], [upd1, blk1]) =>
+      upd0.targetVersionId - upd1.targetVersionId || blk0.height - blk1.height
+    );
+
+    // Create a default response object
+    const response = {
+      currentDocument,
+      versionId     : `${currentVersionId}`,
+      confirmations : 0,
+      updated       : ''
+    };
+
+    // Iterate over each (update block) pair
+    for(const [update, block] of updates) {
+      // Get the hash of the current document
+      const currentDocumentHash = canonicalization.process(response.currentDocument, { encoding: 'base58' });
+
+      // Set confirmations to the block confirmations
+      response.confirmations = block.confirmations;
+
+      // Safely convert versionTime to timestamp
+      const vTime = DateUtils.dateStringToTimestamp(versionTime || '');
+      // Safely convert block.blocktime to timestamp
+      const bTime = DateUtils.blocktimeToTimestamp(block.time);
+      // Set the updated field to the blocktime of the current update
+      response.updated = DateUtils.toISOStringNonFractional(bTime);
+
+      // if resolutionOptions.versionTime is defined and the blocktime is more recent, return currentDocument
+      if(vTime < bTime) {
+        return response;
+      }
+
+      // Check update.targetVersionId against currentVersionId
+      // If update.targetVersionId <= currentVersionId, confirm duplicate update
+      if(update.targetVersionId <= currentVersionId) {
+        updateHashHistory.push(currentDocumentHash);
+        this.confirmDuplicate(update, updateHashHistory);
+      }
+
+      // If update.targetVersionId == currentVersionId + 1, apply the update
+      else if (update.targetVersionId === currentVersionId + 1) {
+      // Prepend `z` to the sourceHash if it does not start with it
+        const sourceHash = update.sourceHash.startsWith('z') ? update.sourceHash : `z${update.sourceHash}`;
+
+        // Check if update.sourceHash !== currentDocumentHash
+        if (sourceHash !== currentDocumentHash) {
+          // Raise an INVALID_DID_UPDATE error if they do not match
+          throw new ResolveError(
+            `Hash mismatch: update.sourceHash !== currentDocumentHash`,
+            INVALID_DID_UPDATE, { sourceHash, currentDocumentHash }
+          );
+        }
+        // Apply the update to the currentDocument and set it in the response
+        response.currentDocument = await this.applyUpdate(response.currentDocument, update);
+        // Create unsigned_update by removing the proof property from update.
+        const unsignedUpdate = JSONUtils.deleteKeys(update, ['proof']) as UnsignedBTCR2Update;
+        // Push the canonicalized unsigned update hash to the updateHashHistory
+        updateHashHistory.push(canonicalization.process(unsignedUpdate, { encoding: 'base58' }));
+      }
+
+      // If update.targetVersionId > currentVersionId + 1, throw LATE_PUBLISHING error
+      else if(update.targetVersionId > currentVersionId + 1) {
+        throw new ResolveError(
+          `Version Id Mismatch: targetVersionId cannot be > currentVersionId + 1`,
+          'LATE_PUBLISHING_ERROR', {
+            targetVersionId  : update.targetVersionId,
+            currentVersionId : String(currentVersionId + 1)
+          }
+        );
+      }
+
+      // Increment currentVersionId
+      currentVersionId++;
+      // Set currentVersionId in response
+      response.versionId = `${currentVersionId}`;
+
+      // If resolutionOptions.versionId is defined and <= currentVersionId, return currentDocument
+      if(currentVersionId >= Number(versionId)) {
+        return response;
+      }
+
+      // Check if the current document is deactivated before further processing
+      if(currentDocument.deactivated) {
+        return response;
+      }
+    }
+
+    // Return response data
+    return response;
+  }
+
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/#confirm-duplicate-update | 7.2.f.1 Confirm Duplicate Update}.
+   * This step confirms that an update with a lower-than-expected targetVersionId is a true duplicate.
+   * @param {SignedBTCR2Update} update The BTCR2 Signed Update to confirm as a duplicate.
+   * @returns {void} Does not return a value, but throws an error if the update is not a valid duplicate.
+   */
+  static confirmDuplicate(update: SignedBTCR2Update, updateHashHistory: string[]): void {
+    // Create unsigned_update by removing the proof property from update.
+    const unsignedUpdate = JSONUtils.deleteKeys(update, ['proof']) as UnsignedBTCR2Update;
+
+    // Hash unsignedUpdate with JSON Document Hashing algorithm
+    const unsignedUpdateHash = canonicalization.process(unsignedUpdate);
+
+    // 5. Let historicalUpdateHash equal updateHashHistory[updateHashIndex].
+    const historicalUpdateHash = updateHashHistory[update.targetVersionId - 2];
+
+    // Check if the updateHash matches the historical hash
+    if (updateHashHistory[update.targetVersionId - 2] !== unsignedUpdateHash) {
+      throw new ResolveError(
+        `Invalid duplicate: ${unsignedUpdateHash} does not match ${historicalUpdateHash}`,
+        LATE_PUBLISHING_ERROR, { unsignedUpdateHash, updateHashHistory }
+      );
+    }
+  }
+
+  /**
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#apply-update | 7.2.f.3 Apply Update}.
+   * @param {DidDocument} currentDocument The current DID Document to apply the update to.
+   * @param {SignedBTCR2Update} update The BTCR2 Signed Update to apply.
+   * @returns {Promise<DidDocument>} The updated DID Document after applying the update.
+   * @throws {ResolveError} If the update is invalid or cannot be applied.
+   */
+  static async applyUpdate(
+    currentDocument: DidDocument,
+    update: SignedBTCR2Update
+  ): Promise<DidDocument> {
+    // Get the capability id from the to update proof.
+    const capabilityId = update.proof?.capability;
+    // Since this field is optional, check that it exists
+    if (!capabilityId) {
+      // If it does not exist, throw INVALID_DID_UPDATE error
+      throw new ResolveError('No root capability found in update', INVALID_DID_UPDATE, update);
+    }
+
+    // Get the root capability object by dereferencing the capabilityId
+    const rootCapability = Appendix.dereferenceZcapId(capabilityId);
+
+    // Deconstruct the invocationTarget and controller from the root capability
+    const { invocationTarget, controller: rootController } = rootCapability;
+    // Check that both invocationTarget and rootController equal currentDocument.id
+    if (![invocationTarget, rootController].every((id) => id === currentDocument.id)) {
+      // If they do not all match, throw INVALID_DID_UPDATE error
+      throw new ResolveError(
+        'Invalid root capability',
+        INVALID_DID_UPDATE, { rootCapability, currentDocument }
+      );
+    }
+
+    // Get the verificationMethod field from the update proof as verificationMethodId.
+    const verificationMethodId = update.proof?.verificationMethod;
+    // Since this field is optional, check that it exists
+    if(!verificationMethodId) {
+      // If it does not exist, throw INVALID_DID_UPDATE error
+      throw new ResolveError('No verificationMethod found in update', INVALID_DID_UPDATE, update);
+    }
+
+    // Get the verificationMethod from the DID Document using the verificationMethodId.
+    const vm = DidBtcr2.getSigningMethod(currentDocument, verificationMethodId);
+
+    // Construct a new SchnorrMultikey.
+    const multikey = SchnorrMultikey.fromVerificationMethod(vm);
+
+    // Construct a new BIP340Cryptosuite with the SchnorrMultikey.
+    const cryptosuite = new BIP340Cryptosuite(multikey);
+
+    // Canonicalize the update
+    const canonicalUpdate = canonicalization.canonicalize(update);
+
+    // Construct a DataIntegrityProof with the cryptosuite
+    const diProof = new BIP340DataIntegrityProof(cryptosuite);
+
+    // Call the verifyProof method
+    const verificationResult = diProof.verifyProof(canonicalUpdate, 'capabilityInvocation');
+
+    // If the result is not verified, throw INVALID_DID_UPDATE error
+    if (!verificationResult.verified) {
+      throw new ResolveError(
+        'Invalid update: proof not verified',
+        INVALID_DID_UPDATE, verificationResult
+      );
+    }
+
+    // Apply the update.patch to the currentDocument to get the updatedDocument.
+    const updatedDocument = JSONPatch.apply(currentDocument, update.patch) as DidDocument;
+
+    // Verify that updatedDocument is conformant to DID Core v1.1.
+    DidDocument.validate(updatedDocument);
+
+    // Canonicalize and hash the updatedDocument to get the currentDocumentHash.
+    const currentDocumentHash = canonicalization.process(currentDocument, { encoding: 'base58' });
+
+    // Prepare the update targetHash for comparison with currentDocumentHash.
+    const updateTargetHash = update.targetHash.startsWith('z') ? update.targetHash : `z${update.targetHash}`;
+
+    // Make sure the update.targetHash equals currentDocumentHash.
+    if (updateTargetHash !== currentDocumentHash) {
+      // If they do not match, throw INVALID_DID_UPDATE error.
+      throw new ResolveError(
+        `Invalid update: updateTargetHash !== currentDocumentHash`,
+        INVALID_DID_UPDATE, { updateTargetHash, currentDocumentHash }
+      );
+    }
+
+    //  Return final updatedDocument.
+    return updatedDocument;
+  }
+}

package/src/core/types.ts

@@ -0,0 +1,95 @@
+import { HexString } from '@did-btcr2/common';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import { SMTProof } from './interfaces.js';
+
+/**
+ * {@link https://dcdpr.github.io/did-btcr2/data-structures.html#cas-announcement | CAS Announcement }
+ * a data structure that maps DIDs to BTCR2 Signed Update hashes. All BTCR2 Signed
+ * Updates (data structure) MUST be hashed with the JSON Document Hashing algorithm.
+ * The concrete representation of this data structure will be published to a CAS.
+ * @example
+ * ```json
+ * {
+ *   "did:btcr2:k1q5pa5tq86fzrl0ez32nh8e0ks4tzzkxnnmn8tdvxk04ahzt70u09dag02h0cp": "a4ayc_80_OGda4BO_1o_V0etpOqiLx1JwB5S3beHW0s",
+ *   "did:btcr2:x1qhjw6jnhwcyu5wau4x0cpwvz74c3g82c3uaehqpaf7lzfgmnwsd7spmmf54": "1HNeOiZeFu7gP1lxi5tdAwGcB9i2xR-Q2jpmbuwTqzU",
+ *   "did:btcr2:k1qgp5h79scv4sfqkzak5g6y89dsy3cq0pd2nussu2cm3zjfhn4ekwrucc4q7t7": "TgdAhWK-24tgzgXB3s_jrRa3IjCWfeAfZAt-Rym0n84"
+ * }
+ * ```
+ */
+export type CASAnnouncement = {
+  [key: string]: string
+}
+
+/**
+ * See {@link https://dcdpr.github.io/did-btcr2/terminology.html#sidecar | Sidecar }
+ * for more details about the sidecar mechanism. See {@link https://dcdpr.github.io/did-btcr2/data-structures.html#sidecar-data | Sidecar Data}
+ * for more details about the data structure.
+ */
+export type Sidecar = {
+  /**
+   * The context string "https://btcr2.dev/context/v1"
+   */
+  '@context'?: string,
+
+  /**
+   * Optional Genesis Did Document. Required when resolving did:btcr2 identifiers
+   * with `x` HRP.D
+   */
+  genesisDocument?: object;
+
+  /**
+   * Optional array of BTCR2 Signed Updates. Required if the DID being resolved
+   * has ever had a published BTCR2 Update.
+   */
+  updates?: Array<SignedBTCR2Update>
+
+  /**
+   * Optional array of CAS Announcements. Required if the DID being reslved has
+   * used a CAS Beacon to publish a BTCR2 Update.
+   */
+  casUpdates?: Array<CASAnnouncement>;
+
+  /**
+   * Optional array of SMT Proofs. Required if the DID being resolved has used
+   * an SMT Beacon to publish a BTCR2 Update.
+   */
+  smtProofs?: Array<SMTProof>;
+};
+
+/**
+ * The Sidecar data structure used for Singleton Beacons.
+ */
+export type SingletonBeaconSidecarData = Map<HexString, SignedBTCR2Update>;
+/**
+ * The Sidecar data structure used for CAS Beacons.
+ */
+export type CASBeaconSidecarData = Map<HexString, CASAnnouncement>;
+/**
+ * The Sidecar data structure used for SMT Beacons.
+ */
+export type SMTBeaconSidecarData = Map<string, SMTProof>;
+
+/**
+ * The Sidecar data structure post-processing used for resolution.
+ */
+export type SidecarData = {
+  /**
+   * Map of BTCR2 Signed Updates by their hash bytes.
+   */
+  updateMap: SingletonBeaconSidecarData;
+
+  /**
+   * Map of CAS Announcements by their hash bytes.
+   */
+  casMap: CASBeaconSidecarData;
+
+  /**
+   * Map of SMT Proofs by their ID.
+   */
+  smtMap: SMTBeaconSidecarData;
+}
+
+/**
+ * Union type for all Beacon Sidecar data structures.
+ */
+export type BeaconSidecarData = SingletonBeaconSidecarData | CASBeaconSidecarData | SMTBeaconSidecarData;