Extends GasFeePoller to update gas properties for unapproved transaction batches

packages/transaction-controller/CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Query only latest page of transactions from accounts API ([#5983](https://github.com/MetaMask/core/pull/5983))
 - Remove incoming transactions when calling `wipeTransactions` ([#5986](https://github.com/MetaMask/core/pull/5986))
 - Poll immediately when calling `startIncomingTransactionPolling` ([#5986](https://github.com/MetaMask/core/pull/5986))
+- Extend `GasFeePoller` to support gas updates for unapproved `transactionBatches`, emitting `transaction-batch-updated` with `gasFeeEstimates`. ([#5950](https://github.com/MetaMask/core/pull/5950))
 
 ## [58.0.0]
 

packages/transaction-controller/src/TransactionController.ts

@@ -940,6 +940,7 @@ export class TransactionController extends BaseController<
       getGasFeeControllerEstimates: this.#getGasFeeEstimates,
       getProvider: (networkClientId) => this.#getProvider({ networkClientId }),
       getTransactions: () => this.state.transactions,
+      getTransactionBatches: () => this.state.transactionBatches,
       layer1GasFeeFlows: this.#layer1GasFeeFlows,
       messenger: this.messagingSystem,
       onStateChange: (listener) => {
@@ -955,6 +956,11 @@ export class TransactionController extends BaseController<
       this.#onGasFeePollerTransactionUpdate.bind(this),
     );
 
+    gasFeePoller.hub.on(
+      'transaction-batch-updated',
+      this.#onGasFeePollerTransactionBatchUpdate.bind(this),
+    );
+
     this.#methodDataHelper = new MethodDataHelper({
       getProvider: (networkClientId) => this.#getProvider({ networkClientId }),
       getState: () => this.state.methodData,
@@ -4226,6 +4232,37 @@ export class TransactionController extends BaseController<
     );
   }
 
+  #onGasFeePollerTransactionBatchUpdate({
+    transactionBatchId,
+    gasFeeEstimates,
+  }: {
+    transactionBatchId: Hex;
+    gasFeeEstimates?: GasFeeEstimates;
+  }) {
+    this.#updateTransactionBatch(transactionBatchId, (batch) => {
+      batch.gasFeeEstimates = gasFeeEstimates;
+      return batch;
+    });
+  }
+
+  #updateTransactionBatch(
+    batchId: string,
+    callback: (batch: TransactionBatchMeta) => TransactionBatchMeta | void,
+  ): void {
+    this.update((state) => {
+      const index = state.transactionBatches.findIndex((b) => b.id === batchId);
+
+      if (index === -1) {
+        throw new Error(`Cannot update batch, ID not found - ${batchId}`);
+      }
+
+      const batch = state.transactionBatches[index];
+      const updated = callback(batch);
+
+      state.transactionBatches[index] = updated ?? batch;
+    });
+  }
+
   #getSelectedAccount() {
     return this.messagingSystem.call('AccountsController:getSelectedAccount');
   }

packages/transaction-controller/src/helpers/GasFeePoller.test.ts

@@ -1,3 +1,4 @@
+import EthQuery from '@metamask/eth-query';
 import type { Provider } from '@metamask/network-controller';
 import type { Hex } from '@metamask/utils';
 
@@ -7,8 +8,13 @@ import {
   updateTransactionGasEstimates,
 } from './GasFeePoller';
 import { flushPromises } from '../../../../tests/helpers';
+import { DefaultGasFeeFlow } from '../gas-flows/DefaultGasFeeFlow';
 import type { TransactionControllerMessenger } from '../TransactionController';
-import type { GasFeeFlowResponse, Layer1GasFeeFlow } from '../types';
+import type {
+  GasFeeFlowResponse,
+  Layer1GasFeeFlow,
+  TransactionBatchMeta,
+} from '../types';
 import {
   GasFeeEstimateLevel,
   GasFeeEstimateType,
@@ -44,6 +50,22 @@ const TRANSACTION_META_MOCK: TransactionMeta = {
   },
 };
 
