feat(stellar): fetch live data in keyring listAccountAssets and getAccountBalances + read balance data from AssetsController + stop account sync while Asset migration is on

packages/stellar-wallet-snap/.env.example

@@ -50,6 +50,9 @@ SECURITY_ALERTS_API_BASE_URL=https://security-alerts.api.cx.metamask.io
 # Cache TTL Milliseconds for sep41 asset balance
 #STELLAR_SEP41_ASSET_BALANCE_TTL_MILLISECONDS=
 
+# Cache TTL Milliseconds for the keyring live account reused by getAccountBalances
+#STELLAR_KEYRING_LIVE_ACCOUNT_TTL_MILLISECONDS=
+
 # Cache TTL Milliseconds for spot prices
 #STELLAR_SPOT_PRICES_TTL_MILLISECONDS=
 

packages/stellar-wallet-snap/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Read account asset balance from AssetsController whfeature flag `enableAssetMigration` and local flag `enableAssetMigration` is on ([#331](https://github.com/MetaMask/internal-snaps/pull/331))
+  - Include SEP-41 balances on keyring `getAccountAssets` and `getAccountBalances`.
 - Read asset metadata from AssetsController when feature flag `enableAssetMigration` and local flag `enableAssetMigration` is on ([#493](https://github.com/MetaMask/internal-snaps/pull/493))
   - `enableAssetMigration` set to off.
 

packages/stellar-wallet-snap/docs/misc/synchronization/assets.md

@@ -32,7 +32,7 @@ Wire format: [SIP-29 Snap Assets API](https://metamask.github.io/SIPs/SIPS/sip-2
 4. Persist catalog via `AssetMetadataRepository.saveMany`.
 5. Failures are logged / tracked; the cron does not fail the whole Snap lifecycle.
 
-During account / transaction sync, `SynchronizeService` also preloads SEP-41 metadata via `fetchSep41AssetsOrSyncOnce`. That path refreshes the token API catalog when `assetMetadataLastSyncedAt` is missing **or** older than `cache.ttlMilliseconds.assetMetadata` (default 1 hour). The timestamp is stamped only by a successful non-empty full catalog sync (`saveMany(..., true)`), so point-lookup `saveMany` calls cannot postpone the hot reload.
+During account / transaction sync, `SynchronizeService` preloads SEP-41 metadata by calling [`AssetMetadataService.synchronizeIfStale`](../../../src/services/asset-metadata/AssetMetadataService.ts), then [`AssetMetadataService.getAssetsByScopeAndType`](../../../src/services/asset-metadata/AssetMetadataService.ts) (`AssetType.Sep41`). `synchronizeIfStale` refreshes the token API catalog when `assetMetadataLastSyncedAt` is missing **or** older than `cache.ttlMilliseconds.assetMetadata` (default 1 hour). `getAssetsByScopeAndType` then returns the persisted rows for that scope and type. The timestamp is stamped only by a successful non-empty full catalog sync (`saveMany(..., true)`), so point-lookup `saveMany` calls cannot postpone the hot reload.
 
 ## Sequence
 

packages/stellar-wallet-snap/snap.config.ts

@@ -45,6 +45,8 @@ const config: SnapConfig = {
       process.env.STELLAR_SIMULATE_TRANSACTION_TTL_MILLISECONDS ?? '',
     STELLAR_SEP41_ASSET_BALANCE_TTL_MILLISECONDS:
       process.env.STELLAR_SEP41_ASSET_BALANCE_TTL_MILLISECONDS ?? '',
+    STELLAR_KEYRING_LIVE_ACCOUNT_TTL_MILLISECONDS:
+      process.env.STELLAR_KEYRING_LIVE_ACCOUNT_TTL_MILLISECONDS ?? '',
     STELLAR_ASSET_METADATA_TTL_MILLISECONDS:
       process.env.STELLAR_ASSET_METADATA_TTL_MILLISECONDS ?? '',
     STELLAR_BASE_FEE_MULTIPLIER: process.env.STELLAR_BASE_FEE_MULTIPLIER ?? '',

packages/stellar-wallet-snap/src/config.test.ts

@@ -55,6 +55,7 @@ const FULL_ENVIRONMENT = {
       loadOnChainAccount: '30000',
       simulateTransaction: '8000',
       sep41AssetBalance: '15000',
+      fetchOnChainAccount: '5000',
       assetMetadata: '900000',
     },
   },
@@ -255,6 +256,7 @@ describe('ConfigProvider', () => {
         loadOnChainAccount: 30000,
         simulateTransaction: 8000,
         sep41AssetBalance: 15000,
+        fetchOnChainAccount: 5000,
         assetMetadata: 900000,
       });
     });
@@ -270,6 +272,7 @@ describe('ConfigProvider', () => {
               loadOnChainAccount: '',
               simulateTransaction: undefined,
               sep41AssetBalance: '',
+              fetchOnChainAccount: undefined,
               assetMetadata: '',
             },
           },
@@ -283,6 +286,7 @@ describe('ConfigProvider', () => {
         loadOnChainAccount: 10 * 60 * 1000,
         simulateTransaction: 10 * 1000,
         sep41AssetBalance: 30 * 1000,
+        fetchOnChainAccount: 5 * 1000,
         assetMetadata: 60 * 60 * 1000,
       });
     });

packages/stellar-wallet-snap/src/config.ts

@@ -113,6 +113,8 @@ export const ConfigStruct = object({
       simulateTransaction: parseIntegerStruct(1000, 10 * 1000),
       // SEP-41 balance reads (multicall on mainnet)
       sep41AssetBalance: parseIntegerStruct(1000, 30 * 1000),
+      // Keyring getAccountAssets result reused by the following getAccountBalances call
+      fetchOnChainAccount: parseIntegerStruct(1000, 5 * 1000),
       // 1 hour — token API asset catalog. Account sync hot-reloads when older.
       assetMetadata: parseIntegerStruct(1000, 60 * 60 * 1000),
     }),
@@ -185,6 +187,8 @@ const ENVIRONMENT = {
         process.env.STELLAR_SIMULATE_TRANSACTION_TTL_MILLISECONDS,
       sep41AssetBalance:
         process.env.STELLAR_SEP41_ASSET_BALANCE_TTL_MILLISECONDS,
+      fetchOnChainAccount:
+        process.env.STELLAR_KEYRING_LIVE_ACCOUNT_TTL_MILLISECONDS,
       assetMetadata: process.env.STELLAR_ASSET_METADATA_TTL_MILLISECONDS,
     },
   },

