feat(multichain-account-service): register XlmAccountProvider and accept providerConfigs[XLM_ACCOUNT_PROVIDER_NAME]

Author: khanti42

oxlint-suppressions.json

@@ -3836,7 +3836,7 @@
   },
   "packages/multichain-account-service/src/MultichainAccountService.test.ts": {
     "typescript/no-unsafe-return": {
-      "count": 5
+      "count": 6
     },
     "typescript/unbound-method": {
       "count": 1

packages/multichain-account-service/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Register `XlmAccountProvider` in `MultichainAccountService` built-in providers and accept `providerConfigs[XLM_ACCOUNT_PROVIDER_NAME]` ([#10867](https://github.com/MetaMask/core/pull/10867))
+
 ### Changed
 
 - Bump `lodash-es` from `^4.17.21` to `^4.18.1` ([#10447](https://github.com/MetaMask/core/pull/10447))

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

@@ -10,6 +10,7 @@ import {
   EthAccountType,
   SolAccountType,
   TrxAccountType,
+  XlmAccountType,
 } from '@metamask/keyring-api';
 import type { Keyring } from '@metamask/keyring-api/v2';
 import { KeyringType } from '@metamask/keyring-api/v2';
@@ -41,6 +42,10 @@ import {
   TRX_ACCOUNT_PROVIDER_NAME,
   TrxAccountProvider,
 } from './providers/TrxAccountProvider.js';
+import {
+  XLM_ACCOUNT_PROVIDER_NAME,
+  XlmAccountProvider,
+} from './providers/XlmAccountProvider.js';
 import type { RootMessenger, MockAccountProvider } from './tests/index.js';
 import {
   MOCK_HARDWARE_ACCOUNT_1,
@@ -94,6 +99,12 @@ jest.mock('./providers/TrxAccountProvider', () => {
     TrxAccountProvider: jest.fn(),
   };
 });
+jest.mock('./providers/XlmAccountProvider', () => {
+  return {
+    ...jest.requireActual('./providers/XlmAccountProvider'),
+    XlmAccountProvider: jest.fn(),
+  };
+});
 
 type Mocks = {
   // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -123,6 +134,8 @@ type Mocks = {
   BtcAccountProvider: MockAccountProvider;
   // eslint-disable-next-line @typescript-eslint/naming-convention
   TrxAccountProvider: MockAccountProvider;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  XlmAccountProvider: MockAccountProvider;
 };
 
 function mockAccountProvider<Provider extends Bip44AccountProvider>(
@@ -164,6 +177,11 @@ function mockAccountProvider<Provider extends Bip44AccountProvider>(
     mocks.isAccountCompatible?.mockImplementation(
       (account: KeyringAccount) => account.type === TrxAccountType.Eoa,
     );
+  } else if (providerClass === (XlmAccountProvider as unknown)) {
+    mocks.getName.mockReturnValue(XLM_ACCOUNT_PROVIDER_NAME);
+    mocks.isAccountCompatible?.mockImplementation(
+      (account: KeyringAccount) => account.type === XlmAccountType.Account,
+    );
   }
 
   // Mirror production behavior: a provider's tracked account IDs are only
@@ -221,6 +239,7 @@ async function setup({
     SolAccountProvider: makeMockAccountProvider(),
     BtcAccountProvider: makeMockAccountProvider(),
     TrxAccountProvider: makeMockAccountProvider(),
+    XlmAccountProvider: makeMockAccountProvider(),
   };
 
   // Required for the `assert` on `MultichainAccountWallet.createMultichainAccountGroup`.
@@ -277,6 +296,7 @@ async function setup({
     SolAccountProvider.NAME = SOL_ACCOUNT_PROVIDER_NAME;
     BtcAccountProvider.NAME = BTC_ACCOUNT_PROVIDER_NAME;
     TrxAccountProvider.NAME = TRX_ACCOUNT_PROVIDER_NAME;
+    XlmAccountProvider.NAME = XLM_ACCOUNT_PROVIDER_NAME;
 
     mockAccountProvider<EvmAccountProvider>(
       EvmAccountProvider,
@@ -306,6 +326,13 @@ async function setup({
       3,
       TrxAccountType.Eoa,
     );
+    mockAccountProvider<XlmAccountProvider>(
+      XlmAccountProvider,
+      mocks.XlmAccountProvider,
+      accounts,
+      4,
+      XlmAccountType.Account,
+    );
   }
 
   const messenger = getMultichainAccountServiceMessenger(rootMessenger);
@@ -351,6 +378,17 @@ describe('MultichainAccountService', () => {
               timeoutMs: 3000,
             },
           },
+          [XLM_ACCOUNT_PROVIDER_NAME]: {
+            maxConcurrency: 1,
+            discovery: {
+              timeoutMs: 2000,
+              maxAttempts: 3,
+              backOffMs: 1000,
+            },
+            createAccounts: {
+              timeoutMs: 3000,
+            },
+          },
         };
 
       const { mocks, messenger } = await setup({
@@ -368,6 +406,11 @@ describe('MultichainAccountService', () => {
         providerConfigs?.[SOL_ACCOUNT_PROVIDER_NAME],
         expect.any(Function), // TraceCallback
       );
+      expect(mocks.XlmAccountProvider.constructor).toHaveBeenCalledWith(
+        messenger,
+        providerConfigs?.[XLM_ACCOUNT_PROVIDER_NAME],
+        expect.any(Function), // TraceCallback
+      );
     });
 
     it('passes traceFallback to providers when no config.trace is provided and perf is disabled', async () => {
@@ -1051,6 +1094,7 @@ describe('MultichainAccountService', () => {
       // Providers that own no accounts for this wallet should be left alone.
       expect(mocks.BtcAccountProvider.deleteAccounts).not.toHaveBeenCalled();
       expect(mocks.TrxAccountProvider.deleteAccounts).not.toHaveBeenCalled();
+      expect(mocks.XlmAccountProvider.deleteAccounts).not.toHaveBeenCalled();
       expect(() =>
         service.getMultichainAccountWallet({
           entropySource: MOCK_HD_KEYRING_1.metadata.id,

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

@@ -30,10 +30,13 @@ import {
   EVM_ACCOUNT_PROVIDER_NAME,
   BtcAccountProviderConfig,
   TrxAccountProviderConfig,
+  XlmAccountProviderConfig,
   BTC_ACCOUNT_PROVIDER_NAME,
   TRX_ACCOUNT_PROVIDER_NAME,
+  XLM_ACCOUNT_PROVIDER_NAME,
   BtcAccountProvider,
   TrxAccountProvider,
+  XlmAccountProvider,
 } from './providers/index.js';
 import { SolAccountProvider } from './providers/SolAccountProvider.js';
 import {
@@ -67,6 +70,7 @@ export type MultichainAccountServiceOptions = {
     [SOL_ACCOUNT_PROVIDER_NAME]?: SolAccountProviderConfig;
     [BTC_ACCOUNT_PROVIDER_NAME]?: BtcAccountProviderConfig;
     [TRX_ACCOUNT_PROVIDER_NAME]?: TrxAccountProviderConfig;
+    [XLM_ACCOUNT_PROVIDER_NAME]?: XlmAccountProviderConfig;
   };
   config?: MultichainAccountServiceConfig;
 };
@@ -207,6 +211,14 @@ export class MultichainAccountService {
           trace,
         ),
       ),
+      new AccountProviderWrapper(
+        this.#messenger,
+        new XlmAccountProvider(
+          this.#messenger,
+          providerConfigs?.[XLM_ACCOUNT_PROVIDER_NAME],
+          trace,
+        ),
+      ),
       // Custom account providers that can be provided by the MetaMask client.
       ...providers,
     ];

packages/multichain-account-service/src/providers/SnapAccountProvider.test.ts

@@ -41,6 +41,7 @@ import {
 import { SolAccountProvider } from './SolAccountProvider.js';
 import { TrxAccountProvider } from './TrxAccountProvider.js';
 import { TimeoutError } from './utils.js';
+import { XlmAccountProvider } from './XlmAccountProvider.js';
 
 jest.mock('../analytics', () => {
   const actual = jest.requireActual('../analytics');
@@ -370,6 +371,18 @@ describe('SnapAccountProvider', () => {
       expect(isSnapAccountProvider(trxProvider)).toBe(true);
     });
 
+    it('creates XlmAccountProvider with default trace', () => {
+      const { messenger } = setup();
+
+      const xlmProvider = new XlmAccountProvider(
+        getMultichainAccountServiceMessenger(messenger),
+      );
+
+      expect(xlmProvider).toBeDefined();
+      expect(isSnapAccountProvider(xlmProvider)).toBe(true);
+      expect(xlmProvider.snapId).toBe(XlmAccountProvider.XLM_SNAP_ID);
+    });
+
     it('creates provider without trace parameter', () => {
       const { messenger } = setup();