@did-btcr2/method 0.25.3 → 0.26.0

package/dist/cjs/did-btcr2.js

@@ -1,193 +0,0 @@
-import { IdentifierHrp, INVALID_DID_DOCUMENT, INVALID_DID_UPDATE, METHOD_NOT_SUPPORTED, MethodError, UpdateError } from '@did-btcr2/common';
-import { Did, DidError, DidErrorCode, } from '@web5/dids';
-import * as ecc from '@bitcoinerlab/secp256k1';
-import { hexToBytes } from '@noble/hashes/utils';
-import { initEccLib } from 'bitcoinjs-lib';
-import { Identifier } from './core/identifier.js';
-import { Resolver } from './core/resolver.js';
-import { Update } from './core/update.js';
-import { Appendix } from './utils/appendix.js';
-/** Initialize secp256k1 ECC library */
-initEccLib(ecc);
-/**
- * Implements {@link https://dcdpr.github.io/did-btcr2 | did:btcr2 DID Method Specification}.
- * did:btcr2 is a censorship-resistant Decentralized Identifier (DID) method using
- * the Bitcoin blockchain as a Verifiable Data Registry to announce changes to the
- * DID document. It supports zero-cost off-chain DID creation; aggregated updates
- * for scalable on-chain update costs; long-term identifiers that can support
- * frequent updates; private communication of the DID document; private DID resolution;
- * and non-repudiation.
- *
- * @class DidBtcr2
- * @type {DidBtcr2}
- * @implements {DidMethod}
- */
-export class DidBtcr2 {
-    /**
-     * Name of the DID method, as defined in the DID BTCR2 specification
-     */
-    static methodName = 'btcr2';
-    /**
-     * Implements section {@link https://dcdpr.github.io/did-btcr2/operations/create.html | 7.1 Create}.
-     * @param {KeyBytes | DocumentBytes} genesisBytes The bytes used to create the genesis document for a did:btcr2 identifier.
-     * This can be either the bytes of the genesis document itself or the bytes of a key that will be used to create the genesis document.
-     * @param {DidCreateOptions} options Options for creating the identifier, including the idType (key or external), version, and network.
-     * @param {string} options.idType The type of identifier to create, either 'KEY' or 'EXTERNAL'. Defaults to 'KEY'.
-     * @param {number} options.version The version number of the did:btcr2 specification to use for creating the identifier. Defaults to 1.
-     * @param {string} options.network The Bitcoin network to use for the identifier, e.g. 'bitcoin', 'testnet', etc. Defaults to 'bitcoin'.
-     * @returns {Promise<string>} Promise resolving to an identifier 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, options) {
-        // Deconstruct the idType, version and network from the options, setting defaults if not given
-        const { idType, version = 1, network = 'bitcoin' } = options || {};
-        if (!idType) {
-            throw new MethodError('idType is required for creating a did:btcr2 identifier', INVALID_DID_DOCUMENT, options);
-        }
-        // Call identifier encoding algorithm
-        return Identifier.encode(genesisBytes, { idType, version, network });
-    }
-    /**
-     * Entry point for section {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html | 7.2 Resolve}.
-     *
-     * Factory method that performs pure setup and returns a {@link Resolver} state machine.
-     * The caller drives resolution by calling `resolver.resolve()` and `resolver.provide()`.
-     * Analogous to Rust's `Document::read()`.
-     *
-     * @param {string} did The did:btcr2 identifier to be resolved.
-     * @param {ResolutionOptions} resolutionOptions Options used during the resolution process.
-     * @returns {Resolver} A sans-I/O state machine the caller drives to completion.
-     * @example
-     * ```ts
-     * const resolver = DidBtcr2.resolve(did, { sidecar });
-     * let state = resolver.resolve();
-     * while (state.status === 'action-required') {
-     *   for (const need of state.needs) { ... provide data ... }
-     *   state = resolver.resolve();
-     * }
-     * const { didDocument, metadata } = state.result;
-     * ```
-     */
-    static resolve(did, resolutionOptions = {}) {
-        // Decode the did to be resolved
-        const didComponents = Identifier.decode(did);
-        // Process sidecar if provided
-        const sidecarData = Resolver.sidecarData(resolutionOptions.sidecar);
-        // Establish the current document for KEY identifiers (pure, synchronous).
-        // For EXTERNAL identifiers, defer to the Resolver's GenesisDocument phase
-        // since validation (Resolve.external) is async.
-        const currentDocument = didComponents.hrp === IdentifierHrp.k
-            ? Resolver.deterministic(didComponents)
-            : null;
-        // Return the sans-I/O state machine
-        return new Resolver(didComponents, sidecarData, currentDocument, {
-            versionId: resolutionOptions.versionId,
-            versionTime: resolutionOptions.versionTime,
-            genesisDocument: resolutionOptions.sidecar?.genesisDocument
-        });
-    }
-    /**
-     * 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.
-     *
-     * 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 {BitcoinConnection} [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 async update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }) {
-        // If no signingMaterial provided, throw an UpdateError with INVALID_DID_UPDATE.
-        if (!signingMaterial) {
-            throw new UpdateError('Missing signing material for update', INVALID_DID_UPDATE, { signingMaterial });
-        }
-        // Convert signingMaterial to bytes if it's a hex string
-        const secretKey = typeof signingMaterial === 'string'
-            ? hexToBytes(signingMaterial)
-            : signingMaterial;
-        // Validate that the verificationMethodId is authorized for capabilityInvocation
-        if (!sourceDocument.capabilityInvocation?.some(vr => vr === verificationMethodId)) {
-            throw new UpdateError('Invalid verificationMethodId: not authorized for capabilityInvocation', INVALID_DID_DOCUMENT, sourceDocument);
-        }
-        // Get the verification method to be used for signing the update
-        const verificationMethod = this.getSigningMethod(sourceDocument, verificationMethodId);
-        // Validate the verificationMethod exists in the sourceDocument
-        if (!verificationMethod) {
-            throw new UpdateError('Invalid verificationMethod: not found in source document', INVALID_DID_DOCUMENT, { sourceDocument, verificationMethodId });
-        }
-        // Validate the verificationMethod is of type 'Multikey'
-        if (verificationMethod.type !== 'Multikey') {
-            throw new UpdateError('Invalid verificationMethod: verificationMethod.type must be "Multikey"', INVALID_DID_DOCUMENT, verificationMethod);
-        }
-        // Validate the publicKeyMultibase prefix is 'zQ3s'
-        if (verificationMethod.publicKeyMultibase?.slice(0, 4) !== 'zQ3s') {
-            throw new UpdateError('Invalid verificationMethodId: publicKeyMultibase prefix must start with "zQ3s"', INVALID_DID_DOCUMENT, verificationMethod);
-        }
-        // Construct an unsigned update following the BTCR2 Update construction algorithm
-        const update = Update.construct(sourceDocument, patches, sourceVersionId);
-        // Sign the unsigned update using the specified verification method
-        const signed = Update.sign(sourceDocument.id, update, verificationMethod, secretKey);
-        // Filter sourceDocument services to get beaconServices matching beaconIds
-        const beaconService = sourceDocument.service
-            .filter((service) => service.id === beaconId)
-            .filter((service) => !!service)
-            .shift();
-        // If no matching beacon service found, throw an UpdateError with INVALID_DID_UPDATE.
-        if (!beaconService) {
-            throw new UpdateError('No beacon service found for provided beaconId', INVALID_DID_UPDATE, { sourceDocument, beaconId });
-        }
-        // Require an explicit bitcoin connection — no silent env-var fallback
-        if (!bitcoin) {
-            throw new UpdateError('Bitcoin connection required for update. Pass a configured `bitcoin` parameter '
-                + 'or use DidBtcr2Api which injects it automatically.', INVALID_DID_UPDATE, { beaconId });
-        }
-        // Announce the signed update to the blockchain using the specified beacon(s)
-        await Update.announce(beaconService, signed, secretKey, bitcoin);
-        // Return signed update if announced successfully
-        return signed;
-    }
-    /**
-     * 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 {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, methodId) {
-        // Set the default methodId to the first assertionMethod if not given
-        methodId ??= '#initialKey';
-        // Verify the DID method is supported.
-        const parsedDid = Did.parse(didDocument.id);
-        if (parsedDid && parsedDid.method !== this.methodName) {
-            throw new MethodError(`Method not supported: ${parsedDid.method}`, METHOD_NOT_SUPPORTED, { identifier: didDocument.id });
-        }
-        // Attempt to find a verification method that matches the given method ID, or if not given,
-        // find the first verification method intended for signing claims.
-        const verificationMethod = didDocument.verificationMethod?.find((vm) => Appendix.extractDidFragment(vm.id) === (Appendix.extractDidFragment(methodId)
-            ?? Appendix.extractDidFragment(didDocument.assertionMethod?.[0])));
-        // If no verification method is found, throw an error
-        if (!(verificationMethod && verificationMethod.publicKeyMultibase)) {
-            throw new DidError(DidErrorCode.InternalError, 'A verification method intended for signing could not be determined from the DID Document');
-        }
-        return verificationMethod;
-    }
-}
-//# sourceMappingURL=did-btcr2.js.map

package/dist/cjs/did-btcr2.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"did-btcr2.js","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAElB,oBAAoB,EACpB,WAAW,EAEX,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,GAAG,EACH,QAAQ,EACR,YAAY,GAEb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,GAAG,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAY/C,uCAAuC;AACvC,UAAU,CAAC,GAAG,CAAC,CAAC;AAEhB;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,UAAU,GAAW,OAAO,CAAC;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,YAAsC,EAAE,OAA0B;QAC9E,8FAA8F;QAC9F,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAEnE,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,oBAAoB,EAAE,OAAO,CAC9B,CAAC;QACJ,CAAC;QAED,qCAAqC;QACrC,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,OAAO,CACZ,GAAW,EACX,oBAAuC,EAAE;QAEzC,gCAAgC;QAChC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEpE,0EAA0E;QAC1E,0EAA0E;QAC1E,gDAAgD;QAChD,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,KAAK,aAAa,CAAC,CAAC;YAC3D,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC;QAET,oCAAoC;QACpC,OAAO,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE;YAC/D,SAAS,EAAS,iBAAiB,CAAC,SAAS;YAC7C,WAAW,EAAO,iBAAiB,CAAC,WAAW;YAC/C,eAAe,EAAG,iBAAiB,CAAC,OAAO,EAAE,eAAe;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAClB,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,OAAO,GASR;QACC,gFAAgF;QAChF,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,WAAW,CACnB,qCAAqC,EACrC,kBAAkB,EAAE,EAAC,eAAe,EAAC,CACtC,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,MAAM,SAAS,GAAG,OAAO,eAAe,KAAK,QAAQ;YACnD,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC;YAC7B,CAAC,CAAC,eAAe,CAAC;QAEpB,gFAAgF;QAChF,IAAG,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,oBAAoB,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,WAAW,CACnB,uEAAuE,EACvE,oBAAoB,EAAE,cAAc,CACrC,CAAC;QACJ,CAAC;QAED,gEAAgE;QAChE,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QAEvF,+DAA+D;QAC/D,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,WAAW,CACnB,0DAA0D,EAC1D,oBAAoB,EAAE,EAAC,cAAc,EAAE,oBAAoB,EAAC,CAC7D,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,IAAI,kBAAkB,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,WAAW,CACnB,wEAAwE,EACxE,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,mDAAmD;QACnD,IAAI,kBAAkB,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YAClE,MAAM,IAAI,WAAW,CACnB,gFAAgF,EAChF,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,iFAAiF;QACjF,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;QAE1E,mEAAmE;QACnE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,SAAS,CAAC,CAAC;QAErF,0EAA0E;QAC1E,MAAM,aAAa,GAAG,cAAc,CAAC,OAAO;aACzC,MAAM,CAAC,CAAC,OAAsB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC;aAC3D,MAAM,CAAC,CAAC,OAAsB,EAA4B,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACvE,KAAK,EAAE,CAAC;QAEX,qFAAqF;QACrF,IAAG,CAAC,aAAa,EAAE,CAAC;YAClB,MAAM,IAAI,WAAW,CACnB,+CAA+C,EAC/C,kBAAkB,EAAE,EAAC,cAAc,EAAE,QAAQ,EAAC,CAC/C,CAAC;QACJ,CAAC;QACD,sEAAsE;QACtE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,WAAW,CACnB,gFAAgF;kBAC9E,oDAAoD,EACtD,kBAAkB,EAAE,EAAE,QAAQ,EAAE,CACjC,CAAC;QACJ,CAAC;QAED,6EAA6E;QAC7E,MAAM,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAEjE,iDAAiD;QACjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAA6B,EAAG,QAAiB;QACvE,qEAAqE;QACrE,QAAQ,KAAK,aAAa,CAAC;QAE3B,sCAAsC;QACtC,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC5C,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YACtD,MAAM,IAAI,WAAW,CAAC,yBAAyB,SAAS,CAAC,MAAM,EAAE,EAAE,oBAAoB,EAAE,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3H,CAAC;QAED,2FAA2F;QAC3F,kEAAkE;QAClE,MAAM,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAC7D,CAAC,EAAyB,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC;eACvG,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CACpE,CAAC;QAEF,qDAAqD;QACrD,IAAI,CAAC,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,aAAa,EAC1B,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QACD,OAAO,kBAA2C,CAAC;IACrD,CAAC"}

package/dist/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","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,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAEvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AAExC,cAAc,gBAAgB,CAAC"}

package/dist/cjs/utils/appendix.js

@@ -1,203 +0,0 @@
-import { strings } from '@helia/strings';
-import { DidError, DidErrorCode, DidVerificationRelationship } from '@web5/dids';
-import { createHelia } from 'helia';
-import { CID } from 'multiformats';
-import { create as createDigest } from 'multiformats/hashes/digest';
-/**
- * Implements {@link https://dcdpr.github.io/did-btcr2/#appendix | 9. Appendix} methods.
- *
- * @class Appendix
- * @type {Appendix}
- */
-export class Appendix {
-    /**
-     * Extracts a DID fragment from a given input
-     * @param {unknown} input The input to extract the DID fragment from
-     * @returns {string | undefined} The extracted DID fragment or undefined if not found
-     */
-    static extractDidFragment(input) {
-        if (typeof input !== 'string')
-            return undefined;
-        if (input.length === 0)
-            return undefined;
-        return input;
-    }
-    /**
-     * Validates that the given object is a DidVerificationMethod
-     * @param {unknown} obj The object to validate
-     * @returns {boolean} A boolean indicating whether the object is a DidVerificationMethod
-     */
-    static isDidVerificationMethod(obj) {
-        // Validate that the given value is an object.
-        if (!obj || typeof obj !== 'object' || obj === null)
-            return false;
-        // Validate that the object has the necessary properties of a DidVerificationMethod.
-        if (!('id' in obj && 'type' in obj && 'controller' in obj))
-            return false;
-        if (typeof obj.id !== 'string')
-            return false;
-        if (typeof obj.type !== 'string')
-            return false;
-        if (typeof obj.controller !== 'string')
-            return false;
-        return true;
-    }
-    /**
-     * Validates that the given object is a DidService
-     * @param {unknown} obj The object to validate
-     * @returns {boolean} A boolean indicating whether the object is a DidService
-     */
-    static isDidService(obj) {
-        // Validate that the given value is an object.
-        if (!obj || typeof obj !== 'object' || obj === null)
-            return false;
-        // Validate that the object has the necessary properties of a DidService.
-        if (!('id' in obj && 'type' in obj && 'serviceEndpoint' in obj))
-            return false;
-        if (typeof obj.id !== 'string')
-            return false;
-        if (typeof obj.type !== 'string')
-            return false;
-        if (typeof obj.serviceEndpoint !== 'string')
-            return false;
-        return true;
-    }
-    /**
-     * Extracts the verification methods from a given DID Document
-     * @param {DidDocument} params.didDocument The DID Document to extract the verification methods from
-     * @returns {DidVerificationMethod[]} An array of DidVerificationMethod objects
-     * @throws {TypeError} if the didDocument is not provided
-     */
-    static getVerificationMethods(didDocument) {
-        if (!didDocument)
-            throw new TypeError(`Required parameter missing: 'didDocument'`);
-        const verificationMethods = [];
-        // Check the 'verificationMethod' array.
-        verificationMethods.push(...didDocument.verificationMethod?.filter(Appendix.isDidVerificationMethod) ?? []);
-        // Check verification relationship properties for embedded verification methods.
-        Object.keys(DidVerificationRelationship).forEach((relationship) => {
-            verificationMethods.push(...didDocument[relationship]
-                ?.filter(Appendix.isDidVerificationMethod) ?? []);
-        });
-        return verificationMethods;
-    }
-    /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#derive-root-capability-from-didbtcr2-identifier | 9.4.1 Derive Root Capability from did:btcr2 Identifier }.
-     *
-     * The Derive Root Capability algorithm deterministically generates a ZCAP-LD root capability from a given did:btcr2
-     * identifier. Each root capability is unique to the identifier. This root capability is defined and understood by the
-     * did:btcr2 specification as the root capability to authorize updates to the specific did:btcr2 identifiers DID
-     * document. It takes in a did:btcr2 identifier and returns a rootCapability object. It returns the root capability.
-     *
-     * @param {string} identifier The did-btcr2 identifier to derive the root capability from
-     * @returns {RootCapability} The root capability object
-     * @example Root capability for updating the DID document for
-     * did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u
-     * ```
-     * {
-     *  "@context": "https://w3id.org/zcap/v1",
-     *  "id": "urn:zcap:root:did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
-     *  "controller": "did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
-     *  "invocationTarget": "did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u"
-     * }
-     * ```
-     */
-    static deriveRootCapability(identifier) {
-        return {
-            '@context': 'https://w3id.org/zcap/v1',
-            id: `urn:zcap:root:${encodeURIComponent(identifier)}`,
-            controller: identifier,
-            invocationTarget: identifier,
-        };
-    }
-    /**
-     * Implements {@link https://dcdpr.github.io/did-btcr2/#dereference-root-capability-identifier | 9.4.2 Dereference Root Capability Identifier}.
-     *
-     * This algorithm takes in capabilityId, a root capability identifier, and dereferences it to rootCapability, the root
-     * capability object.
-     *
-     * @param {string} capabilityId The root capability identifier to dereference.
-     * @returns {RootCapability} The root capability object.
-     * @example a didUpdatePayload with an invoked ZCAP-LD capability containing a patch defining how the DID document
-     * for did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u SHOULD be mutated.
-     * ```
-     * {
-     *  "@context": [
-     *   "https://w3id.org/zcap/v1",
-     *   "https://w3id.org/security/data-integrity/v2",
-     *   "https://w3id.org/json-ld-patch/v1"
-     *  ],
-     *  "patch": [
-     *   {
-     *    "op": "add",
-     *    "path": "/service/4",
-     *    "value": {
-     *       "id": "#linked-domain",
-     *       "type": "LinkedDomains",
-     *       "serviceEndpoint": "https://contact-me.com"
-     *      }
-     *    }
-     *  ],
-     *  "proof": {
-     *    "type": "DataIntegrityProof",
-     *    "cryptosuite": "schnorr-secp256k1-jcs-2025",
-     *    "verificationMethod": "did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u#initialKey",
-     *    "invocationTarget": "did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
-     *    "capability": "urn:zcap:root:did%3Abtcr2%3Ak1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
-     *    "capabilityAction": "Write",
-     *    "proofPurpose": "assertionMethod",
-     *    "proofValue": "z381yXYmxU8NudZ4HXY56DfMN6zfD8syvWcRXzT9xD9uYoQToo8QsXD7ahM3gXTzuay5WJbqTswt2BKaGWYn2hHhVFKJLXaDz"
-     *   }
-     * }
-     */
-    static dereferenceZcapId(capabilityId) {
-        // 1. Set rootCapability to an empty object.
-        const rootCapability = {};
-        // 2. Set components to the result of capabilityId.split(":").
-        const [urn, zcap, root, did] = capabilityId.split(':') ?? [];
-        // 3. Validate components:
-        //    1. Assert length of components is 4.
-        if ([urn, zcap, root, did].length !== 4) {
-            throw new DidError(DidErrorCode.InvalidDid, `Invalid capabilityId: ${capabilityId}`);
-        }
-        //    2. components[0] == urn.
-        if (!urn || urn !== 'urn') {
-            throw new DidError(DidErrorCode.InvalidDid, `Invalid capabilityId: ${capabilityId}`);
-        }
-        //    3. components[1] == zcap.
-        if (!zcap || zcap !== 'zcap') {
-            throw new DidError(DidErrorCode.InvalidDid, `Invalid capabilityId: ${capabilityId}`);
-        }
-        //    4. components[2] == root.
-        if (!root || root !== 'root') {
-            throw new DidError(DidErrorCode.InvalidDid, `Invalid capabilityId: ${capabilityId}`);
-        }
-        // 4. Set uriEncodedId to components[3].
-        const uriEncodedId = did;
-        // 5. Set Identifier the result of decodeURIComponent(uriEncodedId).
-        const Identifier = decodeURIComponent(uriEncodedId);
-        // 6. Set rootCapability.id to capabilityId.
-        rootCapability.id = capabilityId;
-        // 7. Set rootCapability.controller to Identifier.
-        rootCapability.controller = Identifier;
-        // 8. Set rootCapability.invocationTarget to Identifier.
-        rootCapability.invocationTarget = Identifier;
-        // 9. Return rootCapability.
-        return rootCapability;
-    }
-    /**
-     * Implements CAS Lookup Step from {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#process-beacon-signals | 7.2.e Process Beacon Signals }.
-     * @param {HashBytes} hashBytes The hash bytes to look up in the CAS system.
-     * @returns {Promise<string | undefined>} The content fetched from the CAS system, or undefined if not found.
-     */
-    static async fetchFromCas(hashBytes) {
-        // Construct CID from hash bytes
-        const cid = CID.create(1, 1, createDigest(1, hashBytes));
-        // Connect to IPFS/Helia node
-        const helia = await createHelia();
-        const node = strings(helia);
-        // Return the IPFS get result
-        return await node.get(cid, {});
-    }
-}
-//# sourceMappingURL=appendix.js.map

package/dist/cjs/utils/appendix.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"appendix.js","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAEL,QAAQ,EACR,YAAY,EAGZ,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAGpE;;;;;GAKG;AACH,MAAM,OAAO,QAAQ;IACnB;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,KAAc;QAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAChD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QACzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,GAAY;QAChD,8CAA8C;QAC9C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAElE,oFAAoF;QACpF,IAAI,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAEzE,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,GAAY;QACrC,8CAA8C;QAC9C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAClE,yEAAyE;QACzE,IAAI,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,iBAAiB,IAAI,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9E,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,eAAe,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,WAAwB;QAC3D,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;QACnF,MAAM,mBAAmB,GAA4B,EAAE,CAAC;QACxD,wCAAwC;QACxC,mBAAmB,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5G,gFAAgF;QAChF,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAChE,mBAAmB,CAAC,IAAI,CACtB,GAAI,WAAW,CAAC,YAAiC,CAA+B;gBAC9E,EAAE,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,EAAE,CACnD,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,mBAA8C,CAAC;IACxD,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,UAAU,EAAS,0BAA0B;YAC7C,EAAE,EAAiB,iBAAiB,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACpE,UAAU,EAAS,UAAU;YAC7B,gBAAgB,EAAG,UAAU;SAC9B,CAAC;IACJ,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACI,MAAM,CAAC,iBAAiB,CAAC,YAAoB;QAClD,4CAA4C;QAC5C,MAAM,cAAc,GAAG,EAAoB,CAAC;QAE5C,8DAA8D;QAC9D,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAE7D,0BAA0B;QAC1B,0CAA0C;QAC1C,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,8BAA8B;QAC9B,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,wCAAwC;QACxC,MAAM,YAAY,GAAG,GAAG,CAAC;QAEzB,oEAAoE;QACpE,MAAM,UAAU,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAEpD,4CAA4C;QAC5C,cAAc,CAAC,EAAE,GAAG,YAAY,CAAC;QAEjC,kDAAkD;QAClD,cAAc,CAAC,UAAU,GAAG,UAAU,CAAC;QAEvC,wDAAwD;QACxD,cAAc,CAAC,gBAAgB,GAAG,UAAU,CAAC;QAE7C,4BAA4B;QAC5B,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAoB;QAC5C,gCAAgC;QAChC,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QAEzD,6BAA6B;QAC7B,MAAM,KAAK,GAAG,MAAM,WAAW,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5B,6BAA6B;QAC7B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC;CACF"}

