fix: handle mnemonic as object

Author: gantunesr

packages/keyring-eth-hd/src/hd-keyring.test.ts

@@ -340,6 +340,29 @@ describe('hd-keyring', () => {
       expect(accounts[0]).toStrictEqual(firstAcct);
     });
 
+    it('validates mnemonic passed as plain object (simulating encryption/decryption cycle)', async () => {
+      const keyring = new HdKeyring();
+
+      const tempKeyring = new HdKeyring();
+      await tempKeyring.deserialize({ mnemonic: sampleMnemonic });
+      const { mnemonic } = tempKeyring;
+      assert(mnemonic, 'Mnemonic should be defined');
+
+      const mnemonicAsPlainObject: Record<string, number> = {};
+      mnemonic.forEach((value, index) => {
+        mnemonicAsPlainObject[index] = value;
+      });
+
+      await keyring.deserialize({
+        // @ts-expect-error testing plain object mnemonic directly
+        mnemonic: mnemonicAsPlainObject,
+        numberOfAccounts: 1,
+      });
+
+      const accounts = await keyring.getAccounts();
+      expect(accounts[0]).toStrictEqual(firstAcct);
+    });
+
     it('throws when numberOfAccounts is passed with no mnemonic', async () => {
       const keyring = new HdKeyring();
 

packages/keyring-eth-hd/src/hd-keyring.ts

@@ -38,6 +38,8 @@ import { keccak256 } from 'ethereum-cryptography/keccak';
 const hdPathString = `m/44'/60'/0'/0`;
 const type = 'HD Key Tree';
 
+type Mnemonic = string | number[] | SerializedBuffer | Buffer | Uint8Array;
+
 export type HDKeyringOptions = {
   cryptographicFunctions?: CryptographicFunctions;
 };
@@ -601,9 +603,7 @@ export class HdKeyring implements Keyring {
    * as a string, an array of UTF-8 bytes, or a Buffer. Mnemonic input
    * passed as type buffer or array of UTF-8 bytes must be NFKD normalized.
    */
-  async #initFromMnemonic(
-    mnemonic: string | number[] | SerializedBuffer | Buffer | Uint8Array,
-  ): Promise<void> {
+  async #initFromMnemonic(mnemonic: Mnemonic): Promise<void> {
     if (this.root) {
       throw new Error(
         'Eth-Hd-Keyring: Secret recovery phrase already provided',
@@ -652,9 +652,7 @@ export class HdKeyring implements Keyring {
    * @param mnemonic - The mnemonic seed phrase to validate.
    * @throws If the mnemonic is invalid.
    */
-  #isValidMnemonic(
-    mnemonic: string | number[] | SerializedBuffer | Buffer | Uint8Array,
-  ): void {
+  #isValidMnemonic(mnemonic: Mnemonic): void {
     let mnemonicString: string;
 
     if (typeof mnemonic === 'string') {
@@ -667,6 +665,13 @@ export class HdKeyring implements Keyring {
       mnemonicString = mnemonic.toString();
     } else if (mnemonic instanceof Uint8Array) {
       mnemonicString = this.#uint8ArrayToString(mnemonic);
+    } else if (typeof mnemonic === 'object') {
+      // When encrypted/decrypted, Uint8Arrays can become plain objects like {0: ..., 1: ..., ...}
+      // Convert back to Uint8Array first, then to mnemonic string
+      const mnemonicAsUint8Array = Uint8Array.from(
+        Object.values(mnemonic as Record<string, number>),
+      );
+      mnemonicString = this.#uint8ArrayToString(mnemonicAsUint8Array);
     } else {
       throw new Error('Eth-Hd-Keyring: Invalid mnemonic format');
     }

yarn.lock

@@ -673,16 +673,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@ethersproject/basex@npm:^5.8.0":
-  version: 5.8.0
-  resolution: "@ethersproject/basex@npm:5.8.0"
-  dependencies:
-    "@ethersproject/bytes": "npm:^5.8.0"
-    "@ethersproject/properties": "npm:^5.8.0"
-  checksum: 10/1a8d48a9397461ea42ec43b69a15a0d13ba0b9192695713750d9d391503c55b258cca435fa78a4014d23a813053f1a471593b89c7c0d89351639a78d50a12ef2
-  languageName: node
-  linkType: hard
-
 "@ethersproject/bignumber@npm:^5.7.0, @ethersproject/bignumber@npm:^5.8.0":
   version: 5.8.0
   resolution: "@ethersproject/bignumber@npm:5.8.0"
@@ -712,7 +702,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@ethersproject/hash@npm:^5.7.0, @ethersproject/hash@npm:^5.8.0":
+"@ethersproject/hash@npm:^5.7.0":
   version: 5.8.0
   resolution: "@ethersproject/hash@npm:5.8.0"
   dependencies:
@@ -729,26 +719,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@ethersproject/hdnode@npm:^5.8.0":
-  version: 5.8.0
-  resolution: "@ethersproject/hdnode@npm:5.8.0"
-  dependencies:
-    "@ethersproject/abstract-signer": "npm:^5.8.0"
-    "@ethersproject/basex": "npm:^5.8.0"
-    "@ethersproject/bignumber": "npm:^5.8.0"
-    "@ethersproject/bytes": "npm:^5.8.0"
-    "@ethersproject/logger": "npm:^5.8.0"
-    "@ethersproject/pbkdf2": "npm:^5.8.0"
-    "@ethersproject/properties": "npm:^5.8.0"
-    "@ethersproject/sha2": "npm:^5.8.0"
-    "@ethersproject/signing-key": "npm:^5.8.0"
-    "@ethersproject/strings": "npm:^5.8.0"
-    "@ethersproject/transactions": "npm:^5.8.0"
-    "@ethersproject/wordlists": "npm:^5.8.0"
-  checksum: 10/55b35cf30f0dd40e2d5ecd4b2f005ebea82a85a440717a61d4a483074f652d2c7063e9c704272b894bfdd500f7883aa36692931c6808591f702c1da7107ebb61
-  languageName: node
-  linkType: hard
-
 "@ethersproject/keccak256@npm:^5.7.0, @ethersproject/keccak256@npm:^5.8.0":
   version: 5.8.0
   resolution: "@ethersproject/keccak256@npm:5.8.0"
@@ -775,16 +745,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@ethersproject/pbkdf2@npm:^5.8.0":
-  version: 5.8.0
-  resolution: "@ethersproject/pbkdf2@npm:5.8.0"
-  dependencies:
-    "@ethersproject/bytes": "npm:^5.8.0"
-    "@ethersproject/sha2": "npm:^5.8.0"
-  checksum: 10/203bb992eec3042256702f4c8259a37202af7b341cc6e370614cdc52541042fc3b795fb040592bd6be8b67376a798c45312ca1e6d5d179c3e8eb7431882f1fd1
-  languageName: node
-  linkType: hard
-
 "@ethersproject/properties@npm:^5.7.0, @ethersproject/properties@npm:^5.8.0":
   version: 5.8.0
   resolution: "@ethersproject/properties@npm:5.8.0"
@@ -804,17 +764,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@ethersproject/sha2@npm:^5.8.0":
-  version: 5.8.0
-  resolution: "@ethersproject/sha2@npm:5.8.0"
-  dependencies:
-    "@ethersproject/bytes": "npm:^5.8.0"
-    "@ethersproject/logger": "npm:^5.8.0"
-    hash.js: "npm:1.1.7"
-  checksum: 10/ef8916e3033502476fba9358ba1993722ac3bb99e756d5681e4effa3dfa0f0bf0c29d3fa338662830660b45dd359cccb06ba40bc7b62cfd44f4a177b25829404
-  languageName: node
-  linkType: hard
-
 "@ethersproject/signing-key@npm:^5.8.0":
   version: 5.8.0
   resolution: "@ethersproject/signing-key@npm:5.8.0"
@@ -870,19 +819,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@ethersproject/wordlists@npm:^5.8.0":
-  version: 5.8.0
-  resolution: "@ethersproject/wordlists@npm:5.8.0"
-  dependencies:
-    "@ethersproject/bytes": "npm:^5.8.0"
-    "@ethersproject/hash": "npm:^5.8.0"
-    "@ethersproject/logger": "npm:^5.8.0"
-    "@ethersproject/properties": "npm:^5.8.0"
-    "@ethersproject/strings": "npm:^5.8.0"
-  checksum: 10/b8e6aa7d2195bb568847f360f6525ddc3d145404fbd4553e2e05daf4a95f58167591feb69e16e3398a28114ea85e1895fc8f5bd1c0cbf8b578123d7c1d21c32d
-  languageName: node
-  linkType: hard
-
 "@fivebinaries/coin-selection@npm:3.0.0":
   version: 3.0.0
   resolution: "@fivebinaries/coin-selection@npm:3.0.0"
@@ -1748,7 +1684,6 @@ __metadata:
   dependencies:
     "@ethereumjs/tx": "npm:^5.4.0"
     "@ethereumjs/util": "npm:^9.1.0"
-    "@ethersproject/hdnode": "npm:^5.8.0"
     "@lavamoat/allow-scripts": "npm:^3.2.1"
     "@lavamoat/preinstall-always-fail": "npm:^2.1.0"
     "@metamask/account-api": "workspace:^"