Remove fee history fallback (#4210)

Remove the fee history logic from the `GasFeeController`, meaning if the gas API does not support a network, a standard `eth_gasPrice` call is the only fallback.
MetaMask · Apr 27, 2024 · 9349754 · 9349754
1 parent 843a794
commit 9349754
Show file tree

Hide file tree

Showing 14 changed files with 186 additions and 1,422 deletions.
diff --git a/packages/gas-fee-controller/jest.config.js b/packages/gas-fee-controller/jest.config.js
@@ -17,10 +17,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 82.5,
-      functions: 81,
-      lines: 88,
-      statements: 88,
+      branches: 81.35,
+      functions: 81.57,
+      lines: 86.28,
+      statements: 86.44,
     },
   },
 });
diff --git a/packages/gas-fee-controller/src/GasFeeController.test.ts b/packages/gas-fee-controller/src/GasFeeController.test.ts
@@ -18,7 +18,6 @@ import type { Hex } from '@metamask/utils';
 import * as sinon from 'sinon';
 
 import determineGasFeeCalculations from './determineGasFeeCalculations';
-import fetchGasEstimatesViaEthFeeHistory from './fetchGasEstimatesViaEthFeeHistory';
 import {
   fetchGasEstimates,
   fetchLegacyGasPriceEstimates,
@@ -341,7 +340,6 @@ describe('GasFeeController', () => {
             isLegacyGasAPICompatible: true,
             fetchGasEstimates,
             fetchGasEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/suggestedGasFees`,
-            fetchGasEstimatesViaEthFeeHistory,
             fetchLegacyGasPriceEstimates,
             fetchLegacyGasPriceEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/gasPrices`,
             fetchEthGasPriceEstimate,
@@ -398,7 +396,6 @@ describe('GasFeeController', () => {
             isLegacyGasAPICompatible: true,
             fetchGasEstimates,
             fetchGasEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/suggestedGasFees`,
-            fetchGasEstimatesViaEthFeeHistory,
             fetchLegacyGasPriceEstimates,
             fetchLegacyGasPriceEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/gasPrices`,
             fetchEthGasPriceEstimate,
@@ -736,7 +733,6 @@ describe('GasFeeController', () => {
           isLegacyGasAPICompatible: true,
           fetchGasEstimates,
           fetchGasEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/suggestedGasFees`,
-          fetchGasEstimatesViaEthFeeHistory,
           fetchLegacyGasPriceEstimates,
           fetchLegacyGasPriceEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/gasPrices`,
           fetchEthGasPriceEstimate,
@@ -881,7 +877,6 @@ describe('GasFeeController', () => {
           isLegacyGasAPICompatible: false,
           fetchGasEstimates,
           fetchGasEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/suggestedGasFees`,
-          fetchGasEstimatesViaEthFeeHistory,
           fetchLegacyGasPriceEstimates,
           fetchLegacyGasPriceEstimatesUrl: `${GAS_API_BASE_URL}/networks/1337/gasPrices`,
           fetchEthGasPriceEstimate,
@@ -977,7 +972,6 @@ describe('GasFeeController', () => {
           fetchGasEstimatesUrl: `${GAS_API_BASE_URL}/networks/${convertHexToDecimal(
             ChainId.goerli,
           )}/suggestedGasFees`,
-          fetchGasEstimatesViaEthFeeHistory,
           fetchLegacyGasPriceEstimates,
           fetchLegacyGasPriceEstimatesUrl: `${GAS_API_BASE_URL}/networks/${convertHexToDecimal(
             ChainId.goerli,

diff --git a/packages/gas-fee-controller/src/GasFeeController.ts b/packages/gas-fee-controller/src/GasFeeController.ts
@@ -23,7 +23,6 @@ import type { Hex } from '@metamask/utils';
 import { v1 as random } from 'uuid';
 
 import determineGasFeeCalculations from './determineGasFeeCalculations';
-import fetchGasEstimatesViaEthFeeHistory from './fetchGasEstimatesViaEthFeeHistory';
 import {
   calculateTimeEstimate,
   fetchGasEstimates,
@@ -466,7 +465,6 @@ export class GasFeeController extends StaticIntervalPollingController<
         '<chain_id>',
         `${decimalChainId}`,
       ),
-      fetchGasEstimatesViaEthFeeHistory,
       fetchLegacyGasPriceEstimates,
       fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace(
         '<chain_id>',

diff --git a/packages/gas-fee-controller/src/determineGasFeeCalculations.test.ts b/packages/gas-fee-controller/src/determineGasFeeCalculations.test.ts
@@ -1,5 +1,4 @@
 import determineGasFeeCalculations from './determineGasFeeCalculations';
-import fetchGasEstimatesViaEthFeeHistory from './fetchGasEstimatesViaEthFeeHistory';
 import {
   fetchGasEstimates,
   fetchLegacyGasPriceEstimates,
@@ -15,7 +14,6 @@ import type {
 } from './GasFeeController';
 
 jest.mock('./gas-util');
-jest.mock('./fetchGasEstimatesViaEthFeeHistory');
 
 const mockedFetchGasEstimates = fetchGasEstimates as jest.Mock<
   ReturnType<typeof fetchGasEstimates>,
@@ -34,11 +32,6 @@ const mockedCalculateTimeEstimate = calculateTimeEstimate as jest.Mock<
   ReturnType<typeof calculateTimeEstimate>,
   Parameters<typeof calculateTimeEstimate>
 >;
-const mockedFetchGasEstimatesViaEthFeeHistory =
-  fetchGasEstimatesViaEthFeeHistory as jest.Mock<
-    ReturnType<typeof fetchGasEstimatesViaEthFeeHistory>,
-    Parameters<typeof fetchGasEstimatesViaEthFeeHistory>
-  >;
 
 const INFURA_API_KEY_MOCK = 'test';
 
@@ -126,7 +119,6 @@ describe('determineGasFeeCalculations', () => {
     isEIP1559Compatible: false,
     isLegacyGasAPICompatible: false,
     fetchGasEstimates: mockedFetchGasEstimates,
-    fetchGasEstimatesViaEthFeeHistory: mockedFetchGasEstimatesViaEthFeeHistory,
     fetchGasEstimatesUrl: 'http://doesnt-matter',
     fetchLegacyGasPriceEstimates: mockedFetchLegacyGasPriceEstimates,
     fetchLegacyGasPriceEstimatesUrl: 'http://doesnt-matter',
@@ -166,17 +158,10 @@ describe('determineGasFeeCalculations', () => {
     });
 
     describe('when nonRPCGasFeeApisDisabled is true', () => {
-      describe('assuming fetchGasEstimatesViaEthFeeHistory does not throw an error', () => {
-        it('returns a combination of the fetched fee and time estimates', async () => {
-          const gasFeeEstimates = buildMockDataForFetchGasEstimates();
-          mockedFetchGasEstimatesViaEthFeeHistory.mockResolvedValue(
-            gasFeeEstimates,
-          );
-          const estimatedGasFeeTimeBounds =
-            buildMockDataForCalculateTimeEstimate();
-          mockedCalculateTimeEstimate.mockReturnValue(
-            estimatedGasFeeTimeBounds,
-          );
+      describe('assuming fetchEthGasPriceEstimate does not throw an error', () => {
+        it('returns the fetched fee estimates and an empty set of time estimates', async () => {
+          const gasFeeEstimates = buildMockDataForFetchEthGasPriceEstimate();
+          mockedFetchEthGasPriceEstimate.mockResolvedValue(gasFeeEstimates);
 
           const gasFeeCalculations = await determineGasFeeCalculations({
             ...options,
@@ -187,37 +172,26 @@ describe('determineGasFeeCalculations', () => {
 
           expect(gasFeeCalculations).toStrictEqual({
             gasFeeEstimates,
-            estimatedGasFeeTimeBounds,
-            gasEstimateType: 'fee-market',
+            estimatedGasFeeTimeBounds: {},
+            gasEstimateType: 'eth_gasPrice',
           });
         });
       });
 
-      describe('when fetchGasEstimatesViaEthFeeHistory throws an error', () => {
-        beforeEach(() => {
-          mockedFetchGasEstimatesViaEthFeeHistory.mockImplementation(() => {
-            throw new Error('Some API failure');
+      describe('when fetchEthGasPriceEstimate throws an error', () => {
+        it('throws an error that wraps that error', async () => {
+          mockedFetchEthGasPriceEstimate.mockImplementation(() => {
+            throw new Error('fetchEthGasPriceEstimate failed');
           });
-        });
-
-        describe('assuming fetchEthGasPriceEstimate does not throw an error', () => {
-          it('returns the fetched fee estimates and an empty set of time estimates', async () => {
-            const gasFeeEstimates = buildMockDataForFetchEthGasPriceEstimate();
-            mockedFetchEthGasPriceEstimate.mockResolvedValue(gasFeeEstimates);
 
-            const gasFeeCalculations = await determineGasFeeCalculations({
-              ...options,
-              nonRPCGasFeeApisDisabled: true,
-            });
-
-            expect(mockedFetchGasEstimates).toHaveBeenCalledTimes(0);
-
-            expect(gasFeeCalculations).toStrictEqual({
-              gasFeeEstimates,
-              estimatedGasFeeTimeBounds: {},
-              gasEstimateType: 'eth_gasPrice',
-            });
+          const promise = determineGasFeeCalculations({
+            ...options,
+            nonRPCGasFeeApisDisabled: true,
           });
+
+          await expect(promise).rejects.toThrow(
+            'Gas fee/price estimation failed. Message: fetchEthGasPriceEstimate failed',
+          );
         });
       });
     });
@@ -229,103 +203,32 @@ describe('determineGasFeeCalculations', () => {
         });
       });
 
-      describe('assuming neither fetchGasEstimatesViaEthFeeHistory nor calculateTimeEstimate throws errors', () => {
-        it('returns a combination of the fetched fee and time estimates', async () => {
-          const gasFeeEstimates = buildMockDataForFetchGasEstimates();
-          mockedFetchGasEstimatesViaEthFeeHistory.mockResolvedValue(
-            gasFeeEstimates,
-          );
-          const estimatedGasFeeTimeBounds =
-            buildMockDataForCalculateTimeEstimate();
-          mockedCalculateTimeEstimate.mockReturnValue(
-            estimatedGasFeeTimeBounds,
-          );
+      describe('assuming fetchEthGasPriceEstimate does not throw an error', () => {
+        it('returns the fetched fee estimates and an empty set of time estimates', async () => {
+          const gasFeeEstimates = buildMockDataForFetchEthGasPriceEstimate();
+          mockedFetchEthGasPriceEstimate.mockResolvedValue(gasFeeEstimates);
 
           const gasFeeCalculations = await determineGasFeeCalculations(options);
 
           expect(gasFeeCalculations).toStrictEqual({
             gasFeeEstimates,
-            estimatedGasFeeTimeBounds,
-            gasEstimateType: 'fee-market',
-          });
-        });
-      });
-
-      describe('when fetchGasEstimatesViaEthFeeHistory throws an error', () => {
-        beforeEach(() => {
-          mockedFetchGasEstimatesViaEthFeeHistory.mockImplementation(() => {
-            throw new Error('Some API failure');
-          });
-        });
-
-        describe('assuming fetchEthGasPriceEstimate does not throw an error', () => {
-          it('returns the fetched fee estimates and an empty set of time estimates', async () => {
-            const gasFeeEstimates = buildMockDataForFetchEthGasPriceEstimate();
-            mockedFetchEthGasPriceEstimate.mockResolvedValue(gasFeeEstimates);
-
-            const gasFeeCalculations = await determineGasFeeCalculations(
-              options,
-            );
-
-            expect(gasFeeCalculations).toStrictEqual({
-              gasFeeEstimates,
-              estimatedGasFeeTimeBounds: {},
-              gasEstimateType: 'eth_gasPrice',
-            });
-          });
-        });
-
-        describe('when fetchEthGasPriceEstimate throws an error', () => {
-          it('throws an error that wraps that error', async () => {
-            mockedFetchEthGasPriceEstimate.mockImplementation(() => {
-              throw new Error('fetchEthGasPriceEstimate failed');
-            });
-
-            const promise = determineGasFeeCalculations(options);
-
-            await expect(promise).rejects.toThrow(
-              'Gas fee/price estimation failed. Message: fetchEthGasPriceEstimate failed',
-            );
+            estimatedGasFeeTimeBounds: {},
+            gasEstimateType: 'eth_gasPrice',
           });
         });
       });
 
-      describe('when fetchGasEstimatesViaEthFeeHistory does not throw an error, but calculateTimeEstimate throws an error', () => {
-        beforeEach(() => {
-          mockedCalculateTimeEstimate.mockImplementation(() => {
-            throw new Error('Some API failure');
-          });
-        });
-
-        describe('assuming fetchEthGasPriceEstimate does not throw an error', () => {
-          it('returns the fetched fee estimates and an empty set of time estimates', async () => {
-            const gasFeeEstimates = buildMockDataForFetchEthGasPriceEstimate();
-            mockedFetchEthGasPriceEstimate.mockResolvedValue(gasFeeEstimates);
-
-            const gasFeeCalculations = await determineGasFeeCalculations(
-              options,
-            );
-
-            expect(gasFeeCalculations).toStrictEqual({
-              gasFeeEstimates,
-              estimatedGasFeeTimeBounds: {},
-              gasEstimateType: 'eth_gasPrice',
-            });
+      describe('when fetchEthGasPriceEstimate throws an error', () => {
+        it('throws an error that wraps that error', async () => {
+          mockedFetchEthGasPriceEstimate.mockImplementation(() => {
+            throw new Error('fetchEthGasPriceEstimate failed');
           });
-        });
-
-        describe('when fetchEthGasPriceEstimate throws an error', () => {
-          it('throws an error that wraps that error', async () => {
-            mockedFetchEthGasPriceEstimate.mockImplementation(() => {
-              throw new Error('fetchEthGasPriceEstimate failed');
-            });
 
-            const promise = determineGasFeeCalculations(options);
+          const promise = determineGasFeeCalculations(options);
 
-            await expect(promise).rejects.toThrow(
-              'Gas fee/price estimation failed. Message: fetchEthGasPriceEstimate failed',
-            );
-          });
+          await expect(promise).rejects.toThrow(
+            'Gas fee/price estimation failed. Message: fetchEthGasPriceEstimate failed',
+          );
         });
       });
     });