@metamask-previews/keyring-controller 19.0.2-preview-e5e6db48 → 19.0.2-preview-e96ca40c

package/CHANGELOG.md

@@ -7,10 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Changed
-
-- Bump `@metamask/base-controller` from `^7.0.0` to `^7.1.0` ([#5079](https://github.com/MetaMask/core/pull/5079))
-
 ## [19.0.2]
 
 ### Changed

package/dist/KeyringController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_checkForDuplicate, _KeyringController_setUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
+var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_checkForDuplicate, _KeyringController_setUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringController = exports.getDefaultKeyringState = exports.keyringBuilderFactory = exports.SignTypedDataVersion = exports.AccountImportStrategy = exports.isCustodyKeyring = exports.KeyringTypes = void 0;
 const util_1 = require("@ethereumjs/util");
@@ -300,16 +300,17 @@ class KeyringController extends base_controller_1.BaseController {
      * Adds a new account to the default (first) HD seed phrase keyring.
      *
      * @param accountCount - Number of accounts before adding a new one, used to
+     * @param typeIndex - The id of the keyring to add the account to.
      * make the method idempotent.
      * @returns Promise resolving to the added account address.
      */
-    async addNewAccount(accountCount) {
+    async addNewAccount(accountCount, typeIndex) {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            const primaryKeyring = this.getKeyringsByType('HD Key Tree')[0];
-            if (!primaryKeyring) {
+            const selectedKeyring = this.getKeyringsByType('HD Key Tree')[typeIndex ?? 0];
+            if (!selectedKeyring) {
                 throw new Error('No HD keyring found');
             }
-            const oldAccounts = await primaryKeyring.getAccounts();
+            const oldAccounts = await selectedKeyring.getAccounts();
             if (accountCount && oldAccounts.length !== accountCount) {
                 if (accountCount > oldAccounts.length) {
                     throw new Error('Account out of sequence');
@@ -321,8 +322,8 @@ class KeyringController extends base_controller_1.BaseController {
                 }
                 return existingAccount;
             }
-            const [addedAccountAddress] = await primaryKeyring.addAccounts(1);
-            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this);
+            const [addedAccountAddress] = await selectedKeyring.addAccounts(1);
+            await this.verifySeedPhrase(typeIndex ?? 0);
             return addedAccountAddress;
         });
     }
@@ -375,6 +376,14 @@ class KeyringController extends base_controller_1.BaseController {
             });
         });
     }
+    async createKeyringFromMnemonic(mnemonic) {
+        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
+            return await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyringWithFirstAccount).call(this, KeyringTypes.hd, {
+                mnemonic,
+                numberOfAccounts: 1,
+            });
+        });
+    }
     /**
      * Create a new vault and primary keyring.
      *
@@ -431,12 +440,21 @@ class KeyringController extends base_controller_1.BaseController {
      * Gets the seed phrase of the HD keyring.
      *
      * @param password - Password of the keyring.
+     * @param typeIndex - The index of the keyring type.
      * @returns Promise resolving to the seed phrase.
      */
-    async exportSeedPhrase(password) {
+    async exportSeedPhrase(password, typeIndex) {
         await this.verifyPassword(password);
-        assertHasUint8ArrayMnemonic(__classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0]);
-        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0].mnemonic;
+        if (!typeIndex) {
+            assertHasUint8ArrayMnemonic(__classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0]);
+            return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0].mnemonic;
+        }
+        const selectedKeyring = __classPrivateFieldGet(this, _KeyringController_keyrings, "f").filter((keyring) => keyring.type === KeyringTypes.hd)[typeIndex];
+        if (!selectedKeyring) {
+            throw new Error('Keyring not found');
+        }
+        assertHasUint8ArrayMnemonic(selectedKeyring);
+        return selectedKeyring.mnemonic;
     }
     /**
      * Gets the private key from the keyring controlling an address.
@@ -456,10 +474,15 @@ class KeyringController extends base_controller_1.BaseController {
     /**
      * Returns the public addresses of all accounts from every keyring.
      *
+     * @param keyringIndex - The index of the keyring to get the accounts from.
      * @returns A promise resolving to an array of addresses.
      */
