@did-btcr2/common 1.1.0

package/dist/cjs/patch.js

@@ -0,0 +1,163 @@
+import { Btc1Error } from './errors.js';
+/**
+ * Implementation of {@link https://datatracker.ietf.org/doc/html/rfc6902 | IETF RFC 6902 JSON Patch}.
+ *
+ * JavaScript Object Notation (JSON) Patch defines a JSON document structure for expressing a sequence of operations to
+ * apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The
+ * "application/json-patch+json" media type is used to identify such patch documents.
+ *
+ * @class Patch
+ * @type {Patch}
+ */
+export class Patch {
+    /**
+     * Applies a JSON Patch to a source document and returns the patched document.
+     * @param {JSONObject} sourceDocument The source document to patch.
+     * @param {PatchOperation[]} operations The JSON Patch operations to apply.
+     * @returns {JSONObject} The patched document.
+     * @throws {Error} If an unsupported operation is provided.
+     */
+    apply(sourceDocument, operations) {
+        const patchedDocument = JSON.normalize(sourceDocument);
+        for (const operation of operations) {
+            const { op, path, value, from } = operation;
+            const segments = path.split('/').slice(1);
+            switch (op) {
+                case 'add':
+                    this.setValue(patchedDocument, segments, value);
+                    break;
+                case 'remove':
+                    this.removeValue(patchedDocument, segments);
+                    break;
+                case 'replace':
+                    this.setValue(patchedDocument, segments, value);
+                    break;
+                case 'move': {
+                    if (!from)
+                        throw new Error('Missing \'from\' in move operation');
+                    const fromSegments = from.split('/').slice(1);
+                    const movedValue = this.getValue(patchedDocument, fromSegments);
+                    this.removeValue(patchedDocument, fromSegments);
+                    this.setValue(patchedDocument, segments, movedValue);
+                    break;
+                }
+                case 'copy': {
+                    if (!from)
+                        throw new Error('Missing \'from\' in copy operation');
+                    const copiedValue = this.getValue(patchedDocument, from.split('/').slice(1));
+                    this.setValue(patchedDocument, segments, copiedValue);
+                    break;
+                }
+                case 'test': {
+                    const existingValue = this.getValue(patchedDocument, segments);
+                    if (JSON.stringify(existingValue) !== JSON.stringify(value)) {
+                        throw new Btc1Error(`Test operation failed at path`, 'JSON_PATCH_APPLY_ERROR', { path });
+                    }
+                    break;
+                }
+                default:
+                    throw new Btc1Error(`Unsupported JSON Patch operation`, 'JSON_PATCH_APPLY_ERROR', { op });
+            }
+        }
+        return patchedDocument;
+    }
+    /**
+   * Constructs a JSON Patch with a single operation (e.g. add service).
+   * @param {PatchOperation} patches - The patch operation to create.
+   * @param {string} patch.op - The patch operation type (e.g. 'add').
+   * @param {string} patch.path - The JSON Pointer path to apply the operation.
+   * @param {*} patch.value - The value to apply (if applicable).
+   * @returns {PatchOperation[]} A single-entry JSON Patch array.
+   */
+    create(patches) {
+        return patches.map(({ op, path, value, from }) => {
+            const operation = { op, path };
+            if (value !== undefined) {
+                operation.value = value;
+            }
+            if (from !== undefined) {
+                operation.from = from;
+            }
+            return operation;
+        });
+    }
+    /**
+     * Find the diff between a source and target document constructing the patch operations from source => target.
+     * @param {JSONObject} sourceDocument The original JSON object.
+     * @param {JSONObject} targetDocument The target JSON object to transform into.
+     * @returns {PatchOperation[]} An array of JSON Patch operations.
+     */
+    diff(sourceDocument, targetDocument, path) {
+        const operations = [];
+        const sourceKeys = new Set(Object.keys(sourceDocument || {}));
+        const targetKeys = new Set(Object.keys(targetDocument || {}));
+        // Handle removed keys
+        for (const key of sourceKeys) {
+            if (!targetKeys.has(key)) {
+                operations.push({ op: 'remove', path: `${path}/${key}` });
+            }
+        }
+        // Handle added or updated keys
+        for (const key of targetKeys) {
+            const sourceVal = sourceDocument?.[key];
+            const targetVal = targetDocument?.[key];
+            const currentPath = `${path}/${key}`;
+            if (!(key in (sourceDocument || {}))) {
+                operations.push({ op: 'add', path: currentPath, value: targetVal });
+            }
+            else if (typeof sourceVal === 'object' && sourceVal !== null && typeof targetVal === 'object' && targetVal !== null) {
+                operations.push(...this.diff(sourceVal, targetVal, currentPath));
+            }
+            else if (JSON.stringify(sourceVal) !== JSON.stringify(targetVal)) {
+                operations.push({ op: 'replace', path: currentPath, value: targetVal });
+            }
+        }
+        return operations;
+    }
+    /**
+     * Gets the value at a given path in an object.
+     * @private
+     * @param {*} obj The object to get the value from.
+     * @param {string[]} path The path to the value.
+     * @returns {*} The value at the given path.
+     */
+    getValue(obj, path) {
+        return path.reduce((acc, key) => (acc && acc[key] !== undefined ? acc[key] : undefined), obj);
+    }
+    /**
+     * Sets the value at a given path in an object.
+     * @private
+     * @param {*} obj The object to set the value in.
+     * @param {string[]} path The path to the value.
+     * @param {*} value The value to set.
+     * @returns {*} The object with the value set.
+     */
+    setValue(obj, path, value) {
+        let current = obj;
+        for (let i = 0; i < path.length - 1; i++) {
+            const key = path[i];
+            if (!(key in current))
+                current[key] = {};
+            current = current[key];
+        }
+        current[path[path.length - 1]] = value;
+    }
+    /**
+     * Removes the value at a given path in an object.
+     * @private
+     * @param {*} obj The object to remove the value from.
+     * @param {string[]} path The path to the value.
+     * @returns {*} The object with the value removed.
+     */
+    removeValue(obj, path) {
+        let current = obj;
+        for (let i = 0; i < path.length - 1; i++) {
+            const key = path[i];
+            if (!(key in current))
+                return;
+            current = current[key];
+        }
+        delete current[path[path.length - 1]];
+    }
+}
+//# sourceMappingURL=patch.js.map

