@metamask/accounts-controller 36.0.0 → 37.0.0

package/dist/AccountsController.mjs

@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _AccountsController_instances, _AccountsController_assertAccountCanBeRenamed, _AccountsController_getInternalAccountForNonSnapAccount, _AccountsController_getSnapKeyring, _AccountsController_handleOnSnapKeyringAccountEvent, _AccountsController_handleOnKeyringStateChange, _AccountsController_update, _AccountsController_handleOnSnapStateChange, _AccountsController_getLastSelectedAccount, _AccountsController_getLastSelectedIndex, _AccountsController_getInternalAccountFromAddressAndType, _AccountsController_handleOnMultichainNetworkDidChange, _AccountsController_subscribeToMessageEvents, _AccountsController_registerMessageHandlers;
+var _AccountsController_instances, _AccountsController_getAccountExpect, _AccountsController_assertAccountCanBeRenamed, _AccountsController_getInternalAccountForNonSnapAccount, _AccountsController_getSnapKeyring, _AccountsController_handleOnSnapKeyringAccountEvent, _AccountsController_handleOnKeyringStateChange, _AccountsController_update, _AccountsController_handleOnSnapStateChange, _AccountsController_getLastSelectedAccount, _AccountsController_getLastSelectedIndex, _AccountsController_getInternalAccountFromAddressAndType, _AccountsController_handleOnMultichainNetworkDidChange, _AccountsController_subscribeToMessageEvents;
 import { BaseController } from "@metamask/base-controller";
 import { SnapKeyring } from "@metamask/eth-snap-keyring";
 import { EthAccountType, EthMethod, EthScope, isEvmAccountType, KeyringAccountEntropyTypeOption } from "@metamask/keyring-api";
@@ -11,8 +11,24 @@ import { isScopeEqualToAny } from "@metamask/keyring-utils";
 import { isCaipChainId } from "@metamask/utils";
 import $lodash from "lodash";
 const { cloneDeep } = $lodash;
-import { getEvmDerivationPathForIndex, getEvmGroupIndexFromAddressIndex, getUUIDFromAddressOfNormalAccount, isHdKeyringType, isHdSnapKeyringAccount, isSnapKeyringType, keyringTypeToName } from "./utils.mjs";
+import { projectLogger as log } from "./logger.mjs";
+import { constructAccountIdByAddress, getEvmDerivationPathForIndex, getEvmGroupIndexFromAddressIndex, getUUIDFromAddressOfNormalAccount, isHdKeyringType, isHdSnapKeyringAccount, isSnapKeyringType, keyringTypeToName } from "./utils.mjs";
 const controllerName = 'AccountsController';
