@did-btcr2/method 0.27.0 → 0.29.0

package/dist/esm/core/update.js

@@ -1,112 +0,0 @@
-import { canonicalHash, INVALID_DID_UPDATE, JSONPatch, UpdateError } from '@did-btcr2/common';
-import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { DidDocument } from '../utils/did-document.js';
-import { BeaconFactory } from './beacon/factory.js';
-/**
- * Implements {@link https://dcdpr.github.io/did-btcr2/operations/update.html | 7.3 Update}.
- *
- * An update to a did:btcr2 document is an invoked capability using the ZCAP-LD
- * data format, signed by a verificationMethod that has the authority to make
- * the update as specified in the previous DID document. Capability invocations
- * for updates MUST be authorized using Data Integrity following the
- * bip340-jcs-2025 cryptosuite with a proofPurpose of capabilityInvocation.
- *
- * @class Update
- * @type {Update}
- */
-export class Update {
-    /**
-     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-unsigned-update | 7.3.b Construct BTCR2 Unsigned Update}.
-     * This process constructs a BTCR2 Unsigned Update conformant to the spec template.
-     *
-     * @param {Btcr2DidDocument} sourceDocument The source DID document to be updated.
-     * @param {PatchOperation[]} patches The array of JSON Patch operations to apply to the sourceDocument.
-     * @param {number} sourceVersionId The version ID of the source document.
-     * @returns {UnsignedBTCR2Update} The constructed UnsignedBTCR2Update object.
-     * @throws {UpdateError} InvalidDid if sourceDocument.id does not match identifier.
-     */
-    static construct(sourceDocument, patches, sourceVersionId) {
-        // Initialize an unsigned update conformant to btcr2 spec.
-        const unsignedUpdate = {
-            '@context': [
-                'https://w3id.org/security/v2',
-                'https://w3id.org/zcap/v1',
-                'https://w3id.org/json-ld-patch/v1',
-                'https://btcr2.dev/context/v1'
-            ],
-            patch: patches,
-            targetHash: '',
-            targetVersionId: sourceVersionId + 1,
-            sourceHash: canonicalHash(sourceDocument),
-        };
-        // Apply all JSON patches to sourceDocument.
-        const targetDocument = JSONPatch.apply(sourceDocument, patches);
-        try {
-            // Ensure the targetDocument is conformant to DID Core v1.1.
-            DidDocument.isValid(targetDocument);
-        }
-        catch (error) {
-            // If validation fails, throw an UpdateError with INVALID_DID_UPDATE.
-            throw new UpdateError('Error validating targetDocument: ' + (error instanceof Error ? error.message : String(error)), INVALID_DID_UPDATE, targetDocument);
-        }
-        // Set the targetHash by canonicalizing the targetDocument and encoding it in base64url.
-        unsignedUpdate.targetHash = canonicalHash(targetDocument);
-        // Return unsignedUpdate.
-        return unsignedUpdate;
-    }
-    /**
-     * Implements subsection {@link http://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-signed-update | 7.3.c Construct BTCR2 Signed Update }.
-     * This process constructs a BTCR2 Signed Update from a BTCR2 Unsigned Update.
-     *
-     * @param {string} did The did-btcr2 identifier to derive the root capability from
-     * @param {UnsignedBTCR2Update} unsignedUpdate The updatePayload object to be signed
-     * @param {DidVerificationMethod} verificationMethod The verificationMethod object to be used for signing
-     * @returns {SignedBTCR2Update} Did update payload secured with a proof => SignedBTCR2Update
-     * @throws {UpdateError} if the privateKeyBytes are invalid
-     */
-    static sign(did, unsignedUpdate, verificationMethod, secretKey) {
-        // Parse the controller from the verificationMethod
-        const controller = verificationMethod.controller;
-        // Parse the fragment from the vmId
-        const id = verificationMethod.id.slice(verificationMethod.id.indexOf('#'));
-        // Construct a Schnorr Multikey
-        const multikey = SchnorrMultikey.fromSecretKey(id, controller, secretKey);
-        // Define the Data Integrity proof config
-        const config = {
-            '@context': [
-                'https://w3id.org/security/v2',
-                'https://w3id.org/zcap/v1',
-                'https://w3id.org/json-ld-patch/v1',
-                'https://btcr2.dev/context/v1'
-            ],
-            cryptosuite: 'bip340-jcs-2025',
-            type: 'DataIntegrityProof',
-            verificationMethod: verificationMethod.id,
-            proofPurpose: 'capabilityInvocation',
-            capability: `urn:zcap:root:${encodeURIComponent(did)}`,
-            capabilityAction: 'Write',
-        };
-        // Go from multikey => cryptosuite => diproof
-        const diproof = multikey.toCryptosuite().toDataIntegrityProof();
-        // Use the config to add a proof to the unsigned update
-        return diproof.addProof(unsignedUpdate, config);
-    }
-    /**
-     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#announce-did-update | 7.3.d Announce DID Update}.
-     * BTCR2 Signed Updates are announced to the Bitcoin blockchain depending on the Beacon Type.
-     * @param {BeaconService} beaconService The BeaconService object representing the funded beacon to announce the update to.
-     * @param {SignedBTCR2Update} update The signed update object to be announced.
-     * @param {KeyBytes} secretKey The private key used to sign the update for announcement.
-     * @returns {SignedBTCR2Update} The SignedBTCR2Update object containing data to validate the Beacon Signal
-     * @throws {UpdateError} if the beaconService type is invalid
-     */
-    static async announce(beaconService, update, secretKey, bitcoin) {
-        // Establish a beacon object
-        const beacon = BeaconFactory.establish(beaconService);
-        // Broadcast the update
-        const result = await beacon.broadcastSignal(update, secretKey, bitcoin);
-        // Return the sidecarData
-        return result;
-    }
-}
-//# sourceMappingURL=update.js.map

