Merge branch 'develop' into salim/multichain-token-detection-final

Author: salimtb

app/scripts/controllers/swaps/index.ts

@@ -1,17 +1,14 @@
 import { Contract } from '@ethersproject/contracts';
-import {
-  ExternalProvider,
-  JsonRpcFetchFunc,
-  Web3Provider,
-} from '@ethersproject/providers';
+import { Web3Provider } from '@ethersproject/providers';
 import { BaseController, StateMetadata } from '@metamask/base-controller';
-import type { ChainId } from '@metamask/controller-utils';
 import { GasFeeState } from '@metamask/gas-fee-controller';
 import { TransactionParams } from '@metamask/transaction-controller';
 import { captureException } from '@sentry/browser';
 import { BigNumber } from 'bignumber.js';
 import abi from 'human-standard-token-abi';
 import { cloneDeep, mapValues } from 'lodash';
+import { NetworkClient, NetworkClientId } from '@metamask/network-controller';
+import { Hex } from '@metamask/utils';
 import { EtherDenomination } from '../../../../shared/constants/common';
 import { GasEstimateTypes } from '../../../../shared/constants/gas';
 import {
@@ -71,6 +68,13 @@ import type {
   Trade,
 } from './swaps.types';
 
+type Network = {
+  client: NetworkClient;
+  clientId: NetworkClientId;
+  chainId: Hex;
+  ethersProvider: Web3Provider;
+};
+
 const metadata: StateMetadata<SwapsControllerState> = {
   swapsState: {
     persist: false,
@@ -103,28 +107,27 @@ export default class SwapsController extends BaseController<
     properties: Record<string, string | boolean | number | null>;
   }) => void;
 
-  #ethersProvider: Web3Provider;
-
-  #ethersProviderChainId: ChainId;
-
   #indexOfNewestCallInFlight: number;
 
   #pollCount: number;
 
   #pollingTimeout: ReturnType<typeof setTimeout> | null = null;
 
-  #provider: ExternalProvider | JsonRpcFetchFunc;
-
-  #getEIP1559GasFeeEstimates: () => Promise<GasFeeState>;
+  #getEIP1559GasFeeEstimates: (options?: {
+    networkClientId?: NetworkClientId;
+    shouldUpdateState?: boolean;
+  }) => Promise<GasFeeState>;
 
   #getLayer1GasFee: (params: {
     transactionParams: TransactionParams;
-    chainId: ChainId;
+    networkClientId: NetworkClientId;
   }) => Promise<string>;
 
+  #network: Network | undefined;
+
   private _fetchTradesInfo: (
     fetchParams: FetchTradesInfoParams,
-    fetchMetadata: { chainId: ChainId },
+    fetchMetadata: { chainId: Hex },
   ) => Promise<{
     [aggId: string]: Quote;
   }> = defaultFetchTradesInfo;
@@ -267,11 +270,8 @@ export default class SwapsController extends BaseController<
 
     this.#getEIP1559GasFeeEstimates = opts.getEIP1559GasFeeEstimates;
     this.#getLayer1GasFee = opts.getLayer1GasFee;
-    this.#ethersProvider = new Web3Provider(opts.provider);
-    this.#ethersProviderChainId = this._getCurrentChainId();
     this.#indexOfNewestCallInFlight = 0;
     this.#pollCount = 0;
-    this.#provider = opts.provider;
 
     // TODO: this should be private, but since a lot of tests depends on spying on it
     // we cannot enforce privacy 100%
@@ -295,11 +295,11 @@ export default class SwapsController extends BaseController<
       return null;
     }
 