package/dist/cjs/patch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.js","sourceRoot":"","sources":["../../src/patch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;GASG;AACH,MAAM,OAAO,KAAK;IAChB;;;;;;OAMG;IACI,KAAK,CAAC,cAA0B,EAAE,UAA4B;QACnE,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAEvD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;YAE5C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE1C,QAAQ,EAAE,EAAE,CAAC;gBACX,KAAK,KAAK;oBACR,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;oBAChD,MAAM;gBAER,KAAK,QAAQ;oBACX,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;oBAC5C,MAAM;gBAER,KAAK,SAAS;oBACZ,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;oBAChD,MAAM;gBAER,KAAK,MAAM,CAAC,CAAA,CAAC;oBACX,IAAI,CAAC,IAAI;wBAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;oBACjE,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;oBAChE,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;oBAChD,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;oBACrD,MAAM;gBACR,CAAC;gBACD,KAAK,MAAM,CAAC,CAAA,CAAC;oBACX,IAAI,CAAC,IAAI;wBAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;oBACjE,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC7E,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;oBACtD,MAAM;gBAER,CAAC;gBACD,KAAK,MAAM,CAAC,CAAA,CAAC;oBACX,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;oBAC/D,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC5D,MAAM,IAAI,SAAS,CAAC,+BAA+B,EAAE,wBAAwB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC3F,CAAC;oBACD,MAAM;gBACR,CAAC;gBACD;oBACE,MAAM,IAAI,SAAS,CAAC,kCAAkC,EAAE,wBAAwB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;KAOC;IACM,MAAM,CAAC,OAAyB;QACrC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;YAC/C,MAAM,SAAS,GAAmB,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;YAE/C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;YAC1B,CAAC;YAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;YACxB,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,cAA0B,EAAE,cAA0B,EAAE,IAAY;QAC9E,MAAM,UAAU,GAA0B,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9D,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC;QAE9D,sBAAsB;QACtB,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAED,+BAA+B;QAC/B,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,WAAW,GAAG,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;YAErC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;gBACrC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACtE,CAAC;iBAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACtH,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;YACnE,CAAC;iBAAM,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnE,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACK,QAAQ,CAAC,GAAQ,EAAE,IAAc;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC;IAChG,CAAC;IAGD;;;;;;;OAOG;IACK,QAAQ,CAAC,GAAQ,EAAE,IAAc,EAAE,KAAU;QACnD,IAAI,OAAO,GAAG,GAAG,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC;gBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;YACzC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IACzC,CAAC;IAGD;;;;;;OAMG;IACK,WAAW,CAAC,GAAQ,EAAE,IAAc;QAC1C,IAAI,OAAO,GAAG,GAAG,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC;gBAAE,OAAO;YAC9B,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;CACF"}

package/dist/cjs/types.js

@@ -0,0 +1,20 @@
+export var Btc1IdentifierTypes;
+(function (Btc1IdentifierTypes) {
+    Btc1IdentifierTypes["KEY"] = "KEY";
+    Btc1IdentifierTypes["EXTERNAL"] = "EXTERNAL";
+})(Btc1IdentifierTypes || (Btc1IdentifierTypes = {}));
+export var Btc1IdentifierHrp;
+(function (Btc1IdentifierHrp) {
+    Btc1IdentifierHrp["k"] = "k";
+    Btc1IdentifierHrp["x"] = "x";
+})(Btc1IdentifierHrp || (Btc1IdentifierHrp = {}));
+export var BitcoinNetworkNames;
+(function (BitcoinNetworkNames) {
+    BitcoinNetworkNames[BitcoinNetworkNames["bitcoin"] = 0] = "bitcoin";
+    BitcoinNetworkNames[BitcoinNetworkNames["signet"] = 1] = "signet";
+    BitcoinNetworkNames[BitcoinNetworkNames["regtest"] = 2] = "regtest";
+    BitcoinNetworkNames[BitcoinNetworkNames["testnet3"] = 3] = "testnet3";
+    BitcoinNetworkNames[BitcoinNetworkNames["testnet4"] = 4] = "testnet4";
+    BitcoinNetworkNames[BitcoinNetworkNames["mutinynet"] = 5] = "mutinynet";
+})(BitcoinNetworkNames || (BitcoinNetworkNames = {}));
+//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAsEA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,4CAAqB,CAAA;AACzB,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AACD,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,4BAAO,CAAA;IACP,4BAAO,CAAA;AACX,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B;AACD,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC3B,mEAAW,CAAA;IACX,iEAAU,CAAA;IACV,mEAAW,CAAA;IACX,qEAAY,CAAA;IACZ,qEAAY,CAAA;IACZ,uEAAa,CAAA;AACjB,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B"}

