@did-btcr2/method 0.13.1

package/dist/esm/utils/beacons.js

@@ -0,0 +1,206 @@
+import { Btcr2Error, DidBtcr2Error } from '@did-btcr2/common';
+import { payments } from 'bitcoinjs-lib';
+import { BeaconFactory } from '../btcr2/beacon/factory.js';
+import { Btc1Appendix } from './appendix.js';
+/**
+ * Static class of utility functions for the Beacon Service
+ * @class BeaconUtils
+ * @type {BeaconUtils}
+ */
+export class BeaconUtils {
+    /**
+     * Converts a BIP21 Bitcoin URI to a Bitcoin address
+     * @param {string} uri The BIP21 Bitcoin URI to convert
+     * @returns {string} The Bitcoin address extracted from the URI
+     * @throws {DidBtcr2Error} if the URI is not a valid Bitcoin URI
+     */
+    static parseBitcoinAddress(uri) {
+        if (!uri.startsWith('bitcoin:')) {
+            throw new DidBtcr2Error('Invalid Bitcoin URI format', { type: 'BEACON_ERROR' });
+        }
+        return uri.replace('bitcoin:', '').split('?')[0]; // Extracts address from "bitcoin:<address>?params"
+    }
+    /**
+     * Validates that the given object is a Beacon Service
+     * @param {BeaconService} obj The object to validate
+     * @returns {boolean} A boolean indicating whether the object is a Beacon Service
+     */
+    static isBeaconService(obj) {
+        // Return false if the given obj is not a valid DidService.
+        if (!Btc1Appendix.isDidService(obj))
+            return false;
+        // Return false if the type is not a valid beacon service type.
+        if (!['SingletonBeacon', 'CIDAggregateBeacon', 'SMTAggregateBeacon'].includes(obj.type))
+            return false;
+        // Return false if the serviceEndpoint is not a valid BIP21 bitcoin address.
+        if ([obj.serviceEndpoint].flat().some(ep => typeof ep === 'string' && !ep.startsWith('bitcoin:')))
+            return false;
+        // Return false if the casType exists and is not a string.
+        if (obj.casType && typeof obj.casType !== 'string')
+            return false;
+        // Else return true
+        return true;
+    }
+    /**
+     * Extracts the services from a given DID Document
+     * @param {DidDocument} didDocument The DID Document to extract the services from
+     * @returns {DidService[]} An array of DidService objects
+     * @throws {TypeError} if the didDocument is not provided
+     */
+    static getBeaconServices(didDocument) {
+        // Filter out any invalid did service objects.
+        const didServices = didDocument.service?.filter(Btc1Appendix.isDidService) ?? [];
+        // Filter for valid beacon service objects.
+        return (didServices.filter(this.isBeaconService) ?? []);
+    }
+    /**
+     * Generate all 3 Beacon Service Endpoints for a given public key.
+     * @param {GenerateBitcoinAddrsParams} params Required parameters for generating Beacon Services.
+     * @param {KeyBytes} params.publicKey Public key bytes used to generate the beacon object serviceEndpoint.
+     * @param {Network} params.network Bitcoin network interface from bitcoinlib-js.
+     * @returns {Array<Array<string>>} 2D Array of bitcoin addresses (p2pkh, p2wpkh, p2tr).
+     * @throws {DidBtcr2Error} if the bitcoin address is invalid.
+     */
+    static generateBeaconAddresses({ identifier, publicKey, network }) {
+        try {
+            const p2pkh = payments.p2pkh({ pubkey: publicKey, network }).address;
+            const p2wpkh = payments.p2wpkh({ pubkey: publicKey, network }).address;
+            const p2tr = payments.p2tr({ network, internalPubkey: publicKey.slice(1, 33) }).address;
+            if (!p2pkh || !p2wpkh || !p2tr) {
+                throw new DidBtcr2Error('Failed to generate bitcoin addresses');
+            }
+            return [
+                [`${identifier}#initialP2PKH`, p2pkh],
+                [`${identifier}#initialP2WPKH`, p2wpkh],
+                [`${identifier}#initialP2TR`, p2tr]
+            ];
+        }
+        catch (error) {
+            console.error(error);
+            process.exit(1);
+        }
+    }
+    /**
+     * Generate a set of Beacon Services for a given public key.
+     * @param {GenerateBeaconServicesParams} params Required parameters for generating Beacon Services.
+     * @param {KeyBytes} params.publicKey Public key bytes used to generate the beacon object serviceEndpoint.
+     * @param {Network} params.network Bitcoin network interface from bitcoinlib-js.
+     * @param {string} params.beaconType The type of beacon service to create.
+     * @param {string} params.addressType The type of address to create (p2pkh, p2wpkh, p2tr).
+     * @returns {BeaconService} A BeaconService object.
+     * @throws {DidBtcr2Error} if the bitcoin address is invalid.
+     */
+    static generateBeaconService({ id, publicKey: pubkey, network, addressType, type }) {
+        try {
+            if (!id.includes('#')) {
+                id = `${id}#initial${addressType.toUpperCase()}`;
+            }
+            const serviceEndpoint = `bitcoin:${payments[addressType]({ pubkey, network }).address}`;
+            return { id, type, serviceEndpoint, };
+        }
+        catch (error) {
+            console.error(error);
+            process.exit(1);
+        }
+    }
+    /**
+     * Generate a custom Beacon Service.
+     * @param {GenerateBeaconServicesParams} params Required parameters for generating Beacon Services.
+     * @returns
+     */
+    static generateBeaconServiceCustom({ id, publicKey: pubkey, network, addressType, type }) {
+        try {
+            if (!id.includes('#')) {
+                throw new Btcr2Error('Invalid id format. It should include a fragment identifier (e.g., #initialP2PKH).', 'BEACON_ERROR', { id });
+            }
+            const serviceEndpoint = `bitcoin:${payments[addressType]({ pubkey, network }).address}`;
+            return { id, type, serviceEndpoint, };
+        }
+        catch (error) {
+            console.error(error);
+            process.exit(1);
+        }
+    }
+    /**
+     * Generate beacon services.
+     * @param {GenerateBeaconServicesParams} params Required parameters for generating Beacon Services.
+     * @param {string} params.network The name of the Bitcoin network to use.
+     * @param {Uint8Array} params.publicKey Byte array representation of a public key used to generate a new btcr2 key-id-type.
+     * @param {string} params.beaconType Optional beacon type to use (default: SingletonBeacon).
+     * @returns {DidService[]} Array of DidService objects.
+     */
+    static generateBeaconServices({ identifier, network, type, publicKey }) {
+        // Generate the bitcoin addresses
+        const bitcoinAddrs = this.generateBeaconAddresses({ identifier, publicKey, network, });
+        // Map the bitcoin addresses to the beacon service
+        return bitcoinAddrs.map(([id, address]) => {
+            // Convert the address to a BIP-21 URI
+            const serviceEndpoint = `bitcoin:${address}`;
+            // Create the beacon object
+            const beacon = BeaconFactory.establish({ id, type, serviceEndpoint });
+            // Return the beacon service
+            return beacon.service;
+        });
+    }
+    /**
+     * Generate a single beacon service.
+     * @param {GenerateBeaconParams} params Required parameters for generating a single Beacon Service.
+     * @param {string} params.identifier The identifier for the beacon service.
+     * @param {string} params.network The name of the Bitcoin network to use.
+     * @param {Uint8Array} params.publicKey Byte array representation of a public key used to generate a new btcr2 key-id-type.
+     * @param {string} params.type The type of beacon service to create.
+     * @returns {BeaconService} A BeaconService object.
+     * @throws {DidBtcr2Error} if the bitcoin address is invalid.
+     */
+    static generateBeacon({ identifier, network, type, publicKey }) {
+        // Generate the bitcoin addresses
+        const bitcoinAddrs = this.generateBeaconAddresses({ identifier, publicKey, network, });
+        // Map the bitcoin addresses to the beacon service
+        const beacon = bitcoinAddrs.map(([id, address]) => {
+            // Convert the address to a BIP-21 URI
+            const serviceEndpoint = `bitcoin:${address}`;
+            // Create the beacon object
+            const beacon = BeaconFactory.establish({ id, type, serviceEndpoint });
+            // Return the beacon service
+            return beacon.service;
+        });
+        return beacon[0];
+    }
+    /**
+     * Manufacture a pre-filled Beacon using the BeaconFactory.
+     * @param {BeaconServicesParams} params Required parameters for generating a single Beacon Service.
+     * @param {string} params.serviceId The type of service being created (#initialP2PKH, #initialP2WPKH, #initialP2TR).
+     * @param {string} params.beaconType The type of beacon service being created (SingletonBeacon, SMTAggregatorBeacon).
+     * @param {BitcoinAddress} params.bitcoinAddress The bitcoin address to use for the service endpoint.
+     * @returns {BeaconService} One BeaconService object.
+     */
+    static manufactureBeacon(params) {
+        return BeaconFactory.establish(params).service;
+    }
+    /**
+     * Convert beacon service endpoints from BIP-21 URIs to addresses.
+     * @param {Array<BeaconService>} beacons The list of beacon services.
+     * @returns {Array<BeaconServiceAddress>} An array of beacon services with address: bitcoinAddress.
+     */
+    static toBeaconServiceAddress(beacons) {
+        return beacons.map((beacon) => ({ ...beacon, address: beacon.serviceEndpoint.replace('bitcoin:', '') }));
+    }
+    /**
+     * Create a map of address => beaconService with address field.
+     * @param {Array<BeaconService>} beacons The list of beacon services.
+     * @returns {Map<string, BeaconServiceAddress>} A map of address => beaconService.
+     */
+    static getBeaconServiceAddressMap(beacons) {
+        const beaconAddrs = this.toBeaconServiceAddress(beacons);
+        return new Map(beaconAddrs.map((beacon) => ([beacon.address, beacon])));
+    }
+    /**
+     * Get the beacon service ids from a list of beacon services.
+     * @param {Btc1DidDocument} didDocument The DID Document to extract the services from.
+     * @returns {string[]} An array of beacon service ids.
+     */
+    static getBeaconServiceIds(didDocument) {
+        return this.getBeaconServices(didDocument).map((beacon) => beacon.id);
+    }
+}
+//# sourceMappingURL=beacons.js.map

