WIP start integrating abstract class into GasFeeController

Author: shanejonas

packages/gas-fee-controller/src/GasFeeController.ts

@@ -1,8 +1,12 @@
 import type { RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseControllerV2 } from '@metamask/base-controller';
-import { convertHexToDecimal, safelyExecute } from '@metamask/controller-utils';
+import { ChainId, convertHexToDecimal, safelyExecute } from '@metamask/controller-utils';
 import EthQuery from '@metamask/eth-query';
 import type {
+  NetworkClientId,
+  NetworkController,
+  NetworkControllerGetEIP1559CompatibilityAction,
+  NetworkControllerGetNetworkClientByIdAction,
   NetworkControllerGetStateAction,
   NetworkControllerStateChangeEvent,
   NetworkState,
@@ -20,6 +24,7 @@ import {
   fetchEthGasPriceEstimate,
   calculateTimeEstimate,
 } from './gas-util';
+import GasFeeControllerPolling from './GasFeeControllerPolling';
 
 export const LEGACY_GAS_PRICES_API_URL = `https://api.metaswap.codefi.network/gasPrices`;
 
@@ -150,6 +155,10 @@ type FallbackGasFeeEstimates = {
 };
 
 const metadata = {
+  gasFeeEstimatesByChainId: {
+    persist: true,
+    anonymous: false,
+  },
   gasFeeEstimates: { persist: true, anonymous: false },
   estimatedGasFeeTimeBounds: { persist: true, anonymous: false },
   gasEstimateType: { persist: true, anonymous: false },
@@ -190,12 +199,18 @@ export type FetchGasFeeEstimateOptions = {
  * @property gasFeeEstimates - Gas fee estimate data based on new EIP-1559 properties
  * @property estimatedGasFeeTimeBounds - Estimates representing the minimum and maximum
  */
-export type GasFeeState =
+export type GasFeeStateOld =
   | GasFeeStateEthGasPrice
   | GasFeeStateFeeMarket
   | GasFeeStateLegacy
   | GasFeeStateNoEstimates;
 
+export type GasFeeEstimatesByChainId = {
+  gasFeeEstimatesByChainId: Record<string, GasFeeStateOld>;
+};
+
+export type GasFeeState =  GasFeeEstimatesByChainId & GasFeeStateOld;
+
 const name = 'GasFeeController';
 
 export type GasFeeStateChange = {
@@ -210,13 +225,19 @@ export type GetGasFeeState = {
 
 type GasFeeMessenger = RestrictedControllerMessenger<
   typeof name,
-  GetGasFeeState | NetworkControllerGetStateAction,
+  | GetGasFeeState
+  | NetworkControllerGetStateAction
+  | NetworkControllerGetNetworkClientByIdAction
+  | NetworkControllerGetEIP1559CompatibilityAction,
   GasFeeStateChange | NetworkControllerStateChangeEvent,
-  NetworkControllerGetStateAction['type'],
+  | NetworkControllerGetStateAction['type']
+  | NetworkControllerGetNetworkClientByIdAction['type']
+  | NetworkControllerGetEIP1559CompatibilityAction['type'],
   NetworkControllerStateChangeEvent['type']
 >;
 
 const defaultState: GasFeeState = {
+  gasFeeEstimatesByChainId: {},
   gasFeeEstimates: {},
   estimatedGasFeeTimeBounds: {},
   gasEstimateType: GAS_ESTIMATE_TYPES.NONE,
@@ -225,7 +246,7 @@ const defaultState: GasFeeState = {
 /**
  * Controller that retrieves gas fee estimate data and polls for updated data on a set interval
  */
-export class GasFeeController extends BaseControllerV2<
+export class GasFeeController extends GasFeeControllerPolling<
   typeof name,
   GasFeeState,
   GasFeeMessenger
@@ -373,6 +394,65 @@ export class GasFeeController extends BaseControllerV2<
     return _pollToken;
   }
 
+  async #fetchGasFeeEstimateForNetworkClientId(networkClientId: string) {
+    let isEIP1559Compatible = false;
+
+    const networkClient = await this.messagingSystem.call(
+      'NetworkController:getNetworkClientById',
+      networkClientId,
+    );
+
+    const isLegacyGasAPICompatible =
+      networkClient.configuration.chainId === '0x38';
+
+    const decimalChainId = convertHexToDecimal(
+      networkClient.configuration.chainId,
+    );
+
+    try {
+      const result = await this.messagingSystem.call(
+        'NetworkController:getEIP1559Compatibility',
+        networkClientId,
+      );
+
+      isEIP1559Compatible = result || false;
+    } catch (e) {
+      console.error(e);
+      isEIP1559Compatible = false;
+    }
+
+    const ethQuery = new EthQuery(networkClient.provider);
+
+    const gasFeeCalculations = await determineGasFeeCalculations({
+      isEIP1559Compatible,
+      isLegacyGasAPICompatible,
+      fetchGasEstimates,
+      fetchGasEstimatesUrl: this.EIP1559APIEndpoint.replace(
+        '<chain_id>',
+        `${decimalChainId}`,
+      ),
+      fetchGasEstimatesViaEthFeeHistory,
+      fetchLegacyGasPriceEstimates,
+      fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace(
+        '<chain_id>',
+        `${decimalChainId}`,
+      ),
+      fetchEthGasPriceEstimate,
+      calculateTimeEstimate,
+      clientId: this.clientId,
+      ethQuery,
+    });
+
+    // update state per chainid?
+    this.update((state) => {
+      state.gasFeeEstimatesByChainId[networkClient.configuration.chainId] = {
+        gasFeeEstimates: gasFeeCalculations.gasFeeEstimates,
+        estimatedGasFeeTimeBounds: gasFeeCalculations.estimatedGasFeeTimeBounds,
+        gasEstimateType: gasFeeCalculations.gasEstimateType,
+      } as any;
+    });
+  }
+
   /**
    * Gets and sets gasFeeEstimates in state.
    *
@@ -470,6 +550,10 @@ export class GasFeeController extends BaseControllerV2<
     }, this.intervalDelay);
   }
 
+  async executePoll(networkClientId: string): Promise<void> {
+    await this.#fetchGasFeeEstimateForNetworkClientId(networkClientId);
+  }
+
   private resetState() {
     this.update(() => {
       return defaultState;

packages/network-controller/src/NetworkController.ts

@@ -458,11 +458,17 @@ export type NetworkControllerGetNetworkClientByIdAction = {
   handler: NetworkController['getNetworkClientById'];
 };
 
+export type NetworkControllerGetEIP1559CompatibilityAction = {
+  type: `NetworkController:getEIP1559Compatibility`;
+  handler: NetworkController['getEIP1559Compatibility'];
+};
+
 export type NetworkControllerActions =
   | NetworkControllerGetStateAction
   | NetworkControllerGetProviderConfigAction
   | NetworkControllerGetEthQueryAction
-  | NetworkControllerGetNetworkClientByIdAction;
+  | NetworkControllerGetNetworkClientByIdAction
+  | NetworkControllerGetEIP1559CompatibilityAction;
 
 export type NetworkControllerMessenger = RestrictedControllerMessenger<
   typeof name,
@@ -612,6 +618,11 @@ export class NetworkController extends BaseControllerV2<
       this.getNetworkClientById.bind(this),
     );
 
+    this.messagingSystem.registerActionHandler(
+      `${this.name}:getEIP1559Compatibility`,
+      this.getEIP1559Compatibility.bind(this),
+    );
+
     this.#previousProviderConfig = this.state.providerConfig;
   }
 
@@ -1072,7 +1083,7 @@ export class NetworkController extends BaseControllerV2<
    */
   async getEIP1559Compatibility(networkClientId?: NetworkClientId) {
     if (networkClientId) {
-      return this.get1555CompatibilityWithNetworkClientId(networkClientId);
+      return this.get1559CompatibilityWithNetworkClientId(networkClientId);
     }
     if (!this.#ethQuery) {
       return false;
@@ -1097,7 +1108,7 @@ export class NetworkController extends BaseControllerV2<
     return isEIP1559Compatible;
   }
 
-  async get1555CompatibilityWithNetworkClientId(
+  async get1559CompatibilityWithNetworkClientId(
     networkClientId: NetworkClientId,
   ) {
     let metadata = this.state.networksMetadata[networkClientId];