@xyo-network/bip39 2.72.9 → 2.73.1

package/dist/docs.json

@@ -18,7 +18,7 @@
 					"fileName": "wordlists/index.ts",
 					"line": 11,
 					"character": 13,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L11"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L11"
 				}
 			],
 			"type": {
@@ -41,7 +41,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 12,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L12"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L12"
 								}
 							],
 							"type": {
@@ -63,7 +63,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 13,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L13"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L13"
 								}
 							],
 							"type": {
@@ -85,7 +85,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 14,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L14"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L14"
 								}
 							],
 							"type": {
@@ -107,7 +107,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 15,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L15"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L15"
 								}
 							],
 							"type": {
@@ -129,7 +129,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 16,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L16"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L16"
 								}
 							],
 							"type": {
@@ -151,7 +151,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 17,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L17"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L17"
 								}
 							],
 							"type": {
@@ -173,7 +173,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 18,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L18"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L18"
 								}
 							],
 							"type": {
@@ -195,7 +195,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 19,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L19"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L19"
 								}
 							],
 							"type": {
@@ -217,7 +217,7 @@
 									"fileName": "wordlists/index.ts",
 									"line": 20,
 									"character": 2,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L20"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L20"
 								}
 							],
 							"type": {
@@ -250,7 +250,7 @@
 							"fileName": "wordlists/index.ts",
 							"line": 11,
 							"character": 25,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/wordlists/index.ts#L11"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/wordlists/index.ts#L11"
 						}
 					]
 				}