package/dist/esm/core/update.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAM3B,OAAO,EACL,eAAe,EAChB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIpD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,MAAM;IACjB;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,CACd,cAAgC,EAChC,OAAyB,EACzB,eAAuB;QAEvB,0DAA0D;QAC1D,MAAM,cAAc,GAAwB;YAC1C,UAAU,EAAQ;gBAChB,8BAA8B;gBAC9B,0BAA0B;gBAC1B,mCAAmC;gBACnC,8BAA8B;aAC/B;YACD,KAAK,EAAa,OAAO;YACzB,UAAU,EAAQ,EAAE;YACpB,eAAe,EAAG,eAAe,GAAG,CAAC;YACrC,UAAU,EAAQ,aAAa,CAAC,cAAc,CAAC;SAChD,CAAC;QAEF,4CAA4C;QAC5C,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,CAAC;YACH,4DAA4D;YAC5D,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qEAAqE;YACrE,MAAM,IAAI,WAAW,CACnB,mCAAmC,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAC9F,kBAAkB,EAAE,cAAc,CACnC,CAAC;QACJ,CAAC;QAED,wFAAwF;QACxF,cAAc,CAAC,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;QAE1D,yBAAyB;QACzB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,CACT,GAAW,EACX,cAAmC,EACnC,kBAAyC,EACzC,SAAmB;QAEnB,mDAAmD;QACnD,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC;QACjD,mCAAmC;QACnC,MAAM,EAAE,GAAG,kBAAkB,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3E,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,eAAe,CAAC,aAAa,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QAE1E,yCAAyC;QACzC,MAAM,MAAM,GAAwB;YAClC,UAAU,EAAG;gBACX,8BAA8B;gBAC9B,0BAA0B;gBAC1B,mCAAmC;gBACnC,8BAA8B;aAC/B;YACD,WAAW,EAAU,iBAAiB;YACtC,IAAI,EAAiB,oBAAoB;YACzC,kBAAkB,EAAG,kBAAkB,CAAC,EAAE;YAC1C,YAAY,EAAS,sBAAsB;YAC3C,UAAU,EAAW,iBAAiB,kBAAkB,CAAC,GAAG,CAAC,EAAE;YAC/D,gBAAgB,EAAK,OAAO;SAC7B,CAAC;QAEF,6CAA6C;QAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,CAAC;QAEhE,uDAAuD;QACvD,OAAO,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,aAA4B,EAC5B,MAAyB,EACzB,SAAmB,EACnB,OAA0B;QAE1B,4BAA4B;QAC5B,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAEtD,uBAAuB;QACvB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExE,yBAAyB;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/types/core/update.d.ts