-    const { chainId } = fetchParamsMetaData;
-
-    if (chainId !== this.#ethersProviderChainId) {
-      this.#ethersProvider = new Web3Provider(this.#provider);
-      this.#ethersProviderChainId = chainId;
+    let network;
+    if (this.#network?.clientId === fetchParamsMetaData.networkClientId) {
+      network = this.#network;
+    } else {
+      network = this.#setNetwork(fetchParamsMetaData.networkClientId);
     }
 
     const { quotesPollingLimitEnabled, saveFetchedQuotes } =
@@ -327,8 +327,8 @@ export default class SwapsController extends BaseController<
     }
 
     let [newQuotes] = await Promise.all([
-      this._fetchTradesInfo(fetchParams, { ...fetchParamsMetaData }),
-      this._setSwapsNetworkConfig(),
+      this._fetchTradesInfo(fetchParams, { chainId: network.chainId }),
+      this._setSwapsNetworkConfig(network),
     ]);
 
     const { saveFetchedQuotes: saveFetchedQuotesAfterResponse } =
@@ -349,16 +349,16 @@ export default class SwapsController extends BaseController<
       destinationTokenInfo: fetchParamsMetaData?.destinationTokenInfo,
     }));
 
-    const isOptimism = chainId === CHAIN_IDS.OPTIMISM.toString();
-    const isBase = chainId === CHAIN_IDS.BASE.toString();
+    const isOptimism = network.chainId === CHAIN_IDS.OPTIMISM.toString();
+    const isBase = network.chainId === CHAIN_IDS.BASE.toString();
 
     if ((isOptimism || isBase) && Object.values(newQuotes).length > 0) {
       await Promise.all(
         Object.values(newQuotes).map(async (quote) => {
           if (quote.trade) {
             const multiLayerL1TradeFeeTotal = await this.#getLayer1GasFee({
               transactionParams: quote.trade,
-              chainId,
+              networkClientId: network.clientId,
             });
 
             quote.multiLayerL1TradeFeeTotal = multiLayerL1TradeFeeTotal;
@@ -372,13 +372,13 @@ export default class SwapsController extends BaseController<
 
     let approvalRequired = false;
     if (
-      !isSwapsDefaultTokenAddress(fetchParams.sourceToken, chainId) &&
+      !isSwapsDefaultTokenAddress(fetchParams.sourceToken, network.chainId) &&
       Object.values(newQuotes).length
     ) {
       const allowance = await this._getERC20Allowance(
         fetchParams.sourceToken,
         fetchParams.fromAddress,
-        chainId,
+        network,
       );
       const [firstQuote] = Object.values(newQuotes);
 
@@ -428,9 +428,9 @@ export default class SwapsController extends BaseController<
     if (Object.values(newQuotes).length === 0) {
       this.setSwapsErrorKey(QUOTES_NOT_AVAILABLE_ERROR);
     } else {
-      const topQuoteAndSavings = await this.getTopQuoteWithCalculatedSavings(
-        newQuotes,
-      );
+      const topQuoteAndSavings = await this.getTopQuoteWithCalculatedSavings({
+        quotes: newQuotes,
+      });
       if (Array.isArray(topQuoteAndSavings)) {
         topAggId = topQuoteAndSavings[0];
         newQuotes = topQuoteAndSavings[1];
@@ -476,11 +476,27 @@ export default class SwapsController extends BaseController<
     return [newQuotes, topAggId];
   }
 
-  public async getTopQuoteWithCalculatedSavings(
-    quotes: Record<string, Quote> = {},
-  ): Promise<[string | null, Record<string, Quote>] | Record<string, never>> {
+  public async getTopQuoteWithCalculatedSavings({
+    quotes,
+    networkClientId,
+  }: {
+    quotes: Record<string, Quote>;
+    networkClientId?: NetworkClientId;
+  }): Promise<[string | null, Record<string, Quote>] | Record<string, never>> {
+    let chainId;
+    if (networkClientId) {
+      const networkClient = this.messagingSystem.call(
+        'NetworkController:getNetworkClientById',
+        networkClientId,
+      );
+      chainId = networkClient.configuration.chainId;
+    } else if (this.#network === undefined) {
+      throw new Error('There is no network set');
+    } else {
+      chainId = this.#network.chainId;
+    }
+
     const { marketData } = this._getTokenRatesState();
-    const chainId = this._getCurrentChainId();
     const tokenConversionRates = marketData?.[chainId] ?? {};
 
     const { customGasPrice, customMaxPriorityFeePerGas } =
@@ -494,7 +510,7 @@ export default class SwapsController extends BaseController<
     const newQuotes = cloneDeep(quotes);
 
     const { gasFeeEstimates, gasEstimateType } =
-      await this.#getEIP1559GasFeeEstimates();
+      await this.#getEIP1559GasFeeEstimates({ networkClientId });
 
     let usedGasPrice = '0x0';
 
@@ -911,9 +927,9 @@ export default class SwapsController extends BaseController<
   };
 
   // Private Methods
-  private async _fetchSwapsNetworkConfig(chainId: ChainId) {
+  private async _fetchSwapsNetworkConfig(network: Network) {
     const response = await fetchWithCache({
-      url: getBaseApi('network', chainId),
+      url: getBaseApi('network', network.chainId),
       fetchOptions: { method: 'GET' },
       cacheOptions: { cacheRefreshTime: 600000 },
       functionName: '_fetchSwapsNetworkConfig',
@@ -983,29 +999,16 @@ export default class SwapsController extends BaseController<
     return newQuotes;
   }
 
-  private _getCurrentChainId(): ChainId {
-    const { selectedNetworkClientId } = this.messagingSystem.call(
-      'NetworkController:getState',
-    );
-    const {
-      configuration: { chainId },
-    } = this.messagingSystem.call(
-      'NetworkController:getNetworkClientById',
-      selectedNetworkClientId,
-    );
-    return chainId as ChainId;
-  }
-
   private async _getERC20Allowance(
     contractAddress: string,
     walletAddress: string,
-    chainId: ChainId,
+    network: Network,
   ) {
-    const contract = new Contract(contractAddress, abi, this.#ethersProvider);
+    const contract = new Contract(contractAddress, abi, network.ethersProvider);
     return await contract.allowance(
       walletAddress,
       SWAPS_CHAINID_CONTRACT_ADDRESS_MAP[
-        chainId as keyof typeof SWAPS_CHAINID_CONTRACT_ADDRESS_MAP
+        network.chainId as keyof typeof SWAPS_CHAINID_CONTRACT_ADDRESS_MAP
       ],
     );
   }
@@ -1053,8 +1056,7 @@ export default class SwapsController extends BaseController<
   }
 
   // Sets the network config from the MetaSwap API.
-  private async _setSwapsNetworkConfig() {
-    const chainId = this._getCurrentChainId();
+  private async _setSwapsNetworkConfig(network: Network) {
     let swapsNetworkConfig: {
       quotes: number;
       quotesPrefetching: number;
@@ -1065,7 +1067,7 @@ export default class SwapsController extends BaseController<
     } | null = null;
 
     try {
-      swapsNetworkConfig = await this._fetchSwapsNetworkConfig(chainId);
+      swapsNetworkConfig = await this._fetchSwapsNetworkConfig(network);
     } catch (e) {
       console.error('Request for Swaps network config failed: ', e);
     }
@@ -1142,4 +1144,25 @@ export default class SwapsController extends BaseController<
         });
     });
   }
+
+  #setNetwork(networkClientId: NetworkClientId) {
+    const networkClient = this.messagingSystem.call(
+      'NetworkController:getNetworkClientById',
+      networkClientId,
+    );
+    const { chainId } = networkClient.configuration;
+    // Web3Provider (via JsonRpcProvider) creates two extra network requests, so
+    // we cache the object so that we can reuse it for subsequent contract
+    // interactions for the same network
+    const ethersProvider = new Web3Provider(networkClient.provider);
+
+    const network = {
+      client: networkClient,
+      clientId: networkClientId,
+      chainId,
+      ethersProvider,
+    };
+    this.#network = network;
+    return network;
+  }
 }