feat(gasPriceOracle): Allow caller to pass in base fee multiplier

e2e/oracle.e2e.ts

@@ -25,12 +25,12 @@ describe("Gas Price Oracle", function () {
     for (const chainId of chainIds) {
       const chainKey = `NEW_GAS_PRICE_ORACLE_${chainId}`;
       process.env[chainKey] = "true";
-      const { maxFeePerGas, maxPriorityFeePerGas } = await getGasPriceEstimate(provider, chainId, customTransport);
+      const { maxFeePerGas, maxPriorityFeePerGas } = await getGasPriceEstimate(provider, chainId, 1, customTransport);
       dummyLogger.debug({
         at: "Gas Price Oracle#Gas Price Retrieval",
         message: `Retrieved gas price estimate for chain ID ${chainId}`,
-        maxFeePerGas,
-        maxPriorityFeePerGas,
+        maxFeePerGas: maxFeePerGas.toString(),
+        maxPriorityFeePerGas: maxPriorityFeePerGas.toString(),
       });
 
       expect(BigNumber.isBigNumber(maxFeePerGas)).to.be.true;
@@ -54,4 +54,21 @@ describe("Gas Price Oracle", function () {
       delete process.env[chainKey];
     }
   });
+  it("Ethers: applies markup to maxFeePerGas", async function () {
+    for (const chainId of chainIds) {
+      const { maxFeePerGas: markedUpMaxFeePerGas, maxPriorityFeePerGas: markedUpMaxPriorityFeePerGas } =
+        await getGasPriceEstimate(provider, chainId, 2, customTransport);
+      const { maxFeePerGas, maxPriorityFeePerGas } = await getGasPriceEstimate(provider, chainId, 1, customTransport);
+      dummyLogger.debug({
+        at: "Gas Price Oracle#Gas Price Retrieval",
+        message: `Retrieved gas price estimate for chain ID ${chainId}`,
+        maxFeePerGas: maxFeePerGas.toString(),
+        maxPriorityFeePerGas: maxPriorityFeePerGas.toString(),
+        markedUpMaxFeePerGas: markedUpMaxFeePerGas.toString(),
+        markedUpMaxPriorityFeePerGas: markedUpMaxPriorityFeePerGas.toString(),
+      });
+      expect(markedUpMaxFeePerGas.gt(maxFeePerGas)).to.be.true;
+      expect(markedUpMaxPriorityFeePerGas).to.equal(maxPriorityFeePerGas);
+    }
+  });
 });

src/gasPriceOracle/adapters/arbitrum.ts

@@ -5,8 +5,16 @@ import * as ethereum from "./ethereum";
 
 // Arbitrum Nitro implements EIP-1559 pricing, but the priority fee is always refunded to the caller.
 // Reference: https://docs.arbitrum.io/how-arbitrum-works/gas-fees
-export async function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
-  const { maxFeePerGas: _maxFeePerGas, maxPriorityFeePerGas } = await ethereum.eip1559(provider, chainId);
+export async function eip1559(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: number
+): Promise<GasPriceEstimate> {
+  const { maxFeePerGas: _maxFeePerGas, maxPriorityFeePerGas } = await ethereum.eip1559(
+    provider,
+    chainId,
+    baseFeeMultiplier
+  );
 
   // eip1559() sets maxFeePerGas = lastBaseFeePerGas + maxPriorityFeePerGas, so revert that.
   // The caller may apply scaling as they wish afterwards.

src/gasPriceOracle/adapters/ethereum.ts

@@ -9,7 +9,11 @@
  * @param chainId Chain ID of provider instance.
  * @returns Promise of gas price estimate object.
  */
-export function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
+export async function eip1559(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: number
+): Promise<GasPriceEstimate> {
   const useRaw = process.env[`GAS_PRICE_EIP1559_RAW_${chainId}`] === "true";
   return useRaw ? eip1559Raw(provider, chainId) : eip1559Bad(provider, chainId);
 }
@@ -48,18 +52,23 @@
   });
 
   const maxPriorityFeePerGas = feeData.maxPriorityFeePerGas as BigNumber;