@@ -1,52 +0,0 @@
-import type { KeyBytes, PatchOperation } from '@did-btcr2/common';
-import type { SignedBTCR2Update, UnsignedBTCR2Update } from '@did-btcr2/cryptosuite';
-import type { Btcr2DidDocument, DidVerificationMethod } from '../utils/did-document.js';
-import type { BeaconService } from './beacon/interfaces.js';
-import type { BitcoinConnection } from '@did-btcr2/bitcoin';
-/**
- * Implements {@link https://dcdpr.github.io/did-btcr2/operations/update.html | 7.3 Update}.
- *
- * An update to a did:btcr2 document is an invoked capability using the ZCAP-LD
- * data format, signed by a verificationMethod that has the authority to make
- * the update as specified in the previous DID document. Capability invocations
- * for updates MUST be authorized using Data Integrity following the
- * bip340-jcs-2025 cryptosuite with a proofPurpose of capabilityInvocation.
- *
- * @class Update
- * @type {Update}
- */
-export declare class Update {
-    /**
-     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-unsigned-update | 7.3.b Construct BTCR2 Unsigned Update}.
-     * This process constructs a BTCR2 Unsigned Update conformant to the spec template.
-     *
-     * @param {Btcr2DidDocument} sourceDocument The source DID document to be updated.
-     * @param {PatchOperation[]} patches The array of JSON Patch operations to apply to the sourceDocument.
-     * @param {number} sourceVersionId The version ID of the source document.
-     * @returns {UnsignedBTCR2Update} The constructed UnsignedBTCR2Update object.
-     * @throws {UpdateError} InvalidDid if sourceDocument.id does not match identifier.
-     */
-    static construct(sourceDocument: Btcr2DidDocument, patches: PatchOperation[], sourceVersionId: number): UnsignedBTCR2Update;
-    /**
-     * Implements subsection {@link http://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-signed-update | 7.3.c Construct BTCR2 Signed Update }.
-     * This process constructs a BTCR2 Signed Update from a BTCR2 Unsigned Update.
-     *
-     * @param {string} did The did-btcr2 identifier to derive the root capability from
-     * @param {UnsignedBTCR2Update} unsignedUpdate The updatePayload object to be signed
-     * @param {DidVerificationMethod} verificationMethod The verificationMethod object to be used for signing
-     * @returns {SignedBTCR2Update} Did update payload secured with a proof => SignedBTCR2Update
-     * @throws {UpdateError} if the privateKeyBytes are invalid
-     */
-    static sign(did: string, unsignedUpdate: UnsignedBTCR2Update, verificationMethod: DidVerificationMethod, secretKey: KeyBytes): SignedBTCR2Update;
-    /**
-     * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#announce-did-update | 7.3.d Announce DID Update}.
-     * BTCR2 Signed Updates are announced to the Bitcoin blockchain depending on the Beacon Type.
-     * @param {BeaconService} beaconService The BeaconService object representing the funded beacon to announce the update to.
-     * @param {SignedBTCR2Update} update The signed update object to be announced.
-     * @param {KeyBytes} secretKey The private key used to sign the update for announcement.
-     * @returns {SignedBTCR2Update} The SignedBTCR2Update object containing data to validate the Beacon Signal
-     * @throws {UpdateError} if the beaconService type is invalid
-     */
-    static announce(beaconService: BeaconService, update: SignedBTCR2Update, secretKey: KeyBytes, bitcoin: BitcoinConnection): Promise<SignedBTCR2Update>;
-}
-//# sourceMappingURL=update.d.ts.map

