refactor: move initializeAccountTree to authStateMachine

Author: PatrykLucka

app/components/UI/EvmAccountSelectorList/EvmAccountSelectorList.tsx

@@ -40,7 +40,7 @@ import Routes from '../../../constants/navigation/Routes';
 import { selectAccountSections } from '../../../multichain-accounts/selectors/accountTreeController';
 
 // Internal dependencies.
-import { EvmAccountSelectorListProps } from './EvmAccountSelectorList.types';
+import { AccountSection, EvmAccountSelectorListProps } from './EvmAccountSelectorList.types';
 import styleSheet from './EvmAccountSelectorList.styles';
 import { AccountListBottomSheetSelectorsIDs } from '../../../../e2e/selectors/wallet/AccountListBottomSheet.selectors';
 import { WalletViewSelectorsIDs } from '../../../../e2e/selectors/wallet/WalletView.selectors';
@@ -52,11 +52,6 @@ import { Skeleton } from '../../../component-library/components/Skeleton';
 import { selectInternalAccounts } from '../../../selectors/accountsController';
 import { getFormattedAddressFromInternalAccount } from '../../../core/Multichain/utils';
 
-interface AccountSection {
-  title: string;
-  data: Account[];
-}
-
 /**
  * @deprecated This component is deprecated in favor of the CaipAccountSelectorList component.
  * Functionally they should be nearly identical except that EvmAccountSelectorList expects

app/components/UI/EvmAccountSelectorList/EvmAccountSelectorList.types.ts

@@ -65,3 +65,8 @@ export interface EvmAccountSelectorListProps
    */
   privacyMode?: boolean;
 }
+
+export interface AccountSection {
+  title: string;
+  data: Account[];
+}

app/core/Authentication/Authentication.test.ts

@@ -57,22 +57,6 @@ jest.mock('../Engine', () => ({
         keyrings: [{ metadata: { id: 'test-keyring-id' } }],
       },
     },
-    AccountTreeController: {
-      init: jest.fn(),
-    },
-    AccountsController: {
-      updateAccounts: jest.fn(),
-    },
-    RemoteFeatureFlagController: {
-      state: {
-        remoteFeatureFlags: {
-          enableMultichainAccounts: {
-            version: '1',
-            enabled: true,
-          },
-        },
-      },
-    },
   },
 }));
 

app/core/Authentication/Authentication.ts

@@ -39,14 +39,6 @@ import {
   WalletClientType,
 } from '../SnapKeyring/MultichainWalletSnapClient';
 ///: END:ONLY_INCLUDE_IF
-import {
-  assertMultichainAccountsFeatureFlagType,
-  isMultichainAccountsFeatureEnabled,
-  MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_1,
-  MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_2,
-  MultichainAccountsFeatureFlag,
-} from '../../selectors/featureFlagController/multichainAccounts/enabledMultichainAccounts';
-import { Json } from '@metamask/utils';
 
 /**
  * Holds auth data used to determine auth configuration
@@ -233,34 +225,6 @@ class AuthenticationService {
     };
   };
 
-  /**
-   * Checks if multichain accounts are enabled for state 1.
-   * @param remoteFeatureFlags - The remote feature flags object containing the multichain accounts feature flag.
-   * @returns True if the multichain accounts feature is enabled for state 1, false otherwise.
-   */
-  private isMultichainAccountsEnabledForState1 = (remoteFeatureFlags: Json & MultichainAccountsFeatureFlag) => (
-    [MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_1, MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_2].some((featureVersion) =>
-      isMultichainAccountsFeatureEnabled(remoteFeatureFlags, featureVersion)
-    )
-  );
-
-  /**
-   * Initializes the account tree and updates the accounts if multichain accounts is enabled
-   */
-  private initializeAccountTree = async (): Promise<void> => {
-    const { AccountTreeController, AccountsController, RemoteFeatureFlagController } = Engine.context;
-    const { enableMultichainAccounts } = RemoteFeatureFlagController.state.remoteFeatureFlags;
-    if(!assertMultichainAccountsFeatureFlagType(enableMultichainAccounts)) {
-      return;
-    }
-    const isMultichainAccountsEnabled = this.isMultichainAccountsEnabledForState1(enableMultichainAccounts);
-
-    if (isMultichainAccountsEnabled) {
-      AccountTreeController.init();
-      await AccountsController.updateAccounts();
-    }
-  };
-
   /**
    * Reset vault will empty password used to clear/reset vault upon errors during login/creation
    */