-  const maxFeePerGas = maxPriorityFeePerGas.add(feeData.lastBaseFeePerGas as BigNumber);
+  const scaledLastBaseFeePerGas = (feeData.lastBaseFeePerGas as BigNumber).mul(baseFeeMultiplier);
+  const maxFeePerGas = maxPriorityFeePerGas.add(scaledLastBaseFeePerGas);
 
   return { maxPriorityFeePerGas, maxFeePerGas };
 }
 
-export async function legacy(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
+export async function legacy(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: number
+): Promise<GasPriceEstimate> {
   const gasPrice = await provider.getGasPrice();
 
   if (!BigNumber.isBigNumber(gasPrice) || gasPrice.lt(bnZero)) gasPriceError("getGasPrice()", chainId, gasPrice);
 
   return {
-    maxFeePerGas: gasPrice,
+    maxFeePerGas: gasPrice.mul(baseFeeMultiplier),
     maxPriorityFeePerGas: bnZero,
   };
 }

src/gasPriceOracle/adapters/linea.ts

@@ -6,6 +6,10 @@ import { providers } from "ethers";
 import { GasPriceEstimate } from "../types";
 import * as ethereum from "./ethereum";
 
-export function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
-  return ethereum.legacy(provider, chainId);
+export function eip1559(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: number
+): Promise<GasPriceEstimate> {
+  return ethereum.legacy(provider, chainId, baseFeeMultiplier);
 }

src/gasPriceOracle/adapters/polygon.ts

@@ -67,15 +67,21 @@ class PolygonGasStation extends BaseHTTPAdapter {
   }
 }
 