package/dist/cjs/utils/did-document-builder.js

@@ -1,60 +0,0 @@
-import { DidDocumentError, INVALID_DID_DOCUMENT } from '@did-btcr2/common';
-import { DidDocument } from './did-document.js';
-/**
- * A builder class for constructing DID Documents.
- * @type {DidDocumentBuilder}
- * @class DidDocumentBuilder
- */
-export class DidDocumentBuilder {
-    document = {};
-    constructor(initialDocument) {
-        if (!initialDocument.id) {
-            throw new DidDocumentError('Missing required "id" property', INVALID_DID_DOCUMENT, initialDocument);
-        }
-        this.document.id = initialDocument.id;
-        this.document.verificationMethod = initialDocument.verificationMethod ?? [];
-        if (initialDocument['@context']) {
-            this.document['@context'] = initialDocument['@context'];
-        }
-    }
-    withAuthentication(authentication) {
-        if (authentication) {
-            this.document.authentication = authentication;
-        }
-        return this;
-    }
-    withAssertionMethod(assertionMethod) {
-        if (assertionMethod) {
-            this.document.assertionMethod = assertionMethod;
-        }
-        return this;
-    }
-    withCapabilityInvocation(capabilityInvocation) {
-        if (capabilityInvocation) {
-            this.document.capabilityInvocation = capabilityInvocation;
-        }
-        return this;
-    }
-    withCapabilityDelegation(capabilityDelegation) {
-        if (capabilityDelegation) {
-            this.document.capabilityDelegation = capabilityDelegation;
-        }
-        return this;
-    }
-    withService(service) {
-        if (service) {
-            this.document.service = service;
-        }
-        return this;
-    }
-    build() {
-        const didDocument = new DidDocument(this.document);
-        for (const key of Object.keys(didDocument)) {
-            if (didDocument[key] === undefined) {
-                delete didDocument[key];
-            }
-        }
-        return didDocument;
-    }
-}
-//# sourceMappingURL=did-document-builder.js.map

package/dist/cjs/utils/did-document-builder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"did-document-builder.js","sourceRoot":"","sources":["../../../src/utils/did-document-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAyB,MAAM,mBAAmB,CAAC;AAEvE;;;;GAIG;AACH,MAAM,OAAO,kBAAkB;IACrB,QAAQ,GAAyB,EAAE,CAAC;IAE5C,YAAY,eAAqC;QAC/C,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;YACxB,MAAM,IAAI,gBAAgB,CAAC,gCAAgC,EAAE,oBAAoB,EAAE,eAAe,CAAC,CAAC;QACtG,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,eAAe,CAAC,EAAE,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,GAAG,eAAe,CAAC,kBAAkB,IAAI,EAAE,CAAC;QAE5E,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,kBAAkB,CAAC,cAAqD;QACtE,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mBAAmB,CAAC,eAAsD;QACxE,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,eAAe,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wBAAwB,CAAC,oBAA2D;QAClF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wBAAwB,CAAC,oBAA2D;QAClF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,OAA6B;QACvC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;QAClC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,QAAuB,CAAC,CAAC;QAElE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,WAAW,CAAC,GAAwB,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxD,OAAO,WAAW,CAAC,GAAwB,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}