package/dist/esm/canonicalization.js

@@ -0,0 +1,163 @@
+import { sha256 } from '@noble/hashes/sha2';
+import { bytesToHex } from '@noble/hashes/utils';
+import { canonicalize as jcsa } from 'json-canonicalize';
+import { base58btc } from 'multiformats/bases/base58';
+import rdf from 'rdf-canonize';
+import { CanonicalizationError } from './errors.js';
+/**
+ * Canonicalization class provides methods for canonicalizing JSON objects
+ * and hashing them using SHA-256. It supports different canonicalization
+ * algorithms and encoding formats (hex and base58).
+ * @class Canonicalization
+ * @type {Canonicalization}
+ */
+export class Canonicalization {
+    _algorithm;
+    /**
+     * Initializes the Canonicalization class with the specified algorithm.
+     * @param {CanonicalizationAlgorithm} algorithm The canonicalization algorithm to use ('jcs' or 'rdfc').
+     */
+    // TODO: Need to move to using RDFC by default
+    constructor(algorithm = 'jcs') {
+        this._algorithm = algorithm;
+    }
+    /**
+     * Sets the canonicalization algorithm.
+     * @param {'jcs' | 'rdfc'} algorithm Either 'jcs' or 'rdfc'.
+     */
+    set algorithm(algorithm) {
+        // Normalize the passed algorithm to lowercase
+        algorithm = algorithm.toLowerCase();
+        // Validate the algorithm is either 'jcs' or 'rdfc'
+        if (!['jcs', 'rdfc'].includes(algorithm)) {
+            throw new CanonicalizationError(`Unsupported algorithm: ${algorithm}`, 'ALGORITHM_ERROR');
+        }
+        // Set the algorithm
+        this._algorithm = algorithm;
+    }
+    /**
+     * Gets the canonicalization algorithm.
+     * @returns {CanonicalizationAlgorithm} The current canonicalization algorithm.
+     */
+    get algorithm() {
+        return this._algorithm;
+    }
+    /**
+     * Implements {@link http://dcdpr.github.io/did-btcr2/#json-canonicalization-and-hash | 9.2 JSON Canonicalization and Hash}.
+     *
+     * A macro function that takes in a JSON document, document, and canonicalizes it following the JSON Canonicalization
+     * Scheme. The function returns the canonicalizedBytes.
+     *
+     * Optionally encodes a sha256 hashed canonicalized JSON object.
+     * Step 1 Canonicalize (JCS/RDFC) → Step 2 Hash (SHA256) → Step 3 Encode (Hex/Base58).
+     *
+     * @param {JSONObject} object The object to process.
+     * @param {string} encoding The encoding format ('hex' or 'base58').
+     * @returns {Promise<string>} The final SHA-256 hash bytes as a hex string.
+     */
+    async process(object, encoding = 'hex') {
+        // Step 1: Canonicalize
+        const canonicalized = await this.canonicalize(object);
+        // Step 2: Hash
+        const hashed = this.hash(canonicalized);
+        // Step 3: Encode
+        const encoded = this.encode(hashed, encoding);
+        // Return the encoded string
+        return encoded;
+    }
+    /**
+     * Step 1: Uses this.algorithm to determine the method (JCS/RDFC).
+     * @param {JSONObject} object The object to canonicalize.
+     * @returns {Promise<string>} The canonicalized object.
+     */
+    async canonicalize(object) {
+        return await this[this.algorithm](object);
+    }
+    /**
+     * Step 1: Canonicalizes an object using JCS (JSON Canonicalization Scheme).
+     * @param {JSONObject} object The object to canonicalize.
+     * @returns {string} The canonicalized object.
+     */
+    jcs(object) {
+        return jcsa(object);
+    }
+    /**
+     * Step 1: Canonicalizes an object using RDF Canonicalization (RDFC).
+     * @param {JSONObject} object The object to canonicalize.
+     * @returns {Promise<string>} The canonicalized object.
+     */
+    rdfc(object) {
+        return rdf.canonize([object], { algorithm: 'RDFC-1.0' });
+    }
+    /**
+     * Step 2: SHA-256 hashes a canonicalized object.
+     * @param {string} canonicalized The canonicalized object.
+     * @returns {HashBytes} The SHA-256 HashBytes (Uint8Array).
+     */
+    hash(canonicalized) {
+        return sha256(canonicalized);
+    }
+    /**
+     * Step 3: Encodes SHA-256 hashed, canonicalized object as a hex or base58 string.
+     * @param {string} canonicalizedhash The canonicalized object to encode.
+     * @param {string} encoding The encoding format ('hex' or 'base58').
+     * @throws {CanonicalizationError} If the encoding format is not supported.
+     * @returns {string} The encoded string.
+     */
+    encode(canonicalizedhash, encoding = 'hex') {
+        switch (encoding) {
+            case 'hex':
+                return this.hex(canonicalizedhash);
+            case 'base58':
+                return this.base58(canonicalizedhash);
+            default:
+                throw new CanonicalizationError(`Unsupported encoding: ${encoding}`, 'ENCODING_ERROR');
+        }
+    }
+    /**
+     * Step 3.1: Encodes HashBytes (Uint8Array) to a hex string.
+     * @param {HashBytes} hashBytes The hash as a Uint8Array.
+     * @returns {string} The hash as a hex string.
+     */
+    hex(hashBytes) {
+        return bytesToHex(hashBytes);
+    }
+    /**
+     * Step 3.2: Encodes HashBytes (Uint8Array) to a base58btc string.
+     * @param {HashBytes} hashBytes The hash as a Uint8Array.
+     * @returns {string} The hash as a hex string.
+     */
+    base58(hashBytes) {
+        return base58btc.encode(hashBytes);
+    }
+    /**
+     * Canonicalizes an object, hashes it and returns it as hash bytes.
+     * Step 1-2: Canonicalize → Hash.
+     * @param {JSONObject} object The object to process.
+     * @returns {Promise<HashBytes>} The final SHA-256 hash bytes.
+     */
+    async canonicalhash(object) {
+        const canonicalized = await this.canonicalize(object);
+        return this.hash(canonicalized);
+    }
+    /**
+     * Computes the SHA-256 hash of a canonicalized object and encodes it as a hex string.
+     * Step 2-3: Hash → Encode(Hex).
+     * @param {string} canonicalized The canonicalized object to hash.
+     * @returns {string} The SHA-256 hash as a hex string.
+     */
+    hashhex(canonicalized) {
+        return this.encode(this.hash(canonicalized));
+    }
+    /**
+     * Computes the SHA-256 hashes of canonicalized object and encodes it as a base58 string.
+     * Step 2-3: Hash → Encode(base58).
+     * @param {string} canonicalized The canonicalized object to hash.
+     * @returns {string} The SHA-256 hash as a base58 string.
+     */
+    hashb58(canonicalized) {
+        return this.encode(this.hash(canonicalized), 'base58');
+    }
+}
+export const canonicalization = new Canonicalization();
+//# sourceMappingURL=canonicalization.js.map

