chore: adds safeguard for keyring being locked or unlocked (#5473)

## Explanation

We are listening for the `KeyringController` `lock & unlock` events in
order to safeguard the request to the snap.

## References

Fixes:
MetaMask/metamask-extension#30259 (comment)

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/multichain-transactions-controller`

- **Adds**: Safeguard for `KeyringController` `lock & unlock` events

### `@metamask/assets-controllers`

- **Adds**: Safeguard for `KeyringController` `lock & unlock` events in
`MultichainBalancesController`

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

---------

Co-authored-by: Charly Chevalier <[email protected]>

Author: zone-live

packages/assets-controllers/src/MultichainBalancesController/MultichainBalancesController.test.ts

@@ -135,6 +135,7 @@ function getRestrictedMessenger(
       'SnapController:handleRequest',
       'AccountsController:listMultichainAccounts',
       'MultichainAssetsController:getState',
+      'KeyringController:getState',
     ],
     allowedEvents: [
       'AccountsController:accountAdded',
@@ -184,6 +185,13 @@ const setupController = ({
     mockGetAssetsState,
   );
 
+  const mockGetKeyringState = jest.fn().mockReturnValue({
+    isUnlocked: true,
+  });
+  messenger.registerActionHandler(
+    'KeyringController:getState',
+    mockGetKeyringState,
+  );
   const controller = new MultichainBalancesController({
     messenger: multichainBalancesMessenger,
     state,
@@ -195,6 +203,7 @@ const setupController = ({
     mockSnapHandleRequest,
     mockListMultichainAccounts,
     mockGetAssetsState,
+    mockGetKeyringState,
   };
 };
 
@@ -226,6 +235,10 @@ describe('BalancesController', () => {
       'MultichainAssetsController:getState',
       jest.fn(),
     );
+    messenger.registerActionHandler(
+      'KeyringController:getState',
+      jest.fn().mockReturnValue({ isUnlocked: true }),
+    );
 
     const controller = new MultichainBalancesController({
       messenger: multichainBalancesMessenger,
@@ -426,4 +439,20 @@ describe('BalancesController', () => {
       mockBalanceResult,
     );
   });
+
+  it('resumes updating balances after unlocking KeyringController', async () => {
+    const { controller, mockGetKeyringState } = setupController();
+
+    mockGetKeyringState.mockReturnValue({ isUnlocked: false });
+
+    await controller.updateBalance(mockBtcAccount.id);
+    expect(controller.state.balances[mockBtcAccount.id]).toBeUndefined();
+
+    mockGetKeyringState.mockReturnValue({ isUnlocked: true });
+
+    await controller.updateBalance(mockBtcAccount.id);
+    expect(controller.state.balances[mockBtcAccount.id]).toStrictEqual(
+      mockBalanceResult,
+    );
+  });
 });

packages/assets-controllers/src/MultichainBalancesController/MultichainBalancesController.ts

@@ -16,6 +16,7 @@ import type {
   CaipAssetType,
   AccountBalancesUpdatedEventPayload,
 } from '@metamask/keyring-api';
+import type { KeyringControllerGetStateAction } from '@metamask/keyring-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
 import { KeyringClient } from '@metamask/keyring-snap-client';
 import type { HandleSnapRequest } from '@metamask/snaps-controllers';
@@ -94,7 +95,8 @@ export type MultichainBalancesControllerEvents =
 type AllowedActions =
   | HandleSnapRequest
   | AccountsControllerListMultichainAccountsAction
-  | MultichainAssetsControllerGetStateAction;
+  | MultichainAssetsControllerGetStateAction
+  | KeyringControllerGetStateAction;
 
 /**
  * Events that this controller is allowed to subscribe.
@@ -199,6 +201,14 @@ export class MultichainBalancesController extends BaseController<
     accountId: string,
     assets: CaipAssetType[],
   ): Promise<void> {
+    const { isUnlocked } = this.messagingSystem.call(
+      'KeyringController:getState',
+    );
+
+    if (!isUnlocked) {
+      return;
+    }
+
     try {
       const account = this.#getAccount(accountId);
 

packages/multichain-transactions-controller/src/MultichainTransactionsController.test.ts

@@ -145,6 +145,7 @@ const setupController = ({
       allowedActions: [
         'SnapController:handleRequest',
         'AccountsController:listMultichainAccounts',
+        'KeyringController:getState',
       ],
       allowedEvents: [
         'AccountsController:accountAdded',
@@ -169,6 +170,14 @@ const setupController = ({
     ),
   );
 
+  const mockGetKeyringState = jest.fn().mockReturnValue({
+    isUnlocked: true,
+  });
+  messenger.registerActionHandler(
+    'KeyringController:getState',
+    mockGetKeyringState,
+  );
+
   const controller = new MultichainTransactionsController({
     messenger: multichainTransactionsControllerMessenger,
     state,
@@ -179,6 +188,7 @@ const setupController = ({
     messenger,
     mockSnapHandleRequest,
     mockListMultichainAccounts,
+    mockGetKeyringState,
   };
 };
 
@@ -661,4 +671,26 @@ describe('MultichainTransactionsController', () => {
       nullTimestampTx2,
     ]);
   });
+
+  it('resumes updating transactions after unlocking KeyringController', async () => {
+    const { controller, mockGetKeyringState } = setupController();
+
+    mockGetKeyringState.mockReturnValue({ isUnlocked: false });
+
+    await controller.updateTransactionsForAccount(mockBtcAccount.id);
+    expect(
+      controller.state.nonEvmTransactions[mockBtcAccount.id],
+    ).toBeUndefined();
+
+    mockGetKeyringState.mockReturnValue({ isUnlocked: true });
+
+    await controller.updateTransactionsForAccount(mockBtcAccount.id);
+    expect(
+      controller.state.nonEvmTransactions[mockBtcAccount.id],
+    ).toStrictEqual({
+      transactions: mockTransactionResult.data,
+      next: null,
+      lastUpdated: expect.any(Number),
+    });
+  });
 });

packages/multichain-transactions-controller/src/MultichainTransactionsController.ts

@@ -15,6 +15,7 @@ import {
   type Transaction,
   type AccountTransactionsUpdatedEventPayload,
 } from '@metamask/keyring-api';
+import type { KeyringControllerGetStateAction } from '@metamask/keyring-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
 import { KeyringClient } from '@metamask/keyring-snap-client';
 import type { HandleSnapRequest } from '@metamask/snaps-controllers';
@@ -110,6 +111,7 @@ export type MultichainTransactionsControllerMessenger = RestrictedMessenger<
  */
 export type AllowedActions =
   | HandleSnapRequest
+  | KeyringControllerGetStateAction
   | AccountsControllerListMultichainAccountsAction;
 
 /**
@@ -244,6 +246,14 @@ export class MultichainTransactionsController extends BaseController<
    * @param accountId - The ID of the account to get transactions for.
    */
   async updateTransactionsForAccount(accountId: string) {
+    const { isUnlocked } = this.messagingSystem.call(
+      'KeyringController:getState',
+    );
+
+    if (!isUnlocked) {
+      return;
+    }
+
     try {
       const account = this.#listAccounts().find(
         (accountItem) => accountItem.id === accountId,