test: fix with custom transport (#755)

Author: dohaki

e2e/oracle.e2e.ts

@@ -1,11 +1,10 @@
 // @note: This test is _not_ run automatically as part of git hooks or CI.
 import dotenv from "dotenv";
 import winston from "winston";
-import { custom } from "viem";
 import { providers } from "ethers";
 import { getGasPriceEstimate } from "../src/gasPriceOracle";
 import { BigNumber, bnZero, parseUnits } from "../src/utils";
-import { expect } from "../test/utils";
+import { expect, makeCustomTransport } from "../test/utils";
 dotenv.config({ path: ".env" });
 
 const dummyLogger = winston.createLogger({
@@ -16,23 +15,8 @@ const dummyLogger = winston.createLogger({
 const stdLastBaseFeePerGas = parseUnits("12", 9);
 const stdMaxPriorityFeePerGas = parseUnits("1", 9); // EIP-1559 chains only
 const stdMaxFeePerGas = stdLastBaseFeePerGas.add(stdMaxPriorityFeePerGas);
-const stdGasPrice = stdMaxFeePerGas;
 
-const customTransport = custom({
-  // eslint-disable-next-line require-await
-  async request({ method }: { method: string; params: unknown }) {
-    switch (method) {
-      case "eth_gasPrice":
-        return BigInt(stdGasPrice.toString());
-      case "eth_getBlockByNumber":
-        return { baseFeePerGas: BigInt(stdLastBaseFeePerGas.mul(100).div(120).toString()) };
-      case "eth_maxPriorityFeePerGas":
-        return BigInt(stdMaxPriorityFeePerGas.toString());
-      default:
-        console.log(`Unsupported method: ${method}.`);
-    }
-  },
-});
+const customTransport = makeCustomTransport({ stdLastBaseFeePerGas, stdMaxPriorityFeePerGas });
 
 const eip1559Chains = [1, 10, 137, 324, 8453, 42161, 534352];
 const chainIds = [...eip1559Chains, 1337];

src/gasPriceOracle/oracle.ts

@@ -9,16 +9,16 @@ import * as polygon from "./adapters/polygon";
 
 /**
  * Provide an estimate for the current gas price for a particular chain.
- * @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.
+ * @param providerOrChainId A valid ethers provider or a chain ID.
+ * @param transport An optional transport object for custom gas price retrieval.
  * @returns Am object of type GasPriceEstimate.
  */
 export async function getGasPriceEstimate(
-  provider: providers.Provider,
+  providerOrChainId: providers.Provider | number,
   transport?: Transport
 ): Promise<GasPriceEstimate> {
-  const { chainId } = await provider.getNetwork();
+  const chainId =
+    typeof providerOrChainId === "number" ? providerOrChainId : (await providerOrChainId.getNetwork()).chainId;
   const viemProvider = getPublicClient(chainId, transport);
 
   const gasPriceFeeds = {

src/relayFeeCalculator/chain-queries/baseQuery.ts

@@ -14,6 +14,7 @@ import {
   toBNWei,
 } from "../../utils";
 import { Logger, QueryInterface } from "../relayFeeCalculator";
+import { Transport } from "viem";
 
 type Provider = providers.Provider;
 type OptimismProvider = L2Provider<Provider>;
@@ -61,17 +62,25 @@ export class QueryBase implements QueryInterface {
    * Retrieves the current gas costs of performing a fillRelay contract at the referenced SpokePool.
    * @param deposit V3 deposit instance.
    * @param relayerAddress Relayer address to simulate with.
-   * @param gasPrice Optional gas price to use for the simulation.
-   * @param gasUnits Optional gas units to use for the simulation.
+   * @param options
+   * @param options.gasPrice Optional gas price to use for the simulation.
+   * @param options.gasUnits Optional gas units to use for the simulation.
+   * @param options.omitMarkup Optional flag to omit the gas markup.
+   * @param options.transport Optional transport object for custom gas price retrieval.
    * @returns The gas estimate for this function call (multiplied with the optional buffer).
    */
   async getGasCosts(
     deposit: Deposit,
     relayer = DEFAULT_SIMULATED_RELAYER_ADDRESS,
-    gasPrice = this.fixedGasPrice,
-    gasUnits?: BigNumberish,
-    omitMarkup?: boolean
+    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,
@@ -84,8 +93,11 @@ export class QueryBase implements QueryInterface {
       tx,
       relayer,
       this.provider,
-      gasPrice,
-      gasUnits
+      {
+        gasPrice,
+        gasUnits,
+        transport,
+      }
     );
 
     return {

src/relayFeeCalculator/relayFeeCalculator.ts

@@ -17,14 +17,14 @@ import {
   toBN,
   toBNWei,
 } from "../utils";
+import { Transport } from "viem";
 
 // This needs to be implemented for every chain and passed into RelayFeeCalculator
 export interface QueryInterface {
   getGasCosts: (
     deposit: Deposit,
     relayer: string,
-    gasPrice?: BigNumberish,
-    gasLimit?: BigNumberish
+    options?: Partial<{ gasPrice: BigNumberish; gasUnits: BigNumberish; omitMarkup: boolean; transport: Transport }>
   ) => Promise<TransactionCostEstimate>;
   getTokenPrice: (tokenSymbol: string) => Promise<number>;
   getTokenDecimals: (tokenSymbol: string) => number;
@@ -230,7 +230,8 @@ export class RelayFeeCalculator {
     _tokenPrice?: number,
     tokenMapping = TOKEN_SYMBOLS_MAP,
     gasPrice?: BigNumberish,
-    gasLimit?: BigNumberish
+    gasLimit?: BigNumberish,
+    transport?: Transport
   ): Promise<BigNumber> {
     if (toBN(amountToRelay).eq(bnZero)) return MAX_BIG_INT;
 
@@ -245,16 +246,18 @@ export class RelayFeeCalculator {
     const simulatedAmount = simulateZeroFill ? safeOutputAmount : toBN(amountToRelay);
     deposit = { ...deposit, outputAmount: simulatedAmount };
 
-    const getGasCosts = this.queries.getGasCosts(deposit, relayerAddress, gasPrice, gasLimit).catch((error) => {
-      this.logger.error({
-        at: "sdk/gasFeePercent",
-        message: "Error while fetching gas costs",
-        error,
-        simulateZeroFill,
-        deposit,
+    const getGasCosts = this.queries
+      .getGasCosts(deposit, relayerAddress, { gasPrice, gasUnits: gasLimit, transport })
+      .catch((error) => {
+        this.logger.error({
+          at: "sdk/gasFeePercent",
+          message: "Error while fetching gas costs",
+          error,
+          simulateZeroFill,
+          deposit,
+        });
+        throw error;
       });
-      throw error;
-    });
     const [{ tokenGasCost }, tokenPrice] = await Promise.all([
       getGasCosts,
       _tokenPrice ??

src/utils/common.ts

@@ -8,6 +8,7 @@ import { TypedMessage } from "../interfaces/TypedData";
 import { BigNumber, BigNumberish, BN, formatUnits, parseUnits, toBN } from "./BigNumberUtils";
 import { ConvertDecimals } from "./FormattingUtils";
 import { chainIsOPStack } from "./NetworkUtils";
+import { Transport } from "viem";
 
 export type Decimalish = string | number | Decimal;
 export const AddressZero = ethers.constants.AddressZero;
@@ -239,17 +240,24 @@ export type TransactionCostEstimate = {
  * @param unsignedTx The unsigned transaction that this function will estimate.
  * @param senderAddress The address that the transaction will be submitted from.
  * @param provider A valid ethers provider - will be used to reason the gas price.
- * @param gasPrice A manually provided gas price - if set, this function will not resolve the current gas price.
- * @param gasUnits A manually provided gas units - if set, this function will not estimate the gas units.
+ * @param options
+ * @param options.gasPrice A manually provided gas price - if set, this function will not resolve the current gas price.
+ * @param options.gasUnits A manually provided gas units - if set, this function will not estimate the gas units.
+ * @param options.transport A custom transport object for custom gas price retrieval.
  * @returns Estimated cost in units of gas and the underlying gas token (gasPrice * estimatedGasUnits).
  */
 export async function estimateTotalGasRequiredByUnsignedTransaction(
   unsignedTx: PopulatedTransaction,
   senderAddress: string,
   provider: providers.Provider | L2Provider<providers.Provider>,
-  gasPrice?: BigNumberish,
-  gasUnits?: BigNumberish
+  options: Partial<{
+    gasPrice: BigNumberish;
+    gasUnits: BigNumberish;
+    transport: Transport;
+  }> = {}
 ): Promise<TransactionCostEstimate> {
+  const { gasPrice: _gasPrice, gasUnits, transport } = options || {};
+
   const { chainId } = await provider.getNetwork();
   const voidSigner = new VoidSigner(senderAddress, provider);
 
@@ -268,13 +276,14 @@ export async function estimateTotalGasRequiredByUnsignedTransaction(
     // `provider.estimateTotalGasCost` to improve performance.
     const [l1GasCost, l2GasPrice] = await Promise.all([
       provider.estimateL1GasCost(populatedTransaction),
-      gasPrice || provider.getGasPrice(),
+      _gasPrice || provider.getGasPrice(),
     ]);
     const l2GasCost = nativeGasCost.mul(l2GasPrice);
     tokenGasCost = l1GasCost.add(l2GasCost);
   } else {
+    let gasPrice = _gasPrice;
     if (!gasPrice) {
-      const gasPriceEstimate = await getGasPriceEstimate(provider);
+      const gasPriceEstimate = await getGasPriceEstimate(chainId, transport);
       gasPrice = gasPriceEstimate.maxFeePerGas;
     }
     tokenGasCost = nativeGasCost.mul(gasPrice);

test/relayFeeCalculator.test.ts

@@ -25,6 +25,7 @@ import {
   getContractFactory,
   randomAddress,
   setupTokensForWallet,
+  makeCustomTransport,
 } from "./utils";
 import { TOKEN_SYMBOLS_MAP } from "@across-protocol/constants";
 import { EMPTY_MESSAGE, ZERO_ADDRESS } from "../src/constants";
@@ -286,6 +287,7 @@ describe("RelayFeeCalculator: Composable Bridging", function () {
   let owner: SignerWithAddress, relayer: SignerWithAddress, depositor: SignerWithAddress;
   let tokenMap: typeof TOKEN_SYMBOLS_MAP;
   let testGasFeePct: (message?: string) => Promise<BigNumber>;
+  const customTransport = makeCustomTransport();
 
   beforeEach(async function () {
     [owner, relayer, depositor] = await ethers.getSigners();
@@ -345,7 +347,10 @@ describe("RelayFeeCalculator: Composable Bridging", function () {
         false,
         relayer.address,
         1,
-        tokenMap
+        tokenMap,
+        undefined,
+        undefined,
+        customTransport
       );
   });
   it("should not revert if no message is passed", async () => {

test/utils/index.ts

@@ -6,3 +6,4 @@ export * from "./utils";
 export * from "./BlockchainUtils";
 export * from "./SpokePoolUtils";
 export * from "./SpyTransport";
+export * from "./transport";

test/utils/transport.ts

@@ -0,0 +1,26 @@
+import { custom } from "viem";
+import { BigNumber, parseUnits } from "../../src/utils";
+
+export const makeCustomTransport = (
+  params: Partial<{ stdLastBaseFeePerGas: BigNumber; stdMaxPriorityFeePerGas: BigNumber }> = {}
+) => {
+  const { stdLastBaseFeePerGas = parseUnits("12", 9), stdMaxPriorityFeePerGas = parseUnits("1", 9) } = params;
+  const stdMaxFeePerGas = stdLastBaseFeePerGas.add(stdMaxPriorityFeePerGas);
+  const stdGasPrice = stdMaxFeePerGas;
+
+  return custom({
+    // eslint-disable-next-line require-await
+    async request({ method }: { method: string; params: unknown }) {
+      switch (method) {
+        case "eth_gasPrice":
+          return BigInt(stdGasPrice.toString());
+        case "eth_getBlockByNumber":
+          return { baseFeePerGas: BigInt(stdLastBaseFeePerGas.toString()) };
+        case "eth_maxPriorityFeePerGas":
+          return BigInt(stdMaxPriorityFeePerGas.toString());
+        default:
+          throw new Error(`Unsupported method: ${method}.`);
+      }
+    },
+  });
+};