KeyringController.verifySeedPhrase should return a Uint8Array (#1338)

* refactor: verifySeedPhrase should return a Uint8Array * refactor: verifySeedPhrase should return a Uint8Array * docs: update jsdoc
MetaMask · Oct 11, 2023 · cd5385c · cd5385c
1 parent ccbf1ff
commit cd5385c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/packages/keyring-controller/src/KeyringController.test.ts b/packages/keyring-controller/src/KeyringController.test.ts
@@ -877,6 +877,11 @@ describe('KeyringController', () => {
       const seedPhrase = await keyringController.verifySeedPhrase();
       expect(seedPhrase).toBeDefined();
     });
+
+    it('should return current seedphrase as Uint8Array', async () => {
+      const seedPhrase = await keyringController.verifySeedPhrase();
+      expect(seedPhrase).toBeInstanceOf(Uint8Array);
+    });
   });
 
   describe('validatePassword', () => {

diff --git a/packages/keyring-controller/src/KeyringController.ts b/packages/keyring-controller/src/KeyringController.ts
@@ -621,16 +621,16 @@ export class KeyringController extends BaseController<
   /**
    * Verifies the that the seed phrase restores the current keychain's accounts.
    *
-   * @returns Whether the verification succeeds.
+   * @returns Promise resolving to the seed phrase as Uint8Array.
    */
-  async verifySeedPhrase(): Promise<string> {
+  async verifySeedPhrase(): Promise<Uint8Array> {
     const primaryKeyring = this.#keyring.getKeyringsByType(KeyringTypes.hd)[0];
     /* istanbul ignore if */
     if (!primaryKeyring) {
       throw new Error('No HD keyring found.');
     }
 
-    const seedWords = (await primaryKeyring.serialize()).mnemonic;
+    const seedWords = primaryKeyring.mnemonic;
     const accounts = await primaryKeyring.getAccounts();
     /* istanbul ignore if */
     if (accounts.length === 0) {