package/dist/esm/canonicalization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canonicalization.js","sourceRoot":"","sources":["../../src/canonicalization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,IAAI,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,GAAG,MAAM,cAAc,CAAC;AAE/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEpD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACnB,UAAU,CAA4B;IAE9C;;;OAGG;IACH,8CAA8C;IAC9C,YAAY,YAAuC,KAAK;QACtD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS,CAAC,SAAyB;QACrC,8CAA8C;QAC9C,SAAS,GAAG,SAAS,CAAC,WAAW,EAA+B,CAAC;QAEjE,mDAAmD;QACnD,IAAG,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAC,CAAC;YACvC,MAAM,IAAI,qBAAqB,CAAC,0BAA0B,SAAS,EAAE,EAAE,iBAAiB,CAAC,CAAC;QAC5F,CAAC;QACD,oBAAoB;QACpB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,OAAO,CAAC,MAAkB,EAAE,WAAmB,KAAK;QAC/D,uBAAuB;QACvB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACtD,eAAe;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACxC,iBAAiB;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC9C,4BAA4B;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAAkB;QAC1C,OAAO,MAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAiC,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,MAAkB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,MAAkB;QAC5B,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,aAAqB;QAC/B,OAAO,MAAM,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,iBAA4B,EAAE,WAAmB,KAAK;QAClE,QAAO,QAAQ,EAAE,CAAC;YAChB,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACrC,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;YACxC;gBACE,MAAM,IAAI,qBAAqB,CAAC,yBAAyB,QAAQ,EAAE,EAAE,gBAAgB,CAAC,CAAC;QAC3F,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,SAAoB;QAC7B,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAoB;QAChC,OAAO,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,MAAkB;QAC3C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,aAAqB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,aAAqB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC"}

package/dist/esm/constants.js

