Merge branch 'main' into main

cli/base-command.ts

@@ -355,11 +355,12 @@ export abstract class BaseCommand extends Command {
     quoteGasAdjusted: CurrencyAmount<Currency>,
     estimatedGasUsedQuoteToken: CurrencyAmount<Currency>,
     estimatedGasUsedUSD: CurrencyAmount<Currency>,
+    estimatedGasUsedGasToken: CurrencyAmount<Currency> | undefined,
     methodParameters: MethodParameters | undefined,
     blockNumber: BigNumber,
     estimatedGasUsed: BigNumber,
     gasPriceWei: BigNumber,
-    simulationStatus?: SimulationStatus
+    simulationStatus?: SimulationStatus,
   ) {
     this.logger.info(`Best Route:`);
     this.logger.info(`${routeAmountsToString(routeAmounts)}`);
@@ -385,6 +386,13 @@ export abstract class BaseCommand extends Command {
         Math.min(estimatedGasUsedUSD.currency.decimals, 6)
       )}`
     );
+    if(estimatedGasUsedGasToken) {
+      this.logger.info(
+        `Gas Used gas token: ${estimatedGasUsedGasToken.toFixed(
+          Math.min(estimatedGasUsedGasToken.currency.decimals, 6)
+        )}`
+      );
+    }
     this.logger.info(`Calldata: ${methodParameters?.calldata}`);
     this.logger.info(`Value: ${methodParameters?.value}`);
     this.logger.info({

cli/commands/quote-to-ratio.ts

@@ -146,6 +146,7 @@ export class QuoteToRatio extends BaseCommand {
         estimatedGasUsed,
         estimatedGasUsedQuoteToken,
         estimatedGasUsedUSD,
+        estimatedGasUsedGasToken,
         gasPriceWei,
         methodParameters,
         quote,
@@ -159,6 +160,7 @@ export class QuoteToRatio extends BaseCommand {
         quoteGasAdjusted,
         estimatedGasUsedQuoteToken,
         estimatedGasUsedUSD,
+        estimatedGasUsedGasToken,
         methodParameters,
         blockNumber,
         estimatedGasUsed,

cli/commands/quote.ts

@@ -37,6 +37,7 @@ export class Quote extends BaseCommand {
     debugRouting: flags.boolean({ required: false, default: true }),
     enableFeeOnTransferFeeFetching: flags.boolean({ required: false, default: false }),
     requestBlockNumber: flags.integer({ required: false }),
+    gasToken: flags.string({ required: false }),
   };
 
   async run() {
@@ -68,7 +69,8 @@ export class Quote extends BaseCommand {
       simulate,
       debugRouting,
       enableFeeOnTransferFeeFetching,
-      requestBlockNumber
+      requestBlockNumber,
+      gasToken
     } = flags;
 
     const topNSecondHopForTokenAddress = new MapWithLowerCaseKey();
@@ -159,6 +161,7 @@ export class Quote extends BaseCommand {
           forceMixedRoutes,
           debugRouting,
           enableFeeOnTransferFeeFetching,
+          gasToken
         }
       );
     } else {
@@ -196,6 +199,7 @@ export class Quote extends BaseCommand {
           forceMixedRoutes,
           debugRouting,
           enableFeeOnTransferFeeFetching,
+          gasToken
         }
       );
     }
@@ -214,6 +218,7 @@ export class Quote extends BaseCommand {
       estimatedGasUsed,
       estimatedGasUsedQuoteToken,
       estimatedGasUsedUSD,
+      estimatedGasUsedGasToken,
       gasPriceWei,
       methodParameters,
       quote,
@@ -228,6 +233,7 @@ export class Quote extends BaseCommand {
       quoteGasAdjusted,
       estimatedGasUsedQuoteToken,
       estimatedGasUsedUSD,
+      estimatedGasUsedGasToken,
       methodParameters,
       blockNumber,
       estimatedGasUsed,

src/providers/caching-gas-provider.ts

@@ -12,7 +12,8 @@ import { GasPrice, IGasPriceProvider } from './gas-price-provider';
  * @class CachingV3SubgraphProvider
  */
 export class CachingGasStationProvider extends IGasPriceProvider {
-  private GAS_KEY = (chainId: ChainId, blockNumber: number) => `gasPrice-${chainId}-${blockNumber}`;
+  private GAS_KEY = (chainId: ChainId, blockNumber: number) =>
+    `gasPrice-${chainId}-${blockNumber}`;
 
   /**
    * Creates an instance of CachingGasStationProvider.
@@ -28,11 +29,16 @@ export class CachingGasStationProvider extends IGasPriceProvider {
     super();
   }
 
-  public override async getGasPrice(latestBlockNumber: number, requestBlockNumber?: number): Promise<GasPrice> {
+  public override async getGasPrice(
+    latestBlockNumber: number,
+    requestBlockNumber?: number
+  ): Promise<GasPrice> {
     // If block number is specified in the request, we have to use that block number find any potential cache hits.
     // Otherwise, we can use the latest block number.
     const targetBlockNumber = requestBlockNumber ?? latestBlockNumber;
-    const cachedGasPrice = await this.cache.get(this.GAS_KEY(this.chainId, targetBlockNumber));
+    const cachedGasPrice = await this.cache.get(
+      this.GAS_KEY(this.chainId, targetBlockNumber)
+    );
 
     if (cachedGasPrice) {
       log.info(
@@ -43,8 +49,14 @@ export class CachingGasStationProvider extends IGasPriceProvider {
       return cachedGasPrice;
     }
 
-    const gasPrice = await this.gasPriceProvider.getGasPrice(latestBlockNumber, requestBlockNumber);
-    await this.cache.set(this.GAS_KEY(this.chainId, targetBlockNumber), gasPrice);
+    const gasPrice = await this.gasPriceProvider.getGasPrice(
+      latestBlockNumber,
+      requestBlockNumber
+    );
+    await this.cache.set(
+      this.GAS_KEY(this.chainId, targetBlockNumber),
+      gasPrice
+    );
 
     return gasPrice;
   }

src/providers/eip-1559-gas-price-provider.ts

@@ -43,7 +43,10 @@ export class EIP1559GasPriceProvider extends IGasPriceProvider {
     super();
   }
 
-  public override async getGasPrice(_latestBlockNumber: number, requestBlockNumber?: number): Promise<GasPrice> {
+  public override async getGasPrice(
+    _latestBlockNumber: number,
+    requestBlockNumber?: number
+  ): Promise<GasPrice> {
     const feeHistoryRaw = (await this.provider.send('eth_feeHistory', [
       /**
        * @fix Use BigNumber.from(this.blocksToConsider).toHexString() after hardhat adds support
@@ -53,7 +56,9 @@ export class EIP1559GasPriceProvider extends IGasPriceProvider {
       // If the block number is not specified, we have to send hardcoded 'latest' to infura RPC
       // because Infura node pool is eventually consistent and may not have the latest block from our block number.
       // See https://uniswapteam.slack.com/archives/C023A7JDTJP/p1702485038251449?thread_ts=1702471203.519869&cid=C023A7JDTJP
-      requestBlockNumber ? BigNumber.from(requestBlockNumber).toHexString().replace('0x0', '0x') : 'latest',
+      requestBlockNumber
+        ? BigNumber.from(requestBlockNumber).toHexString().replace('0x0', '0x')
+        : 'latest',
       [this.priorityFeePercentile],
     ])) as RawFeeHistoryResponse;
 

src/providers/eth-estimate-gas-provider.ts

@@ -2,7 +2,12 @@ import { BigNumber } from '@ethersproject/bignumber';
 import { JsonRpcProvider } from '@ethersproject/providers';
 import { ChainId } from '@uniswap/sdk-core';
 
-import { SwapOptions, SwapRoute, SwapType } from '../routers';
+import {
+  GasModelProviderConfig,
+  SwapOptions,
+  SwapRoute,
+  SwapType,
+} from '../routers';
 import { BEACON_CHAIN_DEPOSIT_ADDRESS, log } from '../util';
 import {
   calculateGasUsed,
@@ -107,6 +112,7 @@ export class EthEstimateGasSimulator extends Simulator {
     const {
       estimatedGasUsedUSD,
       estimatedGasUsedQuoteToken,
+      estimatedGasUsedGasToken,
       quoteGasAdjusted,
     } = await calculateGasUsed(
       route.quote.currency.chainId,
@@ -127,7 +133,8 @@ export class EthEstimateGasSimulator extends Simulator {
         estimatedGasUsed,
         estimatedGasUsedQuoteToken,
         estimatedGasUsedUSD,
-        swapOptions
+        swapOptions,
+        estimatedGasUsedGasToken
       ),
       simulationStatus: SimulationStatus.Succeeded,
     };
@@ -150,8 +157,7 @@ export class EthEstimateGasSimulator extends Simulator {
     swapOptions: SwapOptions,
     swapRoute: SwapRoute,
     l2GasData?: OptimismGasData | ArbitrumGasData | undefined,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    _providerConfig?: ProviderConfig | undefined
+    _providerConfig?: GasModelProviderConfig | undefined
   ): Promise<SwapRoute> {
     const inputAmount = swapRoute.trade.inputAmount;
     if (

src/providers/eth-gas-station-info-gas-price-provider.ts

@@ -28,8 +28,10 @@ export class ETHGasStationInfoProvider extends IGasPriceProvider {
     this.url = url;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  public override async getGasPrice(_latestBlockNumber: number, _requestBlockNumber?: number): Promise<GasPrice> {
+  public override async getGasPrice(
+    _latestBlockNumber: number,
+    _requestBlockNumber?: number
+  ): Promise<GasPrice> {
     const response = await retry(
       async () => {
         return axios.get<ETHGasStationResponse>(this.url);

src/providers/gas-price-provider.ts

@@ -8,5 +8,8 @@ export type GasPrice = {
  * Provider for getting gas prices.
  */
 export abstract class IGasPriceProvider {
-  public abstract getGasPrice(latestBlockNumber: number, requestBlockNumber?: number): Promise<GasPrice>;
+  public abstract getGasPrice(
+    latestBlockNumber: number,
+    requestBlockNumber?: number
+  ): Promise<GasPrice>;
 }

src/providers/legacy-gas-price-provider.ts

@@ -7,8 +7,10 @@ export class LegacyGasPriceProvider extends IGasPriceProvider {
     super();
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  public override async getGasPrice(_latestBlockNumber: number, _requestBlockNumber?: number): Promise<GasPrice> {
+  public override async getGasPrice(
+    _latestBlockNumber: number,
+    _requestBlockNumber?: number
+  ): Promise<GasPrice> {
     const gasPriceWei = await this.provider.getGasPrice();
     return {
       gasPriceWei,

src/providers/on-chain-gas-price-provider.ts

@@ -27,11 +27,20 @@ export class OnChainGasPriceProvider extends IGasPriceProvider {
     super();
   }
 
-  public override async getGasPrice(latestBlockNumber: number, requestBlockNumber?: number): Promise<GasPrice> {
+  public override async getGasPrice(
+    latestBlockNumber: number,
+    requestBlockNumber?: number
+  ): Promise<GasPrice> {
     if (this.eipChains.includes(this.chainId)) {
-      return this.eip1559GasPriceProvider.getGasPrice(latestBlockNumber, requestBlockNumber);
+      return this.eip1559GasPriceProvider.getGasPrice(
+        latestBlockNumber,
+        requestBlockNumber
+      );
     }
 
-    return this.legacyGasPriceProvider.getGasPrice(latestBlockNumber, requestBlockNumber);
+    return this.legacyGasPriceProvider.getGasPrice(
+      latestBlockNumber,
+      requestBlockNumber
+    );
   }
 }

src/providers/provider.ts

@@ -1,14 +1,8 @@
-import { BigNumber } from '@ethersproject/bignumber';
-
 export type ProviderConfig = {
   /**
    * The block number to use when getting data on-chain.
    */
   blockNumber?: number | Promise<number>;
-  /*
-   * Any additional overhead to add to the gas estimate
-   */
-  additionalGasOverhead?: BigNumber;
   /*
    * Debug flag to test some codepaths
    */

src/providers/simulation-provider.ts

@@ -3,13 +3,17 @@ import { ChainId, TradeType } from '@uniswap/sdk-core';
 import { PERMIT2_ADDRESS } from '@uniswap/universal-router-sdk';
 import { BigNumber } from 'ethers/lib/ethers';
 
-import { SwapOptions, SwapRoute, SwapType } from '../routers';
+import {
+  GasModelProviderConfig,
+  SwapOptions,
+  SwapRoute,
+  SwapType,
+} from '../routers';
 import { Erc20__factory } from '../types/other/factories/Erc20__factory';
 import { Permit2__factory } from '../types/other/factories/Permit2__factory';
 import { CurrencyAmount, log, SWAP_ROUTER_02_ADDRESSES } from '../util';
 
 import { IPortionProvider } from './portion-provider';
-import { ProviderConfig } from './provider';
 import { ArbitrumGasData, OptimismGasData } from './v3/gas-data-provider';
 
 export type SimulationResult = {
@@ -60,7 +64,7 @@ export abstract class Simulator {
     amount: CurrencyAmount,
     quote: CurrencyAmount,
     l2GasData?: OptimismGasData | ArbitrumGasData,
-    providerConfig?: ProviderConfig
+    providerConfig?: GasModelProviderConfig
   ): Promise<SwapRoute> {
     const neededBalance =
       swapRoute.trade.tradeType == TradeType.EXACT_INPUT ? amount : quote;
@@ -105,7 +109,7 @@ export abstract class Simulator {
     swapOptions: SwapOptions,
     swapRoute: SwapRoute,
     l2GasData?: OptimismGasData | ArbitrumGasData,
-    providerConfig?: ProviderConfig
+    providerConfig?: GasModelProviderConfig
   ): Promise<SwapRoute>;
 
   protected async userHasSufficientBalance(

src/providers/static-gas-price-provider.ts

@@ -5,8 +5,11 @@ import { GasPrice, IGasPriceProvider } from './gas-price-provider';
 
 export class StaticGasPriceProvider implements IGasPriceProvider {
   constructor(private gasPriceWei: BigNumber) {}
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async getGasPrice(_latestBlockNumber: number, _requestBlockNumber?: number): Promise<GasPrice> {
+
+  async getGasPrice(
+    _latestBlockNumber: number,
+    _requestBlockNumber?: number
+  ): Promise<GasPrice> {
     return { gasPriceWei: this.gasPriceWei };
   }
 }