+const TRANSACTION_BATCH_META_MOCK: TransactionBatchMeta = {
+  id: 'batch1',
+  chainId: CHAIN_ID_MOCK,
+  networkClientId: NETWORK_CLIENT_ID_MOCK,
+  status: TransactionStatus.unapproved,
+  transactions: [
+    {
+      gas: '0x5208',
+    },
+    {
+      gas: '0x5208',
+    },
+  ],
+  from: '0x123',
+};
+
 const FEE_MARKET_GAS_FEE_ESTIMATES_MOCK = {
   type: GasFeeEstimateType.FeeMarket,
   [GasFeeEstimateLevel.Low]: {
@@ -93,6 +115,9 @@ describe('GasFeePoller', () => {
   let gasFeeFlowMock: jest.Mocked<GasFeeFlow>;
   let triggerOnStateChange: () => void;
   let getTransactionsMock: jest.MockedFunction<() => TransactionMeta[]>;
+  let getTransactionBatchesMock: jest.MockedFunction<
+    () => TransactionBatchMeta[]
+  >;
   const getTransactionLayer1GasFeeMock = jest.mocked(
     getTransactionLayer1GasFee,
   );
@@ -113,13 +138,19 @@ describe('GasFeePoller', () => {
     getTransactionsMock = jest.fn();
     getTransactionsMock.mockReturnValue([{ ...TRANSACTION_META_MOCK }]);
 
+    getTransactionBatchesMock = jest.fn();
+    getTransactionBatchesMock.mockReturnValue([
+      { ...TRANSACTION_BATCH_META_MOCK },
+    ]);
+
     getTransactionLayer1GasFeeMock.mockResolvedValue(LAYER1_GAS_FEE_MOCK);
 
     constructorOptions = {
       findNetworkClientIdByChainId: findNetworkClientIdByChainIdMock,
       gasFeeFlows: [gasFeeFlowMock],
       getGasFeeControllerEstimates: getGasFeeControllerEstimatesMock,
       getTransactions: getTransactionsMock,
+      getTransactionBatches: getTransactionBatchesMock,
       layer1GasFeeFlows: layer1GasFeeFlowsMock,
       messenger: messengerMock,
       onStateChange: (listener: () => void) => {
@@ -212,6 +243,7 @@ describe('GasFeePoller', () => {
 
         getTransactionsMock.mockReturnValueOnce([{ ...TRANSACTION_META_MOCK }]);
         getTransactionsMock.mockReturnValueOnce([]);
+        getTransactionBatchesMock.mockReturnValue([]);
 
         const gasFeePoller = new GasFeePoller(constructorOptions);
         gasFeePoller.hub.on('transaction-updated', listener);
@@ -254,6 +286,155 @@ describe('GasFeePoller', () => {
           triggerOnStateChange();
           await flushPromises();
 
+          expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledTimes(4);
+          expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledWith({
+            networkClientId: 'networkClientId1',
+          });
+          expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledWith({
+            networkClientId: 'networkClientId2',
+          });
+          expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledWith({
+            networkClientId: 'networkClientId4',
+          });
+          expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledWith({
+            networkClientId: NETWORK_CLIENT_ID_MOCK,
+          });
+        });
+      });
+    });
+
+    describe('if unapproved transaction batches', () => {
+      let getGasFeesMock: jest.Mock;
+      beforeEach(() => {
+        getGasFeesMock = jest.fn().mockResolvedValue({
+          estimates: FEE_MARKET_GAS_FEE_ESTIMATES_MOCK,
+        });
+        jest
+          .spyOn(DefaultGasFeeFlow.prototype, 'getGasFees')
+          .mockImplementation(getGasFeesMock);
+      });
+
+      it('emits batch updated event', async () => {
+        const listener = jest.fn();
+        getTransactionsMock.mockReturnValue([]);
+        const gasFeePoller = new GasFeePoller(constructorOptions);
+        gasFeePoller.hub.on('transaction-batch-updated', listener);
+
+        triggerOnStateChange();
+        await flushPromises();
+
+        expect(listener).toHaveBeenCalledTimes(1);
+        expect(listener).toHaveBeenCalledWith({
+          transactionBatchId: TRANSACTION_BATCH_META_MOCK.id,
+          gasFeeEstimates: GAS_FEE_FLOW_RESPONSE_MOCK.estimates,
+          gasFeeEstimatesLoaded: true,
+        });
+      });
+
+      it('calls gas fee flow for batches', async () => {
+        getGasFeeControllerEstimatesMock.mockResolvedValue({});
+
+        new GasFeePoller(constructorOptions);
+
+        triggerOnStateChange();
+        await flushPromises();
+
+        expect(gasFeeFlowMock.getGasFees).toHaveBeenCalledTimes(1);
+        expect(gasFeeFlowMock.getGasFees).toHaveBeenCalledWith({
+          ethQuery: expect.any(EthQuery),
+          gasFeeControllerData: expect.any(Object),
+          messenger: expect.any(Function),
+          transactionMeta: {
+            id: '1',
+            chainId: TRANSACTION_BATCH_META_MOCK.chainId,
+            networkClientId: TRANSACTION_BATCH_META_MOCK.networkClientId,
+            status: TRANSACTION_BATCH_META_MOCK.status,
+            time: expect.any(Number),
+            txParams: {
+              from: TRANSACTION_BATCH_META_MOCK.from,
+              type: TransactionEnvelopeType.feeMarket,
+            },
+          },
+        });
+      });
+
+      it('creates polling timeout for batches', async () => {
+        new GasFeePoller(constructorOptions);
+
+        triggerOnStateChange();
+        await flushPromises();
+
+        expect(jest.getTimerCount()).toBe(1);
+
+        jest.runOnlyPendingTimers();
+        await flushPromises();
+
+        expect(gasFeeFlowMock.getGasFees).toHaveBeenCalledTimes(2);
+      });
+
+      it('does not create additional polling timeout on subsequent state changes', async () => {
+        new GasFeePoller(constructorOptions);
+
+        triggerOnStateChange();
+        await flushPromises();
+
+        triggerOnStateChange();
+        await flushPromises();
+
+        expect(jest.getTimerCount()).toBe(1);
+      });
+
+      it('does nothing if no transaction batches', async () => {
+        const listener = jest.fn();
+
+        getTransactionsMock.mockReturnValue([]);
+        getTransactionBatchesMock.mockReturnValueOnce([
+          { ...TRANSACTION_BATCH_META_MOCK },
+        ]);
+        getTransactionBatchesMock.mockReturnValueOnce([]);
+
+        const gasFeePoller = new GasFeePoller(constructorOptions);
+        gasFeePoller.hub.on('transaction-batch-updated', listener);
+
+        triggerOnStateChange();
+        await flushPromises();
+
+        expect(listener).toHaveBeenCalledTimes(0);
+        expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledTimes(0);
+        expect(gasFeeFlowMock.getGasFees).toHaveBeenCalledTimes(0);
+      });
+
+      describe('fetches GasFeeController data for batches', () => {
+        it('for each unique chain ID in batches', async () => {
+          getTransactionsMock.mockReturnValue([]);
+          getTransactionBatchesMock.mockReturnValue([
+            {
+              ...TRANSACTION_BATCH_META_MOCK,
+              chainId: '0x1',
+              networkClientId: 'networkClientId1',
+            },
+            {
+              ...TRANSACTION_BATCH_META_MOCK,
+              chainId: '0x2',
+              networkClientId: 'networkClientId2',
+            },
+            {
+              ...TRANSACTION_BATCH_META_MOCK,
+              chainId: '0x2',
+              networkClientId: 'networkClientId3',
+            },
+            {
+              ...TRANSACTION_BATCH_META_MOCK,
+              chainId: '0x3',
+              networkClientId: 'networkClientId4',
+            },
+          ]);
+
+          new GasFeePoller(constructorOptions);
+
+          triggerOnStateChange();
+          await flushPromises();
+
           expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledTimes(3);
           expect(getGasFeeControllerEstimatesMock).toHaveBeenCalledWith({
             networkClientId: 'networkClientId1',
@@ -348,6 +529,7 @@ describe('GasFeePoller', () => {
       await flushPromises();
 
       getTransactionsMock.mockReturnValue([]);
+      getTransactionBatchesMock.mockReturnValue([]);
 
       triggerOnStateChange();
       await flushPromises();