@did-btcr2/method 0.19.0 → 0.22.0

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

@@ -1,24 +1,10 @@
-import { PatchOperation } from '@did-btcr2/common';
-import { BTCR2SignedUpdate, BTCR2UnsignedUpdate } from '@did-btcr2/cryptosuite';
-import { DidDocument, DidVerificationMethod } from '../utils/did-document.js';
-import { SidecarData } from './types.js';
-export interface ConstructUpdateParams {
-    identifier: string;
-    sourceDocument: DidDocument;
-    sourceVersionId: number;
-    patch: PatchOperation[];
-}
-export interface UpdateParams extends ConstructUpdateParams {
-    verificationMethodId: string;
-    beaconIds: string[];
-}
-export type InvokePayloadParams = {
-    identifier: string;
-    BTCR2SignedUpdate: BTCR2SignedUpdate;
-    verificationMethod: DidVerificationMethod;
-};
+import { KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { SignedBTCR2Update, UnsignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import { Btcr2DidDocument, DidVerificationMethod } from '../utils/did-document.js';
+import { BeaconService } from './beacon/interfaces.js';
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
 /**
- * Implements {@link https://dcdpr.github.io/did-btcr2/#update | 4.3 Update}.
+ * 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
@@ -31,64 +17,35 @@ export type InvokePayloadParams = {
  */
 export declare class Update {
     /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#construct-did-update-payload | 4.3.1 Construct DID Update Payload}.
-     *
-     * The Construct DID Update Payload algorithm applies the documentPatch to the sourceDocument and verifies the
-     * resulting targetDocument is a conformant DID document. It takes in a Identifier, sourceDocument,
-     * sourceVersionId, and documentPatch objects. It returns an unsigned DID Update Payload.
+     * 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 {ConstructPayloadParams} params See  {@link ConstructPayloadParams} for more details.
-     * @param {string} params.identifier The did-btcr2 identifier to use for verification.
-     * @param {DidDocument} params.sourceDocument The source document to be updated.
-     * @param {string} params.sourceVersionId The versionId of the source document.
-     * @param {DidDocumentPatch} params.patch The JSON patch to be applied to the source document.
-     * @returns {Promise<BTCR2SignedUpdate>} The constructed BTCR2SignedUpdate object.
-     * @throws {MethodError} InvalidDid if sourceDocument.id does not match identifier.
+     * @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 {Promise<SignedBTCR2Update>} The constructed SignedBTCR2Update object.
+     * @throws {UpdateError} InvalidDid if sourceDocument.id does not match identifier.
      */
-    static construct({ identifier, sourceDocument, sourceVersionId, patch, }: {
-        identifier: string;
-        sourceDocument: DidDocument;
-        sourceVersionId: number;
-        patch: PatchOperation[];
-    }): Promise<BTCR2UnsignedUpdate>;
+    static construct(sourceDocument: Btcr2DidDocument, patches: PatchOperation[], sourceVersionId: number): Promise<UnsignedBTCR2Update>;
     /**
-     * {@link https://dcdpr.github.io/did-btcr2/#invoke-did-update-payload | 4.3.2 Invoke DID Update Payload}.
+     * 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.
      *
-     * The Invoke DID Update Payload algorithm takes in a Identifier, an unsigned BTCR2SignedUpdate, and a
-     * verificationMethod. It retrieves the privateKeyBytes for the verificationMethod and adds a capability invocation in
-     * the form of a Data Integrity proof following the Authorization Capabilities (ZCAP-LD) and VC Data Integrity
-     * specifications. It returns the invoked DID Update Payload.
-     *
-     * @param {InvokePayloadParams} params Required params for calling the invokePayload method
-     * @param {string} params.identifier The did-btcr2 identifier to derive the root capability from
-     * @param {BTCR2SignedUpdate} params.BTCR2SignedUpdate The updatePayload object to be signed
-     * @param {DidVerificationMethod} params.verificationMethod The verificationMethod object to be used for signing
-     * @returns {BTCR2SignedUpdate} Did update payload secured with a proof => BTCR2SignedUpdate
-     * @throws {MethodError} if the privateKeyBytes are invalid
+     * @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 invoke({ identifier, unsignedUpdate, verificationMethod }: {
-        identifier: string;
-        unsignedUpdate: BTCR2UnsignedUpdate;
-        verificationMethod: DidVerificationMethod;
-    }): Promise<BTCR2SignedUpdate>;
+    static sign(did: string, unsignedUpdate: UnsignedBTCR2Update, verificationMethod: DidVerificationMethod, secretKey: KeyBytes): Promise<SignedBTCR2Update>;
     /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#announce-did-update | 4.3.3 Announce DID Update}.
-     *
-     * The Announce DID Update algorithm retrieves beaconServices from the sourceDocument and calls the Broadcast DID
-     * Update algorithm corresponding to the type of the Beacon. It takes in a Identifier, sourceDocument, an array of
-     * beaconIds, and a BTCR2SignedUpdate. It returns an array of signalsMetadata, containing the necessary
-     * data to validate the Beacon Signal against the BTCR2SignedUpdate.
-     *
-     * @param {AnnounceUpdatePayloadParams} params Required params for calling the announcePayload method
-     * @param {DidDocument} params.sourceDocument The did-btcr2 did document to derive the root capability from
-     * @param {string[]} params.beaconIds The BTCR2SignedUpdate object to be signed
-     * @param {BTCR2SignedUpdate} params.BTCR2SignedUpdate The verificationMethod object to be used for signing
-     * @returns {BTCR2SignedUpdate} The BTCR2SignedUpdate object containing data to validate the Beacon Signal
-     * @throws {MethodError} if the beaconService type is invalid
+     * 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({ sourceDocument, beaconIds, signedUpdate }: {
-        sourceDocument: DidDocument;
-        beaconIds: string[];
-        signedUpdate: BTCR2SignedUpdate;
-    }): Promise<SidecarData>;
+    static announce(beaconService: BeaconService, update: SignedBTCR2Update, secretKey: KeyBytes, bitcoin: BitcoinNetworkConnection): Promise<SignedBTCR2Update>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAwC,MAAM,wBAAwB,CAAC;AAMtH,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAG9E,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,qBAAqB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,WAAW,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAa,SAAQ,qBAAqB;IACvD,oBAAoB,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,kBAAkB,EAAE,qBAAqB,CAAC;CAC3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAAC,EAC5B,UAAU,EACV,cAAc,EACd,eAAe,EACf,KAAK,GACN,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,WAAW,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,KAAK,EAAE,cAAc,EAAE,CAAC;KACzB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiDhC;;;;;;;;;;;;;;OAcG;WACiB,MAAM,CAAC,EACzB,UAAU,EACV,cAAc,EACd,kBAAkB,EACnB,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,mBAAmB,CAAC;QACpC,kBAAkB,EAAE,qBAAqB,CAAC;KAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA6E9B;;;;;;;;;;;;;;OAcG;WACiB,QAAQ,CAAC,EAC3B,cAAc,EACd,SAAS,EACT,YAAY,EACb,EAAE;QACD,cAAc,EAAE,WAAW,CAAC;QAC5B,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,YAAY,EAAE,iBAAiB,CAAC;KACjC,GAAG,OAAO,CAAC,WAAW,CAAC;CAiDzB"}
+{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../src/core/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,QAAQ,EACR,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAGL,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAe,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEhG,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB;;;;;;;;;OASG;WACU,SAAS,CACpB,cAAc,EAAE,gBAAgB,EAChC,OAAO,EAAE,cAAc,EAAE,EACzB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,mBAAmB,CAAC;IAoC/B;;;;;;;;;OASG;WACU,IAAI,CACf,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,mBAAmB,EACnC,kBAAkB,EAAE,qBAAqB,EACzC,SAAS,EAAE,QAAQ,GAClB,OAAO,CAAC,iBAAiB,CAAC;IAgC7B;;;;;;;;OAQG;WACU,QAAQ,CACnB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,iBAAiB,CAAC;CAU9B"}

package/dist/types/did-btcr2.d.ts

@@ -1,9 +1,9 @@
-import { Canonicalization, DocumentBytes, KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { BitcoinNetworkConnection } from '@did-btcr2/bitcoin';
+import { DocumentBytes, HexString, KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
 import { DidMethod, DidResolutionResult } from '@web5/dids';
 import { ResolutionOptions } from './core/interfaces.js';
-import { SidecarData } from './core/types.js';
-import { DidDocument, DidVerificationMethod } from './utils/did-document.js';
-export declare const canonicalization: Canonicalization;
+import { Btcr2DidDocument, DidVerificationMethod } from './utils/did-document.js';
 export type Btcr2Identifier = string;
 export interface DidCreateOptions {
     /** Type of identifier to create (key or external) */
@@ -27,7 +27,9 @@ export interface DidCreateOptions {
  * @implements {DidMethod}
  */
 export declare class DidBtcr2 implements DidMethod {
-    /** @type {string} Name of the DID method, as defined in the DID BTCR2 specification */
+    /**
+     * Name of the DID method, as defined in the DID BTCR2 specification
+     */
     static methodName: string;
     /**
      * Implements section {@link https://dcdpr.github.io/did-btcr2/operations/create.html | 7.1 Create}.
@@ -39,10 +41,15 @@ export declare class DidBtcr2 implements DidMethod {
      * @param {string} options.network The Bitcoin network to use for the identifier, e.g. 'bitcoin', 'testnet', etc. Defaults to 'bitcoin'.
      * @returns {Promise<Btcr2Identifier>} Promise resolving to a Btcr2Identifier string.
      * @throws {MethodError} if any of the checks fail
+     * @example
+     * ```ts
+     * const genesisBytes = SchnorrKeyPair.generate().publicKey.compressed;
+     * const did = DidBtcr2.create(genesisBytes, { idType: 'KEY', network: 'regtest' });
+     * ```
      */
-    static create(genesisBytes: KeyBytes | DocumentBytes, options?: DidCreateOptions): Promise<Btcr2Identifier>;
+    static create(genesisBytes: KeyBytes | DocumentBytes, options?: DidCreateOptions): Btcr2Identifier;
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#read | 7.2 Resolve}.
+     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html | 7.2 Resolve}.
      * See specification for the {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process | Resolve Process}.
      * See {@link Resolve | Resolve (class)} for class implementation.
      *
@@ -51,66 +58,56 @@ export declare class DidBtcr2 implements DidMethod {
      * blockchain by Authorized Beacon Signals. The Initial DID Document is either
      * deterministically created from the DID or provided by Sidecar Data.
      *
-     * @param {string} did a valid did:btcr2 identifier to be resolved
-     * @param {ResolutionOptions} resolutionOptions see {@link https://www.w3.org/TR/did-1.0/#did-resolution-options | ResolutionOptions}
-     * @param {number} resolutionOptions.versionId optional version of the identifier and/or DID document
-     * @param {number} resolutionOptions.versionTime optional timestamp used during resolution as a bound for when to stop resolving
-     * @param {DidDocument} resolutionOptions.sidecar optional data necessary for resolving a DID
+     * @param {string} did The did:btcr2 identifier to be resolved.
+     * @param {ResolutionOptions} resolutionOptions Options used during the resolution process.
      * @returns {Promise<DidResolutionResult>} Promise resolving to a DID Resolution Result containing the `targetDocument`
-     * @throws {Error} if the resolution fails for any reason
-     * @throws {DidError} InvalidDid if the identifier is invalid
+     * @throws {ResolveError} If the resolution process fails at any step.
      * @example
      * ```ts
      * const resolution = await DidBtcr2.resolve(
-     *  'did:btcr2:k1q0dygyp3gz969tp46dychzy4q78c2k3js68kvyr0shanzg67jnuez2cfplh'
+     *  'did:btcr2:k1qgpr45cheptyjekl3cex80xfnkwhxnlclecwwf92gvdjrszm2uwhzlcxu5xte'
      * )
      * ```
      */
     static resolve(did: string, resolutionOptions?: ResolutionOptions): Promise<DidResolutionResult>;
     /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#update | 4.3 Update}.
-     * See {@link Update} for implementation details.
-     *
-     * 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.
-     *
-     * The Update algorithm takes as inputs a Identifier, sourceDocument, sourceVersionId, documentPatch, a
-     * verificationMethodId and an array of beaconIds. The sourceDocument is the DID document being updated. The
-     * documentPatch is a JSON Patch object containing a set of transformations to be applied to the sourceDocument.
-     * The result of these transformations MUST produce a DID document conformant to the DID Core specification. The
-     * verificationMethodId is an identifier for a verificationMethod within the sourceDocument. The verificationMethod
-     * identified MUST be a BIP340 Multikey. The beaconIds MUST identify service endpoints with one of the three Beacon
-     * Types SingletonBeacon, CASBeacon, and SMTBeacon.
+     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/#read | 7.3 Update}.
+     * See specification for the {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process | Resolve Process}.
+     * See {@link Update | Update (class)} for class implementation.
      *
-     * @param {UpdateParams} params Required parameters for the update operation.
-     * @param {string} params.identifier The btcr2 identifier to be updated.
-     * @param {DidDocument} params.sourceDocument The DID document being updated.
-     * @param {string} params.sourceVersionId The versionId of the source document.
-     * @param {PatchOperation} params.documentPatch The JSON patch to be applied to the source document.
-     * @param {string} params.verificationMethodId The verificationMethod ID to sign the update
-     * @param {string[]} params.beaconIds The beacon IDs to announce the update
-     * @returns {Promise<void>} Promise resolving to void
-     * @throws {MethodError} if the verificationMethod type is not `Multikey` or the publicKeyMultibase header is not `zQ3s`
+     * BTCR2 DID documents can be updated by anchoring BTCR2 Updates to Bitcoin transactions. These transactions MAY be
+     * published to the Bitcoin network. Any property in the DID document may be updated except the id. Doing so would
+     * invalidate the DID document.
+     * @param params An object containing the parameters for the update operation.
+     * @param {Btcr2DidDocument} params.sourceDocument The DID document being updated.
+     * @param {PatchOperation[]} params.patches The array of JSON Patch operations to apply to the sourceDocument.
+     * @param {string} params.sourceVersionId The version ID before applying the update.
+     * @param {string} params.verificationMethodId The verificationMethod ID to sign the update with.
+     * @param {string} params.beaconId The beacon ID associated with the update.
+     * @param {KeyBytes | HexString} [params.signingMaterial] Optional signing material (key bytes or hex string).
+     * @param {BitcoinNetworkConnection} [params.bitcoin] Optional Bitcoin network connection for announcing the update. If not provided, a default connection will be initialized.
+     * @return {Promise<SignedBTCR2Update>} Promise resolving to the signed BTCR2 update.
+     * @throws {UpdateError} if no verificationMethod, verificationMethod type is not `Multikey` or the publicKeyMultibase
+     * header is not `zQ3s`
      */
-    static update(params: {
-        identifier: string;
-        sourceDocument: DidDocument;
+    static update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }: {
+        sourceDocument: Btcr2DidDocument;
+        patches: PatchOperation[];
         sourceVersionId: number;
-        patch: PatchOperation[];
         verificationMethodId: string;
-        beaconIds: string[];
-    }): Promise<SidecarData>;
+        beaconId: string;
+        signingMaterial?: KeyBytes | HexString;
+        bitcoin?: BitcoinNetworkConnection;
+    }): Promise<SignedBTCR2Update>;
     /**
      * Given the W3C DID Document of a `did:btcr2` identifier, return the signing verification method that will be used
      * for signing messages and credentials. If given, the `methodId` parameter is used to select the
      * verification method. If not given, the Identity Key's verification method with an ID fragment
      * of '#initialKey' is used.
-     * @param {DidDocument} didDocument The DID Document of the `did:btcr2` identifier.
+     * @param {Btcr2DidDocument} didDocument The DID Document of the `did:btcr2` identifier.
      * @param {string} [methodId] Optional verification method ID to be used for signing.
      * @returns {DidVerificationMethod} Promise resolving to the {@link DidVerificationMethod} object used for signing.
      * @throws {DidError} if the parsed did method does not match `btcr2` or signing method could not be determined.
      */
-    static getSigningMethod(didDocument: DidDocument, methodId?: string): DidVerificationMethod;
+    static getSigningMethod(didDocument: Btcr2DidDocument, methodId?: string): DidVerificationMethod;
 }

package/dist/types/did-btcr2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"did-btcr2.d.ts","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,aAAa,EAGb,QAAQ,EAIR,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAIL,SAAS,EACT,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAG7E,eAAO,MAAM,gBAAgB,kBAAyB,CAAC;AAEvD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,KAAK,GAAG,UAAU,CAAC;IAC3B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC,uFAAuF;IACvF,MAAM,CAAC,UAAU,EAAE,MAAM,CAAW;IAEpC;;;;;;;;;;OAUG;WACU,MAAM,CACjB,YAAY,EAAE,QAAQ,GAAG,aAAa,EACtC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,eAAe,CAAC;IAe3B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,iBAAiB,GAAE,iBAAiC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqGrH;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CAAC,MAAM,EAAE;QACjC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,WAAW,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,KAAK,EAAE,cAAc,EAAE,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;KACrB,GAAG,OAAO,CAAC,WAAW,CAAC;IAuDxB;;;;;;;;;OASG;WACW,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAG,QAAQ,CAAC,EAAE,MAAM,GAAG,qBAAqB;CA0BpG"}
+{"version":3,"file":"did-btcr2.d.ts","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EACL,aAAa,EACb,SAAS,EAIT,QAAQ,EAIR,cAAc,EAGf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAIL,SAAS,EACT,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAMpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAIzD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAElF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,KAAK,GAAG,UAAU,CAAC;IAC3B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAW;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CACX,YAAY,EAAE,QAAQ,GAAG,aAAa,EACtC,OAAO,CAAC,EAAE,gBAAgB,GACzB,eAAe;IAelB;;;;;;;;;;;;;;;;;;;;OAoBG;WACU,OAAO,CAClB,GAAG,EAAE,MAAM,EACX,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,mBAAmB,CAAC;IA2G/B;;;;;;;;;;;;;;;;;;;OAmBG;WACU,MAAM,CAAC,EAClB,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,OAAO,GACR,EAAE;QACD,cAAc,EAAE,gBAAgB,CAAC;QACjC,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,eAAe,EAAE,MAAM,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QACvC,OAAO,CAAC,EAAE,wBAAwB,CAAC;KACpC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+E9B;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,EAAG,QAAQ,CAAC,EAAE,MAAM,GAAG,qBAAqB;CA0BlG"}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './core/beacon/aggregation/cohort/index.js';
+export * from './core/beacon/aggregation/cohort/status.js';
 export * from './core/beacon/aggregation/cohort/messages/base.js';
 export * from './core/beacon/aggregation/cohort/messages/constants.js';
 export * from './core/beacon/aggregation/cohort/messages/index.js';
@@ -12,7 +13,6 @@ export * from './core/beacon/aggregation/cohort/messages/sign/authorization-requ
 export * from './core/beacon/aggregation/cohort/messages/sign/nonce-contribution.js';
 export * from './core/beacon/aggregation/cohort/messages/sign/request-signature.js';
 export * from './core/beacon/aggregation/cohort/messages/sign/signature-authorization.js';
-export * from './core/beacon/aggregation/cohort/status.js';
 export * from './core/beacon/aggregation/communication/adapter/did-comm.js';
 export * from './core/beacon/aggregation/communication/adapter/nostr.js';
 export * from './core/beacon/aggregation/communication/error.js';
@@ -22,10 +22,12 @@ export * from './core/beacon/aggregation/coordinator.js';
 export * from './core/beacon/aggregation/participant.js';
 export * from './core/beacon/aggregation/session/index.js';
 export * from './core/beacon/aggregation/session/status.js';
+export * from './core/beacon/beacon.js';
 export * from './core/beacon/cas-beacon.js';
 export * from './core/beacon/error.js';
 export * from './core/beacon/factory.js';
 export * from './core/beacon/interfaces.js';
+export * from './core/beacon/signal-discovery.js';
 export * from './core/beacon/singleton.js';
 export * from './core/beacon/smt-beacon.js';
 export * from './core/beacon/utils.js';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,wDAAwD,CAAC;AACvE,cAAc,oDAAoD,CAAC;AACnE,cAAc,gEAAgE,CAAC;AAC/E,cAAc,mEAAmE,CAAC;AAClF,cAAc,kEAAkE,CAAC;AACjF,cAAc,mEAAmE,CAAC;AAClF,cAAc,4DAA4D,CAAC;AAC3E,cAAc,oEAAoE,CAAC;AACnF,cAAc,yEAAyE,CAAC;AACxF,cAAc,sEAAsE,CAAC;AACrF,cAAc,qEAAqE,CAAC;AACpF,cAAc,2EAA2E,CAAC;AAC1F,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6DAA6D,CAAC;AAC5E,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AACnE,cAAc,0CAA0C,CAAC;AACzD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAEvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAE3D,cAAc,mDAAmD,CAAC;AAClE,cAAc,wDAAwD,CAAC;AACvE,cAAc,oDAAoD,CAAC;AACnE,cAAc,gEAAgE,CAAC;AAC/E,cAAc,mEAAmE,CAAC;AAClF,cAAc,kEAAkE,CAAC;AACjF,cAAc,mEAAmE,CAAC;AAClF,cAAc,4DAA4D,CAAC;AAC3E,cAAc,oEAAoE,CAAC;AACnF,cAAc,yEAAyE,CAAC;AACxF,cAAc,sEAAsE,CAAC;AACrF,cAAc,qEAAqE,CAAC;AACpF,cAAc,2EAA2E,CAAC;AAE1F,cAAc,6DAA6D,CAAC;AAC5E,cAAc,0DAA0D,CAAC;AAEzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AAEnE,cAAc,0CAA0C,CAAC;AACzD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAE5D,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAEvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,gBAAgB,CAAC"}

package/dist/types/utils/appendix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appendix.d.ts","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAe,MAAM,mBAAmB,CAAC;AAE3D,OAAO,EACL,WAAW,EAGX,UAAU,EACV,qBAAqB,EAEtB,MAAM,YAAY,CAAC;AAIpB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,QAAQ;IACnB;;;;OAIG;WACW,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAMpE;;;;OAIG;WACW,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB;IAcjF;;;;OAIG;WACW,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU;IAW3D;;;;;OAKG;WACW,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,qBAAqB,EAAE;IAgBvF;;;;;;;;;;;;;;;;;;;;OAoBG;WACW,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc;IAwBtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc;IA+CrE;;;;OAIG;WACU,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAW7E"}
+{"version":3,"file":"appendix.d.ts","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EACL,WAAW,EAGX,UAAU,EACV,qBAAqB,EAEtB,MAAM,YAAY,CAAC;AAIpB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,QAAQ;IACnB;;;;OAIG;WACW,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAMpE;;;;OAIG;WACW,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB;IAcjF;;;;OAIG;WACW,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU;IAW3D;;;;;OAKG;WACW,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,qBAAqB,EAAE;IAgBvF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc;IAU/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc;IA+CrE;;;;OAIG;WACU,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAW7E"}

package/dist/types/utils/did-document-builder.d.ts

@@ -1,9 +1,13 @@
 import { BeaconService } from '../core/beacon/interfaces.js';
 import { DidDocument, DidVerificationMethod } from './did-document.js';
+/**
+ * A builder class for constructing DID Documents.
+ * @type {DidDocumentBuilder}
+ * @class DidDocumentBuilder
+ */
 export declare class DidDocumentBuilder {
     private document;
     constructor(initialDocument: Partial<DidDocument>);
-    withController(controller?: Array<string>): this;
     withAuthentication(authentication: Array<string | DidVerificationMethod>): this;
     withAssertionMethod(assertionMethod: Array<string | DidVerificationMethod>): this;
     withCapabilityInvocation(capabilityInvocation: Array<string | DidVerificationMethod>): this;

package/dist/types/utils/did-document-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"did-document-builder.d.ts","sourceRoot":"","sources":["../../../src/utils/did-document-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAEvE,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAA4B;gBAEhC,eAAe,EAAE,OAAO,CAAC,WAAW,CAAC;IAYjD,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI;IAOhD,kBAAkB,CAAC,cAAc,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAO/E,mBAAmB,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAOjF,wBAAwB,CAAC,oBAAoB,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAO3F,wBAAwB,CAAC,oBAAoB,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAO3F,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI;IAOhD,KAAK,IAAI,WAAW;CAWrB"}
+{"version":3,"file":"did-document-builder.d.ts","sourceRoot":"","sources":["../../../src/utils/did-document-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAA4B;gBAEhC,eAAe,EAAE,OAAO,CAAC,WAAW,CAAC;IAYjD,kBAAkB,CAAC,cAAc,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAO/E,mBAAmB,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAOjF,wBAAwB,CAAC,oBAAoB,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAO3F,wBAAwB,CAAC,oBAAoB,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,IAAI;IAO3F,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI;IAOhD,KAAK,IAAI,WAAW;CAWrB"}

package/dist/types/utils/did-document.d.ts

@@ -1,5 +1,5 @@
-import { JSONObject, KeyBytes } from '@did-btcr2/common';
-import { DidDocument as IIDidDocument, DidVerificationMethod as IIDidVerificationMethod } from '@web5/dids';
+import { HashBytes, JSONObject, KeyBytes } from '@did-btcr2/common';
+import { DidDocument as W3CDidDocument, DidVerificationMethod as W3CDidVerificationMethod } from '@web5/dids';
 import { BeaconService } from '../core/beacon/interfaces.js';
 export declare const ID_PLACEHOLDER_VALUE = "did:btcr2:_";
 export declare const BECH32M_CHARS = "";
@@ -19,7 +19,10 @@ export type VerificationRelationships = {
     capabilityInvocation?: Array<string | DidVerificationMethod>;
     capabilityDelegation?: Array<string | DidVerificationMethod>;
 };
-export interface IDidVerificationMethod extends IIDidVerificationMethod {
+/** Loose type for unvalidated DID / Genesis document-like input objects. */
+export type DidDocumentLike = Partial<Btcr2DidDocument>;
+export type GenesisDocumentLike = Partial<Btcr2DidDocument>;
+export interface Btcr2VerificationMethod extends W3CDidVerificationMethod {
     id: string;
     type: string;
     controller: string;
@@ -32,21 +35,20 @@ export interface IDidVerificationMethod extends IIDidVerificationMethod {
  * @type {DidVerificationMethod}
  *
  */
-export declare class DidVerificationMethod implements IDidVerificationMethod {
+export declare class DidVerificationMethod implements Btcr2VerificationMethod {
     id: string;
     type: string;
     controller: string;
     publicKeyMultibase: string;
     secretKeyMultibase?: string | undefined;
-    constructor({ id, type, controller, publicKeyMultibase, secretKeyMultibase }: IDidVerificationMethod);
+    constructor({ id, type, controller, publicKeyMultibase, secretKeyMultibase }: Btcr2VerificationMethod);
 }
 /**
  * BTCR2 DID Document Interface
- * @interface IDidDocument
- * @type {IDidDocument}
- * @extends {IIDidDocument}
+ * @interface Btcr2DidDocument
+ * @type {Btcr2DidDocument}
+ * @extends {W3CDidDocument}
  * @property {string} id - The identifier of the DID Document.
- * @property {Array<string>} [controller] - The controller of the DID Document.
  * @property {Array<string | JSONObject>} ['@context'] - The context of the DID Document.
  * @property {Array<DidVerificationMethod>} verificationMethod - The verification methods of the DID Document.
  * @property {Array<string | DidVerificationMethod>} [authentication] - The authentication methods of the DID Document.
@@ -55,9 +57,8 @@ export declare class DidVerificationMethod implements IDidVerificationMethod {
  * @property {Array<string | DidVerificationMethod>} [capabilityDelegation] - The capability delegation methods of the DID Document.
  * @property {Array<BeaconService>} service - The services of the DID Document.
  */
-export interface IDidDocument extends IIDidDocument {
+export interface Btcr2DidDocument extends W3CDidDocument {
     id: string;
-    controller?: Array<string>;
     '@context'?: Array<string | JSONObject>;
     verificationMethod: Array<DidVerificationMethod>;
     authentication?: Array<string | DidVerificationMethod>;
@@ -70,9 +71,8 @@ export interface IDidDocument extends IIDidDocument {
  * BTCR2 DID Document extends the DidDocument class adding helper methods and properties
  * @class DidDocument
  * @type {DidDocument}
- * @implements {IDidDocument}
+ * @implements {Btcr2DidDocument}
  * @property {string} id - The identifier of the DID Document.
- * @property {Array<string>} [controller] - The controller of the DID Document.
  * @property {Array<string | JSONObject>} ['@context'] - The context of the DID Document.
  * @property {Array<DidVerificationMethod>} verificationMethod - The verification methods of the DID Document.
  * @property {Array<string | DidVerificationMethod>} [authentication] - The authentication methods of the DID Document.
@@ -81,9 +81,8 @@ export interface IDidDocument extends IIDidDocument {
  * @property {Array<string | DidVerificationMethod>} [capabilityDelegation] - The capability delegation methods of the DID Document.
  * @property {Array<BeaconService>} service - The services of the DID Document.
  */
-export declare class DidDocument implements IDidDocument {
+export declare class DidDocument implements Btcr2DidDocument {
     id: string;
-    controller?: Array<string>;
     '@context'?: Array<string | JSONObject>;
     verificationMethod: Array<DidVerificationMethod>;
     authentication?: Array<string | DidVerificationMethod>;
@@ -92,12 +91,12 @@ export declare class DidDocument implements IDidDocument {
     capabilityDelegation?: Array<string | DidVerificationMethod>;
     service: Array<BeaconService>;
     deactivated?: boolean;
-    constructor(document: IDidDocument);
+    constructor(document: DidDocumentLike);
     /**
      * Convert the DidDocument to a JSON object.
      * @returns {DidDocument} The JSON representation of the DidDocument.
      */
-    json(): DidDocument;
+    json(): object;
     /**
      * Create a minimal DidDocument from "k1" btcr2 identifier.
      * @param {string} publicKeyMultibase The public key in multibase format.
@@ -122,7 +121,7 @@ export declare class DidDocument implements IDidDocument {
      * @returns {boolean} True if the DID document is valid.
      * @throws {DidDocumentError} If any validation check fails.
      */
-    static isValid(didDocument: DidDocument): boolean;
+    static isValid(didDocument: DidDocumentLike): boolean;
     /**
      * Validates that "@context" exists and includes correct values.
      * @private
@@ -163,13 +162,13 @@ export declare class DidDocument implements IDidDocument {
      * @param {DidDocument} didDocument The DID Document to validate.
      * @returns {boolean} True if the verification relationships are valid.
      */
-    static isValidVerificationRelationships(didDocument: DidDocument): boolean;
+    static isValidVerificationRelationships(didDocument: DidDocumentLike): boolean;
     /**
      * Validate the DID Document
      * @returns {DidDocument} Validated DID Document.
      * @throws {DidDocumentError} If the DID Document is invalid.
      */
-    static validate(didDocument: DidDocument | GenesisDocument): DidDocument;
+    static validate(didDocument: any): DidDocument;
     /**
      * Validate the GenesisDocument.
      * @returns {boolean} True if the GenesisDocument is valid.
@@ -192,7 +191,7 @@ export declare class Document {
  * @extends {DidDocument}
  */
 export declare class GenesisDocument extends DidDocument {
-    constructor(document: object | DidDocument);
+    constructor(document: DidDocumentLike);
     /**
      * Convert the GenesisDocument to a DidDocument by replacing the placeholder value with the provided DID.
      * @param did The DID to replace the placeholder value in the document.
@@ -225,4 +224,10 @@ export declare class GenesisDocument extends DidDocument {
      * @returns {DidDocument} The created DidDocument.
      */
     static fromJSON(object: object | DidDocument): GenesisDocument;
+    /**
+     * Convert a GenesisDocument to genesis bytes.
+     * @param {GenesisDocument} genesisDocument The GenesisDocument to convert.
+     * @returns {Bytes} The genesis bytes.
+     */
+    static toGenesisBytes(genesisDocument: GenesisDocumentLike): HashBytes;
 }

package/dist/types/utils/did-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"did-document.d.ts","sourceRoot":"","sources":["../../../src/utils/did-document.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,UAAU,EAEV,QAAQ,EACT,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAc,WAAW,IAAI,aAAa,EAAE,qBAAqB,IAAI,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACxH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAM7D,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAClD,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,eAAO,MAAM,SAAS,QAAuD,CAAC;AAE9E,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAA;CAC9B,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;CAC9D,CAAA;AAED,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACrE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,sBAAsB;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE5B,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,EAAE,sBAAsB;CAWrG;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;IACxC,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,WAAY,YAAW,YAAY;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAA8B;IACrE,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;gBAEV,QAAQ,EAAE,YAAY;IA6DlC;;;OAGG;IACI,IAAI,IAAI,WAAW;IAI1B;;;;;OAKG;WACW,iBAAiB,CAC7B,EAAE,EAAE,MAAM,EACV,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAC5B,WAAW;IAmBd;;;;OAIG;WACW,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,WAAW;IAKrE;;;OAGG;WACW,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,WAAW;IASrD;;;;;OAKG;WACW,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO;IAmBxD;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAO7B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,SAAS;IASxB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAOhC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAIzC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAI9B;;;;;OAKG;WACW,gCAAgC,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO;IA6BjF;;;;OAIG;WACW,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe,GAAG,WAAW;IAW/E;;;OAGG;IACI,eAAe,IAAI,OAAO;IAyBjC;;;OAGG;IACI,cAAc,IAAI,eAAe;CAMzC;AAED,qBAAa,QAAQ;WACL,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe,GAAG,OAAO;CAG3E;AAGD;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,WAAW;gBAClC,QAAQ,EAAE,MAAM,GAAG,WAAW;IAI1C;;;;OAIG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAO9C;;;;OAIG;WACW,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe;IAKxE;;;;;;OAMG;WACW,MAAM,CAClB,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,EAChD,aAAa,EAAE,yBAAyB,EACxC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAC5B,eAAe;IAKlB;;;;OAIG;WACW,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,eAAe;IA4BlF;;;;OAIG;WACW,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,eAAe;CAGtE"}
+{"version":3,"file":"did-document.d.ts","sourceRoot":"","sources":["../../../src/utils/did-document.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,SAAS,EAGT,UAAU,EAEV,QAAQ,EACT,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,WAAW,IAAI,cAAc,EAAE,qBAAqB,IAAI,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAE9G,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAK7D,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAClD,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,eAAO,MAAM,SAAS,QAAuD,CAAC;AAE9E,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAA;CAC9B,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;CAC9D,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACxD,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE5D,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,uBAAuB;IACnE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE5B,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,EAAE,uBAAuB;CAWtG;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;IACxC,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAY,YAAW,gBAAgB;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAGrC;IACF,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACvD,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IACxD,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC;IAC7D,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;gBAEV,QAAQ,EAAE,eAAe;IAkErC;;;OAGG;IACI,IAAI,IAAI,MAAM;IAIrB;;;;;OAKG;WACW,iBAAiB,CAC7B,EAAE,EAAE,MAAM,EACV,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAC5B,WAAW;IAmBd;;;;OAIG;WACW,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,WAAW;IAKrE;;;OAGG;WACW,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,WAAW;IASrD;;;;;OAKG;WACW,OAAO,CAAC,WAAW,EAAE,eAAe,GAAG,OAAO;IAmB5D;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAO7B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,SAAS;IAUxB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAOhC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAIzC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAI9B;;;;;OAKG;WACW,gCAAgC,CAAC,WAAW,EAAE,eAAe,GAAG,OAAO;IAqBrF;;;;OAIG;WACW,QAAQ,CAAC,WAAW,EAAE,GAAG,GAAG,WAAW;IAWrD;;;OAGG;IACI,eAAe,IAAI,OAAO;IAqBjC;;;OAGG;IACI,cAAc,IAAI,eAAe;CAMzC;AAED,qBAAa,QAAQ;WACL,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe,GAAG,OAAO;CAG3E;AAGD;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,WAAW;gBAClC,QAAQ,EAAE,eAAe;IAIrC;;;;OAIG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAO9C;;;;OAIG;WACW,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe;IAKxE;;;;;;OAMG;WACW,MAAM,CAClB,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAAC,EAChD,aAAa,EAAE,yBAAyB,EACxC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAC5B,eAAe;IAIlB;;;;OAIG;WACW,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,eAAe;IA4BlF;;;;OAIG;WACW,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,eAAe;IAIrE;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,eAAe,EAAE,mBAAmB,GAAG,SAAS;CAGvE"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@did-btcr2/method",
-  "version": "0.19.0",
+  "version": "0.22.0",
   "type": "module",
-  "description": "Javascript/TypeScript reference implementation of did:btcr2 method, a censorship resistant DID Method using the Bitcoin blockchain as a Verifiable Data Registry to announce changes to the DID document. Core package of the did-btcr2-js monorepo.",
+  "description": "Reference implementation for the did:btcr2 DID method written in TypeScript and JavaScript. did:btcr2 is a censorship resistant DID Method using the Bitcoin blockchain as a Verifiable Data Registry to announce changes to the DID document. This is the core method implementation for the did-btcr2-js monorepo.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -84,10 +84,10 @@
     "nostr-tools": "^2.15.0",
     "tiny-secp256k1": "^2.2.3",
     "@did-btcr2/bitcoin": "0.3.4",
-    "@did-btcr2/cryptosuite": "4.0.0",
-    "@did-btcr2/common": "3.1.0",
-    "@did-btcr2/kms": "0.1.1",
-    "@did-btcr2/keypair": "0.8.0"
+    "@did-btcr2/cryptosuite": "5.1.0",
+    "@did-btcr2/kms": "0.2.0",
+    "@did-btcr2/keypair": "0.9.1",
+    "@did-btcr2/common": "4.0.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",
@@ -95,7 +95,7 @@
     "@types/chai-as-promised": "^8.0.1",
     "@types/eslint": "^9.6.1",
     "@types/mocha": "^10.0.9",
-    "@types/node": "^22.5.4",
+    "@types/node": "^25.3.0",
     "@typescript-eslint/eslint-plugin": "^8.5.0",
     "@typescript-eslint/parser": "^8.5.0",
     "c8": "^10.1.2",
@@ -138,6 +138,7 @@
     "build:test": "pnpm build && pnpm build:tests && pnpm c8 mocha",
     "build:lint:test": "pnpm build && pnpm build:tests && pnpm lint:fix",
     "prepublish": "pnpm build",
+    "generate:vector": "pnpm tsx lib/generate-vector.ts",
     "do": "pnpm tsx",
     "do:lib": "${PWD}/lib/run-lib.sh",
     "pack:local": "pnpm pack && mv *.tgz ./release"

package/src/core/beacon/beacon.ts

@@ -0,0 +1,58 @@
+import { KeyBytes } from '@did-btcr2/common';
+import { BitcoinNetworkConnection } from '../../../../bitcoin/dist/types/bitcoin.js';
+import { SignedBTCR2Update } from '../../../../cryptosuite/dist/types/data-integrity-proof/interface.js';
+import { SidecarData } from '../types.js';
+import { BeaconService, BeaconSignal, BlockMetadata } from './interfaces.js';
+
+/**
+ * Abstract base class for all BTCR2 Beacon types.
+ * A Beacon is a service listed in a BTCR2 DID document that informs resolvers
+ * how to find authentic updates to the DID.
+ *
+ * Beacons are lightweight typed wrappers around a {@link BeaconService} configuration.
+ * Dependencies (signals, sidecar data, bitcoin connection) are passed as method
+ * parameters rather than held as instance state.
+ *
+ * Use {@link BeaconFactory.establish} to create typed instances from service config.
+ *
+ * @abstract
+ * @class Beacon
+ * @type {Beacon}
+ */
+export abstract class Beacon {
+  /**
+   * The Beacon service configuration parsed from the DID Document.
+   */
+  readonly service: BeaconService;
+
+  constructor(service: BeaconService) {
+    this.service = service;
+  }
+
+  /**
+   * Processes an array of Beacon Signals to extract BTCR2 Signed Updates.
+   * Used during the resolve path.
+   * @param {Array<BeaconSignal>} signals The beacon signals discovered on-chain.
+   * @param {SidecarData} sidecar The processed sidecar data containing update/CAS/SMT maps.
+   * @returns {Promise<Array<[SignedBTCR2Update, BlockMetadata]>>} The updates announced by the signals.
+   */
+  abstract processSignals(
+    signals: Array<BeaconSignal>,
+    sidecar: SidecarData,
+  ): Promise<Array<[SignedBTCR2Update, BlockMetadata]>>;
+
+
+  /**
+   * Broadcasts a signed update as a Beacon Signal to the Bitcoin network.
+   * Used during the update path.
+   * @param {SignedBTCR2Update} signedUpdate The signed BTCR2 update to broadcast.
+   * @param {KeyBytes} secretKey The secret key for signing the Bitcoin transaction.
+   * @param {BitcoinNetworkConnection} bitcoin The Bitcoin network connection.
+   * @returns {Promise<SignedBTCR2Update>} The signed update that was broadcast.
+   */
+  abstract broadcastSignal(
+    signedUpdate: SignedBTCR2Update,
+    secretKey: KeyBytes,
+    bitcoin: BitcoinNetworkConnection
+  ): Promise<SignedBTCR2Update>;
+}