feat(multichain-account-service)!: add error reporting around account creation (#7044)

## Explanation

Used the error reporting service to capture exceptions around account
creation.

## References

n/a

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Integrates `ErrorReportingService` to capture exceptions during
multichain account creation, alignment, and discovery, adds a
`createSentryError` utility, updates messenger/types, and adjusts tests
and peer deps.
> 
> - **multichain-account-service**:
>   - **Error reporting integration**:
> - In `MultichainAccountWallet` and `MultichainAccountGroup`, wrap
provider failures in `createSentryError` and call
`ErrorReportingService:captureException` during `createAccounts` (EVM
and non‑EVM), `alignAccounts`, and `discoverAccounts`.
>   - **Utilities**:
> - Add `utils#createSentryError` to attach `cause` and `context` to
errors.
>   - **Messaging/Types**:
> - Extend `MultichainAccountServiceMessenger` allowed actions to
include `ErrorReportingService:captureException`; update test messenger
delegation.
>   - **Tests**:
> - Update unit tests to register/mock
`ErrorReportingService:captureException` and assert calls on provider
failures.
>   - **Changelog/Deps**:
> - Update `CHANGELOG.md` with BREAKING note; add
`@metamask/error-reporting-service` as a peer dependency (and
devDependency).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
19411d9. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: hmalik88

packages/multichain-account-service/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING:** Added error reporting around account creation with the `ErrorReportingService` ([#7044](https://github.com/MetaMask/core/pull/7044))
+  - The `@metamask/error-reporting-service` is now a peer dependency.
+
 ### Changed
 
 - Limit Bitcoin and Tron providers to 3 concurrent account creations by default when creating multichain account groups ([#7052](https://github.com/MetaMask/core/pull/7052))

packages/multichain-account-service/package.json

@@ -67,6 +67,7 @@
     "@metamask/account-api": "^0.12.0",
     "@metamask/accounts-controller": "^34.0.0",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/error-reporting-service": "^3.0.0",
     "@metamask/eth-hd-keyring": "^13.0.0",
     "@metamask/keyring-controller": "^24.0.0",
     "@metamask/providers": "^22.1.0",
@@ -86,6 +87,7 @@
   "peerDependencies": {
     "@metamask/account-api": "^0.12.0",
     "@metamask/accounts-controller": "^34.0.0",
+    "@metamask/error-reporting-service": "^3.0.0",
     "@metamask/keyring-controller": "^24.0.0",
     "@metamask/providers": "^22.0.0",
     "@metamask/snaps-controllers": "^14.0.0",

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

@@ -23,6 +23,7 @@ import {
   getRootMessenger,
   type RootMessenger,
 } from './tests';
+import type { MultichainAccountServiceMessenger } from './types';
 
 function setup({
   groupIndex = 0,
@@ -44,25 +45,32 @@ function setup({
   wallet: MultichainAccountWallet<Bip44Account<InternalAccount>>;
   group: MultichainAccountGroup<Bip44Account<InternalAccount>>;
   providers: MockAccountProvider[];
+  messenger: MultichainAccountServiceMessenger;
 } {
   const providers = accounts.map((providerAccounts) => {
     return setupNamedAccountProvider({ accounts: providerAccounts });
   });
 
+  const serviceMessenger = getMultichainAccountServiceMessenger(messenger);
+  messenger.registerActionHandler(
+    'ErrorReportingService:captureException',
+    jest.fn(),
+  );
+
   const wallet = new MultichainAccountWallet<Bip44Account<InternalAccount>>({
     entropySource: MOCK_WALLET_1_ENTROPY_SOURCE,
-    messenger: getMultichainAccountServiceMessenger(messenger),
+    messenger: serviceMessenger,
     providers,
   });
 
   const group = new MultichainAccountGroup({
     wallet,
     groupIndex,
     providers,
-    messenger: getMultichainAccountServiceMessenger(messenger),
+    messenger: serviceMessenger,
   });
 
-  return { wallet, group, providers };
+  return { wallet, group, providers, messenger: serviceMessenger };
 }
 
 describe('MultichainAccount', () => {
@@ -213,5 +221,22 @@ describe('MultichainAccount', () => {
         `Failed to fully align multichain account group for entropy ID: ${wallet.entropySource} and group index: ${groupIndex}, some accounts might be missing`,
       );
     });
+
+    it('captures an error when a provider fails to create its account', async () => {
+      const groupIndex = 0;
+      const { group, providers, messenger } = setup({
+        groupIndex,
+        accounts: [[MOCK_WALLET_1_EVM_ACCOUNT], []],
+      });
+      const providerError = new Error('Unable to create accounts');
+      providers[1].createAccounts.mockRejectedValueOnce(providerError);
+      const callSpy = jest.spyOn(messenger, 'call');
+      await group.alignAccounts();
+      expect(callSpy).toHaveBeenCalledWith(
+        'ErrorReportingService:captureException',
+        new Error('Unable to align accounts with provider "Mocked Provider"'),
+      );
+      expect(callSpy.mock.lastCall[1]).toHaveProperty('cause', providerError);
+    });
   });
 });

packages/multichain-account-service/src/MultichainAccountGroup.ts

@@ -17,6 +17,7 @@ import {
 import type { MultichainAccountWallet } from './MultichainAccountWallet';
 import type { NamedAccountProvider } from './providers';
 import type { MultichainAccountServiceMessenger } from './types';
+import { createSentryError } from './utils';
 
 /**
  * A multichain account group that holds multiple accounts.
@@ -236,20 +237,40 @@ export class MultichainAccountGroup<
 
     const results = await Promise.allSettled(
       this.#providers.map(async (provider) => {
-        const accounts = this.#providerToAccounts.get(provider);
-        if (!accounts || accounts.length === 0) {
+        try {
+          const accounts = this.#providerToAccounts.get(provider);
+          if (!accounts || accounts.length === 0) {
+            this.#log(
+              `Found missing accounts for account provider "${provider.getName()}", creating them now...`,
+            );
+            const created = await provider.createAccounts({
+              entropySource: this.wallet.entropySource,
+              groupIndex: this.groupIndex,
+            });
+            this.#log(`Created ${created.length} accounts`);
+
+            return created;
+          }
+          return Promise.resolve();
+        } catch (error) {
+          // istanbul ignore next
           this.#log(
-            `Found missing accounts for account provider "${provider.getName()}", creating them now...`,
+            `${WARNING_PREFIX} ${error instanceof Error ? error.message : String(error)}`,
           );
-          const created = await provider.createAccounts({
-            entropySource: this.wallet.entropySource,
-            groupIndex: this.groupIndex,
-          });
-          this.#log(`Created ${created.length} accounts`);
-
-          return created;
+          const sentryError = createSentryError(
+            `Unable to align accounts with provider "${provider.getName()}"`,
+            error as Error,
+            {
+              groupIndex: this.groupIndex,
+              provider: provider.getName(),
+            },
+          );
+          this.#messenger.call(
+            'ErrorReportingService:captureException',
+            sentryError,
+          );
+          throw error;
         }
-        return Promise.resolve();
       }),
     );
 

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

@@ -67,6 +67,11 @@ function setup({
 
   const serviceMessenger = getMultichainAccountServiceMessenger(messenger);
 
+  messenger.registerActionHandler(
+    'ErrorReportingService:captureException',
+    jest.fn(),
+  );
+
   const wallet = new MultichainAccountWallet<Bip44Account<InternalAccount>>({
     entropySource,
     providers,
@@ -365,6 +370,27 @@ describe('MultichainAccountWallet', () => {
       );
     });
 
+    it('captures an error when a provider fails to create its account', async () => {
+      const groupIndex = 1;
+      const { wallet, providers, messenger } = setup({
+        accounts: [[MOCK_HD_ACCOUNT_1]],
+      });
+      const [provider] = providers;
+      const providerError = new Error('Unable to create accounts');
+      provider.createAccounts.mockRejectedValueOnce(providerError);
+      const callSpy = jest.spyOn(messenger, 'call');
+      await expect(
+        wallet.createMultichainAccountGroup(groupIndex),
+      ).rejects.toThrow(
+        'Unable to create multichain account group for index: 1',
+      );
+      expect(callSpy).toHaveBeenCalledWith(
+        'ErrorReportingService:captureException',
+        new Error('Unable to create account with provider "Mocked Provider 0"'),
+      );
+      expect(callSpy.mock.lastCall[1]).toHaveProperty('cause', providerError);
+    });
+
     it('aggregates non-EVM failures when waiting for all providers', async () => {
       const startingIndex = 0;
 
@@ -704,5 +730,22 @@ describe('MultichainAccountWallet', () => {
       // Other provider proceeds normally
       expect(providers[1].discoverAccounts).toHaveBeenCalledTimes(1);
     });
+
+    it('captures an error when a provider fails to discover its accounts', async () => {
+      const { wallet, providers, messenger } = setup({
+        accounts: [[], []],
+      });
+      const providerError = new Error('Unable to discover accounts');
+      providers[0].discoverAccounts.mockRejectedValueOnce(providerError);
+      const callSpy = jest.spyOn(messenger, 'call');
+      // Ensure the other provider stops immediately to finish the Promise.all
+      providers[1].discoverAccounts.mockResolvedValueOnce([]);
+      await wallet.discoverAccounts();
+      expect(callSpy).toHaveBeenCalledWith(
+        'ErrorReportingService:captureException',
+        new Error('Unable to discover accounts'),
+      );
+      expect(callSpy.mock.lastCall[1]).toHaveProperty('cause', providerError);
+    });
   });
 });

packages/multichain-account-service/src/MultichainAccountWallet.ts

@@ -26,7 +26,7 @@ import {
 import { MultichainAccountGroup } from './MultichainAccountGroup';
 import { EvmAccountProvider, type NamedAccountProvider } from './providers';
 import type { MultichainAccountServiceMessenger } from './types';
-import { toRejectedErrorMessage } from './utils';
+import { createSentryError, toRejectedErrorMessage } from './utils';
 
 /**
  * The context for a provider discovery.
@@ -244,10 +244,26 @@ export class MultichainAccountWallet<
   }): Promise<void> {
     if (awaitAll) {
       const tasks = providers.map((provider) =>
-        provider.createAccounts({
-          entropySource: this.#entropySource,
-          groupIndex,
-        }),
+        provider
+          .createAccounts({
+            entropySource: this.#entropySource,
+            groupIndex,
+          })
+          .catch((error) => {
+            const sentryError = createSentryError(
+              `Unable to create account with provider "${provider.getName()}"`,
+              error,
+              {
+                groupIndex,
+                provider: provider.getName(),
+              },
+            );
+            this.#messenger.call(
+              'ErrorReportingService:captureException',
+              sentryError,
+            );
+            throw error;
+          }),
       );
 
       const results = await Promise.allSettled(tasks);
@@ -276,6 +292,18 @@ export class MultichainAccountWallet<
         .catch((error) => {
           const errorMessage = `Unable to create multichain account group for index: ${groupIndex} (background mode with provider "${provider.getName()}")`;
           this.#log(`${WARNING_PREFIX} ${errorMessage}:`, error);
+          const sentryError = createSentryError(
+            `Unable to create account with provider "${provider.getName()}"`,
+            error,
+            {
+              groupIndex,
+              provider: provider.getName(),
+            },
+          );
+          this.#messenger.call(
+            'ErrorReportingService:captureException',
+            sentryError,
+          );
         });
     });
   }
@@ -411,6 +439,18 @@ export class MultichainAccountWallet<
       } catch (error) {
         const errorMessage = `Unable to create multichain account group for index: ${groupIndex} with provider "${evmProvider.getName()}". Error: ${(error as Error).message}`;
         this.#log(`${ERROR_PREFIX} ${errorMessage}:`, error);
+        const sentryError = createSentryError(
+          `Unable to create account with provider "${evmProvider.getName()}"`,
+          error as Error,
+          {
+            groupIndex,
+            provider: evmProvider.getName(),
+          },
+        );
+        this.#messenger.call(
+          'ErrorReportingService:captureException',
+          sentryError,
+        );
         throw new Error(errorMessage);
       }
 
@@ -575,6 +615,18 @@ export class MultichainAccountWallet<
               ),
               error,
             );
+            const sentryError = createSentryError(
+              'Unable to discover accounts',
+              error as Error,
+              {
+                provider: providerName,
+                groupIndex: targetGroupIndex,
+              },
+            );
+            this.#messenger.call(
+              'ErrorReportingService:captureException',
+              sentryError,
+            );
             break;
           }
 

packages/multichain-account-service/src/tests/messenger.ts

@@ -55,6 +55,7 @@ export function getMultichainAccountServiceMessenger(
       'AccountsController:getAccount',
       'AccountsController:getAccountByAddress',
       'AccountsController:listMultichainAccounts',
+      'ErrorReportingService:captureException',
       'SnapController:handleRequest',
       'KeyringController:withKeyring',
       'KeyringController:getState',

packages/multichain-account-service/src/types.ts

@@ -11,6 +11,7 @@ import type {
   AccountsControllerGetAccountByAddressAction,
   AccountsControllerListMultichainAccountsAction,
 } from '@metamask/accounts-controller';
+import type { ErrorReportingServiceCaptureExceptionAction } from '@metamask/error-reporting-service';
 import type { KeyringAccount } from '@metamask/keyring-api';
 import type {
   KeyringControllerAddNewKeyringAction,
@@ -135,7 +136,8 @@ type AllowedActions =
   | KeyringControllerGetKeyringsByTypeAction
   | KeyringControllerAddNewKeyringAction
   | NetworkControllerGetNetworkClientByIdAction
-  | NetworkControllerFindNetworkClientIdByChainIdAction;
+  | NetworkControllerFindNetworkClientIdByChainIdAction
+  | ErrorReportingServiceCaptureExceptionAction;
 
 /**
  * All events published by other modules that {@link MultichainAccountService}

packages/multichain-account-service/src/utils.ts

@@ -10,3 +10,28 @@ export const toRejectedErrorMessage = <Result>(
   }
   return errorMessage;
 };
+
+/**
+ * Creates a Sentry error from an error message, an inner error and a context.
+ *
+ * NOTE: Sentry defaults to a depth of 3 when extracting non-native attributes.
+ * As such, the context depth shouldn't be too deep.
+ *
+ * @param msg - The error message to create a Sentry error from.
+ * @param innerError - The inner error to create a Sentry error from.
+ * @param context - The context to add to the Sentry error.
+ * @returns A Sentry error.
+ */
+export const createSentryError = (
+  msg: string,
+  innerError: Error,
+  context: Record<string, unknown>,
+) => {
+  const error = new Error(msg) as Error & {
+    cause: Error;
+    context: typeof context;
+  };
+  error.cause = innerError;
+  error.context = context;
+  return error;
+};

yarn.lock

@@ -4197,6 +4197,7 @@ __metadata:
     "@metamask/accounts-controller": "npm:^34.0.0"
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/base-controller": "npm:^9.0.0"
+    "@metamask/error-reporting-service": "npm:^3.0.0"
     "@metamask/eth-hd-keyring": "npm:^13.0.0"
     "@metamask/eth-snap-keyring": "npm:^18.0.0"
     "@metamask/key-tree": "npm:^10.1.1"
@@ -4227,6 +4228,7 @@ __metadata:
   peerDependencies:
     "@metamask/account-api": ^0.12.0
     "@metamask/accounts-controller": ^34.0.0
+    "@metamask/error-reporting-service": ^3.0.0
     "@metamask/keyring-controller": ^24.0.0
     "@metamask/providers": ^22.0.0
     "@metamask/snaps-controllers": ^14.0.0