@leather.io/crypto 1.0.3 → 1.0.4

package/dist/index.d.mts

@@ -10,9 +10,25 @@ declare enum DerivationPathDepth {
 }
 declare const extractAccountIndexFromPath: (path: string) => number;
 declare const extractAddressIndexFromPath: (path: string) => number;
+/**
+ * @description
+ * A key origin path refers to the identifier commonly used as part of the key
+ * information provided as part of a Output Descriptor described in BIP-380. It
+ * replaces the `m/` part of a derivation path with the master key fingerprint to which the
+ * key it describes belongs.
+ * @example `0a3fd8ef/84'/0'/0'`
+ */
+declare function createKeyOriginPath(fingerprint: string, path: string): string;
 
 declare function generateMnemonic(): string;
-declare function deriveBip39MnemonicFromSeed(mnemonic: string): Promise<Uint8Array>;
+declare function deriveBip39SeedFromMnemonic(mnemonic: string): Promise<Uint8Array>;
+/** @deprecated Inaccurately named fn, use `deriveBip39SeedFromMnemonic` */
+declare const deriveBip39MnemonicFromSeed: typeof deriveBip39SeedFromMnemonic;
 declare function deriveRootBip32Keychain(seed: Uint8Array): HDKey;
+/**
+ * Gets keychain fingerprint directly from mnemonic. This is useful for
+ * referencing a mnemonic safely by an identifier.
+ */
+declare function getMnemonicRootKeyFingerprint(mnemonic: string): Promise<string>;
 
-export { DerivationPathDepth, deriveBip39MnemonicFromSeed, deriveRootBip32Keychain, extractAccountIndexFromPath, extractAddressIndexFromPath, generateMnemonic };
+export { DerivationPathDepth, createKeyOriginPath, deriveBip39MnemonicFromSeed, deriveBip39SeedFromMnemonic, deriveRootBip32Keychain, extractAccountIndexFromPath, extractAddressIndexFromPath, generateMnemonic, getMnemonicRootKeyFingerprint };

package/dist/index.mjs