@@ -0,0 +1,116 @@
+import { sha256 } from '@noble/hashes/sha2';
+export const ID_PLACEHOLDER_VALUE = 'did:btcr2:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
+export const OP_RETURN = 0x6a;
+export const OP_PUSH32 = 0x20;
+export const VALID_HRP = ['k', 'x'];
+export const MULTIBASE_URI_PREFIX = 'urn:mb:';
+export const INITIAL_BLOCK_REWARD = 50;
+export const HALVING_INTERVAL = 150;
+export const COINBASE_MATURITY_DELAY = 100;
+export const POLAR_BOB_CLIENT_CONFIG = {
+    username: 'polaruser',
+    password: 'polarpass',
+    host: 'http://127.0.0.1:18443',
+    allowDefaultWallet: true,
+    version: '28.1.0'
+};
+export const POLAR_ALICE_CLIENT_CONFIG = {
+    username: 'polaruser',
+    password: 'polarpass',
+    host: 'http://127.0.0.1:18444',
+    allowDefaultWallet: true,
+    version: '28.1.0'
+};
+export const DEFAULT_REST_CONFIG = { host: 'http://localhost:3000' };
+export const DEFAULT_RPC_CONFIG = POLAR_BOB_CLIENT_CONFIG;
+export const DEFAULT_BLOCK_CONFIRMATIONS = 7;
+// Fixed public key header bytes per the Data Integrity BIP340 Cryptosuite spec: [0xe7, 0x01] / [231, 1]
+export const BIP340_PUBLIC_KEY_MULTIBASE_PREFIX = new Uint8Array([0xe7, 0x01]);
+// Hash of the BIP-340 Multikey prefix
+export const BIP340_PUBLIC_KEY_MULTIBASE_PREFIX_HASH = Buffer.from(sha256(BIP340_PUBLIC_KEY_MULTIBASE_PREFIX)).toString('hex');
+// Fixed secret key header bytes per the Data Integrity BIP340 Cryptosuite spec: [0x81, 0x26] / [129, 38]
+export const BIP340_SECRET_KEY_MULTIBASE_PREFIX = new Uint8Array([0x81, 0x26]);
+// Hash of the BIP-340 Multikey prefix
+export const BIP340_SECRET_KEY_MULTIBASE_PREFIX_HASH = Buffer.from(sha256(BIP340_SECRET_KEY_MULTIBASE_PREFIX)).toString('hex');
+// curve's field size
+export const B256 = 2n ** 256n;
+// curve's field prime
+export const P = B256 - 0x1000003d1n;
+// curve (group) order
+export const N = B256 - 0x14551231950b75fc4402da1732fc9bebfn;
+// base point x
+export const Gx = 0x79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798n;
+// base point y
+export const Gy = 0x483ada7726a3c4655da4fbfc0e1108a8fd17b448a68554199c47d08ffb10d4b8n;
+// curve parameters
+export const a = 0n;
+export const b = 7n;
+export const p = P;
+export const n = N;
+export const CURVE = {
+    p,
+    n,
+    a,
+    b,
+    Gx,
+    Gy
+};
+export const W3C_DID_V1 = 'https://www.w3.org/ns/did/v1';
+export const W3C_DID_V1_1 = 'https://www.w3.org/TR/did-1.1';
+export const W3C_DATA_INTEGRITY_V1 = 'https://w3id.org/security/data-integrity/v1';
+export const W3C_DATA_INTEGRITY_V2 = 'https://w3id.org/security/data-integrity/v2';
+export const W3C_SECURITY_V2 = 'https://w3id.org/security/v2';
+export const BTC1_METHOD_CONTEXT = 'https://btcr2.dev/context/v1';
+export const W3C_ZCAP_V1 = 'https://w3id.org/zcap/v1';
+export const W3C_JSONLD_PATCH_V1 = 'https://w3id.org/json-ld-patch/v1';
+export const W3C_MULTIKEY_V1 = 'https://w3id.org/security/multikey/v1';
+export const W3C_DID_RESOLUTION_V1 = 'https://w3id.org/did-resolution/v1';
+export const CONTEXT_URL_MAP = {
+    w3c: {
+        did: {
+            v1: 'https://www.w3.org/ns/did/v1',
+            v1_1: 'https://www.w3.org/TR/did-1.1',
+        },
+        didresolution: {
+            v1: 'https://w3id.org/did-resolution/v1',
+        },
+        security: {
+            v2: 'https://w3id.org/security/v2',
+        },
+        dataintegrity: {
+            v1: 'https://w3id.org/security/data-integrity/v1',
+            v2: 'https://w3id.org/security/data-integrity/v2',
+        },
+        zcap: {
+            v1: 'https://w3id.org/zcap/v1',
+        },
+        jsonldpatch: {
+            v1: 'https://w3id.org/json-ld-patch/v1',
+        },
+        multikey: {
+            v1: 'https://w3id.org/security/multikey/v1',
+        },
+    },
+    btcr2: {
+        diddocument: {
+            v1: 'https://dcdpr.github.io/did-btcr2-js/ns/did-document/v1',
+        },
+        method: {
+            v1: 'https://btcr2.dev/context/v1'
+        },
+    },
+};
+export const BTC1_DID_DOCUMENT_CONTEXT = [
+    CONTEXT_URL_MAP.w3c.did.v1_1,
+    CONTEXT_URL_MAP.btcr2.method.v1,
+];
+export const BTC1_MULTIKEY_CONTEXT = [
+    CONTEXT_URL_MAP.w3c.did.v1,
+    CONTEXT_URL_MAP.w3c.multikey.v1
+];
+export const BTC1_DID_UPDATE_PAYLOAD_CONTEXT = [
+    CONTEXT_URL_MAP.w3c.security.v2,
+    CONTEXT_URL_MAP.w3c.zcap.v1,
+    CONTEXT_URL_MAP.w3c.jsonldpatch.v1,
+];
+//# sourceMappingURL=constants.js.map