package/dist/types/core/update.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAO3C,OAAO,KAAK,EAEV,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAIhC,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAGxF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE5D;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,CACd,cAAc,EAAE,gBAAgB,EAChC,OAAO,EAAE,cAAc,EAAE,EACzB,eAAe,EAAE,MAAM,GACtB,mBAAmB;IAoCtB;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,CACT,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,mBAAmB,EACnC,kBAAkB,EAAE,qBAAqB,EACzC,SAAS,EAAE,QAAQ,GAClB,iBAAiB;IAgCpB;;;;;;;;OAQG;WACU,QAAQ,CACnB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,iBAAiB,CAAC;CAU9B"}

package/src/core/update.ts

@@ -1,158 +0,0 @@
-import type {
-  KeyBytes,
-  PatchOperation} from '@did-btcr2/common';
-import {
-  canonicalHash,
-  INVALID_DID_UPDATE,
-  JSONPatch,
-  UpdateError
-} from '@did-btcr2/common';
-import type {
-  DataIntegrityConfig,
-  SignedBTCR2Update,
-  UnsignedBTCR2Update
-} from '@did-btcr2/cryptosuite';
-import {
-  SchnorrMultikey
-} from '@did-btcr2/cryptosuite';
-import type { Btcr2DidDocument, DidVerificationMethod } from '../utils/did-document.js';
-import { DidDocument } from '../utils/did-document.js';
-import { BeaconFactory } from './beacon/factory.js';
-import type { BeaconService } from './beacon/interfaces.js';
-import type { BitcoinConnection } from '@did-btcr2/bitcoin';
-
-/**
- * Implements {@link https://dcdpr.github.io/did-btcr2/operations/update.html | 7.3 Update}.
- *
- * An update to a did:btcr2 document is an invoked capability using the ZCAP-LD
- * data format, signed by a verificationMethod that has the authority to make
- * the update as specified in the previous DID document. Capability invocations
- * for updates MUST be authorized using Data Integrity following the
- * bip340-jcs-2025 cryptosuite with a proofPurpose of capabilityInvocation.
- *
- * @class Update
- * @type {Update}
- */
-export class Update {
-  /**
-   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-unsigned-update | 7.3.b Construct BTCR2 Unsigned Update}.
-   * This process constructs a BTCR2 Unsigned Update conformant to the spec template.
-   *
-   * @param {Btcr2DidDocument} sourceDocument The source DID document to be updated.
-   * @param {PatchOperation[]} patches The array of JSON Patch operations to apply to the sourceDocument.
-   * @param {number} sourceVersionId The version ID of the source document.
-   * @returns {UnsignedBTCR2Update} The constructed UnsignedBTCR2Update object.
-   * @throws {UpdateError} InvalidDid if sourceDocument.id does not match identifier.
-   */
-  static construct(
-    sourceDocument: Btcr2DidDocument,
-    patches: PatchOperation[],
-    sourceVersionId: number,
-  ): UnsignedBTCR2Update {
-    // Initialize an unsigned update conformant to btcr2 spec.
-    const unsignedUpdate: UnsignedBTCR2Update = {
-      '@context'      : [
-        'https://w3id.org/security/v2',
-        'https://w3id.org/zcap/v1',
-        'https://w3id.org/json-ld-patch/v1',
-        'https://btcr2.dev/context/v1'
-      ],
-      patch           : patches,
-      targetHash      : '',
-      targetVersionId : sourceVersionId + 1,
-      sourceHash      : canonicalHash(sourceDocument),
-    };
-
-    // Apply all JSON patches to sourceDocument.
-    const targetDocument = JSONPatch.apply(sourceDocument, patches);
-
-    try {
-      // Ensure the targetDocument is conformant to DID Core v1.1.
-      DidDocument.isValid(targetDocument);
-    } catch (error) {
-      // If validation fails, throw an UpdateError with INVALID_DID_UPDATE.
-      throw new UpdateError(
-        'Error validating targetDocument: ' + (error instanceof Error ? error.message : String(error)),
-        INVALID_DID_UPDATE, targetDocument
-      );
-    }
-
-    // Set the targetHash by canonicalizing the targetDocument and encoding it in base64url.
-    unsignedUpdate.targetHash = canonicalHash(targetDocument);
-
-    // Return unsignedUpdate.
-    return unsignedUpdate;
-  }
-
-  /**
-   * Implements subsection {@link http://dcdpr.github.io/did-btcr2/operations/update.html#construct-btcr2-signed-update | 7.3.c Construct BTCR2 Signed Update }.
-   * This process constructs a BTCR2 Signed Update from a BTCR2 Unsigned Update.
-   *
-   * @param {string} did The did-btcr2 identifier to derive the root capability from
-   * @param {UnsignedBTCR2Update} unsignedUpdate The updatePayload object to be signed
-   * @param {DidVerificationMethod} verificationMethod The verificationMethod object to be used for signing
-   * @returns {SignedBTCR2Update} Did update payload secured with a proof => SignedBTCR2Update
-   * @throws {UpdateError} if the privateKeyBytes are invalid
-   */
-  static sign(
-    did: string,
-    unsignedUpdate: UnsignedBTCR2Update,
-    verificationMethod: DidVerificationMethod,
-    secretKey: KeyBytes,
-  ): SignedBTCR2Update {
-    // Parse the controller from the verificationMethod
-    const controller = verificationMethod.controller;
-    // Parse the fragment from the vmId
-    const id = verificationMethod.id.slice(verificationMethod.id.indexOf('#'));
-
-    // Construct a Schnorr Multikey
-    const multikey = SchnorrMultikey.fromSecretKey(id, controller, secretKey);
-
-    // Define the Data Integrity proof config
-    const config: DataIntegrityConfig = {
-      '@context' : [
-        'https://w3id.org/security/v2',
-        'https://w3id.org/zcap/v1',
-        'https://w3id.org/json-ld-patch/v1',
-        'https://btcr2.dev/context/v1'
-      ],
-      cryptosuite        : 'bip340-jcs-2025',
-      type               : 'DataIntegrityProof',
-      verificationMethod : verificationMethod.id,
-      proofPurpose       : 'capabilityInvocation',
-      capability         : `urn:zcap:root:${encodeURIComponent(did)}`,
-      capabilityAction   : 'Write',
-    };
-
-    // Go from multikey => cryptosuite => diproof
-    const diproof = multikey.toCryptosuite().toDataIntegrityProof();
-
-    // Use the config to add a proof to the unsigned update
-    return diproof.addProof(unsignedUpdate, config);
-  }
-
-  /**
-   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/update.html#announce-did-update | 7.3.d Announce DID Update}.
-   * BTCR2 Signed Updates are announced to the Bitcoin blockchain depending on the Beacon Type.
-   * @param {BeaconService} beaconService The BeaconService object representing the funded beacon to announce the update to.
-   * @param {SignedBTCR2Update} update The signed update object to be announced.
-   * @param {KeyBytes} secretKey The private key used to sign the update for announcement.
-   * @returns {SignedBTCR2Update} The SignedBTCR2Update object containing data to validate the Beacon Signal
-   * @throws {UpdateError} if the beaconService type is invalid
-   */
-  static async announce(
-    beaconService: BeaconService,
-    update: SignedBTCR2Update,
-    secretKey: KeyBytes,
-    bitcoin: BitcoinConnection
-  ): Promise<SignedBTCR2Update> {
-    // Establish a beacon object
-    const beacon = BeaconFactory.establish(beaconService);
-
-    // Broadcast the update
-    const result = await beacon.broadcastSignal(update, secretKey, bitcoin);
-
-    // Return the sidecarData
-    return result;
-  }
-}