-export async function gasStation(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
+export async function gasStation(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: number
+): Promise<GasPriceEstimate> {
   const gasStation = new PolygonGasStation({ chainId: chainId, timeout: 2000, retries: 0 });
   let maxPriorityFeePerGas: BigNumber;
   let maxFeePerGas: BigNumber;
   try {
     ({ maxPriorityFeePerGas, maxFeePerGas } = await gasStation.getFeeData());
+    maxFeePerGas = maxFeePerGas.mul(baseFeeMultiplier);
   } catch (err) {
     // Fall back to the RPC provider. May be less accurate.
-    ({ maxPriorityFeePerGas, maxFeePerGas } = await eip1559(provider, chainId));
+    // @dev Don't incorporate multiplier until after catch statement
+    ({ maxPriorityFeePerGas, maxFeePerGas } = await eip1559(provider, chainId, baseFeeMultiplier));
 
     // Per the GasStation docs, the minimum priority fee on Polygon is 30 Gwei.
     // https://docs.polygon.technology/tools/gas/polygon-gas-station/#interpretation

src/gasPriceOracle/oracle.ts

@@ -1,8 +1,8 @@
 import assert from "assert";
 import { Transport } from "viem";
 import { providers } from "ethers";
 import { CHAIN_IDs } from "../constants";
-import { BigNumber, chainIsOPStack } from "../utils";
+import { assert, BigNumber, chainIsOPStack } from "../utils";
 import { GasPriceEstimate } from "./types";
 import { getPublicClient } from "./util";
 import * as arbitrum from "./adapters/arbitrum";
@@ -18,20 +18,27 @@
  * @param chainId The chain ID to query for gas prices.
  * @param provider A valid ethers provider.
  * @param legacyFallback In the case of an unrecognised chain, fall back to type 0 gas estimation.
+ * @parm baseFeeMarkup Multiplier applied to base fee for EIP1559 gas prices (or total fee for legacy).
  * @returns Am object of type GasPriceEstimate.
  */
 export async function getGasPriceEstimate(
   provider: providers.Provider,
   chainId?: number,
+  baseFeeMultiplier = 1.0,
   transport?: Transport,
   legacyFallback = true
 ): Promise<GasPriceEstimate> {
+  assert(
+    baseFeeMultiplier >= 1.0 && baseFeeMultiplier <= 5,
+    `Require 1.0 < base fee multiplier (${baseFeeMultiplier}) <= 5.0 for a total gas multiplier within [+1.0, +5.0]`
+  );
+
   chainId ?? ({ chainId } = await provider.getNetwork());
 
   const useViem = process.env[`NEW_GAS_PRICE_ORACLE_${chainId}`] === "true";
   return useViem
-    ? getViemGasPriceEstimate(chainId, transport)
-    : getEthersGasPriceEstimate(provider, chainId, legacyFallback);
+    ? getViemGasPriceEstimate(chainId, transport, baseFeeMultiplier)
+    : getEthersGasPriceEstimate(provider, chainId, legacyFallback, baseFeeMultiplier);
 }
 
 /**
@@ -44,7 +51,8 @@
 function getEthersGasPriceEstimate(
   provider: providers.Provider,
   chainId: number,
-  legacyFallback = true
+  legacyFallback = true,
+  baseFeeMultiplier = 1.0
 ): Promise<GasPriceEstimate> {
   const gasPriceFeeds = {
     [CHAIN_IDs.ALEPH_ZERO]: arbitrum.eip1559,
@@ -60,7 +68,7 @@
   assert(gasPriceFeed || legacyFallback, `No suitable gas price oracle for Chain ID ${chainId}`);
   gasPriceFeed ??= chainIsOPStack(chainId) ? ethereum.eip1559 : ethereum.legacy;
 
-  return gasPriceFeed(provider, chainId);
+  return gasPriceFeed(provider, chainId, baseFeeMultiplier);
 }
 
 /**
@@ -71,7 +79,8 @@
  */
 export async function getViemGasPriceEstimate(
   providerOrChainId: providers.Provider | number,
-  transport?: Transport
+  transport?: Transport,
+  baseFeeMultiplier = 1.0
 ): Promise<GasPriceEstimate> {
   const chainId =
     typeof providerOrChainId === "number" ? providerOrChainId : (await providerOrChainId.getNetwork()).chainId;
@@ -96,8 +105,9 @@
     maxPriorityFeePerGas ??= BigInt(0);
   }
 
+  // Apply markup to base fee which will be  more volatile than priority fee.
   return {
-    maxFeePerGas: BigNumber.from(maxFeePerGas.toString()),
+    maxFeePerGas: BigNumber.from(maxFeePerGas.toString()).mul(baseFeeMultiplier),
     maxPriorityFeePerGas: BigNumber.from(maxPriorityFeePerGas.toString()),
   };
 }

src/relayFeeCalculator/chain-queries/baseQuery.ts

@@ -1,6 +1,5 @@
 import { L2Provider } from "@eth-optimism/sdk/dist/interfaces/l2-provider";
 import { providers } from "ethers";
-import assert from "assert";
 import { Coingecko } from "../../coingecko";
 import { CHAIN_IDs, DEFAULT_SIMULATED_RELAYER_ADDRESS } from "../../constants";
 import { Deposit } from "../../interfaces";
@@ -9,9 +8,7 @@ import {
   BigNumberish,
   TransactionCostEstimate,
   estimateTotalGasRequiredByUnsignedTransaction,
-  fixedPointAdjustment,
   populateV3Relay,
-  toBNWei,
 } from "../../utils";
 import { Logger, QueryInterface } from "../relayFeeCalculator";
 import { Transport } from "viem";
@@ -38,7 +35,6 @@ export class QueryBase implements QueryInterface {
    * @param symbolMapping A mapping to valid ERC20 tokens and their respective characteristics
    * @param spokePoolAddress The valid address of the Spoke Pool deployment
    * @param simulatedRelayerAddress The address that these queries will reference as the sender. Note: This address must be approved for USDC
-   * @param gasMarkup A multiplier that is applied to the total gas estimate
    * @param logger A logging utility to report logs
    * @param coingeckoProApiKey An optional CoinGecko API key that links to a PRO account
    * @param fixedGasPrice Overrides the gas price with a fixed value. Note: primarily used for the Boba blockchain
@@ -49,7 +45,6 @@ export class QueryBase implements QueryInterface {
     readonly symbolMapping: SymbolMappingType,
     readonly spokePoolAddress: string,
     readonly simulatedRelayerAddress: string,
-    readonly gasMarkup: number,
     readonly logger: Logger,
     readonly coingeckoProApiKey?: string,
     readonly fixedGasPrice?: BigNumberish,
@@ -75,18 +70,10 @@ export class QueryBase implements QueryInterface {
     options: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
-      omitMarkup: boolean;
       transport: Transport;
     }> = {}
   ): Promise<TransactionCostEstimate> {
-    const { gasPrice = this.fixedGasPrice, gasUnits, omitMarkup, transport } = options;
-
-    const gasMarkup = omitMarkup ? 0 : this.gasMarkup;
-    assert(
-      gasMarkup > -1 && gasMarkup <= 4,
-      `Require -1.0 < Gas Markup (${gasMarkup}) <= 4.0 for a total gas multiplier within (0, +5.0]`
-    );
-    const gasTotalMultiplier = toBNWei(1.0 + gasMarkup);
+    const { gasPrice = this.fixedGasPrice, gasUnits, transport } = options;
 
     const tx = await populateV3Relay(this.spokePool, deposit, relayer);
     const {
@@ -100,8 +87,8 @@ export class QueryBase implements QueryInterface {
     });
 
     return {
-      nativeGasCost: nativeGasCost.mul(gasTotalMultiplier).div(fixedPointAdjustment),
-      tokenGasCost: tokenGasCost.mul(gasTotalMultiplier).div(fixedPointAdjustment),
+      nativeGasCost,
+      tokenGasCost,
       gasPrice: impliedGasPrice,
     };
   }

src/relayFeeCalculator/chain-queries/factory.ts

@@ -27,7 +27,6 @@ export class QueryBase__factory {
     simulatedRelayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS,
     coingeckoProApiKey?: string,
     logger: Logger = DEFAULT_LOGGER,
-    gasMarkup = 0,
     coingeckoBaseCurrency = "eth"
   ): QueryBase {
     assert(isDefined(spokePoolAddress));
@@ -39,8 +38,7 @@ export class QueryBase__factory {
         spokePoolAddress,
         simulatedRelayerAddress,
         coingeckoProApiKey,
-        logger,
-        gasMarkup
+        logger
       );
     }
 
@@ -51,8 +49,7 @@ export class QueryBase__factory {
         spokePoolAddress,
         simulatedRelayerAddress,
         coingeckoProApiKey,
-        logger,
-        gasMarkup
+        logger
       );
     }
 
@@ -64,7 +61,6 @@ export class QueryBase__factory {
       symbolMapping,
       spokePoolAddress,
       simulatedRelayerAddress,
-      gasMarkup,
       logger,
       coingeckoProApiKey,
       fixedGasPrice[chainId],

src/utils/common.ts

@@ -265,9 +265,10 @@
   const voidSigner = new VoidSigner(senderAddress, provider);
 
   // Estimate the Gas units required to submit this transaction.
+  const gasMultiplier = 1.0; // Don't apply any multiplier to the gas price.
   const queries = [
     gasUnits ? Promise.resolve(BigNumber.from(gasUnits)) : voidSigner.estimateGas(unsignedTx),
-    _gasPrice ? Promise.resolve({ maxFeePerGas: _gasPrice }) : getGasPriceEstimate(provider, chainId, transport),
+    _gasPrice ? Promise.resolve({ maxFeePerGas: _gasPrice }) : getGasPriceEstimate(provider, chainId, gasMultiplier, transport),
   ] as const;
   let [nativeGasCost, { maxFeePerGas: gasPrice }] = await Promise.all(queries);
   assert(nativeGasCost.gt(bnZero), "Gas cost should not be 0");