package/dist/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C,MAAM,CAAC,MAAM,oBAAoB,GAAG,wEAAwE,CAAC;AAC7G,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAC9C,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAC3C,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ,EAAa,WAAW;IAChC,QAAQ,EAAa,WAAW;IAChC,IAAI,EAAiB,wBAAwB;IAC7C,kBAAkB,EAAG,IAAI;IACzB,OAAO,EAAc,QAAQ;CAC9B,CAAC;AACF,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,QAAQ,EAAa,WAAW;IAChC,QAAQ,EAAa,WAAW;IAChC,IAAI,EAAiB,wBAAwB;IAC7C,kBAAkB,EAAG,IAAI;IACzB,OAAO,EAAc,QAAQ;CAC9B,CAAC;AACF,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;AACrE,MAAM,CAAC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAC1D,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC;AAE7C,wGAAwG;AACxG,MAAM,CAAC,MAAM,kCAAkC,GAAU,IAAI,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACtF,sCAAsC;AACtC,MAAM,CAAC,MAAM,uCAAuC,GAAY,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxI,yGAAyG;AACzG,MAAM,CAAC,MAAM,kCAAkC,GAAU,IAAI,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACtF,sCAAsC;AACtC,MAAM,CAAC,MAAM,uCAAuC,GAAY,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxI,qBAAqB;AACrB,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,IAAI,IAAI,CAAC;AAC/B,sBAAsB;AACtB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,YAAY,CAAC;AACrC,sBAAsB;AACtB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,oCAAoC,CAAC;AAC7D,eAAe;AACf,MAAM,CAAC,MAAM,EAAE,GAAG,mEAAmE,CAAC;AACtF,eAAe;AACf,MAAM,CAAC,MAAM,EAAE,GAAG,mEAAmE,CAAC;AACtF,mBAAmB;AACnB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;AACpB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;AACpB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACnB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACnB,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,CAAC;IACD,CAAC;IACD,CAAC;IACD,CAAC;IACD,EAAE;IACF,EAAE;CACH,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,8BAA8B,CAAC;AACzD,MAAM,CAAC,MAAM,YAAY,GAAI,+BAA+B,CAAC;AAC7D,MAAM,CAAC,MAAM,qBAAqB,GAAG,6CAA6C,CAAC;AACnF,MAAM,CAAC,MAAM,qBAAqB,GAAG,6CAA6C,CAAC;AACnF,MAAM,CAAC,MAAM,eAAe,GAAG,8BAA8B,CAAC;AAC9D,MAAM,CAAC,MAAM,mBAAmB,GAAG,8BAA8B,CAAC;AAClE,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AACtD,MAAM,CAAC,MAAM,mBAAmB,GAAG,mCAAmC,CAAC;AACvE,MAAM,CAAC,MAAM,eAAe,GAAG,uCAAuC,CAAC;AACvE,MAAM,CAAC,MAAM,qBAAqB,GAAG,oCAAoC,CAAC;AAC1E,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,GAAG,EAAG;QACJ,GAAG,EAAa;YACd,EAAE,EAAK,8BAA8B;YACrC,IAAI,EAAG,+BAA+B;SACvC;QACD,aAAa,EAAG;YACd,EAAE,EAAG,oCAAoC;SAC1C;QACD,QAAQ,EAAG;YACT,EAAE,EAAG,8BAA8B;SACpC;QACD,aAAa,EAAG;YACd,EAAE,EAAG,6CAA6C;YAClD,EAAE,EAAG,6CAA6C;SACnD;QACD,IAAI,EAAY;YACd,EAAE,EAAG,0BAA0B;SAChC;QACD,WAAW,EAAK;YACd,EAAE,EAAG,mCAAmC;SACzC;QACD,QAAQ,EAAQ;YACd,EAAE,EAAG,uCAAuC;SAC7C;KACF;IACD,KAAK,EAAG;QACN,WAAW,EAAG;YACZ,EAAE,EAAG,yDAAyD;SAC/D;QACD,MAAM,EAAG;YACP,EAAE,EAAG,8BAA8B;SACpC;KACF;CAEF,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI;IAC5B,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;CAChC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;IAC1B,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;CAChC,CAAC;AAEF,MAAM,CAAC,MAAM,+BAA+B,GAAG;IAC7C,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;IAC/B,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;IAC3B,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;CACnC,CAAC"}

package/dist/esm/errors.js