packages/stellar-wallet-snap/src/constants.ts

@@ -32,6 +32,16 @@ export const STROOPS_PER_XLM = 10_000_000;
  */
 export const BASE_RESERVE_STROOPS = XLM_PER_BASE_RESERVE * STROOPS_PER_XLM;
 
+/**
+ * Base-reserve units reserved for the account entry itself (not subentries).
+ *
+ * Stellar minimum balance is
+ * `(2 + subentry_count + num_sponsoring − num_sponsored) × base_reserve`.
+ *
+ * @see https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#minimum-balance
+ */
+export const ACCOUNT_MINIMUM_BASE_RESERVE_UNIT = 2;
+
 /**
  * Stellar's coin type
  *

packages/stellar-wallet-snap/src/context.ts

@@ -134,6 +134,7 @@ const onChainAccountService = new OnChainAccountService({
   logger,
   networkService,
   onChainAccountRepository,
+  assetsService,
   assetMetadataService,
 });
 
@@ -357,6 +358,7 @@ const clientRequestHandler = new ClientRequestHandler({
 
 /** ------------------------------ Export Handlers ------------------------------ */
 export {
+  assetsService,
   clientRequestHandler,
   cronjobHandler,
   keyringHandler,

packages/stellar-wallet-snap/src/handlers/accountResolver.test.ts

@@ -65,9 +65,9 @@ describe('AccountResolver', () => {
     const resolveOnChainAccountSpy = jest
       .spyOn(OnChainAccountService.prototype, 'resolveOnChainAccount')
       .mockResolvedValue(onChainAccount);
-    const resolveOnChainAccountByKeyringAccountIdSpy = jest.spyOn(
+    const getOnChainAccountSnapshotSpy = jest.spyOn(
       OnChainAccountService.prototype,
-      'resolveOnChainAccountByKeyringAccountId',
+      'getOnChainAccountSnapshot',
     );
     const resolveWalletSpy = jest
       .spyOn(WalletService.prototype, 'resolveWallet')
@@ -86,7 +86,7 @@ describe('AccountResolver', () => {
       onChainAccount,
       resolveAccountSpy,
       resolveOnChainAccountSpy,
-      resolveOnChainAccountByKeyringAccountIdSpy,
+      getOnChainAccountSnapshotSpy,
       resolveWalletSpy,
     };
   }
@@ -156,12 +156,10 @@ describe('AccountResolver', () => {
       account,
       wallet,
       onChainAccount,
-      resolveOnChainAccountByKeyringAccountIdSpy,
+      getOnChainAccountSnapshotSpy,
       resolveOnChainAccountSpy,
     } = setup();
-    resolveOnChainAccountByKeyringAccountIdSpy.mockResolvedValue(
-      onChainAccount,
-    );
+    getOnChainAccountSnapshotSpy.mockResolvedValue(onChainAccount);
 
     const result = await accountResolver.resolveAccount({
       accountId: keyringAccountId,
@@ -174,17 +172,17 @@ describe('AccountResolver', () => {
       onChainAccount,
       wallet,
     });
-    expect(resolveOnChainAccountByKeyringAccountIdSpy).toHaveBeenCalledWith(
+    expect(getOnChainAccountSnapshotSpy).toHaveBeenCalledWith(
       account.id,
+      account.address,
       scope,
     );
     expect(resolveOnChainAccountSpy).not.toHaveBeenCalled();
   });
 
   it('throws AccountNotActivatedException when state has no on-chain snapshot', async () => {
-    const { accountResolver, resolveOnChainAccountByKeyringAccountIdSpy } =
-      setup();
-    resolveOnChainAccountByKeyringAccountIdSpy.mockResolvedValue(null);
+    const { accountResolver, getOnChainAccountSnapshotSpy } = setup();
+    getOnChainAccountSnapshotSpy.mockResolvedValue(null);
 
     await expect(
       accountResolver.resolveAccount({
@@ -196,8 +194,7 @@ describe('AccountResolver', () => {
   });
 
   it('throws DerivedAccountAddressMismatchException when state snapshot address differs from keyring', async () => {
-    const { accountResolver, resolveOnChainAccountByKeyringAccountIdSpy } =
-      setup();
+    const { accountResolver, getOnChainAccountSnapshotSpy } = setup();
 
     const otherAddress = generateStellarAddress();
     const mockRawAccount = createMockAccountWithBalances(
@@ -210,9 +207,7 @@ describe('AccountResolver', () => {
       scope,
       horizonSource(mockRawAccount, scope),
     );
-    resolveOnChainAccountByKeyringAccountIdSpy.mockResolvedValue(
-      mismatchedOnChainAccount,
-    );
+    getOnChainAccountSnapshotSpy.mockResolvedValue(mismatchedOnChainAccount);
 
     await expect(
       accountResolver.resolveAccount({

packages/stellar-wallet-snap/src/handlers/accountResolver.ts

@@ -161,8 +161,9 @@ export class AccountResolver {
       );
     }
     const onChainAccount =
-      await this.#onChainAccountService.resolveOnChainAccountByKeyringAccountId(
+      await this.#onChainAccountService.getOnChainAccountSnapshot(
         account.id,
+        account.address,
         scope,
       );
     // It is a tradeoff when loading on-chain account from state,

packages/stellar-wallet-snap/src/handlers/clientRequest/onAmountInput.test.ts

@@ -83,11 +83,8 @@ describe('OnAmountInputHandler', () => {
     jest.spyOn(AccountService.prototype, 'resolveAccount').mockResolvedValue({
       account,
     });
-    const resolveOnChainAccountByKeyringAccountIdSpy = jest
-      .spyOn(
-        OnChainAccountService.prototype,
-        'resolveOnChainAccountByKeyringAccountId',
-      )
+    const getOnChainAccountSnapshotSpy = jest
+      .spyOn(OnChainAccountService.prototype, 'getOnChainAccountSnapshot')
       .mockResolvedValue(onChainAccount);
     jest
       .spyOn(WalletService.prototype, 'resolveWallet')
@@ -125,7 +122,7 @@ describe('OnAmountInputHandler', () => {
       onChainAccount,
       wallet,
       createValidatedSendTransaction,
-      resolveOnChainAccountByKeyringAccountIdSpy,
+      getOnChainAccountSnapshotSpy,
     };
   }
 
@@ -177,14 +174,15 @@ describe('OnAmountInputHandler', () => {
       account,
       onChainAccount,
       createValidatedSendTransaction,
-      resolveOnChainAccountByKeyringAccountIdSpy,
+      getOnChainAccountSnapshotSpy,
     } = setup();
 
     const result = await handler.handle(baseRequest());
 
     expect(result).toStrictEqual({ valid: true, errors: [] });
-    expect(resolveOnChainAccountByKeyringAccountIdSpy).toHaveBeenCalledWith(
+    expect(getOnChainAccountSnapshotSpy).toHaveBeenCalledWith(
       account.id,
+      account.address,
       scope,
     );
     expect(createValidatedSendTransaction).toHaveBeenCalledWith({
@@ -204,13 +202,14 @@ describe('OnAmountInputHandler', () => {
       handler,
       account,
       createValidatedSendTransaction,
-      resolveOnChainAccountByKeyringAccountIdSpy,
+      getOnChainAccountSnapshotSpy,
     } = setup();
 
     await handler.handle(baseRequest({ assetId: testnetAssetId }));
 
-    expect(resolveOnChainAccountByKeyringAccountIdSpy).toHaveBeenCalledWith(
+    expect(getOnChainAccountSnapshotSpy).toHaveBeenCalledWith(
       account.id,
+      account.address,
       KnownCaip2ChainId.Testnet,
     );
     expect(createValidatedSendTransaction).toHaveBeenCalledWith(
@@ -289,8 +288,8 @@ describe('OnAmountInputHandler', () => {
   });
 
   it('returns invalid when keyring state has no on-chain snapshot', async () => {
-    const { handler, resolveOnChainAccountByKeyringAccountIdSpy } = setup();
-    resolveOnChainAccountByKeyringAccountIdSpy.mockResolvedValueOnce(null);
+    const { handler, getOnChainAccountSnapshotSpy } = setup();
+    getOnChainAccountSnapshotSpy.mockResolvedValueOnce(null);
 
     expect(await handler.handle(baseRequest())).toStrictEqual({
       valid: false,