@metamask/keyring-sdk 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0]
+
+### Added
+
+- Add `decodeMnemonic` and `decodeMnemonicWords` ([#612](https://github.com/MetaMask/accounts/pull/612))
+
 ## [3.0.0]
 
 ### Added
@@ -114,7 +120,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release, extracted from `@metamask/keyring-api` ([#478](https://github.com/MetaMask/accounts/pull/478), [#482](https://github.com/MetaMask/accounts/pull/482))
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@3.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@3.1.0...HEAD
+[3.1.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@3.0.0...@metamask/keyring-sdk@3.1.0
 [3.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.3.0...@metamask/keyring-sdk@3.0.0
 [2.3.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.2.0...@metamask/keyring-sdk@2.3.0
 [2.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.1.1...@metamask/keyring-sdk@2.2.0

package/dist/mnemonic.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeMnemonic = exports.encodeMnemonicWords = void 0;
+exports.decodeMnemonic = exports.decodeMnemonicWords = exports.encodeMnemonic = exports.encodeMnemonicWords = void 0;
 const english_1 = require("@metamask/scure-bip39/dist/wordlists/english.js");
 /**
  * Encodes a mnemonic as a string of words.
@@ -27,4 +27,39 @@ function encodeMnemonic(mnemonicIndicesBytes) {
     return Array.from(new TextEncoder().encode(encodeMnemonicWords(mnemonicIndicesBytes)));
 }
 exports.encodeMnemonic = encodeMnemonic;
+/**
+ * Decodes a string of mnemonic words as an array of bytes (16-bit unsigned
+ * integers) representing the indices of the words in the mnemonic.
+ *
+ * @param mnemonic - A string representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+function decodeMnemonicWords(mnemonic) {
+    if (mnemonic === '') {
+        return new Uint8Array();
+    }
+    const mnemonicIndices = mnemonic.split(' ').map((word) => {
+        const index = english_1.wordlist.indexOf(word);
+        if (index === -1) {
+            throw new Error(`Invalid mnemonic word: "${word}"`);
+        }
+        return index;
+    });
+    return new Uint8Array(new Uint16Array(mnemonicIndices).buffer);
+}
+exports.decodeMnemonicWords = decodeMnemonicWords;
+/**
+ * Decodes an array of bytes (UTF-8) representing a mnemonic as an array of
+ * bytes (16-bit unsigned integers) representing the indices of the words in
+ * the mnemonic.
+ *
+ * @param mnemonicBytes - An array of bytes (UTF-8) representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+function decodeMnemonic(mnemonicBytes) {
+    return decodeMnemonicWords(new TextDecoder().decode(mnemonicBytes));
+}
+exports.decodeMnemonic = decodeMnemonic;
 //# sourceMappingURL=mnemonic.cjs.map

package/dist/mnemonic.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"mnemonic.cjs","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":";;;AAAA,6EAAwE;AAExE;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,oBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI;IAChC,0EAA0E;IAC1E,iEAAiE;IACjE,oBAAoB;IACpB,IAAI,WAAW,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAC7D,CAAC;IACF,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AARD,kDAQC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,oBAAgC;IAC7D,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC;AAJD,wCAIC","sourcesContent":["import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';\n\n/**\n * Encodes a mnemonic as a string of words.\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns A string representing the mnemonic.\n */\nexport function encodeMnemonicWords(mnemonicIndicesBytes: Uint8Array): string {\n  const mnemonicIndices = Array.from(\n    // Create a new `Uint8Array` to ensure we have a proper view on the buffer\n    // without having to worry about `byteOffset` and `byteLength` of\n    // the inner buffer.\n    new Uint16Array(new Uint8Array(mnemonicIndicesBytes).buffer),\n  );\n  return mnemonicIndices.map((i) => wordlist[i]).join(' ');\n}\n\n/**\n * Encodes a mnemonic as an array of bytes (UTF-8).\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns An array of bytes (UTF-8) representing the mnemonic.\n */\nexport function encodeMnemonic(mnemonicIndicesBytes: Uint8Array): number[] {\n  return Array.from(\n    new TextEncoder().encode(encodeMnemonicWords(mnemonicIndicesBytes)),\n  );\n}\n"]}
+{"version":3,"file":"mnemonic.cjs","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":";;;AAAA,6EAAwE;AAExE;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,oBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI;IAChC,0EAA0E;IAC1E,iEAAiE;IACjE,oBAAoB;IACpB,IAAI,WAAW,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAC7D,CAAC;IACF,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AARD,kDAQC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,oBAAgC;IAC7D,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC;AAJD,wCAIC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;QACpB,OAAO,IAAI,UAAU,EAAE,CAAC;IAC1B,CAAC;IAED,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvD,MAAM,KAAK,GAAG,kBAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,GAAG,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,UAAU,CAAC,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AACjE,CAAC;AAdD,kDAcC;AAED;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAAC,aAAyB;IACtD,OAAO,mBAAmB,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;AACtE,CAAC;AAFD,wCAEC","sourcesContent":["import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';\n\n/**\n * Encodes a mnemonic as a string of words.\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns A string representing the mnemonic.\n */\nexport function encodeMnemonicWords(mnemonicIndicesBytes: Uint8Array): string {\n  const mnemonicIndices = Array.from(\n    // Create a new `Uint8Array` to ensure we have a proper view on the buffer\n    // without having to worry about `byteOffset` and `byteLength` of\n    // the inner buffer.\n    new Uint16Array(new Uint8Array(mnemonicIndicesBytes).buffer),\n  );\n  return mnemonicIndices.map((i) => wordlist[i]).join(' ');\n}\n\n/**\n * Encodes a mnemonic as an array of bytes (UTF-8).\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns An array of bytes (UTF-8) representing the mnemonic.\n */\nexport function encodeMnemonic(mnemonicIndicesBytes: Uint8Array): number[] {\n  return Array.from(\n    new TextEncoder().encode(encodeMnemonicWords(mnemonicIndicesBytes)),\n  );\n}\n\n/**\n * Decodes a string of mnemonic words as an array of bytes (16-bit unsigned\n * integers) representing the indices of the words in the mnemonic.\n *\n * @param mnemonic - A string representing the mnemonic.\n * @returns An array of bytes representing the indices of the words in the mnemonic.\n * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.\n */\nexport function decodeMnemonicWords(mnemonic: string): Uint8Array {\n  if (mnemonic === '') {\n    return new Uint8Array();\n  }\n\n  const mnemonicIndices = mnemonic.split(' ').map((word) => {\n    const index = wordlist.indexOf(word);\n    if (index === -1) {\n      throw new Error(`Invalid mnemonic word: \"${word}\"`);\n    }\n    return index;\n  });\n\n  return new Uint8Array(new Uint16Array(mnemonicIndices).buffer);\n}\n\n/**\n * Decodes an array of bytes (UTF-8) representing a mnemonic as an array of\n * bytes (16-bit unsigned integers) representing the indices of the words in\n * the mnemonic.\n *\n * @param mnemonicBytes - An array of bytes (UTF-8) representing the mnemonic.\n * @returns An array of bytes representing the indices of the words in the mnemonic.\n * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.\n */\nexport function decodeMnemonic(mnemonicBytes: Uint8Array): Uint8Array {\n  return decodeMnemonicWords(new TextDecoder().decode(mnemonicBytes));\n}\n"]}

package/dist/mnemonic.d.cts

@@ -12,4 +12,23 @@ export declare function encodeMnemonicWords(mnemonicIndicesBytes: Uint8Array): s
  * @returns An array of bytes (UTF-8) representing the mnemonic.
  */
 export declare function encodeMnemonic(mnemonicIndicesBytes: Uint8Array): number[];
+/**
+ * Decodes a string of mnemonic words as an array of bytes (16-bit unsigned
+ * integers) representing the indices of the words in the mnemonic.
+ *
+ * @param mnemonic - A string representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+export declare function decodeMnemonicWords(mnemonic: string): Uint8Array;
+/**
+ * Decodes an array of bytes (UTF-8) representing a mnemonic as an array of
+ * bytes (16-bit unsigned integers) representing the indices of the words in
+ * the mnemonic.
+ *
+ * @param mnemonicBytes - An array of bytes (UTF-8) representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+export declare function decodeMnemonic(mnemonicBytes: Uint8Array): Uint8Array;
 //# sourceMappingURL=mnemonic.d.cts.map

package/dist/mnemonic.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"mnemonic.d.cts","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,CAQ5E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,EAAE,CAIzE"}
+{"version":3,"file":"mnemonic.d.cts","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,CAQ5E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,EAAE,CAIzE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAchE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,UAAU,GAAG,UAAU,CAEpE"}

package/dist/mnemonic.d.mts

@@ -12,4 +12,23 @@ export declare function encodeMnemonicWords(mnemonicIndicesBytes: Uint8Array): s
  * @returns An array of bytes (UTF-8) representing the mnemonic.
  */
 export declare function encodeMnemonic(mnemonicIndicesBytes: Uint8Array): number[];
+/**
+ * Decodes a string of mnemonic words as an array of bytes (16-bit unsigned
+ * integers) representing the indices of the words in the mnemonic.
+ *
+ * @param mnemonic - A string representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+export declare function decodeMnemonicWords(mnemonic: string): Uint8Array;
+/**
+ * Decodes an array of bytes (UTF-8) representing a mnemonic as an array of
+ * bytes (16-bit unsigned integers) representing the indices of the words in
+ * the mnemonic.
+ *
+ * @param mnemonicBytes - An array of bytes (UTF-8) representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+export declare function decodeMnemonic(mnemonicBytes: Uint8Array): Uint8Array;
 //# sourceMappingURL=mnemonic.d.mts.map

package/dist/mnemonic.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"mnemonic.d.mts","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,CAQ5E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,EAAE,CAIzE"}
+{"version":3,"file":"mnemonic.d.mts","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,CAQ5E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,oBAAoB,EAAE,UAAU,GAAG,MAAM,EAAE,CAIzE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAchE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,UAAU,GAAG,UAAU,CAEpE"}

package/dist/mnemonic.mjs

@@ -22,4 +22,37 @@ export function encodeMnemonicWords(mnemonicIndicesBytes) {
 export function encodeMnemonic(mnemonicIndicesBytes) {
     return Array.from(new TextEncoder().encode(encodeMnemonicWords(mnemonicIndicesBytes)));
 }
+/**
+ * Decodes a string of mnemonic words as an array of bytes (16-bit unsigned
+ * integers) representing the indices of the words in the mnemonic.
+ *
+ * @param mnemonic - A string representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+export function decodeMnemonicWords(mnemonic) {
+    if (mnemonic === '') {
+        return new Uint8Array();
+    }
+    const mnemonicIndices = mnemonic.split(' ').map((word) => {
+        const index = wordlist.indexOf(word);
+        if (index === -1) {
+            throw new Error(`Invalid mnemonic word: "${word}"`);
+        }
+        return index;
+    });
+    return new Uint8Array(new Uint16Array(mnemonicIndices).buffer);
+}
+/**
+ * Decodes an array of bytes (UTF-8) representing a mnemonic as an array of
+ * bytes (16-bit unsigned integers) representing the indices of the words in
+ * the mnemonic.
+ *
+ * @param mnemonicBytes - An array of bytes (UTF-8) representing the mnemonic.
+ * @returns An array of bytes representing the indices of the words in the mnemonic.
+ * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.
+ */
+export function decodeMnemonic(mnemonicBytes) {
+    return decodeMnemonicWords(new TextDecoder().decode(mnemonicBytes));
+}
 //# sourceMappingURL=mnemonic.mjs.map

package/dist/mnemonic.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"mnemonic.mjs","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,wDAAqD;AAExE;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,oBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI;IAChC,0EAA0E;IAC1E,iEAAiE;IACjE,oBAAoB;IACpB,IAAI,WAAW,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAC7D,CAAC;IACF,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,oBAAgC;IAC7D,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC","sourcesContent":["import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';\n\n/**\n * Encodes a mnemonic as a string of words.\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns A string representing the mnemonic.\n */\nexport function encodeMnemonicWords(mnemonicIndicesBytes: Uint8Array): string {\n  const mnemonicIndices = Array.from(\n    // Create a new `Uint8Array` to ensure we have a proper view on the buffer\n    // without having to worry about `byteOffset` and `byteLength` of\n    // the inner buffer.\n    new Uint16Array(new Uint8Array(mnemonicIndicesBytes).buffer),\n  );\n  return mnemonicIndices.map((i) => wordlist[i]).join(' ');\n}\n\n/**\n * Encodes a mnemonic as an array of bytes (UTF-8).\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns An array of bytes (UTF-8) representing the mnemonic.\n */\nexport function encodeMnemonic(mnemonicIndicesBytes: Uint8Array): number[] {\n  return Array.from(\n    new TextEncoder().encode(encodeMnemonicWords(mnemonicIndicesBytes)),\n  );\n}\n"]}
+{"version":3,"file":"mnemonic.mjs","sourceRoot":"","sources":["../src/mnemonic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,wDAAqD;AAExE;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,oBAAgC;IAClE,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI;IAChC,0EAA0E;IAC1E,iEAAiE;IACjE,oBAAoB;IACpB,IAAI,WAAW,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAC7D,CAAC;IACF,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,oBAAgC;IAC7D,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAgB;IAClD,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;QACpB,OAAO,IAAI,UAAU,EAAE,CAAC;IAC1B,CAAC;IAED,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,GAAG,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,UAAU,CAAC,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,aAAyB;IACtD,OAAO,mBAAmB,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;AACtE,CAAC","sourcesContent":["import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';\n\n/**\n * Encodes a mnemonic as a string of words.\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns A string representing the mnemonic.\n */\nexport function encodeMnemonicWords(mnemonicIndicesBytes: Uint8Array): string {\n  const mnemonicIndices = Array.from(\n    // Create a new `Uint8Array` to ensure we have a proper view on the buffer\n    // without having to worry about `byteOffset` and `byteLength` of\n    // the inner buffer.\n    new Uint16Array(new Uint8Array(mnemonicIndicesBytes).buffer),\n  );\n  return mnemonicIndices.map((i) => wordlist[i]).join(' ');\n}\n\n/**\n * Encodes a mnemonic as an array of bytes (UTF-8).\n *\n * @param mnemonicIndicesBytes - An array of bytes (16-bit unsigned integers) representing the indices of the words in the mnemonic.\n * @returns An array of bytes (UTF-8) representing the mnemonic.\n */\nexport function encodeMnemonic(mnemonicIndicesBytes: Uint8Array): number[] {\n  return Array.from(\n    new TextEncoder().encode(encodeMnemonicWords(mnemonicIndicesBytes)),\n  );\n}\n\n/**\n * Decodes a string of mnemonic words as an array of bytes (16-bit unsigned\n * integers) representing the indices of the words in the mnemonic.\n *\n * @param mnemonic - A string representing the mnemonic.\n * @returns An array of bytes representing the indices of the words in the mnemonic.\n * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.\n */\nexport function decodeMnemonicWords(mnemonic: string): Uint8Array {\n  if (mnemonic === '') {\n    return new Uint8Array();\n  }\n\n  const mnemonicIndices = mnemonic.split(' ').map((word) => {\n    const index = wordlist.indexOf(word);\n    if (index === -1) {\n      throw new Error(`Invalid mnemonic word: \"${word}\"`);\n    }\n    return index;\n  });\n\n  return new Uint8Array(new Uint16Array(mnemonicIndices).buffer);\n}\n\n/**\n * Decodes an array of bytes (UTF-8) representing a mnemonic as an array of\n * bytes (16-bit unsigned integers) representing the indices of the words in\n * the mnemonic.\n *\n * @param mnemonicBytes - An array of bytes (UTF-8) representing the mnemonic.\n * @returns An array of bytes representing the indices of the words in the mnemonic.\n * @throws If the mnemonic contains a word that is not in the English BIP-39 wordlist.\n */\nexport function decodeMnemonic(mnemonicBytes: Uint8Array): Uint8Array {\n  return decodeMnemonicWords(new TextDecoder().decode(mnemonicBytes));\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-sdk",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "MetaMask Keyring SDK",
   "keywords": [
     "keyring",