Merge pull request #51 from MetaMask/feat/chg-trust-refine

feat: Add Horizon-based transaction tracking and keyring settlement for trustline operation status tracking

Author: khanti42

packages/site/src/pages/index.tsx

@@ -446,10 +446,6 @@ const Index = () => {
     }
 
     const trimmedLimit = trustlineLimit.trim();
-    if (action === 'delete' && !trimmedLimit) {
-      setTrustlineOutput('For remove trustline, enter limit 0.');
-      return;
-    }
 
     const account = resolveSelectedAccount();
     if (!account) {
@@ -473,8 +469,6 @@ const Index = () => {
     };
     if (action === 'add' && trimmedLimit) {
       params.limit = trimmedLimit;
-    } else if (action === 'delete') {
-      params.limit = '0';
     }
 
     try {

packages/snap/src/context.ts

@@ -162,6 +162,10 @@ const refreshConfirmationPricesHandler = new RefreshConfirmationPricesHandler({
 
 const trackTransactionHandler = new TrackTransactionHandler({
   logger,
+  networkService,
+  onChainAccountService,
+  accountService,
+  transactionService,
 });
 
 const syncAccountsHandler = new SyncAccountsHandler({

packages/snap/src/handlers/clientRequest/changeTrustOpt.test.ts

@@ -38,6 +38,7 @@ import { getTestWallet } from '../../services/wallet/__mocks__/wallet.fixtures';
 import { ConfirmationInterfaceKey } from '../../ui/confirmation/api';
 import { ConfirmationUXController } from '../../ui/confirmation/controller';
 import { logger } from '../../utils/logger';
+import { TrackTransactionHandler } from '../cronjob/trackTransaction';
 
 jest.mock('../../utils/logger');
 jest.mock('@metamask/keyring-snap-sdk', () => ({
@@ -48,6 +49,9 @@ describe('ChangeTrustOptHandler', () => {
   beforeEach(() => {
     jest.mocked(emitSnapKeyringEvent).mockReset();
     jest.mocked(emitSnapKeyringEvent).mockResolvedValue(undefined);
+    jest
+      .spyOn(TrackTransactionHandler, 'scheduleBackgroundEvent')
+      .mockResolvedValue(undefined);
   });
 
   const accountId = '11111111-1111-4111-8111-111111111111';
@@ -247,6 +251,13 @@ describe('ChangeTrustOptHandler', () => {
         },
       },
     });
+    expect(
+      TrackTransactionHandler.scheduleBackgroundEvent,
+    ).toHaveBeenCalledWith({
+      txId: 'dGVzdC10eC1pZA==',
+      scope,
+      accountIds: [account.id],
+    });
   });
 
   it('returns success early for opt-in when trustline already exists', async () => {
@@ -269,6 +280,9 @@ describe('ChangeTrustOptHandler', () => {
     expect(signTransactionSpy).not.toHaveBeenCalled();
     expect(sendTransaction).not.toHaveBeenCalled();
     expect(savePendingKeyringTransaction).not.toHaveBeenCalled();
+    expect(
+      TrackTransactionHandler.scheduleBackgroundEvent,
+    ).not.toHaveBeenCalled();
   });
 
   it('throws TrustlineNotFoundException for opt-out when trustline does not exist', async () => {
@@ -336,6 +350,13 @@ describe('ChangeTrustOptHandler', () => {
         },
       },
     });
+    expect(
+      TrackTransactionHandler.scheduleBackgroundEvent,
+    ).toHaveBeenCalledWith({
+      txId: 'dGVzdC10eC1pZA==',
+      scope,
+      accountIds: [account.id],
+    });
   });
 
   it('throws UserRejectedRequestError when confirmation is rejected', async () => {
@@ -357,6 +378,9 @@ describe('ChangeTrustOptHandler', () => {
     expect(sendTransaction).not.toHaveBeenCalled();
     expect(networkSendSpy).not.toHaveBeenCalled();
     expect(savePendingKeyringTransaction).not.toHaveBeenCalled();
+    expect(
+      TrackTransactionHandler.scheduleBackgroundEvent,
+    ).not.toHaveBeenCalled();
   });
 
   it('continues successfully when saving pending transaction fails', async () => {
@@ -373,5 +397,6 @@ describe('ChangeTrustOptHandler', () => {
       transactionId: 'dGVzdC10eC1pZA==',
     });
     expect(sendTransaction).toHaveBeenCalledTimes(1);
+    expect(TrackTransactionHandler.scheduleBackgroundEvent).toHaveBeenCalled();
   });
 });

packages/snap/src/handlers/clientRequest/changeTrustOpt.ts

@@ -41,6 +41,7 @@ import type { WalletService } from '../../services/wallet';
 import { ConfirmationInterfaceKey } from '../../ui/confirmation/api';
 import type { ConfirmationUXController } from '../../ui/confirmation/controller';
 import { createPrefixedLogger, type ILogger } from '../../utils/logger';
+import { TrackTransactionHandler } from '../cronjob/trackTransaction';
 
 export class ChangeTrustOptHandler extends WithClientRequestActiveAccountResolve<
   ChangeTrustOptJsonRpcRequest,
@@ -164,6 +165,12 @@ export class ChangeTrustOptHandler extends WithClientRequestActiveAccountResolve
       action,
     });
 
+    await TrackTransactionHandler.scheduleBackgroundEvent({
+      txId: transactionId,
+      scope,
+      accountIds: [account.id],
+    });
+
     return {
       status: true,
       transactionId,

packages/snap/src/handlers/cronjob/api.test.ts

@@ -49,6 +49,12 @@ describe('Cronjob API structs', () => {
       expect(value).toStrictEqual({ accountIds: [id] });
     });
 
+    it('accepts empty object when accountIds is omitted', () => {
+      const value = {};
+      assert(value, SyncAccountParamsStruct);
+      expect(value).toStrictEqual({});
+    });
+
     it('rejects empty account id arrays', () => {
       expect(() => assert({ accountIds: [] }, SyncAccountParamsStruct)).toThrow(
         StructError,
@@ -92,6 +98,20 @@ describe('Cronjob API structs', () => {
       });
     });
 
+    it('accepts synchronize accounts requests with empty params object', () => {
+      const value = {
+        ...jsonRpcBase,
+        method: BackgroundEventMethod.SynchronizeAccounts,
+        params: {},
+      };
+      assert(value, SyncAccountJsonRpcRequestStruct);
+      expect(value).toStrictEqual({
+        ...jsonRpcBase,
+        method: BackgroundEventMethod.SynchronizeAccounts,
+        params: {},
+      });
+    });
+
     it('rejects wrong method for synchronize accounts request', () => {
       expect(() =>
         assert(

packages/snap/src/handlers/cronjob/api.ts

@@ -4,10 +4,12 @@ import {
   assign,
   boolean,
   enums,
+  integer,
   literal,
   nonempty,
   object,
   optional,
+  size,
   string,
   type,
   union,
@@ -48,10 +50,15 @@ export const TrackTransactionParamsStruct = type({
   txId: nonempty(string()),
   scope: KnownCaip2ChainIdStruct,
   accountIds: nonempty(array(UuidStruct)),
+  /** Reschedule counter; omitted on first schedule (treated as 0). */
+  attempt: optional(size(integer(), 0, 30)),
 });
 
 export const SyncAccountParamsStruct = object({
-  accountIds: union([nonempty(array(UuidStruct)), literal('selected')]),
+  /** Omitted or undefined means “selected accounts” (declarative cron may send `{}`). */
+  accountIds: optional(
+    union([nonempty(array(UuidStruct)), literal('selected')]),
+  ),
 });
 
 export const RefreshConfirmationPricesJsonRpcRequestStruct = assign(

packages/snap/src/handlers/cronjob/syncAccounts.test.ts

@@ -110,6 +110,27 @@ describe('SyncAccountsHandler', () => {
     );
   });
 
+  it('treats empty params object like selected accounts', async () => {
+    const { handler, accountService, onChainAccountService } = setupTest();
+    const selectedAccounts = [firstAccount];
+    accountService.getAllSelected.mockResolvedValue(selectedAccounts);
+
+    const request = {
+      jsonrpc: '2.0',
+      id: 1,
+      method: BackgroundEventMethod.SynchronizeAccounts,
+      params: {},
+    };
+
+    await handler.handle(request);
+
+    expect(accountService.getAllSelected).toHaveBeenCalledTimes(1);
+    expect(onChainAccountService.synchronize).toHaveBeenCalledWith(
+      selectedAccounts,
+      AppConfig.selectedNetwork,
+    );
+  });
+
   it('synchronizes accounts fetched by ids when accountIds is an array of account ids', async () => {
     const { handler, accountService, onChainAccountService } = setupTest();
     const accountIds = [firstAccount.id, secondAccount.id];

packages/snap/src/handlers/cronjob/syncAccounts.ts

@@ -56,16 +56,13 @@ export class SyncAccountsHandler extends CronjobBaseHandler<SyncAccountJsonRpcRe
    * `JSON.parse(JSON.stringify(jobs))` validated successfully (same logical shape).
    * Omitted params mean "selected accounts" here.
    *
-   * @param request SyncAccountJsonRpcRequest
+   * @param request - Cron JSON-RPC request (params may be omitted or `{}`).
    */
   protected async handleCronJobRequest(
     request: SyncAccountJsonRpcRequest,
   ): Promise<void> {
     const scope = AppConfig.selectedNetwork;
-    const accountIds =
-      request.params === undefined
-        ? ('selected' as const)
-        : request.params.accountIds;
+    const accountIds = request.params?.accountIds ?? ('selected' as const);
 
     let accounts: StellarKeyringAccount[] = [];
     if (accountIds === 'selected') {