@did-btcr2/method 0.23.0 → 0.24.1

package/src/core/resolve.ts

@@ -3,7 +3,8 @@ import {
   getNetwork
 } from '@did-btcr2/bitcoin';
 import {
-  Canonicalization,
+  canonicalHash,
+  canonicalize,
   DateUtils,
   IdentifierHrp,
   INVALID_DID,
@@ -23,7 +24,7 @@ import {
   UnsignedBTCR2Update
 } from '@did-btcr2/cryptosuite';
 import { CompressedSecp256k1PublicKey } from '@did-btcr2/keypair';
-import { bytesToHex } from '@noble/hashes/utils';
+import { hex } from '@scure/base';
 import { DidBtcr2 } from '../did-btcr2.js';
 import { Appendix } from '../utils/appendix.js';
 import { DidDocument, ID_PLACEHOLDER_VALUE } from '../utils/did-document.js';
@@ -104,15 +105,19 @@ export class Resolve {
     didComponents: DidComponents,
     genesisDocument: object,
   ): Promise<DidDocument> {
-    // Canonicalize and sha256 hash the currentDocument
-    const hashBytes = Canonicalization.process(genesisDocument, { encoding: 'hex' });
-
+    // Get the genesis bytes from the did components
     const { genesisBytes } = didComponents;
 
+    // Convert the genesis bytes to a hex string
+    const genesisHex = hex.encode(genesisBytes);
+
+    // Canonicalize and sha256 hash the currentDocument
+    const hashBytes = canonicalHash(genesisDocument);
+
     // If the genesisBytes do not match the hashBytes, throw an error
-    if (bytesToHex(genesisBytes) !== hashBytes) {
+    if (genesisHex !== hashBytes) {
       throw new ResolveError(
-        `Initial document mismatch: genesisBytes ${bytesToHex(genesisBytes)} !== hashBytes ${hashBytes}`,
+        `Initial document mismatch: genesisBytes ${genesisHex} !== hashBytes ${hashBytes}`,
         INVALID_DID_DOCUMENT, { genesisBytes, hashBytes }
       );
     }
@@ -139,14 +144,14 @@ export class Resolve {
     const updateMap = new Map<string, SignedBTCR2Update>();
     if(sidecar.updates?.length)
       for(const update of sidecar.updates) {
-        updateMap.set(Canonicalization.process(update, { encoding: 'hex' }), update);
+        updateMap.set(canonicalHash(update, { encoding: 'hex' }), update);
       }
 
     // CAS Announcements map
     const casMap = new Map<string, CASAnnouncement>();
     if(sidecar.casUpdates?.length)
       for(const update of sidecar.casUpdates) {
-        casMap.set(Canonicalization.process(update, { encoding: 'hex' }), update);
+        casMap.set(canonicalHash(update, { encoding: 'hex' }), update);
       }
 
     // SMT Proofs map
@@ -275,11 +280,13 @@ export class Resolve {
     // Iterate over each (update block) pair
     for(const [update, block] of updates) {
       // Get the hash of the current document
-      const currentDocumentHash = Canonicalization.process(response.didDocument, { encoding: 'base58btc' });
+      const currentDocumentHash = canonicalHash(response.didDocument, { encoding: 'base64url' });
 
       // Safely convert block.time to timestamp
       const blocktime = DateUtils.blocktimeToTimestamp(block.time);
 
+      // TODO: How to detect if block is unconfirmed and exit gracefully or return without it
+
       // Set the updated field to the blocktime of the current update
       response.metadata.updated = DateUtils.toISOStringNonFractional(blocktime);
 
@@ -317,7 +324,7 @@ export class Resolve {
         // Create unsigned_update by removing the proof property from update.
         const unsignedUpdate = JSONUtils.deleteKeys(update, ['proof']) as UnsignedBTCR2Update;
         // Push the canonicalized unsigned update hash to the updateHashHistory
-        updateHashHistory.push(Canonicalization.process(unsignedUpdate, { encoding: 'base58btc' }));
+        updateHashHistory.push(canonicalHash(unsignedUpdate, { encoding: 'base64url' }));
       }
 
       // If update.targetVersionId > currentVersionId + 1, throw LATE_PUBLISHING error
@@ -366,7 +373,7 @@ export class Resolve {
     const { proof: _, ...unsignedUpdate } = update;
 
     // Hash unsignedUpdate with JSON Document Hashing algorithm
-    const unsignedUpdateHash = Canonicalization.process(unsignedUpdate);
+    const unsignedUpdateHash = canonicalHash(unsignedUpdate);
 
     // Let historicalUpdateHash equal updateHashHistory[updateHashIndex].
     const historicalUpdateHash = updateHashHistory[update.targetVersionId - 2];
@@ -431,7 +438,7 @@ export class Resolve {
     const cryptosuite = new BIP340Cryptosuite(multikey);
 
     // Canonicalize the update
-    const canonicalUpdate = Canonicalization.canonicalize(update);
+    const canonicalUpdate = canonicalize(update);
 
     // Construct a DataIntegrityProof with the cryptosuite
     const diProof = new BIP340DataIntegrityProof(cryptosuite);
@@ -454,7 +461,7 @@ export class Resolve {
     DidDocument.validate(updatedDocument);
 
     // Canonicalize and hash the updatedDocument to get the currentDocumentHash.
-    const currentDocumentHash = Canonicalization.process(updatedDocument, { encoding: 'base58btc' });
+    const currentDocumentHash = canonicalHash(updatedDocument, { encoding: 'base64url' });
 
     // Prepare the update targetHash for comparison with currentDocumentHash.
     const updateTargetHash = update.targetHash;

package/src/core/update.ts

@@ -1,5 +1,5 @@
 import {
-  Canonicalization,
+  canonicalHash,
   INVALID_DID_UPDATE,
   JSONPatch,
   KeyBytes,
@@ -56,7 +56,7 @@ export class Update {
       patch           : patches,
       targetHash      : '',
       targetVersionId : sourceVersionId + 1,
-      sourceHash      : Canonicalization.process(sourceDocument, { encoding: 'base58btc' }),
+      sourceHash      : canonicalHash(sourceDocument, { encoding: 'base64url' }),
     };
 
     // Apply all JSON patches to sourceDocument.
@@ -73,8 +73,8 @@ export class Update {
       );
     }
 
-    // Set the targetHash by canonicalizing the targetDocument and encoding it in base58.
-    unsignedUpdate.targetHash = Canonicalization.process(targetDocument, { encoding: 'base58btc' });
+    // Set the targetHash by canonicalizing the targetDocument and encoding it in base64url.
+    unsignedUpdate.targetHash = canonicalHash(targetDocument, { encoding: 'base64url' });
 
     // Return unsignedUpdate.
     return unsignedUpdate;

package/src/did-btcr2.ts

@@ -45,7 +45,6 @@ export interface DidCreateOptions {
   network?: string;
 }
 
-// TODO: convert to API driver?
 /** Initialize tiny secp256k1 */
 initEccLib(tinysecp);
 
@@ -265,7 +264,6 @@ export class DidBtcr2 implements DidMethod {
     signingMaterial?: KeyBytes | HexString;
     bitcoin?: BitcoinConnection;
   }): Promise<SignedBTCR2Update> {
-    // TODO: provide KMS as alternative
     // If no signingMaterial provided, throw an UpdateError with INVALID_DID_UPDATE.
     if (!signingMaterial) {
       throw new UpdateError(

package/src/index.ts

@@ -46,6 +46,5 @@ export * from './core/update.js';
 export * from './utils/appendix.js';
 export * from './utils/did-document-builder.js';
 export * from './utils/did-document.js';
-export * from './utils/general.js';
 
 export * from './did-btcr2.js';

package/src/utils/did-document.ts

@@ -1,8 +1,8 @@
 import { getNetwork } from '@did-btcr2/bitcoin';
 import {
-  BTCR2_DID_DOCUMENT_CONTEXT,
-  Canonicalization,
+  canonicalize,
   DidDocumentError,
+  hash,
   HashBytes,
   IdentifierTypes,
   INVALID_DID_DOCUMENT,
@@ -18,6 +18,10 @@ import { BeaconUtils } from '../core/beacon/utils.js';
 import { Identifier } from '../core/identifier.js';
 import { Appendix } from './appendix.js';
 
+export const BTCR2_DID_DOCUMENT_CONTEXT = [
+  'https://www.w3.org/ns/did/v1.1',
+  'https://btcr2.dev/context/v1',
+];
 export const ID_PLACEHOLDER_VALUE = 'did:btcr2:_';
 export const BECH32M_CHARS = '';
 export const DID_REGEX = /did:btcr2:(x1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]*)/g;
@@ -120,8 +124,8 @@ export interface Btcr2DidDocument extends W3CDidDocument {
 export class DidDocument implements Btcr2DidDocument {
   id: string;
   '@context'?: Array<string | JSONObject> = [
-    'https://www.w3.org/TR/did-1.1',
-    'https://btcr2.dev/context/v1'
+    'https://www.w3.org/ns/did/v1.1',
+    'https://btcr2.dev/context/v1',
   ];
   verificationMethod: Array<DidVerificationMethod>;
   authentication?: Array<string | DidVerificationMethod>;
@@ -166,7 +170,7 @@ export class DidDocument implements Btcr2DidDocument {
     this.verificationMethod = document.verificationMethod || [];
     this.service = document.service || [];
     this['@context'] = document['@context'] || [
-      'https://www.w3.org/TR/did-1.1',
+      'https://www.w3.org/ns/did/v1.1',
       'https://btcr2.dev/context/v1'
     ];
 
@@ -321,18 +325,6 @@ export class DidDocument implements Btcr2DidDocument {
     }
   }
 
-  /**
-   * 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.
-   */
-  private static isValidController(controller: Array<string>): boolean {
-    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
@@ -537,6 +529,6 @@ export class GenesisDocument extends DidDocument {
    * @returns {Bytes} The genesis bytes.
    */
   static toGenesisBytes(genesisDocument: GenesisDocumentLike): HashBytes {
-    return Canonicalization.andHash(genesisDocument);
+    return hash(canonicalize(genesisDocument));
   }
 }

package/dist/cjs/utils/general.js

@@ -1,195 +0,0 @@
-import { BIP340_PUBLIC_KEY_MULTIBASE_PREFIX } from '@did-btcr2/common';
-import { sha256 } from '@noble/hashes/sha2';
-import { CURVE, getPublicKey, utils } from '@noble/secp256k1';
-import { HDKey } from '@scure/bip32';
-import { generateMnemonic, mnemonicToSeed } from '@scure/bip39';
-import { wordlist } from '@scure/bip39/wordlists/english';
-import { base58btc } from 'multiformats/bases/base58';
-/**
- * Static class of general utility functions for the did-btcr2 spec implementation
- * @class GeneralUtils
- * @type {GeneralUtils}
- */
-export class GeneralUtils {
-    /**
-     * Helper function to encode a secp256k1 key in SchnorrSecp256k1 Multikey Format
-     * @param {KeyBytes} xOnlyKeyBytes
-     * @returns {PublicKeyMultibase}
-     */
-    static encode(xOnlyKeyBytes) {
-        if (xOnlyKeyBytes.length !== 32) {
-            throw new Error('x-only public key must be 32 bytes');
-        }
-        const prefix = Array.from(BIP340_PUBLIC_KEY_MULTIBASE_PREFIX);
-        const x = Array.from(xOnlyKeyBytes);
-        // Set the prefix and the public key bytes
-        const multikeyBytes = new Uint8Array([...prefix, ...x]);
-        // Encode the public key as a multibase base58btc string
-        return base58btc.encode(multikeyBytes);
-    }
-    /**
-     * Converts a bigint to a buffer
-     * @param {bigint} value The bigint to convert
-     * @returns {Buffer} The buffer representation of the bigint
-     */
-    static bigintToBuffer(value) {
-        const hex = value.toString(16).padStart(64, '0');
-        return Buffer.from(hex, 'hex');
-    }
-    /**
-     * Generates a new mnemonic phrase and HD wallet
-     * @returns {HdWallet} Promise resolving to a new hdwallet object w/ mnemonic and hdkey
-     * @throws {Error} if the public key bytes cannot be derived
-     */
-    static async generateHdWallet() {
-        // Generate random mnemonic phrase.
-        const mnemonic = generateMnemonic(wordlist, 128);
-        // Generate seed from random mnemonic phrase.
-        const seed = await mnemonicToSeed(mnemonic);
-        // Generate HDKey from seed.
-        const hdkey = HDKey.fromMasterSeed(seed);
-        // Ensure HDKey returns valid
-        if (!hdkey) {
-            throw new Error('Failed to derive hd wallet');
-        }
-        return { mnemonic, hdkey };
-    }
-    static generateCompressedSecp256k1KeyPair() {
-        const privateKey = utils.randomPrivateKey();
-        if (!utils.isValidPrivateKey(privateKey)) {
-            throw new Error('Invalid private key');
-        }
-        return { privateKey, publicKey: getPublicKey(privateKey, true) };
-    }
-    ;
-    /**
-     * Recovers an HDKey from a mnemonic phrase
-     * @param {string} mnemonic The mnemonic phrase to recover the HDKey from
-     * @param {Uint8Array} seed Optional seed to recover the HDKey from
-     * @returns {HDKey} Promise resolving to the recovered HDKey
-     * @throws Error if the HDKey cannot be recovered
-     */
-    static async recoverHdWallet(mnemonic, seed) {
-        seed ??= await mnemonicToSeed(mnemonic);
-        // Generate HDKey from seed.
-        const hdkey = HDKey.fromMasterSeed(seed);
-        // Ensure HDKey returns valid
-        if (!hdkey) {
-            throw new Error('Failed to recover hdkey');
-        }
-        // Return the HDKey
-        return hdkey;
-    }
-    /**
-     * Recovers a secp256k1 privateKey from its original entropy
-     * @param {Uint8Array} xorEntropy The original entropy to recover the privateKey from
-     * @param {Uint8Array} salt The salt used to tweak the privateKey
-     * @returns {Uint8Array} The recovered privateKey
-     * @throws {Error} if the privateKey cannot be recovered
-     */
-    static recoverTweakedRawPrivateKey(xorEntropy, salt) {
-        // If entropy is not 32 bytes, hash it to get a deterministic 32-byte private key
-        if (xorEntropy.length !== 32) {
-            xorEntropy = sha256(xorEntropy);
-        }
-        const entropy = this.XNOR(xorEntropy, salt);
-        // Convert entropy to hex
-        const hexEntropy = Buffer.from(entropy).toString('hex');
-        // Convert hexEntropy to BigInt
-        const privateKey = BigInt(`0x${hexEntropy}`);
-        // Ensure private key is in valid secp256k1 range1
-        if (privateKey < BigInt(1) || privateKey >= CURVE.n) {
-            throw new Error('Invalid private key derived from entropy');
-        }
-        // The valid 32-byte private key
-        return entropy;
-    }
-    /**
-     * Recovers a secp256k1 privateKey from its original entropy
-     * @param {Uint8Array} entropy The entropy to recover the privateKey from
-     * @returns {Uint8Array} The recovered privateKey
-     * @throws {Error} if the privateKey cannot be recovered
-     */
-    static recoverRawPrivateKey(entropy) {
-        // If entropy is not 32 bytes, hash it to get a deterministic 32-byte private key
-        if (entropy.length !== 32) {
-            entropy = sha256(entropy);
-        }
-        // Convert entropy to hex
-        const hexEntropy = Buffer.from(entropy).toString('hex');
-        // Convert hexEntropy to BigInt
-        const privateKey = BigInt(`0x${hexEntropy}`);
-        // Ensure private key is in valid secp256k1 range1
-        if (privateKey < BigInt(1) || privateKey >= CURVE.n) {
-            throw new Error('Invalid private key derived from entropy');
-        }
-        // The valid 32-byte private key
-        return entropy;
-    }
-    /**
-     * Tweak the entropy with a salt using XOR
-     * @param {Uint8Array} entropy The entropy to tweak
-     * @param {Uint8Array} salt The salt to tweak the entropy with
-     * @returns {Uint8Array} The tweaked entropy
-     */
-    static XOR(entropy, salt) {
-        const tweaked = new Uint8Array(entropy.length);
-        for (let i = 0; i < entropy.length; i++) {
-            tweaked[i] = entropy[i] ^ salt[i % salt.length]; // XOR with repeating salt
-        }
-        return tweaked;
-    }
-    /**
-     * Untweak the entropy with a salt using XNOR
-     *
-     * @param {Uint8Array} tweakedEntropy The tweaked entropy to untweak
-     * @param {Uint8Array} salt The salt to untweak the entropy with
-     * @returns {Uint8Array} The original entropy
-     */
-    static XNOR(tweakedEntropy, salt) {
-        const originalEntropy = new Uint8Array(tweakedEntropy.length);
-        for (let i = 0; i < tweakedEntropy.length; i++) {
-            originalEntropy[i] = tweakedEntropy[i] ^ salt[i % salt.length]; // XOR with salt again
-        }
-        return originalEntropy;
-    }
-    /**
-     * Recovers an HDKey from a mnemonic phrase
-     * @param {string} mnemonic The mnemonic phrase to recover the HDKey from
-     * @param {string} path The path to derive the child key from
-     * @returns {Uint8Array} Promise resolving to the recovered private key bytes
-     * @throws {Error} if the HDKey cannot be recovered
-     */
-    static async recoverHdChildFromMnemonic(mnemonic, path) {
-        // Generate HDKey from seed.
-        const hdkey = await this.recoverHdWallet(mnemonic);
-        // Ensure HDKey returns valid
-        if (!hdkey) {
-            throw new Error('Failed to recover hdkey');
-        }
-        // Return the privateKey of the derived childKey
-        const childPrivKeyBytes = hdkey.derive(path).privateKey;
-        if (!childPrivKeyBytes) {
-            throw new Error('Failed to recover child private key');
-        }
-        return childPrivKeyBytes;
-    }
-    /**
-     * Derives a child key from an HDKey
-     * @param {HDKey} hdkey The HDKey to derive the child key from
-     * @param {string} path The path to derive the child key from
-     * @returns {HDKey} A Promise resolving to the child key
-     * @throws {Error} Error if the child key cannot be derived
-     */
-    static deriveChildKey(hdkey, path) {
-        // Derive child key from HDKey.
-        const childKey = hdkey.derive(path);
-        // Ensure child key returns valid
-        if (!childKey) {
-            throw new Error(`Failed to derive child key`);
-        }
-        // Return the child key
-        return childKey;
-    }
-}
-//# sourceMappingURL=general.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"general.js","sourceRoot":"","sources":["../../../src/utils/general.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,kCAAkC,EAAY,MAAM,mBAAmB,CAAC;AAC3F,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACvB;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,aAAuB;QAC1C,IAAI,aAAa,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAC9D,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,0CAA0C;QAC1C,MAAM,aAAa,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QACxD,wDAAwD;QACxD,OAAO,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,KAAa;QACjC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB;QAC3B,mCAAmC;QACnC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACjD,6CAA6C;QAC7C,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC5C,4BAA4B;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,kCAAkC;QACvC,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAC5C,IAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;IACnE,CAAC;IAAA,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAgB,EAAE,IAAiB;QAC9D,IAAI,KAAK,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;QACxC,4BAA4B;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,mBAAmB;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,2BAA2B,CAAC,UAAsB,EAAE,IAAgB;QACzE,iFAAiF;QACjF,IAAI,UAAU,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC7B,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5C,yBAAyB;QACzB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,+BAA+B;QAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC;QAC7C,kDAAkD;QAClD,IAAI,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QACD,gCAAgC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,OAAmB;QAC7C,iFAAiF;QACjF,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC1B,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,yBAAyB;QACzB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,+BAA+B;QAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC;QAC7C,kDAAkD;QAClD,IAAI,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QACD,gCAAgC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,OAAmB,EAAE,IAAgB;QAC9C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B;QAC7E,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,cAA0B,EAAE,IAAgB;QACtD,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,eAAe,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,sBAAsB;QACxF,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,QAAgB,EAAE,IAAY;QACpE,4BAA4B;QAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACnD,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,gDAAgD;QAChD,MAAM,iBAAiB,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;QACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,KAAY,EAAE,IAAY;QAC9C,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpC,iCAAiC;QACjC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,uBAAuB;QACvB,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/dist/esm/utils/general.js

@@ -1,195 +0,0 @@
-import { BIP340_PUBLIC_KEY_MULTIBASE_PREFIX } from '@did-btcr2/common';
-import { sha256 } from '@noble/hashes/sha2';
-import { CURVE, getPublicKey, utils } from '@noble/secp256k1';
-import { HDKey } from '@scure/bip32';
-import { generateMnemonic, mnemonicToSeed } from '@scure/bip39';
-import { wordlist } from '@scure/bip39/wordlists/english';
-import { base58btc } from 'multiformats/bases/base58';
-/**
- * Static class of general utility functions for the did-btcr2 spec implementation
- * @class GeneralUtils
- * @type {GeneralUtils}
- */
-export class GeneralUtils {
-    /**
-     * Helper function to encode a secp256k1 key in SchnorrSecp256k1 Multikey Format
-     * @param {KeyBytes} xOnlyKeyBytes
-     * @returns {PublicKeyMultibase}
-     */
-    static encode(xOnlyKeyBytes) {
-        if (xOnlyKeyBytes.length !== 32) {
-            throw new Error('x-only public key must be 32 bytes');
-        }
-        const prefix = Array.from(BIP340_PUBLIC_KEY_MULTIBASE_PREFIX);
-        const x = Array.from(xOnlyKeyBytes);
-        // Set the prefix and the public key bytes
-        const multikeyBytes = new Uint8Array([...prefix, ...x]);
-        // Encode the public key as a multibase base58btc string
-        return base58btc.encode(multikeyBytes);
-    }
-    /**
-     * Converts a bigint to a buffer
-     * @param {bigint} value The bigint to convert
-     * @returns {Buffer} The buffer representation of the bigint
-     */
-    static bigintToBuffer(value) {
-        const hex = value.toString(16).padStart(64, '0');
-        return Buffer.from(hex, 'hex');
-    }
-    /**
-     * Generates a new mnemonic phrase and HD wallet
-     * @returns {HdWallet} Promise resolving to a new hdwallet object w/ mnemonic and hdkey
-     * @throws {Error} if the public key bytes cannot be derived
-     */
-    static async generateHdWallet() {
-        // Generate random mnemonic phrase.
-        const mnemonic = generateMnemonic(wordlist, 128);
-        // Generate seed from random mnemonic phrase.
-        const seed = await mnemonicToSeed(mnemonic);
-        // Generate HDKey from seed.
-        const hdkey = HDKey.fromMasterSeed(seed);
-        // Ensure HDKey returns valid
-        if (!hdkey) {
-            throw new Error('Failed to derive hd wallet');
-        }
-        return { mnemonic, hdkey };
-    }
-    static generateCompressedSecp256k1KeyPair() {
-        const privateKey = utils.randomPrivateKey();
-        if (!utils.isValidPrivateKey(privateKey)) {
-            throw new Error('Invalid private key');
-        }
-        return { privateKey, publicKey: getPublicKey(privateKey, true) };
-    }
-    ;
-    /**
-     * Recovers an HDKey from a mnemonic phrase
-     * @param {string} mnemonic The mnemonic phrase to recover the HDKey from
-     * @param {Uint8Array} seed Optional seed to recover the HDKey from
-     * @returns {HDKey} Promise resolving to the recovered HDKey
-     * @throws Error if the HDKey cannot be recovered
-     */
-    static async recoverHdWallet(mnemonic, seed) {
-        seed ??= await mnemonicToSeed(mnemonic);
-        // Generate HDKey from seed.
-        const hdkey = HDKey.fromMasterSeed(seed);
-        // Ensure HDKey returns valid
-        if (!hdkey) {
-            throw new Error('Failed to recover hdkey');
-        }
-        // Return the HDKey
-        return hdkey;
-    }
-    /**
-     * Recovers a secp256k1 privateKey from its original entropy
-     * @param {Uint8Array} xorEntropy The original entropy to recover the privateKey from
-     * @param {Uint8Array} salt The salt used to tweak the privateKey
-     * @returns {Uint8Array} The recovered privateKey
-     * @throws {Error} if the privateKey cannot be recovered
-     */
-    static recoverTweakedRawPrivateKey(xorEntropy, salt) {
-        // If entropy is not 32 bytes, hash it to get a deterministic 32-byte private key
-        if (xorEntropy.length !== 32) {
-            xorEntropy = sha256(xorEntropy);
-        }
-        const entropy = this.XNOR(xorEntropy, salt);
-        // Convert entropy to hex
-        const hexEntropy = Buffer.from(entropy).toString('hex');
-        // Convert hexEntropy to BigInt
-        const privateKey = BigInt(`0x${hexEntropy}`);
-        // Ensure private key is in valid secp256k1 range1
-        if (privateKey < BigInt(1) || privateKey >= CURVE.n) {
-            throw new Error('Invalid private key derived from entropy');
-        }
-        // The valid 32-byte private key
-        return entropy;
-    }
-    /**
-     * Recovers a secp256k1 privateKey from its original entropy
-     * @param {Uint8Array} entropy The entropy to recover the privateKey from
-     * @returns {Uint8Array} The recovered privateKey
-     * @throws {Error} if the privateKey cannot be recovered
-     */
-    static recoverRawPrivateKey(entropy) {
-        // If entropy is not 32 bytes, hash it to get a deterministic 32-byte private key
-        if (entropy.length !== 32) {
-            entropy = sha256(entropy);
-        }
-        // Convert entropy to hex
-        const hexEntropy = Buffer.from(entropy).toString('hex');
-        // Convert hexEntropy to BigInt
-        const privateKey = BigInt(`0x${hexEntropy}`);
-        // Ensure private key is in valid secp256k1 range1
-        if (privateKey < BigInt(1) || privateKey >= CURVE.n) {
-            throw new Error('Invalid private key derived from entropy');
-        }
-        // The valid 32-byte private key
-        return entropy;
-    }
-    /**
-     * Tweak the entropy with a salt using XOR
-     * @param {Uint8Array} entropy The entropy to tweak
-     * @param {Uint8Array} salt The salt to tweak the entropy with
-     * @returns {Uint8Array} The tweaked entropy
-     */
-    static XOR(entropy, salt) {
-        const tweaked = new Uint8Array(entropy.length);
-        for (let i = 0; i < entropy.length; i++) {
-            tweaked[i] = entropy[i] ^ salt[i % salt.length]; // XOR with repeating salt
-        }
-        return tweaked;
-    }
-    /**
-     * Untweak the entropy with a salt using XNOR
-     *
-     * @param {Uint8Array} tweakedEntropy The tweaked entropy to untweak
-     * @param {Uint8Array} salt The salt to untweak the entropy with
-     * @returns {Uint8Array} The original entropy
-     */
-    static XNOR(tweakedEntropy, salt) {
-        const originalEntropy = new Uint8Array(tweakedEntropy.length);
-        for (let i = 0; i < tweakedEntropy.length; i++) {
-            originalEntropy[i] = tweakedEntropy[i] ^ salt[i % salt.length]; // XOR with salt again
-        }
-        return originalEntropy;
-    }
-    /**
-     * Recovers an HDKey from a mnemonic phrase
-     * @param {string} mnemonic The mnemonic phrase to recover the HDKey from
-     * @param {string} path The path to derive the child key from
-     * @returns {Uint8Array} Promise resolving to the recovered private key bytes
-     * @throws {Error} if the HDKey cannot be recovered
-     */
-    static async recoverHdChildFromMnemonic(mnemonic, path) {
-        // Generate HDKey from seed.
-        const hdkey = await this.recoverHdWallet(mnemonic);
-        // Ensure HDKey returns valid
-        if (!hdkey) {
-            throw new Error('Failed to recover hdkey');
-        }
-        // Return the privateKey of the derived childKey
-        const childPrivKeyBytes = hdkey.derive(path).privateKey;
-        if (!childPrivKeyBytes) {
-            throw new Error('Failed to recover child private key');
-        }
-        return childPrivKeyBytes;
-    }
-    /**
-     * Derives a child key from an HDKey
-     * @param {HDKey} hdkey The HDKey to derive the child key from
-     * @param {string} path The path to derive the child key from
-     * @returns {HDKey} A Promise resolving to the child key
-     * @throws {Error} Error if the child key cannot be derived
-     */
-    static deriveChildKey(hdkey, path) {
-        // Derive child key from HDKey.
-        const childKey = hdkey.derive(path);
-        // Ensure child key returns valid
-        if (!childKey) {
-            throw new Error(`Failed to derive child key`);
-        }
-        // Return the child key
-        return childKey;
-    }
-}
-//# sourceMappingURL=general.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"general.js","sourceRoot":"","sources":["../../../src/utils/general.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,kCAAkC,EAAY,MAAM,mBAAmB,CAAC;AAC3F,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACvB;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,aAAuB;QAC1C,IAAI,aAAa,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAC9D,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,0CAA0C;QAC1C,MAAM,aAAa,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QACxD,wDAAwD;QACxD,OAAO,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,KAAa;QACjC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB;QAC3B,mCAAmC;QACnC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACjD,6CAA6C;QAC7C,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC5C,4BAA4B;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,kCAAkC;QACvC,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAC5C,IAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;IACnE,CAAC;IAAA,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAgB,EAAE,IAAiB;QAC9D,IAAI,KAAK,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;QACxC,4BAA4B;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,mBAAmB;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,2BAA2B,CAAC,UAAsB,EAAE,IAAgB;QACzE,iFAAiF;QACjF,IAAI,UAAU,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC7B,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5C,yBAAyB;QACzB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,+BAA+B;QAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC;QAC7C,kDAAkD;QAClD,IAAI,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QACD,gCAAgC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,OAAmB;QAC7C,iFAAiF;QACjF,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC1B,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,yBAAyB;QACzB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,+BAA+B;QAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC;QAC7C,kDAAkD;QAClD,IAAI,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QACD,gCAAgC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,OAAmB,EAAE,IAAgB;QAC9C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B;QAC7E,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,cAA0B,EAAE,IAAgB;QACtD,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,eAAe,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,sBAAsB;QACxF,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,QAAgB,EAAE,IAAY;QACpE,4BAA4B;QAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACnD,6BAA6B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,gDAAgD;QAChD,MAAM,iBAAiB,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;QACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,KAAY,EAAE,IAAY;QAC9C,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpC,iCAAiC;QACjC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,uBAAuB;QACvB,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}