-    async getAccounts() {
-        return this.state.keyrings.reduce((accounts, keyring) => accounts.concat(keyring.accounts), []);
+    async getAccounts(keyringIndex) {
+        const keyrings = this.state.keyrings.filter((keyring) => keyring.type === KeyringTypes.hd);
+        if (keyringIndex) {
+            return keyrings[keyringIndex].accounts;
+        }
+        return keyrings.reduce((accounts, keyring) => accounts.concat(keyring.accounts), []);
     }
     /**
      * Get encryption public key.
@@ -837,10 +860,43 @@ class KeyringController extends base_controller_1.BaseController {
     /**
      * Verifies the that the seed phrase restores the current keychain's accounts.
      *
+     * @param typeIndex - The index of the keyring to verify.
      * @returns Promise resolving to the seed phrase as Uint8Array.
      */
-    async verifySeedPhrase() {
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this));
+    async verifySeedPhrase(typeIndex) {
+        const primaryKeyring = this.getKeyringsByType(KeyringTypes.hd)[typeIndex ?? 0];
+        if (!primaryKeyring) {
+            throw new Error('No HD keyring found.');
+        }
+        assertHasUint8ArrayMnemonic(primaryKeyring);
+        const seedWords = primaryKeyring.mnemonic;
+        const accounts = await primaryKeyring.getAccounts();
+        /* istanbul ignore if */
+        if (accounts.length === 0) {
+            throw new Error('Cannot verify an empty keyring.');
+        }
+        // The HD Keyring Builder is a default keyring builder
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const hdKeyringBuilder = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringBuilderForType).call(this, KeyringTypes.hd);
+        const hdKeyring = hdKeyringBuilder();
+        // @ts-expect-error @metamask/eth-hd-keyring correctly handles
+        // Uint8Array seed phrases in the `deserialize` method.
+        await hdKeyring.deserialize({
+            mnemonic: seedWords,
+            numberOfAccounts: accounts.length,
+        });
+        const testAccounts = await hdKeyring.getAccounts();
+        /* istanbul ignore if */
+        if (testAccounts.length !== accounts.length) {
+            throw new Error('Seed phrase imported incorrect number of accounts.');
+        }
+        testAccounts.forEach((account, i) => {
+            /* istanbul ignore if */
+            if (account.toLowerCase() !== accounts[i].toLowerCase()) {
+                throw new Error('Seed phrase imported different accounts.');
+            }
+        });
+        return seedWords;
     }
     async withKeyring(selector, operation, options = {
         createIfMissing: false,
@@ -1124,47 +1180,6 @@ async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyringWithFirstAccount).call(this, keyring.type, keyring.opts);
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
-}, _KeyringController_verifySeedPhrase = 
-/**
- * Internal non-exclusive method to verify the seed phrase.
- *
- * @returns A promise resolving to the seed phrase as Uint8Array.
- */
-async function _KeyringController_verifySeedPhrase() {
-    __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
-    const primaryKeyring = this.getKeyringsByType(KeyringTypes.hd)[0];
-    if (!primaryKeyring) {
-        throw new Error('No HD keyring found.');
-    }
-    assertHasUint8ArrayMnemonic(primaryKeyring);
-    const seedWords = primaryKeyring.mnemonic;
-    const accounts = await primaryKeyring.getAccounts();
-    /* istanbul ignore if */
-    if (accounts.length === 0) {
-        throw new Error('Cannot verify an empty keyring.');
-    }
-    // The HD Keyring Builder is a default keyring builder
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const hdKeyringBuilder = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringBuilderForType).call(this, KeyringTypes.hd);
-    const hdKeyring = hdKeyringBuilder();
-    // @ts-expect-error @metamask/eth-hd-keyring correctly handles
-    // Uint8Array seed phrases in the `deserialize` method.
-    await hdKeyring.deserialize({
-        mnemonic: seedWords,
-        numberOfAccounts: accounts.length,
-    });
-    const testAccounts = await hdKeyring.getAccounts();
-    /* istanbul ignore if */
-    if (testAccounts.length !== accounts.length) {
-        throw new Error('Seed phrase imported incorrect number of accounts.');
-    }
-    testAccounts.forEach((account, i) => {
-        /* istanbul ignore if */
-        if (account.toLowerCase() !== accounts[i].toLowerCase()) {
-            throw new Error('Seed phrase imported different accounts.');
-        }
-    });
-    return seedWords;
 }, _KeyringController_getUpdatedKeyrings = 
 /**
  * Get the updated array of each keyring's type and
@@ -1360,6 +1375,7 @@ async function _KeyringController_createKeyringWithFirstAccount(type, opts) {
     if (!firstAccount) {
         throw new Error(constants_1.KeyringControllerError.NoFirstAccount);
     }
+    return firstAccount;
 }, _KeyringController_newKeyring = 
 /**
  * Instantiate, initialize and return a new keyring of the given `type`,