@metamask-previews/keyring-controller 19.0.2-preview-579728ba → 19.0.2-preview-e218ba33

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_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_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;
 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");
@@ -48,7 +48,6 @@ const eth_simple_keyring_1 = __importDefault(require("@metamask/eth-simple-keyri
 const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
 const ethereumjs_wallet_1 = __importStar(require("ethereumjs-wallet"));
-const ulid_1 = require("ulid");
 const constants_1 = require("./constants.cjs");
 const name = 'KeyringController';
 /**
@@ -200,14 +199,11 @@ function isSerializedKeyringsArray(array) {
  */
 async function displayForKeyring(keyring) {
     const accounts = await keyring.getAccounts();
-    const { opts } = keyring;
     return {
         type: keyring.type,
         // Cast to `string[]` here is safe here because `accounts` has no nullish
         // values, and `normalize` returns `string` unless given a nullish value
         accounts: accounts.map(normalize),
-        typeIndex: opts?.typeIndex,
-        id: opts?.id,
     };
 }
 /**
@@ -304,23 +300,16 @@ 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 keyringId - 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, keyringId) {
+    async addNewAccount(accountCount) {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            let selectedKeyring;
-            if (keyringId) {
-                selectedKeyring = this.getKeyringById(keyringId);
-            }
-            else {
-                selectedKeyring = this.getKeyringsByType('HD Key Tree')[0];
-            }
-            if (!selectedKeyring) {
+            const primaryKeyring = this.getKeyringsByType('HD Key Tree')[0];
+            if (!primaryKeyring) {
                 throw new Error('No HD keyring found');
             }
-            const oldAccounts = await selectedKeyring.getAccounts();
+            const oldAccounts = await primaryKeyring.getAccounts();
             if (accountCount && oldAccounts.length !== accountCount) {
                 if (accountCount > oldAccounts.length) {
                     throw new Error('Account out of sequence');
@@ -332,8 +321,8 @@ class KeyringController extends base_controller_1.BaseController {
                 }
                 return existingAccount;
             }
-            const [addedAccountAddress] = await selectedKeyring.addAccounts(1);
-            await this.verifySeedPhrase();
+            const [addedAccountAddress] = await primaryKeyring.addAccounts(1);
+            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this);
             return addedAccountAddress;
         });
     }
@@ -386,14 +375,6 @@ 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.
      *
@@ -475,13 +456,10 @@ class KeyringController extends base_controller_1.BaseController {
     /**
      * Returns the public addresses of all accounts from every keyring.
      *
-     * @param keyringId - The id of the keyring to get the accounts from.
      * @returns A promise resolving to an array of addresses.
      */
-    async getAccounts(keyringId) {
-        return this.state.keyrings
-            .filter((keyring) => (keyringId ? keyring.id === keyringId : true))
-            .reduce((accounts, keyring) => accounts.concat(keyring.accounts), []);
+    async getAccounts() {
+        return this.state.keyrings.reduce((accounts, keyring) => accounts.concat(keyring.accounts), []);
     }
     /**
      * Get encryption public key.
@@ -515,19 +493,6 @@ class KeyringController extends base_controller_1.BaseController {
         }
         return keyring.decryptMessage(address, messageParams.data);
     }
-    /**
-     * Returns the keyring with the given id.
-     *
-     * @param id - The id of the keyring to return.
-     * @returns The keyring with the given id.
-     */
-    getKeyringById(id) {
-        const keyring = __classPrivateFieldGet(this, _KeyringController_keyrings, "f").find((item) => item.opts.id === id);
-        if (!keyring) {
-            throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
-        }
-        return keyring;
-    }
     /**
      * Returns the currently initialized keyring that manages
      * the specified `address` if one exists.
@@ -875,39 +840,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to the seed phrase as Uint8Array.
      */
     async verifySeedPhrase() {
-        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;
+        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this));
     }
     async withKeyring(selector, operation, options = {
         createIfMissing: false,
@@ -917,15 +850,12 @@ class KeyringController extends base_controller_1.BaseController {
             if ('address' in selector) {
                 keyring = (await this.getKeyringForAccount(selector.address));
             }
-            else if ('type' in selector) {
+            else {
                 keyring = this.getKeyringsByType(selector.type)[selector.index || 0];
                 if (!keyring && options.createIfMissing) {
                     keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, selector.type, options.createWithData));
                 }
             }
-            else if ('id' in selector) {
-                keyring = this.getKeyringById(selector.id);
-            }
             if (!keyring) {
                 throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
             }
@@ -1194,6 +1124,47 @@ 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
@@ -1389,7 +1360,6 @@ 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`,
@@ -1409,25 +1379,8 @@ async function _KeyringController_newKeyring(type, data) {
         throw new Error(`${constants_1.KeyringControllerError.NoKeyringBuilder}. Keyring type: ${type}`);
     }
     const keyring = keyringBuilder();
-    // find the last index of the type
-    const lastIndexOfType = __classPrivateFieldGet(this, _KeyringController_keyrings, "f").reduce((maxIndex, item) => {
-        if (item.type === type) {
-            return Math.max(maxIndex, item.opts
-                ?.typeIndex ?? 0);
-        }
-        return maxIndex;
-    }, 0);
-    if (type === KeyringTypes.hd) {
-        await keyring.deserialize({
-            ...(data ?? {}),
-            typeIndex: lastIndexOfType + 1,
-            id: (0, ulid_1.ulid)(),
-        });
-    }
-    else {
-        // @ts-expect-error Enforce data type after updating clients
-        await keyring.deserialize(data);
-    }
+    // @ts-expect-error Enforce data type after updating clients
+    await keyring.deserialize(data);
     if (keyring.init) {
         await keyring.init();
     }