@@ -27,23 +27,34 @@ var extractAccountIndexFromPath = extractSectionFromDerivationPath(
 var extractAddressIndexFromPath = extractSectionFromDerivationPath(
   5 /* AddressIndex */
 );
+function createKeyOriginPath(fingerprint, path) {
+  return `${fingerprint}/${path.replace("m/", "")}`;
+}
 
 // src/index.ts
 function generateMnemonic() {
   return scureGenerateMnemonic(wordlist, 256);
 }
-async function deriveBip39MnemonicFromSeed(mnemonic) {
+async function deriveBip39SeedFromMnemonic(mnemonic) {
   return mnemonicToSeed(mnemonic);
 }
+var deriveBip39MnemonicFromSeed = deriveBip39SeedFromMnemonic;
 function deriveRootBip32Keychain(seed) {
   return HDKey.fromMasterSeed(seed);
 }
+async function getMnemonicRootKeyFingerprint(mnemonic) {
+  const keychain = deriveRootBip32Keychain(await deriveBip39SeedFromMnemonic(mnemonic));
+  return keychain.fingerprint.toString(16);
+}
 export {
   DerivationPathDepth,
+  createKeyOriginPath,
   deriveBip39MnemonicFromSeed,
+  deriveBip39SeedFromMnemonic,
   deriveRootBip32Keychain,
   extractAccountIndexFromPath,
   extractAddressIndexFromPath,
-  generateMnemonic
+  generateMnemonic,
+  getMnemonicRootKeyFingerprint
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/derivation-path-utils.ts"],"sourcesContent":["import { HDKey } from '@scure/bip32';\nimport { mnemonicToSeed, generateMnemonic as scureGenerateMnemonic } from '@scure/bip39';\nimport { wordlist } from '@scure/bip39/wordlists/english';\n\nexport * from './derivation-path-utils';\n\nexport function generateMnemonic() {\n  return scureGenerateMnemonic(wordlist, 256);\n}\n\nexport async function deriveBip39MnemonicFromSeed(mnemonic: string) {\n  return mnemonicToSeed(mnemonic);\n}\n\nexport function deriveRootBip32Keychain(seed: Uint8Array) {\n  return HDKey.fromMasterSeed(seed);\n}\n","export enum DerivationPathDepth {\n  Root = 0,\n  Purpose = 1,\n  CoinType = 2,\n  Account = 3,\n  ChangeReceive = 4,\n  AddressIndex = 5,\n}\n\nfunction extractSectionFromDerivationPath(depth: DerivationPathDepth) {\n  return (path: string) => {\n    const segments = path.split('/');\n    const accountNum = parseInt(segments[depth].replaceAll(\"'\", ''), 10);\n    if (isNaN(accountNum)) throw new Error(`Cannot parse ${DerivationPathDepth[depth]} from path`);\n    return accountNum;\n  };\n}\n\nexport const extractAccountIndexFromPath = extractSectionFromDerivationPath(\n  DerivationPathDepth.Account\n);\n\nexport const extractAddressIndexFromPath = extractSectionFromDerivationPath(\n  DerivationPathDepth.AddressIndex\n);\n"],"mappings":";AAAA,SAAS,aAAa;AACtB,SAAS,gBAAgB,oBAAoB,6BAA6B;AAC1E,SAAS,gBAAgB;;;ACFlB,IAAK,sBAAL,kBAAKA,yBAAL;AACL,EAAAA,0CAAA,UAAO,KAAP;AACA,EAAAA,0CAAA,aAAU,KAAV;AACA,EAAAA,0CAAA,cAAW,KAAX;AACA,EAAAA,0CAAA,aAAU,KAAV;AACA,EAAAA,0CAAA,mBAAgB,KAAhB;AACA,EAAAA,0CAAA,kBAAe,KAAf;AANU,SAAAA;AAAA,GAAA;AASZ,SAAS,iCAAiC,OAA4B;AACpE,SAAO,CAAC,SAAiB;AACvB,UAAM,WAAW,KAAK,MAAM,GAAG;AAC/B,UAAM,aAAa,SAAS,SAAS,KAAK,EAAE,WAAW,KAAK,EAAE,GAAG,EAAE;AACnE,QAAI,MAAM,UAAU,EAAG,OAAM,IAAI,MAAM,gBAAgB,oBAAoB,KAAK,CAAC,YAAY;AAC7F,WAAO;AAAA,EACT;AACF;AAEO,IAAM,8BAA8B;AAAA,EACzC;AACF;AAEO,IAAM,8BAA8B;AAAA,EACzC;AACF;;;ADlBO,SAAS,mBAAmB;AACjC,SAAO,sBAAsB,UAAU,GAAG;AAC5C;AAEA,eAAsB,4BAA4B,UAAkB;AAClE,SAAO,eAAe,QAAQ;AAChC;AAEO,SAAS,wBAAwB,MAAkB;AACxD,SAAO,MAAM,eAAe,IAAI;AAClC;","names":["DerivationPathDepth"]}
+{"version":3,"sources":["../src/index.ts","../src/derivation-path-utils.ts"],"sourcesContent":["import { HDKey } from '@scure/bip32';\nimport { mnemonicToSeed, generateMnemonic as scureGenerateMnemonic } from '@scure/bip39';\nimport { wordlist } from '@scure/bip39/wordlists/english';\n\nexport * from './derivation-path-utils';\n\nexport function generateMnemonic() {\n  return scureGenerateMnemonic(wordlist, 256);\n}\n\nexport async function deriveBip39SeedFromMnemonic(mnemonic: string) {\n  return mnemonicToSeed(mnemonic);\n}\n/** @deprecated Inaccurately named fn, use `deriveBip39SeedFromMnemonic` */\nexport const deriveBip39MnemonicFromSeed = deriveBip39SeedFromMnemonic;\n\nexport function deriveRootBip32Keychain(seed: Uint8Array) {\n  return HDKey.fromMasterSeed(seed);\n}\n\n/**\n * Gets keychain fingerprint directly from mnemonic. This is useful for\n * referencing a mnemonic safely by an identifier.\n */\nexport async function getMnemonicRootKeyFingerprint(mnemonic: string) {\n  const keychain = deriveRootBip32Keychain(await deriveBip39SeedFromMnemonic(mnemonic));\n  return keychain.fingerprint.toString(16);\n}\n","export enum DerivationPathDepth {\n  Root = 0,\n  Purpose = 1,\n  CoinType = 2,\n  Account = 3,\n  ChangeReceive = 4,\n  AddressIndex = 5,\n}\n\nfunction extractSectionFromDerivationPath(depth: DerivationPathDepth) {\n  return (path: string) => {\n    const segments = path.split('/');\n    const accountNum = parseInt(segments[depth].replaceAll(\"'\", ''), 10);\n    if (isNaN(accountNum)) throw new Error(`Cannot parse ${DerivationPathDepth[depth]} from path`);\n    return accountNum;\n  };\n}\n\nexport const extractAccountIndexFromPath = extractSectionFromDerivationPath(\n  DerivationPathDepth.Account\n);\n\nexport const extractAddressIndexFromPath = extractSectionFromDerivationPath(\n  DerivationPathDepth.AddressIndex\n);\n\n/**\n * @description\n * A key origin path refers to the identifier commonly used as part of the key\n * information provided as part of a Output Descriptor described in BIP-380. It\n * replaces the `m/` part of a derivation path with the master key fingerprint to which the\n * key it describes belongs.\n * @example `0a3fd8ef/84'/0'/0'`\n */\nexport function createKeyOriginPath(fingerprint: string, path: string) {\n  return `${fingerprint}/${path.replace('m/', '')}`;\n}\n"],"mappings":";AAAA,SAAS,aAAa;AACtB,SAAS,gBAAgB,oBAAoB,6BAA6B;AAC1E,SAAS,gBAAgB;;;ACFlB,IAAK,sBAAL,kBAAKA,yBAAL;AACL,EAAAA,0CAAA,UAAO,KAAP;AACA,EAAAA,0CAAA,aAAU,KAAV;AACA,EAAAA,0CAAA,cAAW,KAAX;AACA,EAAAA,0CAAA,aAAU,KAAV;AACA,EAAAA,0CAAA,mBAAgB,KAAhB;AACA,EAAAA,0CAAA,kBAAe,KAAf;AANU,SAAAA;AAAA,GAAA;AASZ,SAAS,iCAAiC,OAA4B;AACpE,SAAO,CAAC,SAAiB;AACvB,UAAM,WAAW,KAAK,MAAM,GAAG;AAC/B,UAAM,aAAa,SAAS,SAAS,KAAK,EAAE,WAAW,KAAK,EAAE,GAAG,EAAE;AACnE,QAAI,MAAM,UAAU,EAAG,OAAM,IAAI,MAAM,gBAAgB,oBAAoB,KAAK,CAAC,YAAY;AAC7F,WAAO;AAAA,EACT;AACF;AAEO,IAAM,8BAA8B;AAAA,EACzC;AACF;AAEO,IAAM,8BAA8B;AAAA,EACzC;AACF;AAUO,SAAS,oBAAoB,aAAqB,MAAc;AACrE,SAAO,GAAG,WAAW,IAAI,KAAK,QAAQ,MAAM,EAAE,CAAC;AACjD;;;AD9BO,SAAS,mBAAmB;AACjC,SAAO,sBAAsB,UAAU,GAAG;AAC5C;AAEA,eAAsB,4BAA4B,UAAkB;AAClE,SAAO,eAAe,QAAQ;AAChC;AAEO,IAAM,8BAA8B;AAEpC,SAAS,wBAAwB,MAAkB;AACxD,SAAO,MAAM,eAAe,IAAI;AAClC;AAMA,eAAsB,8BAA8B,UAAkB;AACpE,QAAM,WAAW,wBAAwB,MAAM,4BAA4B,QAAQ,CAAC;AACpF,SAAO,SAAS,YAAY,SAAS,EAAE;AACzC;","names":["DerivationPathDepth"]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@leather.io/crypto",
   "author": "leather.io",
   "description": "Generic crypto utils package for Leather",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "license": "MIT",
   "exports": {
     ".": "./dist/index.mjs"
@@ -14,7 +14,7 @@
   "devDependencies": {
     "@vitest/coverage-istanbul": "0.34.6",
     "tsup": "8.1.0",
-    "vitest": "0.34.6"
+    "vitest": "2.0.3"
   },
   "files": [
     "dist"
@@ -26,7 +26,7 @@
     "build": "tsup",
     "build:watch": "tsup --watch",
     "prepublish": "pnpm build",
-    "test:unit": "vitest",
+    "test:unit": "vitest run",
     "typecheck": "tsc --noEmit"
   }
 }