+const MESSENGER_EXPOSED_METHODS = [
+    'setSelectedAccount',
+    'setAccountName',
+    'setAccountNameAndSelectAccount',
+    'listAccounts',
+    'listMultichainAccounts',
+    'updateAccounts',
+    'getSelectedAccount',
+    'getSelectedMultichainAccount',
+    'getAccountByAddress',
+    'getAccount',
+    'getAccounts',
+    'updateAccountMetadata',
+    'loadBackup',
+];
 const accountsControllerMetadata = {
     internalAccounts: {
         includeInStateLogs: true,
@@ -20,13 +36,24 @@ const accountsControllerMetadata = {
         includeInDebugSnapshot: false,
         usedInUi: true,
     },
+    accountIdByAddress: {
+        includeInStateLogs: false,
+        persist: false,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
 };
 const defaultState = {
     internalAccounts: {
         accounts: {},
         selectedAccount: '',
     },
+    accountIdByAddress: {},
 };
+/**
+ * @deprecated This constant is deprecated and will be removed in a future version.
+ * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
+ */
 export const EMPTY_ACCOUNT = {
     id: '',
     address: '',
@@ -49,6 +76,8 @@ export const EMPTY_ACCOUNT = {
  * The accounts controller also listens for keyring state changes and updates the internal accounts accordingly.
  * The accounts controller also listens for snap state changes and updates the internal accounts accordingly.
  *
+ * @deprecated This class is deprecated and will be removed in a future version.
+ * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
  */
 export class AccountsController extends BaseController {
     /**
@@ -59,6 +88,7 @@ export class AccountsController extends BaseController {
      * @param options.state - Initial state to set on this controller
      */
     constructor({ messenger, state, }) {
+        const accountIdByAddress = constructAccountIdByAddress(state?.internalAccounts?.accounts ?? {});
         super({
             messenger,
             name: controllerName,
@@ -66,15 +96,18 @@ export class AccountsController extends BaseController {
             state: {
                 ...defaultState,
                 ...state,
+                accountIdByAddress,
             },
         });
         _AccountsController_instances.add(this);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
         __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_subscribeToMessageEvents).call(this);
-        __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_registerMessageHandlers).call(this);
     }
     /**
      * Returns the internal account object for the given account ID, if it exists.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param accountId - The ID of the account to retrieve.
      * @returns The internal account object, or undefined if the account does not exist.
      */
@@ -84,6 +117,8 @@ export class AccountsController extends BaseController {
     /**
      * Returns the internal account objects for the given account IDs, if they exist.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param accountIds - The IDs of the accounts to retrieve.
      * @returns The internal account objects, or undefined if the account(s) do not exist.
      */
@@ -93,6 +128,8 @@ export class AccountsController extends BaseController {
     /**
      * Returns an array of all evm internal accounts.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @returns An array of InternalAccount objects.
      */
     listAccounts() {
@@ -102,6 +139,8 @@ export class AccountsController extends BaseController {
     /**
      * Returns an array of all internal accounts.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param chainId - The chain ID.
      * @returns An array of InternalAccount objects.
      */
@@ -115,23 +154,11 @@ export class AccountsController extends BaseController {
         }
         return accounts.filter((account) => isScopeEqualToAny(chainId, account.scopes));
     }
-    /**
-     * Returns the internal account object for the given account ID.
-     *
-     * @param accountId - The ID of the account to retrieve.
-     * @returns The internal account object.
-     * @throws An error if the account ID is not found.
-     */
-    getAccountExpect(accountId) {
-        const account = this.getAccount(accountId);
-        if (account === undefined) {
-            throw new Error(`Account Id "${accountId}" not found`);
-        }
-        return account;
-    }
     /**
      * Returns the last selected EVM account.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @returns The selected internal account.
      */
     getSelectedAccount() {
@@ -141,7 +168,7 @@ export class AccountsController extends BaseController {
         if (selectedAccount === '') {
             return EMPTY_ACCOUNT;
         }
-        const account = this.getAccountExpect(selectedAccount);
+        const account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountExpect).call(this, selectedAccount);
         if (isEvmAccountType(account.type)) {
             return account;
         }
@@ -159,6 +186,8 @@ export class AccountsController extends BaseController {
      *
      * Retrieves the last selected account by chain ID.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param chainId - The chain ID to filter the accounts.
      * @returns The last selected account compatible with the specified chain ID or undefined.
      */
@@ -170,7 +199,7 @@ export class AccountsController extends BaseController {
             return EMPTY_ACCOUNT;
         }
         if (!chainId) {
-            return this.getAccountExpect(selectedAccount);
+            return __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountExpect).call(this, selectedAccount);
         }
         const accounts = this.listMultichainAccounts(chainId);
         return __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getLastSelectedAccount).call(this, accounts);
@@ -179,19 +208,37 @@ export class AccountsController extends BaseController {
      * Returns the account with the specified address.
      * ! This method will only return the first account that matches the address
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param address - The address of the account to retrieve.
      * @returns The account with the specified address, or undefined if not found.
      */
     getAccountByAddress(address) {
-        return this.listMultichainAccounts().find((account) => account.address.toLowerCase() === address.toLowerCase());
+        // We need to have a fallback as a cache miss might be attributed to a checksummed address being passed.
+        let accountId = this.state.accountIdByAddress[address];
+        if (!accountId) {
+            // FIXME: We should not need lower-cased addresses, but some consumers might
+            // still be using non-normalized addresses. For now we keep it
+            // for convenience, but we will need to remove this fallback
+            // at some point.
+            // NOTE: We should only hit that branch for EVM accounts only.
+            const lowercasedAddress = address.toLowerCase();
+            accountId = this.state.accountIdByAddress[lowercasedAddress];
+            if (accountId) {
+                log(`Cache missed for account ID: ${accountId}, received address: "${address}", matched address: "${lowercasedAddress}"`);
+            }
+        }
+        return accountId ? this.getAccount(accountId) : undefined;
     }
     /**
      * Sets the selected account by its ID.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param accountId - The ID of the account to be selected.
      */
     setSelectedAccount(accountId) {
-        const account = this.getAccountExpect(accountId);
+        const account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountExpect).call(this, accountId);
         if (this.state.internalAccounts.selectedAccount === account.id) {
             return;
         }
@@ -204,6 +251,8 @@ export class AccountsController extends BaseController {
     /**
      * Sets the name of the account with the given ID.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param accountId - The ID of the account to set the name for.
      * @param accountName - The new name for the account.
      * @throws An error if an account with the same name already exists.
@@ -219,12 +268,14 @@ export class AccountsController extends BaseController {
     /**
      * Sets the name of the account with the given ID and select it.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param accountId - The ID of the account to set the name for and select.
      * @param accountName - The new name for the account.
      * @throws An error if an account with the same name already exists.
      */
     setAccountNameAndSelectAccount(accountId, accountName) {
-        const account = this.getAccountExpect(accountId);
+        const account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountExpect).call(this, accountId);
         __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_assertAccountCanBeRenamed).call(this, account, accountName);
         const internalAccount = {
             ...account,
@@ -244,11 +295,13 @@ export class AccountsController extends BaseController {
     /**
      * Updates the metadata of the account with the given ID.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param accountId - The ID of the account for which the metadata will be updated.
      * @param metadata - The new metadata for the account.
      */
     updateAccountMetadata(accountId, metadata) {
-        const account = this.getAccountExpect(accountId);
+        const account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountExpect).call(this, accountId);
         if (metadata.name) {
             __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_assertAccountCanBeRenamed).call(this, account, metadata.name);
         }
@@ -267,9 +320,12 @@ export class AccountsController extends BaseController {
      * Updates the internal accounts list by retrieving normal and snap accounts,
      * removing duplicates, and updating the metadata of each account.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @returns A Promise that resolves when the accounts have been updated.
      */
     async updateAccounts() {
+        log('Synchronizing accounts with keyrings...');
         const keyringAccountIndexes = new Map();
         const existingInternalAccounts = this.state.internalAccounts.accounts;
         const internalAccounts = {};
@@ -305,22 +361,34 @@ export class AccountsController extends BaseController {
         }
         __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_update).call(this, (state) => {
             state.internalAccounts.accounts = internalAccounts;
+            state.accountIdByAddress = constructAccountIdByAddress(internalAccounts);
         });
+        log('Accounts synchronized!');
     }
     /**
      * Loads the backup state of the accounts controller.
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use `AccountTreeController`, `MultichainAccountService`, or the Keyring API v2 instead.
      * @param backup - The backup state to load.
      */
     loadBackup(backup) {
         if (backup.internalAccounts) {
+            const accountIdByAddress = constructAccountIdByAddress(backup.internalAccounts.accounts);
             this.update((currentState) => {
                 currentState.internalAccounts = backup.internalAccounts;
+                currentState.accountIdByAddress = accountIdByAddress;
             });
         }
     }
 }
-_AccountsController_instances = new WeakSet(), _AccountsController_assertAccountCanBeRenamed = function _AccountsController_assertAccountCanBeRenamed(account, accountName) {
+_AccountsController_instances = new WeakSet(), _AccountsController_getAccountExpect = function _AccountsController_getAccountExpect(accountId) {
+    const account = this.getAccount(accountId);
+    if (account === undefined) {
+        throw new Error(`Account Id "${accountId}" not found`);
+    }
+    return account;
+}, _AccountsController_assertAccountCanBeRenamed = function _AccountsController_assertAccountCanBeRenamed(account, accountName) {
     if (this.listMultichainAccounts().find((internalAccount) => internalAccount.metadata.name === accountName &&
         internalAccount.id !== account.id)) {
         throw new Error('Account name already exists');
@@ -409,6 +477,7 @@ _AccountsController_instances = new WeakSet(), _AccountsController_assertAccount
     if (!isUnlocked || keyrings.length === 0) {
         return;
     }
+    log('Synchronizing accounts with keyrings (through :stateChange)...');
     // State patches.
     const generatePatch = () => {
         return {
@@ -475,10 +544,11 @@ _AccountsController_instances = new WeakSet(), _AccountsController_assertAccount
         added: [],
     };
     __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_update).call(this, (state) => {
-        const { internalAccounts } = state;
+        const { internalAccounts, accountIdByAddress } = state;
         for (const patch of [patches.snap, patches.normal]) {
             for (const account of patch.removed) {
                 delete internalAccounts.accounts[account.id];
+                delete accountIdByAddress[account.address];
                 diff.removed.push(account.id);
             }
             for (const added of patch.added) {
@@ -495,6 +565,7 @@ _AccountsController_instances = new WeakSet(), _AccountsController_assertAccount
                             lastSelected,
                         },
                     };
+                    accountIdByAddress[account.address] = account.id;
                     diff.added.push(internalAccounts.accounts[account.id]);
                 }
             }
@@ -511,6 +582,7 @@ _AccountsController_instances = new WeakSet(), _AccountsController_assertAccount
             this.messenger.publish('AccountsController:accountAdded', account);
         }
     });
+    log('Accounts synchronized (through :stateChange)!');
     // NOTE: Since we also track "updated" accounts with our patches, we could fire a new event
     // like `accountUpdated` (we would still need to check if anything really changed on the account).
 }, _AccountsController_update = function _AccountsController_update(callback, beforeAutoSelectAccount) {
@@ -657,18 +729,5 @@ _AccountsController_instances = new WeakSet(), _AccountsController_assertAccount
     this.messenger.subscribe('SnapKeyring:accountTransactionsUpdated', (snapAccountEvent) => __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_handleOnSnapKeyringAccountEvent).call(this, 'AccountsController:accountTransactionsUpdated', snapAccountEvent));
     // Handle account change when multichain network is changed
     this.messenger.subscribe('MultichainNetworkController:networkDidChange', (id) => __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_handleOnMultichainNetworkDidChange).call(this, id));
-}, _AccountsController_registerMessageHandlers = function _AccountsController_registerMessageHandlers() {
-    this.messenger.registerActionHandler(`${controllerName}:setSelectedAccount`, this.setSelectedAccount.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:listAccounts`, this.listAccounts.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:listMultichainAccounts`, this.listMultichainAccounts.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:setAccountName`, this.setAccountName.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:setAccountNameAndSelectAccount`, this.setAccountNameAndSelectAccount.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:updateAccounts`, this.updateAccounts.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:getSelectedAccount`, this.getSelectedAccount.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:getSelectedMultichainAccount`, this.getSelectedMultichainAccount.bind(this));
-    this.messenger.registerActionHandler(`${controllerName}:getAccountByAddress`, this.getAccountByAddress.bind(this));
-    this.messenger.registerActionHandler(`AccountsController:getAccount`, this.getAccount.bind(this));
-    this.messenger.registerActionHandler(`AccountsController:getAccounts`, this.getAccounts.bind(this));
-    this.messenger.registerActionHandler(`AccountsController:updateAccountMetadata`, this.updateAccountMetadata.bind(this));
 };
 //# sourceMappingURL=AccountsController.mjs.map