@leather.io/crypto 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +4 -2
- package/dist/index.mjs +15 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -54,7 +54,9 @@ declare function deriveKeychainFromXpub(xpub: string): HDKey;
|
|
|
54
54
|
* Gets keychain fingerprint directly from mnemonic. This is useful for
|
|
55
55
|
* referencing a mnemonic safely by an identifier.
|
|
56
56
|
*/
|
|
57
|
-
declare function getMnemonicRootKeyFingerprint(mnemonic: string): Promise<string>;
|
|
57
|
+
declare function getMnemonicRootKeyFingerprint(mnemonic: string, passphrase?: string): Promise<string>;
|
|
58
58
|
declare function deriveKeychainDescriptor(rootKeychain: HDKey, path: string): string;
|
|
59
|
+
declare function isValidMnemonicWord(word: string): boolean;
|
|
60
|
+
declare function isValidMnemonic(mnemonic: string): boolean;
|
|
59
61
|
|
|
60
|
-
export { DerivationPathDepth, createExtendedPublicKeyDescriptor, createKeyOriginPath, deriveBip39MnemonicFromSeed, deriveBip39SeedFromMnemonic, deriveKeychainDescriptor, deriveKeychainFromXpub, deriveRootBip32Keychain, extractAccountIndexFromDescriptor, extractAccountIndexFromPath, extractAddressIndexFromPath, extractDerivationPathFromDescriptor, extractFingerprintFromDescriptor, extractFingerprintFromKeyOriginPath, extractKeyOriginPathFromDescriptor, generateMnemonic, getMnemonicRootKeyFingerprint, validateKeyOriginPath };
|
|
62
|
+
export { DerivationPathDepth, createExtendedPublicKeyDescriptor, createKeyOriginPath, deriveBip39MnemonicFromSeed, deriveBip39SeedFromMnemonic, deriveKeychainDescriptor, deriveKeychainFromXpub, deriveRootBip32Keychain, extractAccountIndexFromDescriptor, extractAccountIndexFromPath, extractAddressIndexFromPath, extractDerivationPathFromDescriptor, extractFingerprintFromDescriptor, extractFingerprintFromKeyOriginPath, extractKeyOriginPathFromDescriptor, generateMnemonic, getMnemonicRootKeyFingerprint, isValidMnemonic, isValidMnemonicWord, validateKeyOriginPath };
|
package/dist/index.mjs
CHANGED
|
@@ -65,7 +65,11 @@ function extractAccountIndexFromDescriptor(descriptor) {
|
|
|
65
65
|
|
|
66
66
|
// src/keychain.ts
|
|
67
67
|
import { HDKey } from "@scure/bip32";
|
|
68
|
-
import {
|
|
68
|
+
import {
|
|
69
|
+
mnemonicToSeed,
|
|
70
|
+
generateMnemonic as scureGenerateMnemonic,
|
|
71
|
+
validateMnemonic
|
|
72
|
+
} from "@scure/bip39";
|
|
69
73
|
import { wordlist } from "@scure/bip39/wordlists/english";
|
|
70
74
|
import { toHexString } from "@leather.io/utils";
|
|
71
75
|
function generateMnemonic() {
|
|
@@ -81,8 +85,8 @@ function deriveRootBip32Keychain(seed) {
|
|
|
81
85
|
function deriveKeychainFromXpub(xpub) {
|
|
82
86
|
return HDKey.fromExtendedKey(xpub);
|
|
83
87
|
}
|
|
84
|
-
async function getMnemonicRootKeyFingerprint(mnemonic) {
|
|
85
|
-
const keychain = deriveRootBip32Keychain(await deriveBip39SeedFromMnemonic(mnemonic));
|
|
88
|
+
async function getMnemonicRootKeyFingerprint(mnemonic, passphrase) {
|
|
89
|
+
const keychain = deriveRootBip32Keychain(await deriveBip39SeedFromMnemonic(mnemonic, passphrase));
|
|
86
90
|
return toHexString(keychain.fingerprint);
|
|
87
91
|
}
|
|
88
92
|
function deriveKeychainDescriptor(rootKeychain, path) {
|
|
@@ -93,6 +97,12 @@ function deriveKeychainDescriptor(rootKeychain, path) {
|
|
|
93
97
|
const accountKeychain = rootKeychain.derive(path);
|
|
94
98
|
return createExtendedPublicKeyDescriptor(keyOriginPath, accountKeychain.publicExtendedKey);
|
|
95
99
|
}
|
|
100
|
+
function isValidMnemonicWord(word) {
|
|
101
|
+
return wordlist.includes(word);
|
|
102
|
+
}
|
|
103
|
+
function isValidMnemonic(mnemonic) {
|
|
104
|
+
return validateMnemonic(mnemonic, wordlist);
|
|
105
|
+
}
|
|
96
106
|
export {
|
|
97
107
|
DerivationPathDepth,
|
|
98
108
|
createExtendedPublicKeyDescriptor,
|
|
@@ -111,6 +121,8 @@ export {
|
|
|
111
121
|
extractKeyOriginPathFromDescriptor,
|
|
112
122
|
generateMnemonic,
|
|
113
123
|
getMnemonicRootKeyFingerprint,
|
|
124
|
+
isValidMnemonic,
|
|
125
|
+
isValidMnemonicWord,
|
|
114
126
|
validateKeyOriginPath
|
|
115
127
|
};
|
|
116
128
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/derivation-path-utils.ts","../src/keychain.ts"],"sourcesContent":["import { isHexString } from '@leather.io/utils';\n\nexport 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\nexport function extractFingerprintFromKeyOriginPath(keyOriginPath: string) {\n const fingerprint = keyOriginPath.split('/')[0];\n if (!isHexString(fingerprint)) throw new Error('Fingerprint must be a hexadecimal string');\n return fingerprint;\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 if (!isHexString(fingerprint)) throw new Error('Fingerprint must be a hexadecimal string');\n return `${fingerprint}/${path.replace('m/', '')}`;\n}\n\nexport function validateKeyOriginPath(keyOriginPath: string) {\n if (keyOriginPath.includes('[') || keyOriginPath.includes(']'))\n throw new Error('Key origin path should not contain square brackets');\n\n if (!keyOriginPath.includes('/'))\n throw new Error('Key origin path must contain a fingerprint and derivation path');\n\n if (!isHexString(extractFingerprintFromKeyOriginPath(keyOriginPath)))\n throw new Error('Fingerprint must be a hexadecimal string');\n\n if (keyOriginPath.split('/').length < 4)\n throw new Error('Key origin path is too short. Should describe at least to the account level');\n\n return true;\n}\n\n/**\n * @description\n * Creates a descriptor with key origin and xpub\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3`\n */\nexport function createExtendedPublicKeyDescriptor(keyOriginPath: string, xpub: string) {\n validateKeyOriginPath(keyOriginPath);\n return `[${keyOriginPath}]${xpub}`;\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3` -> `0a3fd8ef/84'/0'/0'`\n */\nexport function extractKeyOriginPathFromDescriptor(descriptor: string) {\n const keyOriginPath = descriptor.split(']')[0].replace('[', '');\n validateKeyOriginPath(keyOriginPath);\n return keyOriginPath;\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3` -> `m/84'/0'/0'`\n */\nexport function extractDerivationPathFromDescriptor(descriptor: string) {\n const keyOriginPath = extractKeyOriginPathFromDescriptor(descriptor);\n return 'm/' + keyOriginPath.split('/').slice(1).join('/');\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3` -> `0a3fd8ef`\n */\nexport function extractFingerprintFromDescriptor(descriptor: string) {\n return extractFingerprintFromKeyOriginPath(extractKeyOriginPathFromDescriptor(descriptor));\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/6']xpuba1b…2c3` -> `6`\n */\nexport function extractAccountIndexFromDescriptor(descriptor: string) {\n return extractAccountIndexFromPath(extractKeyOriginPathFromDescriptor(descriptor));\n}\n","import { HDKey } from '@scure/bip32';\nimport {
|
|
1
|
+
{"version":3,"sources":["../src/derivation-path-utils.ts","../src/keychain.ts"],"sourcesContent":["import { isHexString } from '@leather.io/utils';\n\nexport 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\nexport function extractFingerprintFromKeyOriginPath(keyOriginPath: string) {\n const fingerprint = keyOriginPath.split('/')[0];\n if (!isHexString(fingerprint)) throw new Error('Fingerprint must be a hexadecimal string');\n return fingerprint;\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 if (!isHexString(fingerprint)) throw new Error('Fingerprint must be a hexadecimal string');\n return `${fingerprint}/${path.replace('m/', '')}`;\n}\n\nexport function validateKeyOriginPath(keyOriginPath: string) {\n if (keyOriginPath.includes('[') || keyOriginPath.includes(']'))\n throw new Error('Key origin path should not contain square brackets');\n\n if (!keyOriginPath.includes('/'))\n throw new Error('Key origin path must contain a fingerprint and derivation path');\n\n if (!isHexString(extractFingerprintFromKeyOriginPath(keyOriginPath)))\n throw new Error('Fingerprint must be a hexadecimal string');\n\n if (keyOriginPath.split('/').length < 4)\n throw new Error('Key origin path is too short. Should describe at least to the account level');\n\n return true;\n}\n\n/**\n * @description\n * Creates a descriptor with key origin and xpub\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3`\n */\nexport function createExtendedPublicKeyDescriptor(keyOriginPath: string, xpub: string) {\n validateKeyOriginPath(keyOriginPath);\n return `[${keyOriginPath}]${xpub}`;\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3` -> `0a3fd8ef/84'/0'/0'`\n */\nexport function extractKeyOriginPathFromDescriptor(descriptor: string) {\n const keyOriginPath = descriptor.split(']')[0].replace('[', '');\n validateKeyOriginPath(keyOriginPath);\n return keyOriginPath;\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3` -> `m/84'/0'/0'`\n */\nexport function extractDerivationPathFromDescriptor(descriptor: string) {\n const keyOriginPath = extractKeyOriginPathFromDescriptor(descriptor);\n return 'm/' + keyOriginPath.split('/').slice(1).join('/');\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/0']xpuba1b…2c3` -> `0a3fd8ef`\n */\nexport function extractFingerprintFromDescriptor(descriptor: string) {\n return extractFingerprintFromKeyOriginPath(extractKeyOriginPathFromDescriptor(descriptor));\n}\n\n/**\n * @example `[0a3fd8ef/84'/0'/6']xpuba1b…2c3` -> `6`\n */\nexport function extractAccountIndexFromDescriptor(descriptor: string) {\n return extractAccountIndexFromPath(extractKeyOriginPathFromDescriptor(descriptor));\n}\n","import { HDKey } from '@scure/bip32';\nimport {\n mnemonicToSeed,\n generateMnemonic as scureGenerateMnemonic,\n validateMnemonic,\n} from '@scure/bip39';\nimport { wordlist } from '@scure/bip39/wordlists/english';\n\nimport { toHexString } from '@leather.io/utils';\n\nimport {\n DerivationPathDepth,\n createExtendedPublicKeyDescriptor,\n createKeyOriginPath,\n} from './derivation-path-utils';\n\nexport function generateMnemonic() {\n return scureGenerateMnemonic(wordlist, 256);\n}\n\nexport async function deriveBip39SeedFromMnemonic(mnemonic: string, passphrase?: string) {\n return mnemonicToSeed(mnemonic, passphrase);\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\nexport function deriveKeychainFromXpub(xpub: string) {\n return HDKey.fromExtendedKey(xpub);\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, passphrase?: string) {\n const keychain = deriveRootBip32Keychain(await deriveBip39SeedFromMnemonic(mnemonic, passphrase));\n return toHexString(keychain.fingerprint);\n}\n\nexport function deriveKeychainDescriptor(rootKeychain: HDKey, path: string) {\n const masterFingerprint = toHexString(rootKeychain.fingerprint);\n const keyOriginPath = createKeyOriginPath(masterFingerprint, path);\n\n if (rootKeychain.depth !== DerivationPathDepth.Root)\n throw new Error('Cannot derive account keychain from non-root keychain');\n\n const accountKeychain = rootKeychain.derive(path);\n return createExtendedPublicKeyDescriptor(keyOriginPath, accountKeychain.publicExtendedKey);\n}\n\nexport function isValidMnemonicWord(word: string): boolean {\n return wordlist.includes(word);\n}\n\nexport function isValidMnemonic(mnemonic: string): boolean {\n return validateMnemonic(mnemonic, wordlist);\n}\n"],"mappings":";AAAA,SAAS,mBAAmB;AAErB,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;AAEO,SAAS,oCAAoC,eAAuB;AACzE,QAAM,cAAc,cAAc,MAAM,GAAG,EAAE,CAAC;AAC9C,MAAI,CAAC,YAAY,WAAW,EAAG,OAAM,IAAI,MAAM,0CAA0C;AACzF,SAAO;AACT;AAUO,SAAS,oBAAoB,aAAqB,MAAc;AACrE,MAAI,CAAC,YAAY,WAAW,EAAG,OAAM,IAAI,MAAM,0CAA0C;AACzF,SAAO,GAAG,WAAW,IAAI,KAAK,QAAQ,MAAM,EAAE,CAAC;AACjD;AAEO,SAAS,sBAAsB,eAAuB;AAC3D,MAAI,cAAc,SAAS,GAAG,KAAK,cAAc,SAAS,GAAG;AAC3D,UAAM,IAAI,MAAM,oDAAoD;AAEtE,MAAI,CAAC,cAAc,SAAS,GAAG;AAC7B,UAAM,IAAI,MAAM,gEAAgE;AAElF,MAAI,CAAC,YAAY,oCAAoC,aAAa,CAAC;AACjE,UAAM,IAAI,MAAM,0CAA0C;AAE5D,MAAI,cAAc,MAAM,GAAG,EAAE,SAAS;AACpC,UAAM,IAAI,MAAM,6EAA6E;AAE/F,SAAO;AACT;AAOO,SAAS,kCAAkC,eAAuB,MAAc;AACrF,wBAAsB,aAAa;AACnC,SAAO,IAAI,aAAa,IAAI,IAAI;AAClC;AAKO,SAAS,mCAAmC,YAAoB;AACrE,QAAM,gBAAgB,WAAW,MAAM,GAAG,EAAE,CAAC,EAAE,QAAQ,KAAK,EAAE;AAC9D,wBAAsB,aAAa;AACnC,SAAO;AACT;AAKO,SAAS,oCAAoC,YAAoB;AACtE,QAAM,gBAAgB,mCAAmC,UAAU;AACnE,SAAO,OAAO,cAAc,MAAM,GAAG,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG;AAC1D;AAKO,SAAS,iCAAiC,YAAoB;AACnE,SAAO,oCAAoC,mCAAmC,UAAU,CAAC;AAC3F;AAKO,SAAS,kCAAkC,YAAoB;AACpE,SAAO,4BAA4B,mCAAmC,UAAU,CAAC;AACnF;;;ACtGA,SAAS,aAAa;AACtB;AAAA,EACE;AAAA,EACA,oBAAoB;AAAA,EACpB;AAAA,OACK;AACP,SAAS,gBAAgB;AAEzB,SAAS,mBAAmB;AAQrB,SAAS,mBAAmB;AACjC,SAAO,sBAAsB,UAAU,GAAG;AAC5C;AAEA,eAAsB,4BAA4B,UAAkB,YAAqB;AACvF,SAAO,eAAe,UAAU,UAAU;AAC5C;AAEO,IAAM,8BAA8B;AAEpC,SAAS,wBAAwB,MAAkB;AACxD,SAAO,MAAM,eAAe,IAAI;AAClC;AAEO,SAAS,uBAAuB,MAAc;AACnD,SAAO,MAAM,gBAAgB,IAAI;AACnC;AAMA,eAAsB,8BAA8B,UAAkB,YAAqB;AACzF,QAAM,WAAW,wBAAwB,MAAM,4BAA4B,UAAU,UAAU,CAAC;AAChG,SAAO,YAAY,SAAS,WAAW;AACzC;AAEO,SAAS,yBAAyB,cAAqB,MAAc;AAC1E,QAAM,oBAAoB,YAAY,aAAa,WAAW;AAC9D,QAAM,gBAAgB,oBAAoB,mBAAmB,IAAI;AAEjE,MAAI,aAAa;AACf,UAAM,IAAI,MAAM,uDAAuD;AAEzE,QAAM,kBAAkB,aAAa,OAAO,IAAI;AAChD,SAAO,kCAAkC,eAAe,gBAAgB,iBAAiB;AAC3F;AAEO,SAAS,oBAAoB,MAAuB;AACzD,SAAO,SAAS,SAAS,IAAI;AAC/B;AAEO,SAAS,gBAAgB,UAA2B;AACzD,SAAO,iBAAiB,UAAU,QAAQ;AAC5C;","names":["DerivationPathDepth"]}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@leather.io/crypto",
|
|
3
3
|
"author": "leather.io",
|
|
4
4
|
"description": "Generic crypto utils package for Leather",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.2.0",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"exports": {
|
|
8
8
|
".": "./dist/index.mjs"
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"dependencies": {
|
|
11
11
|
"@scure/bip32": "1.4.0",
|
|
12
12
|
"@scure/bip39": "1.3.0",
|
|
13
|
-
"@leather.io/utils": "0.11.
|
|
13
|
+
"@leather.io/utils": "0.11.1"
|
|
14
14
|
},
|
|
15
15
|
"devDependencies": {
|
|
16
16
|
"@vitest/coverage-istanbul": "0.34.6",
|