@@ -0,0 +1,151 @@
+/**
+ * An enumeration of possible DID error codes.
+ */
+export var Btc1ErrorCode;
+(function (Btc1ErrorCode) {
+    /** The DID supplied does not conform to valid syntax. */
+    Btc1ErrorCode["INVALID_DID"] = "INVALID_DID";
+    /** The supplied method name is not supported by the DID method and/or DID resolver implementation. */
+    Btc1ErrorCode["METHOD_NOT_SUPPORTED"] = "METHOD_NOT_SUPPORTED";
+    /** An unexpected error occurred during the requested DID operation. */
+    Btc1ErrorCode["INTERNAL_ERROR"] = "INTERNAL_ERROR";
+    /** The DID document supplied does not conform to valid syntax. */
+    Btc1ErrorCode["INVALID_DID_DOCUMENT"] = "INVALID_DID_DOCUMENT";
+    /** The DID Update supplied does not conform to valid syntax. */
+    Btc1ErrorCode["INVALID_DID_UPDATE"] = "INVALID_DID_UPDATE";
+    /** The byte length of a DID document does not match the expected value. */
+    Btc1ErrorCode["INVALID_DID_DOCUMENT_LENGTH"] = "INVALID_DID_DOCUMENT_LENGTH";
+    /** The DID URL supplied to the dereferencing function does not conform to valid syntax. */
+    Btc1ErrorCode["INVALID_DID_URL"] = "INVALID_DID_URL";
+    /** The given proof of a previous DID is invalid */
+    Btc1ErrorCode["INVALID_PREVIOUS_DID_PROOF"] = "INVALID_PREVIOUS_DID_PROOF";
+    /** An invalid public key is detected during a DID operation. */
+    Btc1ErrorCode["INVALID_PUBLIC_KEY"] = "INVALID_PUBLIC_KEY";
+    /** An invalid multibase format is detected on the public key during a DID operation. */
+    Btc1ErrorCode["INVALID_PUBLIC_KEY_MULTIBASE"] = "INVALID_PUBLIC_KEY_MULTIBASE";
+    /** The byte length of a public key does not match the expected value. */
+    Btc1ErrorCode["INVALID_PUBLIC_KEY_LENGTH"] = "INVALID_PUBLIC_KEY_LENGTH";
+    /** An invalid public key type was detected during a DID operation. */
+    Btc1ErrorCode["INVALID_PUBLIC_KEY_TYPE"] = "INVALID_PUBLIC_KEY_TYPE";
+    /** Verification of a signature failed during a DID operation. */
+    Btc1ErrorCode["INVALID_SIGNATURE"] = "INVALID_SIGNATURE";
+    /** General: The resource requested was not found. */
+    /** DID Resolution: The DID resolver was unable to find the DID document resulting from the resolution request.  */
+    Btc1ErrorCode["NOT_FOUND"] = "NOT_FOUND";
+    /**
+     * The representation requested via the `accept` input metadata property is not supported by the
+     * DID method and/or DID resolver implementation.
+     */
+    Btc1ErrorCode["REPRESENTATION_NOT_SUPPORTED"] = "REPRESENTATION_NOT_SUPPORTED";
+    /** The type of a public key is not supported by the DID method and/or DID resolver implementation. */
+    Btc1ErrorCode["UNSUPPORTED_PUBLIC_KEY_TYPE"] = "UNSUPPORTED_PUBLIC_KEY_TYPE";
+    /** The proof verification operation failed. */
+    Btc1ErrorCode["PROOF_VERIFICATION_ERROR"] = "PROOF_VERIFICATION_ERROR";
+    /** The proof generation operation failed. */
+    Btc1ErrorCode["PROOF_GENERATION_ERROR"] = "PROOF_GENERATION_ERROR";
+    /** The proof serialization operation failed. */
+    Btc1ErrorCode["PROOF_SERIALIZATION_ERROR"] = "PROOF_SERIALIZATION_ERROR";
+    /** The proof could not be parsed properly. */
+    Btc1ErrorCode["PROOF_PARSING_ERROR"] = "PROOF_PARSING_ERROR";
+    /** The verification method was formed improperly. */
+    Btc1ErrorCode["VERIFICATION_METHOD_ERROR"] = "VERIFICATION_METHOD_ERROR";
+    /** Something about the DID Update Payload indicates the potential for late publishing. */
+    Btc1ErrorCode["LATE_PUBLISHING_ERROR"] = "LATE_PUBLISHING_ERROR";
+    /** The sidecar data in the DID Update Payload was invalid. */
+    Btc1ErrorCode["INVALID_SIDECAR_DATA"] = "INVALID_SIDECAR_DATA";
+    /** The proof is missing or has a malformed challenge field. */
+    Btc1ErrorCode["INVALID_CHALLENGE_ERROR"] = "INVALID_CHALLENGE_ERROR";
+    /** The proof is missing or has a malformed domain field. */
+    Btc1ErrorCode["INVALID_DOMAIN_ERROR"] = "INVALID_DOMAIN_ERROR";
+})(Btc1ErrorCode || (Btc1ErrorCode = {}));
+export const { INVALID_DID, METHOD_NOT_SUPPORTED, INTERNAL_ERROR, INVALID_DID_DOCUMENT, INVALID_DID_UPDATE, INVALID_DID_DOCUMENT_LENGTH, INVALID_DID_URL, INVALID_PREVIOUS_DID_PROOF, INVALID_PUBLIC_KEY, INVALID_PUBLIC_KEY_MULTIBASE, INVALID_PUBLIC_KEY_LENGTH, INVALID_PUBLIC_KEY_TYPE, INVALID_SIGNATURE, NOT_FOUND, REPRESENTATION_NOT_SUPPORTED, UNSUPPORTED_PUBLIC_KEY_TYPE, PROOF_VERIFICATION_ERROR, PROOF_GENERATION_ERROR, PROOF_SERIALIZATION_ERROR, PROOF_PARSING_ERROR, VERIFICATION_METHOD_ERROR, LATE_PUBLISHING_ERROR, INVALID_SIDECAR_DATA, INVALID_CHALLENGE_ERROR, INVALID_DOMAIN_ERROR } = Btc1ErrorCode;
+export class DidBtc1Error extends Error {
+    name = 'DidBtc1Error';
+    type = 'DidBtc1Error';
+    data;
+    constructor(message, options = {}) {
+        super(message);
+        this.type = options.type ?? this.type;
+        this.name = options.name ?? this.name;
+        this.data = options.data;
+        // Ensures that instanceof works properly, the correct prototype chain when using inheritance,
+        // and that V8 stack traces (like Chrome, Edge, and Node.js) are more readable and relevant.
+        Object.setPrototypeOf(this, new.target.prototype);
+        // Captures the stack trace in V8 engines (like Chrome, Edge, and Node.js).
+        // In non-V8 environments, the stack trace will still be captured.
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, DidBtc1Error);
+        }
+    }
+}
+export class Btc1Error extends DidBtc1Error {
+    constructor(message, type, data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class Btc1ReadError extends DidBtc1Error {
+    constructor(message, type = 'Btc1ReadError', data) {
+        super(message, { type, name: 'Btc1ReadError', data });
+    }
+}
+export class Btc1KeyManagerError extends DidBtc1Error {
+    constructor(message, type = 'Btc1KeyManagerError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class DidDocumentError extends DidBtc1Error {
+    constructor(message, type = 'DidDocumentError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class CryptosuiteError extends DidBtc1Error {
+    constructor(message, type = 'CryptosuiteError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class KeyPairError extends DidBtc1Error {
+    constructor(message, type = 'KeyPairError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class SecretKeyError extends DidBtc1Error {
+    constructor(message, type = 'SecretKeyError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class PublicKeyError extends DidBtc1Error {
+    constructor(message, type = 'PublicKeyError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class MultikeyError extends DidBtc1Error {
+    constructor(message, type = 'MultikeyError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class ProofError extends DidBtc1Error {
+    constructor(message, type = 'ProofError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class SingletonBeaconError extends DidBtc1Error {
+    constructor(message, type = 'SingletonBeaconError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class CIDAggregateBeaconError extends DidBtc1Error {
+    constructor(message, type = 'CIDAggregateBeaconError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class SMTAggregateBeaconError extends DidBtc1Error {
+    constructor(message, type = 'SMTAggregateBeaconError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+export class CanonicalizationError extends DidBtc1Error {
+    constructor(message, type = 'CanonicalizationError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,aA+EX;AA/ED,WAAY,aAAa;IACvB,yDAAyD;IACzD,4CAA2B,CAAA;IAE3B,sGAAsG;IACtG,8DAA6C,CAAA;IAE7C,uEAAuE;IACvE,kDAAiC,CAAA;IAEjC,kEAAkE;IAClE,8DAA6C,CAAA;IAE7C,gEAAgE;IAChE,0DAAyC,CAAA;IAEzC,2EAA2E;IAC3E,4EAA2D,CAAA;IAE3D,2FAA2F;IAC3F,oDAAmC,CAAA;IAEnC,mDAAmD;IACnD,0EAAyD,CAAA;IAEzD,gEAAgE;IAChE,0DAAyC,CAAA;IAEzC,wFAAwF;IACxF,8EAA6D,CAAA;IAE7D,yEAAyE;IACzE,wEAAuD,CAAA;IAEvD,sEAAsE;IACtE,oEAAmD,CAAA;IAEnD,iEAAiE;IACjE,wDAAuC,CAAA;IAEvC,qDAAqD;IACrD,mHAAmH;IACnH,wCAAuB,CAAA;IAEvB;;;OAGG;IACH,8EAA6D,CAAA;IAE7D,sGAAsG;IACtG,4EAA2D,CAAA;IAE3D,+CAA+C;IAC/C,sEAAqD,CAAA;IAErD,6CAA6C;IAC7C,kEAAiD,CAAA;IAEjD,gDAAgD;IAChD,wEAAuD,CAAA;IAEvD,8CAA8C;IAC9C,4DAA2C,CAAA;IAE3C,qDAAqD;IACrD,wEAAuD,CAAA;IAExD,0FAA0F;IACzF,gEAA+C,CAAA;IAE/C,8DAA8D;IAC9D,8DAA6C,CAAA;IAE7C,+DAA+D;IAC/D,oEAAmD,CAAA;IAEnD,4DAA4D;IAC5D,8DAA6C,CAAA;AAC/C,CAAC,EA/EW,aAAa,KAAb,aAAa,QA+ExB;AAED,MAAM,CAAC,MAAM,EACX,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,2BAA2B,EAC3B,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,EAClB,4BAA4B,EAC5B,yBAAyB,EACzB,uBAAuB,EACvB,iBAAiB,EACjB,SAAS,EACT,4BAA4B,EAC5B,2BAA2B,EAC3B,wBAAwB,EACxB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,oBAAoB,EACrB,GAAG,aAAa,CAAC;AAQlB,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,IAAI,GAAW,cAAc,CAAC;IAC9B,IAAI,GAAW,cAAc,CAAC;IAC9B,IAAI,CAAuB;IAE3B,YAAY,OAAe,EAAE,UAAwB,EAAE;QACrD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAEzB,8FAA8F;QAC9F,4FAA4F;QAC5F,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElD,2EAA2E;QAC3E,kEAAkE;QAClE,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,YAAY,OAAe,EAAE,IAAY,EAAE,IAA0B;QACnE,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C,YAAY,OAAe,EAAE,OAAe,eAAe,EAAE,IAA0B;QACrF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IACnD,YAAY,OAAe,EAAE,OAAe,qBAAqB,EAAE,IAA0B;QAC3F,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,YAAY,OAAe,EAAE,OAAe,kBAAkB,EAAE,IAA0B;QACxF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,YAAY,OAAe,EAAE,OAAe,kBAAkB,EAAE,IAA0B;QACxF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,OAAe,EAAE,OAAe,cAAc,EAAE,IAA0B;QACpF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C,YAAY,OAAe,EAAE,OAAe,gBAAgB,EAAE,IAA0B;QACtF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C,YAAY,OAAe,EAAE,OAAe,gBAAgB,EAAE,IAA0B;QACtF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C,YAAY,OAAe,EAAE,OAAe,eAAe,EAAE,IAA0B;QACrF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,YAAY;IAC1C,YAAY,OAAe,EAAE,OAAe,YAAY,EAAE,IAA0B;QAClF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,YAAY,OAAe,EAAE,OAAe,sBAAsB,EAAE,IAA0B;QAC5F,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAe,EAAE,OAAe,yBAAyB,EAAE,IAA0B;QAC/F,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAe,EAAE,OAAe,yBAAyB,EAAE,IAA0B;QAC/F,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IACrD,YAAY,OAAe,EAAE,OAAe,uBAAuB,EAAE,IAA0B;QAC7F,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF"}