Cherry pick 7857b82 (Solana account discovery on SRP import from #15614) (#15870)

- Solana account discovery was not working on the RC due to the
discovery logic not being included in the correct code fences. I have
fixed this by changing the incorrect code fence to `///:
BEGIN:ONLY_INCLUDE_IF(solana)`
- This PR also adds a small fix that was discovered after fixing account
discovery. The issue was that once a Solana account was discovered, it
would be set as the default account. Now, when a solana account is
discovered, we do not automatically set it as the selected account which
is the same behaviour we have on extension. I took this code directly
from

[extension](https://github.com/MetaMask/metamask-extension/blob/726bcad098f67b7223e90be0885290399b6fae95/app/scripts/lib/snap-keyring/snap-keyring.ts#L326-L332).

Fixes: https://consensyssoftware.atlassian.net/browse/MUL-208

1. load branch
2. import any SRP
3. complete onboarding
4. Notice: A solana account should be auto created for the SRP. If the
account had a balance, it should be correct. If not, it should have a
zero balance.
5. Optional, import a second SRP
6. a new solana account under that SRP should also be created.


https://github.com/user-attachments/assets/a9c22c59-f4d4-44cd-bf52-11d6d4f88b49

<!-- [screenshots/recordings] -->


https://github.com/user-attachments/assets/9074c40b-6178-4bf3-9dd6-aad6fcd6a63f

- [ ] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding

Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

---------

Co-authored-by: Curtis David <Curtis.David7@gmail.com>

Author: owencraston

app/actions/multiSrp/index.ts

@@ -3,7 +3,7 @@ import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 import ExtendedKeyringTypes from '../../constants/keyringTypes';
 import Engine from '../../core/Engine';
 import { KeyringSelector } from '@metamask/keyring-controller';
-///: BEGIN:ONLY_INCLUDE_IF(beta)
+///: BEGIN:ONLY_INCLUDE_IF(solana)
 import {
   MultichainWalletSnapFactory,
   WalletClientType,
@@ -64,7 +64,7 @@ export async function importNewSecretRecoveryPhrase(mnemonic: string) {
     async ({ keyring }) => keyring.getAccounts(),
   );
 
-  ///: BEGIN:ONLY_INCLUDE_IF(beta)
+  ///: BEGIN:ONLY_INCLUDE_IF(solana)
   const multichainClient = MultichainWalletSnapFactory.createClient(
     WalletClientType.Solana,
   );

app/core/Authentication/Authentication.ts

@@ -31,12 +31,12 @@ import NavigationService from '../NavigationService';
 import Routes from '../../constants/navigation/Routes';
 import { TraceName, TraceOperation, endTrace, trace } from '../../util/trace';
 import ReduxService from '../redux';
-///: BEGIN:ONLY_INCLUDE_IF(beta)
+///: BEGIN:ONLY_INCLUDE_IF(solana)
 import {
   MultichainWalletSnapFactory,
   WalletClientType,
 } from '../SnapKeyring/MultichainWalletSnapClient';
-///: END:ONLY_INCLUDE_IF(beta)
+///: END:ONLY_INCLUDE_IF
 
 /**
  * Holds auth data used to determine auth configuration
@@ -91,7 +91,7 @@ class AuthenticationService {
     const { KeyringController }: any = Engine.context;
     if (clearEngine) await Engine.resetState();
     await KeyringController.createNewVaultAndRestore(password, parsedSeed);
-    ///: BEGIN:ONLY_INCLUDE_IF(beta)
+    ///: BEGIN:ONLY_INCLUDE_IF(solana)
     const primaryHdKeyringId =
       Engine.context.KeyringController.state.keyrings[0].metadata.id;
     const client = MultichainWalletSnapFactory.createClient(
@@ -101,7 +101,7 @@ class AuthenticationService {
       },
     );
     await client.addDiscoveredAccounts(primaryHdKeyringId);
-    ///: END:ONLY_INCLUDE_IF(beta)
+    ///: END:ONLY_INCLUDE_IF
     password = this.wipeSensitiveData();
     parsedSeed = this.wipeSensitiveData();
   };
@@ -119,7 +119,7 @@ class AuthenticationService {
     await Engine.resetState();
     await KeyringController.createNewVaultAndKeychain(password);
 
-    ///: BEGIN:ONLY_INCLUDE_IF(beta)
+    ///: BEGIN:ONLY_INCLUDE_IF(solana)
     const primaryHdKeyringId =
       Engine.context.KeyringController.state.keyrings[0].metadata.id;
     const client = MultichainWalletSnapFactory.createClient(
@@ -129,7 +129,7 @@ class AuthenticationService {
       },
     );
     await client.addDiscoveredAccounts(primaryHdKeyringId);
-    ///: END:ONLY_INCLUDE_IF(beta)
+    ///: END:ONLY_INCLUDE_IF
     password = this.wipeSensitiveData();
   };
 

app/core/SnapKeyring/SnapKeyring.test.ts

@@ -29,7 +29,6 @@ const mockSetSelectedAccount = jest.fn();
 const mockRemoveAccountHelper = jest.fn();
 const mockGetAccountByAddress = jest.fn();
 const mockSetAccountName = jest.fn();
-const mockSetAccountNameAndSelectAccount = jest.fn();
 const mockSnapControllerHandleRequest = jest.fn();
 const mockListMultichainAccounts = jest.fn();
 
@@ -85,7 +84,6 @@ const createControllerMessenger = ({
       'AccountsController:getAccountByAddress',
       'AccountsController:listMultichainAccounts',
       'AccountsController:setAccountName',
-      'AccountsController:setAccountNameAndSelectAccount',
     ],
     allowedEvents: [],
   });
@@ -110,8 +108,6 @@ const createControllerMessenger = ({
         return mockSetSelectedAccount(params);
       case 'AccountsController:setAccountName':
         return mockSetAccountName.mockReturnValue(null)(params);
-      case 'AccountsController:setAccountNameAndSelectAccount':
-        return mockSetAccountNameAndSelectAccount.mockReturnValue(null)(params);
       case 'AccountsController:listMultichainAccounts':
         return mockListMultichainAccounts.mockReturnValue([])();
       case 'SnapController:handleRequest':
@@ -221,12 +217,16 @@ describe('Snap Keyring Methods', () => {
       ]);
       expect(mockPersisKeyringHelper).toHaveBeenCalledTimes(1);
       expect(mockGetAccounts).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).not.toHaveBeenCalled();
       expect(mockEndFlow).toHaveBeenCalledWith([{ id: mockFlowId }]);
 
       // Wait for any pending promises (including the account finalization which tracks the event)
       await waitForAllPromises();
 
+      // Verify that setSelectedAccount is called but setAccountName is not called
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).not.toHaveBeenCalled();
+
       // Verify trackSnapAccountEvent was called for successful account creation
       expect(trackSnapAccountEvent).toHaveBeenCalled();
     });
@@ -260,17 +260,21 @@ describe('Snap Keyring Methods', () => {
         true,
       ]);
       expect(mockGetAccounts).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledWith([
+
+      // Wait for any pending promises (including the account finalization which tracks the event)
+      await waitForAllPromises();
+
+      // Verify that setSelectedAccount and setAccountName are called separately
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).toHaveBeenCalledTimes(1);
+      expect(mockSetAccountName).toHaveBeenCalledWith([
         mockAccount.id,
         mockNameSuggestion,
       ]);
       expect(mockEndFlow).toHaveBeenCalledTimes(2);
       expect(mockEndFlow).toHaveBeenCalledWith([{ id: mockFlowId }]);
 
-      // Wait for any pending promises (including the account finalization which tracks the event)
-      await waitForAllPromises();
-
       // Verify trackSnapAccountEvent was called
       expect(trackSnapAccountEvent).toHaveBeenCalled();
     });
@@ -402,8 +406,15 @@ describe('Snap Keyring Methods', () => {
 
       // Verify that the account was created and named
       expect(mockPersisKeyringHelper).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledWith([
+
+      // Wait for any pending promises (including the account finalization)
+      await waitForAllPromises();
+
+      // Verify that setSelectedAccount and setAccountName are called separately
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).toHaveBeenCalledTimes(1);
+      expect(mockSetAccountName).toHaveBeenCalledWith([
         mockAccount.id,
         mockNameSuggestion,
       ]);
@@ -437,8 +448,15 @@ describe('Snap Keyring Methods', () => {
 
       // Verify that the account was created and named
       expect(mockPersisKeyringHelper).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledWith([
+
+      // Wait for any pending promises (including the account finalization)
+      await waitForAllPromises();
+
+      // Verify that setSelectedAccount and setAccountName are called separately
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).toHaveBeenCalledTimes(1);
+      expect(mockSetAccountName).toHaveBeenCalledWith([
         mockAccount.id,
         mockNameSuggestion,
       ]);
@@ -484,8 +502,90 @@ describe('Snap Keyring Methods', () => {
 
       // Verify that the account was created and named
       expect(mockPersisKeyringHelper).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledTimes(1);
-      expect(mockSetAccountNameAndSelectAccount).toHaveBeenCalledWith([
+
+      // Wait for any pending promises (including the account finalization)
+      await waitForAllPromises();
+
+      // Verify that setSelectedAccount and setAccountName are called separately
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).toHaveBeenCalledTimes(1);
+      expect(mockSetAccountName).toHaveBeenCalledWith([
+        mockAccount.id,
+        mockNameSuggestion,
+      ]);
+    });
+
+    it('always sets selected account for both preinstalled and non-preinstalled snaps with default options', async () => {
+      // Test with preinstalled snap first
+      (isSnapPreinstalled as jest.Mock).mockReturnValue(true);
+
+      const mockNameSuggestion = 'suggested name';
+      mockAddRequest.mockReturnValueOnce({
+        success: true,
+        name: mockNameSuggestion,
+      });
+
+      const builder = createSnapKeyringBuilder();
+      await builder().handleKeyringSnapMessage(mockSnapId, {
+        method: KeyringEvent.AccountCreated,
+        params: {
+          account: mockAccount,
+          displayConfirmation: false,
+          accountNameSuggestion: mockNameSuggestion,
+        },
+      });
+
+      // Wait for any pending promises (including the account finalization)
+      await waitForAllPromises();
+
+      // Verify that both setSelectedAccount and setAccountName are called for preinstalled snap
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).toHaveBeenCalledTimes(1);
+      expect(mockSetAccountName).toHaveBeenCalledWith([
+        mockAccount.id,
+        mockNameSuggestion,
+      ]);
+
+      // Reset mocks for second test and set them up again
+      mockSetSelectedAccount.mockReset();
+      mockSetAccountName.mockReset();
+      mockAddRequest.mockReset();
+      mockPersisKeyringHelper.mockReset();
+      mockStartFlow.mockReset();
+      mockEndFlow.mockReset();
+      mockGetAccounts.mockReset();
+
+      // Set up mocks for second test
+      mockAddRequest.mockReturnValueOnce({
+        success: true,
+        name: mockNameSuggestion,
+      });
+      mockStartFlow.mockReturnValue({ id: mockFlowId });
+      mockEndFlow.mockReturnValue(true);
+      mockGetAccounts.mockResolvedValue([]);
+
+      // Test with non-preinstalled snap
+      (isSnapPreinstalled as jest.Mock).mockReturnValue(false);
+
+      await builder().handleKeyringSnapMessage(mockSnapId, {
+        method: KeyringEvent.AccountCreated,
+        params: {
+          account: mockAccount,
+          displayConfirmation: false,
+          accountNameSuggestion: mockNameSuggestion,
+        },
+      });
+
+      // Wait for any pending promises (including the account finalization)
+      await waitForAllPromises();
+
+      // Verify that both setSelectedAccount and setAccountName are called for non-preinstalled snap too
+      expect(mockSetSelectedAccount).toHaveBeenCalledTimes(1);
+      expect(mockSetSelectedAccount).toHaveBeenCalledWith([mockAccount.id]);
+      expect(mockSetAccountName).toHaveBeenCalledTimes(1);
+      expect(mockSetAccountName).toHaveBeenCalledWith([
         mockAccount.id,
         mockNameSuggestion,
       ]);

app/core/SnapKeyring/SnapKeyring.ts

@@ -16,9 +16,7 @@ import { getTraceTags } from '../../util/sentry/tags';
 import { store } from '../../store';
 import { MetaMetricsEvents } from '../../core/Analytics/MetaMetrics.events';
 import { trackSnapAccountEvent } from '../Analytics/helpers/SnapKeyring/trackSnapAccountEvent';
-import {
-  endPerformanceTrace,
-} from '../../core/redux/slices/performance';
+import { endPerformanceTrace } from '../../core/redux/slices/performance';
 import { PerformanceEventNames } from '../redux/slices/performance/constants';
 
 /**
@@ -148,11 +146,13 @@ class SnapKeyringImpl implements SnapKeyringCallbacks {
   private async addAccountFinalize({
     address: _address,
     snapId,
+    skipSetSelectedAccountStep,
     accountName,
     onceSaved,
   }: {
     address: string;
     snapId: SnapId;
+    skipSetSelectedAccountStep: boolean;
     onceSaved: Promise<string>;
     accountName?: string;
   }) {
@@ -172,17 +172,20 @@ class SnapKeyringImpl implements SnapKeyringCallbacks {
         // state, so we can safely uses this state to run post-processing.
         // (e.g. renaming the account, select the account, etc...)
 
-        // Set the selected account to the new account
-        if (accountName) {
+        if (!skipSetSelectedAccountStep) {
+          // Set the selected account to the new account
           this.#messenger.call(
-            'AccountsController:setAccountNameAndSelectAccount',
+            'AccountsController:setSelectedAccount',
             accountId,
-            accountName,
           );
-        } else {
+        }
+
+        if (accountName) {
+          // Set the account name if one is provided
           this.#messenger.call(
-            'AccountsController:setSelectedAccount',
+            'AccountsController:setAccountName',
             accountId,
+            accountName,
           );
         }
 
@@ -220,6 +223,7 @@ class SnapKeyringImpl implements SnapKeyringCallbacks {
     accountNameSuggestion: string = '',
     {
       displayAccountNameSuggestion,
+      setSelectedAccount,
     }: SnapKeyringInternalOptions = getDefaultInternalOptions(),
   ) {
     assertIsValidSnapId(snapId);
@@ -237,13 +241,18 @@ class SnapKeyringImpl implements SnapKeyringCallbacks {
       skipAccountNameSuggestionDialog,
     });
 
+    // Only pre-installed Snaps can skip the account from being selected.
+    const skipSetSelectedAccountStep =
+      isSnapPreinstalled(snapId) && !setSelectedAccount;
+
     // The second part is about selecting the newly created account and showing some other
     // confirmation dialogs (or error dialogs if anything goes wrong while persisting the account
     // into the state.
     // eslint-disable-next-line no-void
     void this.addAccountFinalize({
       address,
       snapId,
+      skipSetSelectedAccountStep,
       onceSaved,
       accountName,
     });