refactor(multichain-account-service)!: replace withKeyring usage with withKeyringV2

packages/multichain-account-service/CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Replace `KeyringController:withKeyring` with `KeyringController:withKeyringV2` for the EVM account provider ([#8491](https://github.com/MetaMask/core/pull/8491))
 - Bump `@metamask/accounts-controller` from `^37.1.1` to `^38.0.0` ([#8363](https://github.com/MetaMask/core/pull/8363), [#8665](https://github.com/MetaMask/core/pull/8665))
 - Bump `@metamask/keyring-controller` from `^25.1.1` to `^25.4.0` ([#8363](https://github.com/MetaMask/core/pull/8363), [#8634](https://github.com/MetaMask/core/pull/8634), [#8665](https://github.com/MetaMask/core/pull/8665))
 - Bump `@metamask/messenger` from `^1.0.0` to `^1.2.0` ([#8364](https://github.com/MetaMask/core/pull/8364), [#8373](https://github.com/MetaMask/core/pull/8373), [#8632](https://github.com/MetaMask/core/pull/8632))

packages/multichain-account-service/src/MultichainAccountService.test.ts

@@ -11,8 +11,9 @@ import {
   SolAccountType,
   TrxAccountType,
 } from '@metamask/keyring-api';
+import type { Keyring } from '@metamask/keyring-api/v2';
+import { KeyringType } from '@metamask/keyring-api/v2';
 import type { KeyringObject } from '@metamask/keyring-controller';
-import type { EthKeyring } from '@metamask/keyring-internal-api';
 
 import { traceFallback } from './analytics';
 import { isPerfEnabled, withLocalPerfTrace } from './analytics/perf';
@@ -1537,13 +1538,13 @@ describe('MultichainAccountService', () => {
         );
 
         rootMessenger.registerActionHandler(
-          'KeyringController:withKeyring',
+          'KeyringController:withKeyringV2',
           async (_, operation) => {
             const newKeyring = mocks.KeyringController.keyrings.find(
-              (keyring) => keyring.type === 'HD Key Tree',
+              (keyring) => keyring.type === KeyringType.Hd,
             ) as KeyringObject;
             return operation({
-              keyring: {} as unknown as EthKeyring,
+              keyring: {} as unknown as Keyring,
               metadata: newKeyring.metadata,
             });
           },
@@ -1580,13 +1581,13 @@ describe('MultichainAccountService', () => {
         );
 
         rootMessenger.registerActionHandler(
-          'KeyringController:withKeyring',
+          'KeyringController:withKeyringV2',
           async (_, operation) => {
             const newKeyring = mocks.KeyringController.keyrings.find(
               (keyring) => keyring.type === 'HD Key Tree',
             ) as KeyringObject;
             return operation({
-              keyring: {} as unknown as EthKeyring,
+              keyring: {} as unknown as Keyring,
               metadata: newKeyring.metadata,
             });
           },

packages/multichain-account-service/src/providers/BaseBip44AccountProvider.ts

@@ -5,10 +5,14 @@ import type {
   EntropySourceId,
   KeyringAccount,
 } from '@metamask/keyring-api';
-import type { KeyringCapabilities } from '@metamask/keyring-api/v2';
+import type {
+  Keyring as KeyringV2,
+  KeyringCapabilities,
+} from '@metamask/keyring-api/v2';
 import type {
   KeyringMetadata,
   KeyringSelector,
+  KeyringSelectorV2,
 } from '@metamask/keyring-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
 
@@ -155,6 +159,17 @@ export abstract class BaseBip44AccountProvider<
     ) as unknown as Account;
   }
 
+  /**
+   * Run an operation against a V1 keyring selected by `selector`.
+   *
+   * Forwards to `KeyringController:withKeyring`. Use this for keyrings that
+   * have not yet migrated to the unified V2 `Keyring` interface (e.g. the
+   * snap keyring).
+   *
+   * @param selector - The selector identifying the keyring.
+   * @param operation - The operation to run with the selected keyring.
+   * @returns The result of the operation.
+   */
   protected async withKeyring<SelectedKeyring, CallbackResult = void>(
     selector: KeyringSelector,
     operation: ({
@@ -178,6 +193,43 @@ export abstract class BaseBip44AccountProvider<
     return result as CallbackResult;
   }
 
+  /**
+   * Run an operation against a V2 keyring selected by `selector`.
+   *
+   * Forwards to `KeyringController:withKeyringV2`. Use this for keyrings
+   * that implement the unified V2 `Keyring` interface from
+   * `@metamask/keyring-api/v2`.
+   *
+   * @param selector - The selector identifying the keyring.
+   * @param operation - The operation to run with the selected keyring.
+   * @returns The result of the operation.
+   */
+  protected async withKeyringV2<
+    SelectedKeyring extends KeyringV2 = KeyringV2,
+    CallbackResult = void,
+  >(
+    selector: KeyringSelectorV2<SelectedKeyring>,
+    operation: ({
+      keyring,
+      metadata,
+    }: {
+      keyring: SelectedKeyring;
+      metadata: KeyringMetadata;
+    }) => Promise<CallbackResult>,
+  ): Promise<CallbackResult> {
+    const result = await this.messenger.call(
+      'KeyringController:withKeyringV2',
+      selector,
+      ({ keyring, metadata }) =>
+        operation({
+          keyring: keyring as SelectedKeyring,
+          metadata,
+        }),
+    );
+
+    return result as CallbackResult;
+  }
+
   abstract get capabilities(): KeyringCapabilities;
 
   abstract getName(): string;