@@ -483,8 +447,6 @@ class AuthenticationService {
       this.retrySolanaDiscoveryIfPending();
       ///: END:ONLY_INCLUDE_IF
 
-      //TODO: Move this logic to the Engine when the account tree state will be persisted
-      this.initializeAccountTree();
       // TODO: Replace "any" with type
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (e: any) {
@@ -539,8 +501,6 @@ class AuthenticationService {
       this.retrySolanaDiscoveryIfPending();
       ///: END:ONLY_INCLUDE_IF
 
-      //TODO: Move this logic to the Engine when the account tree state will be persisted
-      this.initializeAccountTree();
       // TODO: Replace "any" with type
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (e: any) {

app/multichain-accounts/AccountTreeInitService/index.ts

@@ -0,0 +1,33 @@
+import { Json } from '@metamask/utils';
+import {
+  assertMultichainAccountsFeatureFlagType,
+  isMultichainAccountsFeatureEnabled,
+  MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_1,
+  MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_2,
+  MultichainAccountsFeatureFlag,
+} from '../../selectors/featureFlagController/multichainAccounts/enabledMultichainAccounts';
+import Engine from '../../core/Engine';
+
+export class AccountTreeInitService {
+  initializeAccountTree = async (): Promise<void> => {
+    const { AccountTreeController, AccountsController, RemoteFeatureFlagController } = Engine.context;
+    const { enableMultichainAccounts } = RemoteFeatureFlagController.state.remoteFeatureFlags;
+    if(!assertMultichainAccountsFeatureFlagType(enableMultichainAccounts)) {
+      return;
+    }
+    const isMultichainAccountsEnabled = this.isMultichainAccountsEnabledForState1(enableMultichainAccounts);
+
+    if (isMultichainAccountsEnabled) {
+      AccountTreeController.init();
+      await AccountsController.updateAccounts();
+    }
+  };
+
+  private isMultichainAccountsEnabledForState1 = (remoteFeatureFlags: Json & MultichainAccountsFeatureFlag) => (
+    [MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_1, MULTI_CHAIN_ACCOUNTS_FEATURE_VERSION_2].some((featureVersion) =>
+      isMultichainAccountsFeatureEnabled(remoteFeatureFlags, featureVersion)
+    )
+  );
+}
+
+export default new AccountTreeInitService();

app/multichain-accounts/controllers/account-tree-controller/constants.ts

@@ -1,9 +1,6 @@
 import { AccountTreeController, AccountTreeControllerMessenger } from '@metamask/account-tree-controller';
 import type { ControllerInitFunction } from '../../../core/Engine/types';
 
-// Export constants
-export * from './constants';
-
 /**
  * Initialize the AccountTreeController.
  *

app/multichain-accounts/controllers/account-tree-controller/index.ts

@@ -12,17 +12,13 @@ export function getAccountTreeControllerMessenger(
   return baseControllerMessenger.getRestricted({
     name: 'AccountTreeController',
     allowedEvents: [
-      'AccountsController:stateChange',
       'AccountsController:accountAdded',
       'AccountsController:accountRemoved',
-      'KeyringController:stateChange',
     ],
     allowedActions: [
       'AccountsController:listMultichainAccounts',
-      'AccountsController:listAccounts',
       'SnapController:get',
       'KeyringController:getState',
-      'KeyringController:getAccounts',
     ],
   });
 }

app/multichain-accounts/messengers/account-tree-controller-messenger/index.ts

@@ -20,6 +20,7 @@ import {
 } from './xmlHttpRequestOverride';
 import EngineService from '../../core/EngineService';
 import { AppStateEventProcessor } from '../../core/AppStateEventListener';
+import AccountTreeInitService from '../../multichain-accounts/AccountTreeInitService';
 
 export function* appLockStateMachine() {
   let biometricsListenerTask: Task<void> | undefined;
@@ -50,6 +51,8 @@ export function* authStateMachine() {
     yield take(UserActionType.LOGIN);
     const appLockStateMachineTask: Task<void> = yield fork(appLockStateMachine);
     LockManagerService.startListening();
+    //TODO: Move this logic to the Engine when the account tree state will be persisted
+    AccountTreeInitService.initializeAccountTree();
     // Listen to app lock behavior.
     yield take(UserActionType.LOGOUT);
     LockManagerService.stopListening();

app/store/sagas/index.ts

@@ -44,6 +44,27 @@ jest.mock('../../core/AppStateEventListener', () => ({
   },
 }));
 
+jest.mock('../../core/Engine', () => ({
+  context: {
+    AccountTreeController: {
+      init: jest.fn(),
+    },
+    AccountsController: {
+      updateAccounts: jest.fn(),
+    },
+    RemoteFeatureFlagController: {
+      state: {
+        remoteFeatureFlags: {
+          enableMultichainAccounts: {
+            version: '1',
+            enabled: true,
+          },
+        },
+      },
+    },
+  },
+}));
+
 describe('authStateMachine', () => {
   beforeEach(() => {
     mockNavigate.mockClear();