package/dist/esm/utils/beacons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"beacons.js","sourceRoot":"","sources":["../../../src/utils/beacons.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAmB,MAAM,mBAAmB,CAAC;AAE/E,OAAO,EAAY,QAAQ,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AA6B7C;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACtB;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,GAAW;QAC3C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,aAAa,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mDAAmD;IACvG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,GAAyB;QACrD,2DAA2D;QAC3D,IAAG,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAEjD,+DAA+D;QAC/D,IAAG,CAAC,CAAC,iBAAiB,EAAE,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAErG,4EAA4E;QAC5E,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAEhH,0DAA0D;QAC1D,IAAG,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAEhE,mBAAmB;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAAC,WAAwB;QACtD,8CAA8C;QAC9C,MAAM,WAAW,GAAiB,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;QAC/F,2CAA2C;QAC3C,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAoB,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAIrE;QACC,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC;YACrE,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC;YACvE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;YACxF,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC/B,MAAM,IAAI,aAAa,CAAC,sCAAsC,CAAC,CAAC;YAClE,CAAC;YACD,OAAO;gBACL,CAAC,GAAG,UAAU,eAAe,EAAE,KAAK,CAAC;gBACrC,CAAC,GAAG,UAAU,gBAAgB,EAAE,MAAM,CAAC;gBACvC,CAAC,GAAG,UAAU,cAAc,EAAE,IAAI,CAAC;aACpC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAMtF;QACC,IAAI,CAAC;YACH,IAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrB,EAAE,GAAG,GAAG,EAAE,WAAW,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;YACnD,CAAC;YACD,MAAM,eAAe,GAAG,WAAW,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YACxF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,GAAG,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,2BAA2B,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAM5F;QACC,IAAI,CAAC;YACH,IAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,UAAU,CAClB,mFAAmF,EACnF,cAAc,EACd,EAAE,EAAE,EAAE,CACP,CAAC;YACJ,CAAC;YACD,MAAM,eAAe,GAAG,WAAW,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YACxF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,GAAG,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,sBAAsB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAK1E;QACC,iCAAiC;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,GAAG,CAAC,CAAC;QAEvF,kDAAkD;QAClD,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE;YACxC,sCAAsC;YACtC,MAAM,eAAe,GAAG,WAAW,OAAO,EAAE,CAAC;YAC7C,2BAA2B;YAC3B,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;YACtE,4BAA4B;YAC5B,OAAO,MAAM,CAAC,OAAO,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,cAAc,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAKlE;QACC,iCAAiC;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,GAAG,CAAC,CAAC;QAEvF,kDAAkD;QAClD,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE;YAChD,sCAAsC;YACtC,MAAM,eAAe,GAAG,WAAW,OAAO,EAAE,CAAC;YAC7C,2BAA2B;YAC3B,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;YACtE,4BAA4B;YAC5B,OAAO,MAAM,CAAC,OAAO,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAqB;QACnD,OAAO,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,OAA6B;QAChE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,0BAA0B,CAAC,OAA6B;QACpE,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QACzD,OAAO,IAAI,GAAG,CAA+B,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,WAA4B;QAC5D,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}

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

@@ -0,0 +1,61 @@
+import { DidDocumentError, INVALID_DID_DOCUMENT } from '@did-btcr2/common';
+import { Btc1DidDocument } from './did-document.js';
+export class Btc1DidDocumentBuilder {
+    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'];
+        }
+    }
+    withController(controller) {
+        if (controller) {
+            this.document.controller = controller ?? [this.document.id];
+        }
+        return this;
+    }
+    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 Btc1DidDocument(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/esm/utils/did-document-builder.js.map

@@ -0,0 +1 @@
+{"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,eAAe,EAA0B,MAAM,mBAAmB,CAAC;AAE5E,MAAM,OAAO,sBAAsB;IACzB,QAAQ,GAA6B,EAAE,CAAC;IAEhD,YAAY,eAAyC;QACnD,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,cAAc,CAAC,UAA0B;QACvC,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAG,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB,CAAC,cAAsD;QACvE,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mBAAmB,CAAC,eAAuD;QACzE,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,eAAe,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wBAAwB,CAAC,oBAA4D;QACnF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wBAAwB,CAAC,oBAA4D;QACnF,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,eAAe,CAAC,IAAI,CAAC,QAA2B,CAAC,CAAC;QAE1E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,WAAW,CAAC,GAA4B,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC5D,OAAO,WAAW,CAAC,GAA4B,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}

package/dist/esm/utils/did-document.js

@@ -0,0 +1,380 @@
+import { BTCR2_DID_DOCUMENT_CONTEXT, Btcr2IdentifierTypes, DidDocumentError, ID_PLACEHOLDER_VALUE, INVALID_DID_DOCUMENT, Logger } from '@did-btcr2/common';
+import { Btc1Appendix } from './appendix.js';
+import { BeaconUtils } from './beacons.js';
+import { Btc1Identifier } from './identifier.js';
+export const BECH32M_CHARS = '';
+export const BTC1_DID_REGEX = /did:btcr2:(x1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]*)/g;
+/**
+ * DID BTCR2 Verification Method extends the DidVerificationMethod class adding helper methods and properties
+ * @class Btc1VerificationMethod
+ * @type {Btc1VerificationMethod}
+ *
+ */
+export class Btc1VerificationMethod {
+    id;
+    type;
+    controller;
+    publicKeyMultibase;
+    secretKeyMultibase;
+    constructor({ id, type, controller, publicKeyMultibase, secretKeyMultibase }) {
+        this.id = id;
+        this.type = type;
+        this.controller = controller;
+        this.publicKeyMultibase = publicKeyMultibase;
+        this.secretKeyMultibase = secretKeyMultibase;
+        if (!secretKeyMultibase) {
+            delete this.secretKeyMultibase;
+        }
+    }
+}
+/**
+ * BTCR2 DID Document extends the DidDocument class adding helper methods and properties
+ * @class Btc1DidDocument
+ * @type {Btc1DidDocument}
+ * @implements {IBtc1DidDocument}
+ * @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 | Btc1VerificationMethod>} [authentication] - The authentication methods of the DID Document.
+ * @property {Array<string | Btc1VerificationMethod>} [assertionMethod] - The assertion methods of the DID Document.
+ * @property {Array<string | Btc1VerificationMethod>} [capabilityInvocation] - The capability invocation methods of the DID Document.
+ * @property {Array<string | Btc1VerificationMethod>} [capabilityDelegation] - The capability delegation methods of the DID Document.
+ * @property {Array<BeaconService>} service - The services of the DID Document.
+ */
+export class Btc1DidDocument {
+    id;
+    controller;
+    '@context' = BTCR2_DID_DOCUMENT_CONTEXT;
+    verificationMethod;
+    authentication;
+    assertionMethod;
+    capabilityInvocation;
+    capabilityDelegation;
+    service;
+    constructor(document) {
+        // Set the ID and ID type
+        const idType = document.id.includes('k1')
+            ? Btcr2IdentifierTypes.KEY
+            : Btcr2IdentifierTypes.EXTERNAL;
+        // Validate ID and parts for non-intermediate
+        const isIntermediate = document.id === ID_PLACEHOLDER_VALUE;
+        // Deconstruct the document parts for validation
+        const { id, controller, verificationMethod: vm, service } = document;
+        if (!isIntermediate) {
+            if (!Btc1DidDocument.isValidId(id)) {
+                throw new DidDocumentError(`Invalid id: ${id}`, INVALID_DID_DOCUMENT, document);
+            }
+            if (!Btc1DidDocument.isValidController(controller ?? [id])) {
+                throw new DidDocumentError(`Invalid controller: ${controller}`, INVALID_DID_DOCUMENT, document);
+            }
+            if (!Btc1DidDocument.isValidVerificationMethods(vm)) {
+                throw new DidDocumentError('Invalid verificationMethod: ' + vm, INVALID_DID_DOCUMENT, document);
+            }
+            if (!Btc1DidDocument.isValidServices(service)) {
+                throw new DidDocumentError('Invalid service: ' + service, INVALID_DID_DOCUMENT, document);
+            }
+        }
+        // Set core properties
+        this.id = document.id;
+        this.verificationMethod = document.verificationMethod;
+        this.service = document.service;
+        this['@context'] = document['@context'] || BTCR2_DID_DOCUMENT_CONTEXT;
+        this.controller = document.controller || [this.id];
+        // Relationships logic based on idType
+        if (idType === Btcr2IdentifierTypes.KEY) {
+            // auto-generate #initialKey if missing
+            const keyRef = `${this.id}#initialKey`;
+            this.authentication = document.authentication || [keyRef];
+            this.assertionMethod = document.assertionMethod || [keyRef];
+            this.capabilityInvocation = document.capabilityInvocation || [keyRef];
+            this.capabilityDelegation = document.capabilityDelegation || [keyRef];
+        }
+        else {
+            // EXTERNAL: use provided arrays, must be defined
+            this.authentication = document.authentication;
+            this.assertionMethod = document.assertionMethod;
+            this.capabilityInvocation = document.capabilityInvocation;
+            this.capabilityDelegation = document.capabilityDelegation;
+        }
+        // Sanitize the DID Document
+        Btc1DidDocument.sanitize(this);
+        // If the DID Document is not an intermediateDocument, validate it
+        if (!isIntermediate) {
+            Btc1DidDocument.validate(this);
+        }
+        else {
+            this.validateIntermediate();
+        }
+    }
+    /**
+     * Convert the Btc1DidDocument to a JSON object.
+     * @returns {JSONObject} The JSON representation of the Btc1DidDocument.
+     */
+    json() {
+        return {
+            id: this.id,
+            controller: this.controller,
+            '@context': this['@context'],
+            verificationMethod: this.verificationMethod,
+            authentication: this.authentication,
+            assertionMethod: this.assertionMethod,
+            capabilityInvocation: this.capabilityInvocation,
+            capabilityDelegation: this.capabilityDelegation,
+            service: this.service
+        };
+    }
+    /**
+     * Create a minimal Btc1DidDocument from "k1" btcr2 identifier.
+     * @param {string} publicKeyMultibase The public key in multibase format.
+     * @param {Array<BeaconService>} service The beacon services to be included in the document.
+     * @returns {Btc1DidDocument} A new Btc1DidDocument with the placeholder ID.
+     */
+    static fromKeyIdentifier(id, publicKeyMultibase, service) {
+        // Ensure the ID is in the correct format
+        id = id.includes('#') ? id : `${id}#initialKey`;
+        // Create the verification method and the Btc1DidDocument
+        const document = {
+            id,
+            verificationMethod: [
+                new Btc1VerificationMethod({
+                    id,
+                    type: 'Multikey',
+                    controller: id,
+                    publicKeyMultibase
+                })
+            ],
+            service
+        };
+        return new Btc1DidDocument(document);
+    }
+    /**
+     * Create a Btc1DidDocument from "x1" btcr2 identifier.
+     * @param {ExternalData} data The verification methods of the DID Document.
+     * @returns {Btc1DidDocument} A new Btc1DidDocument.
+     */
+    static fromExternalIdentifier(data) {
+        return new Btc1DidDocument(data);
+    }
+    /**
+     * Sanitize the DID Document by removing undefined values
+     * @returns {Btc1DidDocument} The sanitized DID Document
+     */
+    static sanitize(doc) {
+        for (const key of Object.keys(doc)) {
+            if (doc[key] === undefined) {
+                delete doc[key];
+            }
+        }
+        return doc;
+    }
+    /**
+     * Validates a Btc1DidDocument by breaking it into modular validation methods.
+     * @param {Btc1DidDocument} didDocument The DID document to validate.
+     * @returns {boolean} True if the DID document is valid.
+     * @throws {DidDocumentError} If any validation check fails.
+     */
+    static isValid(didDocument) {
+        if (!this.isValidContext(didDocument?.['@context'])) {
+            throw new DidDocumentError('Invalid "@context"', INVALID_DID_DOCUMENT, didDocument);
+        }
+        if (!this.isValidId(didDocument?.id)) {
+            throw new DidDocumentError('Invalid "id"', INVALID_DID_DOCUMENT, didDocument);
+        }
+        if (!this.isValidVerificationMethods(didDocument?.verificationMethod)) {
+            throw new DidDocumentError('Invalid "verificationMethod"', INVALID_DID_DOCUMENT, didDocument);
+        }
+        if (!this.isValidServices(didDocument?.service)) {
+            throw new DidDocumentError('Invalid "service"', INVALID_DID_DOCUMENT, didDocument);
+        }
+        if (!this.isValidVerificationRelationships(didDocument)) {
+            throw new DidDocumentError('Invalid verification relationships', INVALID_DID_DOCUMENT, didDocument);
+        }
+        return true;
+    }
+    /**
+     * Validates that "@context" exists and includes correct values.
+     * @private
+     * @param {Btc1DidDocument['@context']} context The context to validate.
+     * @returns {boolean} True if the context is valid.
+     */
+    static isValidContext(context) {
+        if (!context)
+            return false;
+        if (!Array.isArray(context))
+            return false;
+        if (!context.every(ctx => typeof ctx === 'string' && BTCR2_DID_DOCUMENT_CONTEXT.includes(ctx)))
+            return false;
+        return true;
+    }
+    /**
+     * Validates that the DID Document has a valid id.
+     * @private
+     * @param {string} id The id to validate.
+     * @returns {boolean} True if the id is valid.
+     */
+    static isValidId(id) {
+        try {
+            Btc1Identifier.decode(id);
+            return true;
+        }
+        catch (error) {
+            Logger.error('Invalid DID Document ID', error);
+            return false;
+        }
+    }
+    /**
+     * Validates that the controller exists and is correctly formatted.
+     * @param {Array<string>} controller The controller to validate.
+     * @returns {boolean} True if the controller is valid.
+     */
+    static isValidController(controller) {
+        if (!controller)
+            return false;
+        if (!Array.isArray(controller))
+            return false;
+        if (!controller.every(c => typeof c === 'string'))
+            return false;
+        return true;
+    }
+    /**
+     * Validates that verification methods exist and are correctly formatted.
+     * @private
+     * @param {DidVerificationMethod[]} verificationMethod The verification methods to validate.
+     * @returns {boolean} True if the verification methods are valid.
+     */
+    static isValidVerificationMethods(verificationMethod) {
+        return Array.isArray(verificationMethod) && verificationMethod.every(Btc1Appendix.isDidVerificationMethod);
+    }
+    /**
+     * Validates that the DID Document has valid services.
+     * @private
+     * @param {DidService[]} service The services to validate.
+     * @returns {boolean} True if the services are valid.
+     */
+    static isValidServices(service) {
+        return Array.isArray(service) && service.every(BeaconUtils.isBeaconService);
+    }
+    /**
+     * Validates verification relationships (authentication, assertionMethod, capabilityInvocation, capabilityDelegation).
+     * @private
+     * @param {Btc1DidDocument} didDocument The DID Document to validate.
+     * @returns {boolean} True if the verification relationships are valid.
+     */
+    static isValidVerificationRelationships(didDocument) {
+        // Define the available verification relationships
+        const possibleVerificationRelationships = [
+            'authentication',
+            'assertionMethod',
+            'capabilityInvocation',
+            'capabilityDelegation'
+        ];
+        // Get the DID Document keys
+        const verificationRelationships = Object.keys(didDocument);
+        // Filter the DID Document keys to only those that are in the available verification relationships
+        const availableVerificationRelationships = possibleVerificationRelationships.filter(key => verificationRelationships.includes(key));
+        // Check if all available verification relationships are valid
+        return availableVerificationRelationships.every((key) => 
+        // Check if the key exists in the DID Document
+        didDocument[key] &&
+            // Check if the key is an array
+            Array.isArray(didDocument[key]) &&
+            // Check that every value in the array is a string or DidVerificationMethod
+            didDocument[key].every(entry => typeof entry === 'string' || Btc1Appendix.isDidVerificationMethod(entry)));
+    }
+    /**
+     * Validate the DID Document
+     * @returns {Btc1DidDocument} Validated DID Document.
+     * @throws {DidDocumentError} If the DID Document is invalid.
+     */
+    static validate(didDocument) {
+        // Validate the DID Document
+        if (didDocument.id === ID_PLACEHOLDER_VALUE) {
+            didDocument.validateIntermediate();
+        }
+        else {
+            Btc1DidDocument.isValid(didDocument);
+        }
+        // Return the DID Document
+        return didDocument;
+    }
+    /**
+     * Validate the IntermediateDidDocument.
+     * @returns {boolean} True if the IntermediateDidDocument is valid.
+     */
+    validateIntermediate() {
+        // Validate the id
+        if (this.id !== ID_PLACEHOLDER_VALUE) {
+            throw new DidDocumentError('Invalid IntermediateDidDocument ID', INVALID_DID_DOCUMENT, this);
+        }
+        // Validate the controller
+        if (!this.controller?.every(c => c === ID_PLACEHOLDER_VALUE)) {
+            throw new DidDocumentError('Invalid IntermediateDidDocument controller', INVALID_DID_DOCUMENT, this);
+        }
+        // Validate the verificationMethod
+        if (!this.verificationMethod.every(vm => vm.id.includes(ID_PLACEHOLDER_VALUE) && vm.controller === ID_PLACEHOLDER_VALUE)) {
+            throw new DidDocumentError('Invalid IntermediateDidDocument verificationMethod', INVALID_DID_DOCUMENT, this);
+        }
+        // Validate the service
+        if (!this.service.every(svc => svc.id.includes(ID_PLACEHOLDER_VALUE))) {
+            throw new DidDocumentError('Invalid IntermediateDidDocument service', INVALID_DID_DOCUMENT, this);
+        }
+        if (!Btc1DidDocument.isValidVerificationRelationships(this)) {
+            // Return true if all validations pass
+            throw new DidDocumentError('Invalid IntermediateDidDocument assertionMethod', INVALID_DID_DOCUMENT, this);
+        }
+    }
+    /**
+     * Convert the Btc1DidDocument to an IntermediateDidDocument.
+     * @returns {IntermediateDidDocument} The IntermediateDidDocument representation of the Btc1DidDocument.
+     */
+    toIntermediate() {
+        if (this.id.includes('k1')) {
+            throw new DidDocumentError('Cannot convert a key identifier to an intermediate document', INVALID_DID_DOCUMENT, this);
+        }
+        return new IntermediateDidDocument(this);
+    }
+}
+/**
+ * IntermediateDidDocument extends the Btc1DidDocument class for creating and managing intermediate DID documents.
+ * This class is used to create a minimal DID document with a placeholder ID.
+ * It is used in the process of creating a new DID document.
+ * @class IntermediateDidDocument
+ * @extends {Btc1DidDocument}
+ */
+export class IntermediateDidDocument extends Btc1DidDocument {
+    constructor(document) {
+        const intermediateDocument = JSON.cloneReplace(document, BTC1_DID_REGEX, ID_PLACEHOLDER_VALUE);
+        super(intermediateDocument);
+    }
+    /**
+     * Create a minimal IntermediateDidDocument with a placeholder ID.
+     * @param {Array<Btc1VerificationMethod>} verificationMethod The public key in multibase format.
+     * @param {VerificationRelationships} relationships The public key in multibase format.
+     * @param {Array<BeaconService>} service The service to be included in the document.
+     * @returns {IntermediateDidDocument} A new IntermediateDidDocument with the placeholder ID.
+     */
+    static create(verificationMethod, relationships, service) {
+        const id = ID_PLACEHOLDER_VALUE;
+        return new IntermediateDidDocument({ id, ...relationships, verificationMethod, service, });
+    }
+    /**
+     * Convert the IntermediateDidDocument to a Btc1DidDocument by replacing the placeholder value with the provided DID.
+     * @param did The DID to replace the placeholder value in the document.
+     * @returns {Btc1DidDocument} A new Btc1DidDocument with the placeholder value replaced by the provided DID.
+     */
+    toBtc1DidDocument(did) {
+        const stringThis = JSON.stringify(this).replaceAll(ID_PLACEHOLDER_VALUE, did);
+        const parseThis = JSON.parse(stringThis);
+        return new Btc1DidDocument(parseThis);
+    }
+    /**
+     * Create a Btc1DidDocument from a JSON object.
+     * @param {JSONObject} object The JSON object to convert.
+     * @returns {Btc1DidDocument} The created Btc1DidDocument.
+     */
+    static from(object) {
+        return new IntermediateDidDocument(object).toBtc1DidDocument(object.id);
+    }
+}
+//# sourceMappingURL=did-document.js.map