feat(accounts-controller): add new setAccountNameAndSelectAccount action

Author: ccharly

packages/accounts-controller/src/AccountsController.ts

@@ -69,6 +69,11 @@ export type AccountsControllerSetAccountNameAction = {
   handler: AccountsController['setAccountName'];
 };
 
+export type AccountsControllerSetAccountNameAndSelectAccountAction = {
+  type: `${typeof controllerName}:setAccountNameAndSelectAccount`;
+  handler: AccountsController['setAccountNameAndSelectAccount'];
+};
+
 export type AccountsControllerListAccountsAction = {
   type: `${typeof controllerName}:listAccounts`;
   handler: AccountsController['listAccounts'];
@@ -124,6 +129,7 @@ export type AccountsControllerActions =
   | AccountsControllerListAccountsAction
   | AccountsControllerListMultichainAccountsAction
   | AccountsControllerSetAccountNameAction
+  | AccountsControllerSetAccountNameAndSelectAccountAction
   | AccountsControllerUpdateAccountsAction
   | AccountsControllerGetAccountByAddressAction
   | AccountsControllerGetSelectedAccountAction
@@ -437,6 +443,56 @@ export class AccountsController extends BaseController<
     });
   }
 
+  /**
+   * Sets the name of the account with the given ID and select it.
+   *
+   * @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: string, accountName: string): void {
+    const account = this.getAccountExpect(accountId);
+
+    this.#assertAccountCanBeRenamed(account, accountName);
+
+    const internalAccount = {
+      ...account,
+      metadata: {
+        ...account.metadata,
+        name: accountName,
+      },
+    };
+
+    this.#update((state) => {
+      const { internalAccounts } = state;
+      // FIXME: Using the state as-is cause the following error: "Type instantiation is excessively
+      // deep and possibly infinite.ts(2589)" (https://github.com/MetaMask/utils/issues/168)
+      // Using a type-cast workaround this error and is slightly better than using a @ts-expect-error
+      // which sometimes fail when compiling locally.
+      internalAccounts.accounts[accountId] = internalAccount;
+
+      internalAccounts.accounts[account.id].metadata.lastSelected = Date.now();
+      internalAccounts.selectedAccount = account.id;
+    });
+
+    this.messagingSystem.publish(
+      'AccountsController:accountRenamed',
+      internalAccount,
+    );
+  }
+
+  #assertAccountCanBeRenamed(account: InternalAccount, accountName: string) {
+    if (
+      this.listMultichainAccounts().find(
+        (internalAccount) =>
+          internalAccount.metadata.name === accountName &&
+          internalAccount.id !== account.id,
+      )
+    ) {
+      throw new Error('Account name already exists');
+    }
+  }
+
   /**
    * Updates the metadata of the account with the given ID.
    *
@@ -449,15 +505,8 @@ export class AccountsController extends BaseController<
   ): void {
     const account = this.getAccountExpect(accountId);
 
-    if (
-      metadata.name &&
-      this.listMultichainAccounts().find(
-        (internalAccount) =>
-          internalAccount.metadata.name === metadata.name &&
-          internalAccount.id !== accountId,
-      )
-    ) {
-      throw new Error('Account name already exists');
+    if (metadata.name) {
+      this.#assertAccountCanBeRenamed(account, metadata.name);
     }
 
     const internalAccount = {
@@ -1197,6 +1246,11 @@ export class AccountsController extends BaseController<
       this.setAccountName.bind(this),
     );
 
+    this.messagingSystem.registerActionHandler(
+      `${controllerName}:setAccountNameAndSelectAccount`,
+      this.setAccountNameAndSelectAccount.bind(this),
+    );
+
     this.messagingSystem.registerActionHandler(
       `${controllerName}:updateAccounts`,
       this.updateAccounts.bind(this),

packages/accounts-controller/src/index.ts

@@ -4,6 +4,7 @@ export type {
   AccountsControllerGetStateAction,
   AccountsControllerSetSelectedAccountAction,
   AccountsControllerSetAccountNameAction,
+  AccountsControllerSetAccountNameAndSelectAccountAction,
   AccountsControllerListAccountsAction,
   AccountsControllerListMultichainAccountsAction,
   AccountsControllerUpdateAccountsAction,