@@ -268,7 +268,7 @@
 					"fileName": "index.ts",
 					"line": 99,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L99"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L99"
 				}
 			],
 			"signatures": [
@@ -311,7 +311,7 @@
 							"fileName": "index.ts",
 							"line": 99,
 							"character": 0,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L99"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L99"
 						}
 					],
 					"parameters": [
@@ -380,7 +380,7 @@
 					"fileName": "index.ts",
 					"line": 43,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L43"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L43"
 				}
 			],
 			"signatures": [
@@ -414,7 +414,7 @@
 							"fileName": "index.ts",
 							"line": 43,
 							"character": 0,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L43"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L43"
 						}
 					],
 					"parameters": [
@@ -479,7 +479,7 @@
 					"fileName": "index.ts",
 					"line": 79,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L79"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L79"
 				}
 			],
 			"signatures": [
@@ -513,7 +513,7 @@
 							"fileName": "index.ts",
 							"line": 79,
 							"character": 0,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L79"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L79"
 						}
 					],
 					"parameters": [
@@ -582,7 +582,7 @@
 					"fileName": "index.ts",
 					"line": 129,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L129"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L129"
 				}
 			],
 			"signatures": [
@@ -625,7 +625,7 @@
 							"fileName": "index.ts",
 							"line": 129,
 							"character": 0,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L129"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L129"
 						}
 					],
 					"parameters": [
@@ -703,7 +703,7 @@
 					"fileName": "index.ts",
 					"line": 143,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L143"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L143"
 				}
 			],
 			"signatures": [
@@ -746,7 +746,7 @@
 							"fileName": "index.ts",
 							"line": 143,
 							"character": 0,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L143"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L143"
 						}
 					],
 					"parameters": [
@@ -813,7 +813,7 @@
 					"fileName": "index.ts",
 					"line": 108,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L108"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L108"
 				}
 			],
 			"signatures": [
@@ -844,7 +844,7 @@
 							"fileName": "index.ts",
 							"line": 108,
 							"character": 0,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/a30e48b7307fe/packages/protocol/packages/bip39/src/index.ts#L108"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/ca169d4420ae1/packages/protocol/packages/bip39/src/index.ts#L108"
 						}
 					],
 					"parameters": [

package/dist/index.d.mts

@@ -0,0 +1,77 @@
+declare const wordlists: {
+    czech: string[];
+    english: string[];
+    french: string[];
+    italian: string[];
+    japanese: string[];
+    korean: string[];
+    simplifiedChinese: string[];
+    spanish: string[];
+    traditionalChinese: string[];
+};
+
+/**
+ * Generate x random words. Uses Cryptographically-Secure Random Number Generator.
+ * @param wordlist imported wordlist for specific language
+ * @param strength mnemonic strength 128-256 bits
+ * @example
+ * generateMnemonic(wordlist, 128)
+ * // 'legal winner thank year wave sausage worth useful legal winner thank yellow'
+ */
+declare function generateMnemonic(wordlist: string[], strength?: number): string;
+/**
+ * Reversible: Converts mnemonic string to raw entropy in form of byte array.
+ * @param mnemonic 12-24 words
+ * @param wordlist imported wordlist for specific language
+ * @example
+ * const mnem = 'legal winner thank year wave sausage worth useful legal winner thank yellow';
+ * mnemonicToEntropy(mnem, wordlist)
+ * // Produces
+ * new Uint8Array([
+ *   0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f,
+ *   0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f
+ * ])
+ */
+declare function mnemonicToEntropy(mnemonic: string, wordlist: string[]): Uint8Array;
+/**
+ * Reversible: Converts raw entropy in form of byte array to mnemonic string.
+ * @param entropy byte array
+ * @param wordlist imported wordlist for specific language
+ * @returns 12-24 words
+ * @example
+ * const ent = new Uint8Array([
+ *   0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f,
+ *   0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f
+ * ]);
+ * entropyToMnemonic(ent, wordlist);
+ * // 'legal winner thank year wave sausage worth useful legal winner thank yellow'
+ */
+declare function entropyToMnemonic(entropy: Uint8Array, wordlist: string[]): string;
+/**
+ * Validates mnemonic for being 12-24 words contained in `wordlist`.
+ */
+declare function validateMnemonic(mnemonic: string, wordlist: string[]): boolean;
+/**
+ * Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password.
+ * @param mnemonic 12-24 words
+ * @param passphrase string that will additionally protect the key
+ * @returns 64 bytes of key data
+ * @example
+ * const mnem = 'legal winner thank year wave sausage worth useful legal winner thank yellow';
+ * await mnemonicToSeed(mnem, 'password');
+ * // new Uint8Array([...64 bytes])
+ */
+declare function mnemonicToSeed(mnemonic: string, passphrase?: string): Promise<Uint8Array>;
+/**
+ * Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password.
+ * @param mnemonic 12-24 words
+ * @param passphrase string that will additionally protect the key
+ * @returns 64 bytes of key data
+ * @example
+ * const mnem = 'legal winner thank year wave sausage worth useful legal winner thank yellow';
+ * mnemonicToSeedSync(mnem, 'password');
+ * // new Uint8Array([...64 bytes])
+ */
+declare function mnemonicToSeedSync(mnemonic: string, passphrase?: string): Uint8Array;
+
+export { entropyToMnemonic, generateMnemonic, mnemonicToEntropy, mnemonicToSeed, mnemonicToSeedSync, validateMnemonic, wordlists };

package/dist/{types/index.d.ts → index.d.ts}

@@ -1,4 +1,15 @@
-export * from './wordlists';
+declare const wordlists: {
+    czech: string[];
+    english: string[];
+    french: string[];
+    italian: string[];
+    japanese: string[];
+    korean: string[];
+    simplifiedChinese: string[];
+    spanish: string[];
+    traditionalChinese: string[];
+};
+
 /**
  * Generate x random words. Uses Cryptographically-Secure Random Number Generator.
  * @param wordlist imported wordlist for specific language
@@ -7,7 +18,7 @@ export * from './wordlists';
  * generateMnemonic(wordlist, 128)
  * // 'legal winner thank year wave sausage worth useful legal winner thank yellow'
  */
-export declare function generateMnemonic(wordlist: string[], strength?: number): string;
+declare function generateMnemonic(wordlist: string[], strength?: number): string;
 /**
  * Reversible: Converts mnemonic string to raw entropy in form of byte array.
  * @param mnemonic 12-24 words
@@ -21,7 +32,7 @@ export declare function generateMnemonic(wordlist: string[], strength?: number):
  *   0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f, 0x7f
  * ])
  */
-export declare function mnemonicToEntropy(mnemonic: string, wordlist: string[]): Uint8Array;
+declare function mnemonicToEntropy(mnemonic: string, wordlist: string[]): Uint8Array;
 /**
  * Reversible: Converts raw entropy in form of byte array to mnemonic string.
  * @param entropy byte array
@@ -35,11 +46,11 @@ export declare function mnemonicToEntropy(mnemonic: string, wordlist: string[]):
  * entropyToMnemonic(ent, wordlist);
  * // 'legal winner thank year wave sausage worth useful legal winner thank yellow'
  */
-export declare function entropyToMnemonic(entropy: Uint8Array, wordlist: string[]): string;
+declare function entropyToMnemonic(entropy: Uint8Array, wordlist: string[]): string;
 /**
  * Validates mnemonic for being 12-24 words contained in `wordlist`.
  */
-export declare function validateMnemonic(mnemonic: string, wordlist: string[]): boolean;
+declare function validateMnemonic(mnemonic: string, wordlist: string[]): boolean;
 /**
  * Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password.
  * @param mnemonic 12-24 words
@@ -50,7 +61,7 @@ export declare function validateMnemonic(mnemonic: string, wordlist: string[]):
  * await mnemonicToSeed(mnem, 'password');
  * // new Uint8Array([...64 bytes])
  */
-export declare function mnemonicToSeed(mnemonic: string, passphrase?: string): Promise<Uint8Array>;
+declare function mnemonicToSeed(mnemonic: string, passphrase?: string): Promise<Uint8Array>;
 /**
  * Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password.
  * @param mnemonic 12-24 words
@@ -61,5 +72,6 @@ export declare function mnemonicToSeed(mnemonic: string, passphrase?: string): P
  * mnemonicToSeedSync(mnem, 'password');
  * // new Uint8Array([...64 bytes])
  */
-export declare function mnemonicToSeedSync(mnemonic: string, passphrase?: string): Uint8Array;
-//# sourceMappingURL=index.d.ts.map
+declare function mnemonicToSeedSync(mnemonic: string, passphrase?: string): Uint8Array;
+
+export { entropyToMnemonic, generateMnemonic, mnemonicToEntropy, mnemonicToSeed, mnemonicToSeedSync, validateMnemonic, wordlists };