@across-protocol/sdk 3.3.31 → 3.4.0

package/dist/types/utils/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/utils/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAG3E,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,oBAAoB,EAAE,SAAS,EAAc,MAAM,QAAQ,CAAC;AAE7E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAyC,MAAM,kBAAkB,CAAC;AAGtG,OAAO,EAAW,SAAS,EAAE,MAAM,MAAM,CAAC;AAK1C,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnD,eAAO,MAAM,WAAW,+CAA+B,CAAC;AACxD,eAAO,MAAM,WAAW,kBAAqD,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,aAAa,MAAM,KAAG,EAA0C,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,aAAa,MAAM,KAAG,MAA+C,CAAC;AAE/G;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,EAAE,CAIxD;AACD;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,EAAE,CAIxD;AAED,eAAO,MAAM,oBAAoB,kBAAe,CAAC;AAEjD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,YAAY,EACxB,KAAK,GAAE,MAAM,GAAG,MAAU,EAC1B,UAAU,SAAK,EACf,cAAc,SAAK,GAClB,MAAM,CAIR;AAED;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,YAAY,YAAY,KAAG,SAEnE,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,YAAY,EACtB,KAAK,GAAE,MAAM,GAAG,MAAU,EAC1B,QAAQ,SAAK,GACZ,MAAM,CAGR;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,GAAG,EAAE,CAE9E;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,8BAA8B,gBAC5B,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAGF,CAAC;AACF;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,gBAC1B,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAaF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,gBACL,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAEF,CAAC;AACF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,QAAS,MAAM,OAAO,MAAM,QAAQ,MAAM,eAYvE,CAAC;AAEF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAEpC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ1F;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,SAAS,CAAC;IACzB,YAAY,EAAE,SAAS,CAAC;IACxB,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,6CAA6C,CACjE,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,CAAC,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,EAC7D,OAAO,GAAE,OAAO,CAAC;IACf,QAAQ,EAAE,YAAY,CAAC;IACvB,QAAQ,EAAE,YAAY,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAM,GACN,OAAO,CAAC,uBAAuB,CAAC,CA6ClC;AAgBD,wBAAgB,aAAa,WAE5B"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/utils/common.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAiC,MAAM,kBAAkB,CAAC;AAG9F,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnD,eAAO,MAAM,WAAW,+CAA+B,CAAC;AACxD,eAAO,MAAM,WAAW,kBAAqD,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,aAAa,MAAM,KAAG,EAA0C,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,aAAa,MAAM,KAAG,MAA+C,CAAC;AAE/G;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,EAAE,CAIxD;AACD;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,EAAE,CAIxD;AAED,eAAO,MAAM,oBAAoB,kBAAe,CAAC;AAEjD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,YAAY,EACxB,KAAK,GAAE,MAAM,GAAG,MAAU,EAC1B,UAAU,SAAK,EACf,cAAc,SAAK,GAClB,MAAM,CAIR;AAED;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,YAAY,YAAY,KAAG,SAEnE,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,YAAY,EACtB,KAAK,GAAE,MAAM,GAAG,MAAU,EAC1B,QAAQ,SAAK,GACZ,MAAM,CAGR;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,GAAG,EAAE,CAE9E;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,8BAA8B,gBAC5B,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAGF,CAAC;AACF;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,gBAC1B,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAaF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,gBACL,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAEF,CAAC;AACF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,QAAS,MAAM,OAAO,MAAM,QAAQ,MAAM,eAYvE,CAAC;AAEF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAEpC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ1F;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,SAAS,CAAC;IACzB,YAAY,EAAE,SAAS,CAAC;IACxB,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,wBAAgB,aAAa,WAE5B"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@across-protocol/sdk",
   "author": "UMA Team",
-  "version": "3.3.31",
+  "version": "3.4.0",
   "license": "AGPL-3.0",
   "homepage": "https://docs.across.to/reference/sdk",
   "files": [

package/src/clients/BundleDataClient/BundleDataClient.ts

@@ -31,6 +31,7 @@ import {
   isSlowFill,
   mapAsync,
   bnUint32Max,
+  isZeroValueDeposit,
 } from "../../utils";
 import winston from "winston";
 import {
@@ -778,6 +779,9 @@ export class BundleDataClient {
           continue;
         }
         originClient.getDepositsForDestinationChain(destinationChainId).forEach((deposit) => {
+          if (isZeroValueDeposit(deposit)) {
+            return;
+          }
           depositCounter++;
           const relayDataHash = this.getRelayHashFromEvent(deposit);
           if (v3RelayHashes[relayDataHash]) {
@@ -793,6 +797,14 @@ export class BundleDataClient {
             slowFillRequest: undefined,
           };
 
+          // Once we've saved the deposit hash into v3RelayHashes, then we can exit early here if the inputAmount
+          // is 0 because there can be no expired amount to refund and no unexecutable slow fill amount to return
+          // if this deposit did expire. Input amount can only be zero at this point if the message is non-empty,
+          // but the message doesn't matter for expired deposits and unexecutable slow fills.
+          if (deposit.inputAmount.eq(0)) {
+            return;
+          }
+
           // If deposit block is within origin chain bundle block range, then save as bundle deposit.
           // If deposit is in bundle and it has expired, additionally save it as an expired deposit.
           // If deposit is not in the bundle block range, then save it as an older deposit that
@@ -840,7 +852,10 @@ export class BundleDataClient {
         await forEachAsync(
           destinationClient
             .getFillsForOriginChain(originChainId)
-            .filter((fill) => fill.blockNumber <= destinationChainBlockRange[1]),
+            // We can remove fills for deposits with input amount equal to zero because these will result in 0 refunded
+            // tokens to the filler. We can't remove non-empty message deposit here in case there is a slow fill
+            // request for the deposit, we'd want to see the fill took place.
+            .filter((fill) => fill.blockNumber <= destinationChainBlockRange[1] && !isZeroValueDeposit(fill)),
           async (fill) => {
             const relayDataHash = this.getRelayHashFromEvent(fill);
             fillCounter++;
@@ -933,7 +948,7 @@ export class BundleDataClient {
         await forEachAsync(
           destinationClient
             .getSlowFillRequestsForOriginChain(originChainId)
-            .filter((request) => request.blockNumber <= destinationChainBlockRange[1]),
+            .filter((request) => request.blockNumber <= destinationChainBlockRange[1] && !isZeroValueDeposit(request)),
           async (slowFillRequest: SlowFillRequestWithBlock) => {
             const relayDataHash = this.getRelayHashFromEvent(slowFillRequest);
 

package/src/gasPriceOracle/adapters/arbitrum.ts

@@ -2,14 +2,21 @@ import { providers } from "ethers";
 import { bnOne } from "../../utils";
 import { GasPriceEstimate } from "../types";
 import * as ethereum from "./ethereum";
+import { GasPriceEstimateOptions } from "../oracle";
 
-// 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);
+/**
+ * @notice Return Arbitrum orbit gas fees
+ * @dev 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 so we hardcode the priority fee
+ * to 1 wei.
+ * @param provider Ethers Provider
+ * @returns GasPriceEstimate
+ */
+export async function eip1559(provider: providers.Provider, opts: GasPriceEstimateOptions): Promise<GasPriceEstimate> {
+  const { maxFeePerGas: _maxFeePerGas, maxPriorityFeePerGas } = await ethereum.eip1559(provider, opts);
 
-  // eip1559() sets maxFeePerGas = lastBaseFeePerGas + maxPriorityFeePerGas, so revert that.
-  // The caller may apply scaling as they wish afterwards.
+  // eip1559() sets maxFeePerGas = lastBaseFeePerGas + maxPriorityFeePerGas, so back out priority fee.
+  // The remaining maxFeePerGas should be scaled already.
   const maxFeePerGas = _maxFeePerGas.sub(maxPriorityFeePerGas).add(bnOne);
 
   return { maxPriorityFeePerGas: bnOne, maxFeePerGas };

package/src/gasPriceOracle/adapters/ethereum.ts

@@ -1,26 +1,40 @@
 import assert from "assert";
 import { providers } from "ethers";
-import { BigNumber, bnZero, getNetworkName } from "../../utils";
+import { BigNumber, bnZero, fixedPointAdjustment, getNetworkName } from "../../utils";
 import { GasPriceEstimate } from "../types";
 import { gasPriceError } from "../util";
+import { GasPriceEstimateOptions } from "../oracle";
+
+// TODO: We intend to remove `eip1559Bad()` as an option and make eip1559Raw the only option eventually. The reason
+// they both exist currently is because eip1559Raw is new and untested on production so we will slowly roll it out
+// by using the convenient environment variable safety guard.
 
 /**
+ * @dev If GAS_PRICE_EIP1559_RAW_${chainId}=true, then constructs total fee by adding
+ * eth_getBlock("pending").baseFee to eth_maxPriorityFeePerGas, otherwise calls the ethers provider's
+ * getFeeData() method which adds eth_getBlock("latest").baseFee to a hardcoded priority fee of 1.5 gwei.
  * @param provider ethers RPC provider instance.
- * @param chainId Chain ID of provider instance.
  * @returns Promise of gas price estimate object.
  */
-export function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
-  const useRaw = process.env[`GAS_PRICE_EIP1559_RAW_${chainId}`] === "true";
-  return useRaw ? eip1559Raw(provider, chainId) : eip1559Bad(provider, chainId);
+export function eip1559(provider: providers.Provider, opts: GasPriceEstimateOptions): Promise<GasPriceEstimate> {
+  const useRaw = process.env[`GAS_PRICE_EIP1559_RAW_${opts.chainId}`] === "true";
+  return useRaw
+    ? eip1559Raw(provider, opts.chainId, opts.baseFeeMultiplier)
+    : eip1559Bad(provider, opts.chainId, opts.baseFeeMultiplier);
 }
 
 /**
  * @note Performs direct RPC calls to retrieve the RPC-suggested priority fee for the next block.
+ * @dev Constructs total fee by adding eth_getBlock("pending").baseFee to eth_maxPriorityFeePerGas
  * @param provider ethers RPC provider instance.
  * @param chainId Chain ID of the provider instance.
  * @returns Promise of gas price estimate object.
  */
-export async function eip1559Raw(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
+export async function eip1559Raw(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: BigNumber
+): Promise<GasPriceEstimate> {
   const [{ baseFeePerGas }, _maxPriorityFeePerGas] = await Promise.all([
     provider.getBlock("pending"),
     (provider as providers.JsonRpcProvider).send("eth_maxPriorityFeePerGas", []),
@@ -28,19 +42,27 @@ export async function eip1559Raw(provider: providers.Provider, chainId: number):
   const maxPriorityFeePerGas = BigNumber.from(_maxPriorityFeePerGas);
   assert(BigNumber.isBigNumber(baseFeePerGas), `No baseFeePerGas received on ${getNetworkName(chainId)}`);
 
+  const scaledBaseFee = baseFeePerGas.mul(baseFeeMultiplier).div(fixedPointAdjustment);
   return {
-    maxFeePerGas: maxPriorityFeePerGas.add(baseFeePerGas),
+    maxFeePerGas: maxPriorityFeePerGas.add(scaledBaseFee),
     maxPriorityFeePerGas,
   };
 }
 
 /**
- * @note Resolves priority gas pricing poorly, because the priority fee is hardcoded to 1.5 Gwei in ethers v5.
+ * @notice Returns fee data using provider's getFeeData() method.
+ * @note Resolves priority gas pricing poorly, because the priority fee is hardcoded to 1.5 Gwei in ethers v5's
+ * getFeeData() method
+ * @dev TODO: Remove this function soon. See note above about slowly rolling out eip1559Raw.
  * @param provider ethers RPC provider instance.
  * @param chainId Chain ID of the provider instance.
  * @returns Promise of gas price estimate object.
  */
-export async function eip1559Bad(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
+export async function eip1559Bad(
+  provider: providers.Provider,
+  chainId: number,
+  baseFeeMultiplier: BigNumber
+): Promise<GasPriceEstimate> {
   const feeData = await provider.getFeeData();
 
   [feeData.lastBaseFeePerGas, feeData.maxPriorityFeePerGas].forEach((field: BigNumber | null) => {
@@ -48,18 +70,27 @@ export async function eip1559Bad(provider: providers.Provider, chainId: number):
   });
 
   const maxPriorityFeePerGas = feeData.maxPriorityFeePerGas as BigNumber;
-  const maxFeePerGas = maxPriorityFeePerGas.add(feeData.lastBaseFeePerGas as BigNumber);
+  const scaledLastBaseFeePerGas = (feeData.lastBaseFeePerGas as BigNumber)
+    .mul(baseFeeMultiplier)
+    .div(fixedPointAdjustment);
+  const maxFeePerGas = maxPriorityFeePerGas.add(scaledLastBaseFeePerGas);
 
   return { maxPriorityFeePerGas, maxFeePerGas };
 }
 
-export async function legacy(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
+/**
+ * @notice Returns result of eth_gasPrice RPC call
+ * @dev Its recommended to use the eip1559Raw method over this one where possible as it will be more accurate.
+ * @returns GasPriceEstimate
+ */
+export async function legacy(provider: providers.Provider, opts: GasPriceEstimateOptions): Promise<GasPriceEstimate> {
+  const { chainId, baseFeeMultiplier } = opts;
   const gasPrice = await provider.getGasPrice();
 
   if (!BigNumber.isBigNumber(gasPrice) || gasPrice.lt(bnZero)) gasPriceError("getGasPrice()", chainId, gasPrice);
 
   return {
-    maxFeePerGas: gasPrice,
+    maxFeePerGas: gasPrice.mul(baseFeeMultiplier).div(fixedPointAdjustment),
     maxPriorityFeePerGas: bnZero,
   };
 }

package/src/gasPriceOracle/adapters/linea-viem.ts

@@ -1,14 +1,40 @@
-import { PublicClient } from "viem";
+import { Address, Hex, PublicClient } from "viem";
 import { estimateGas } from "viem/linea";
 import { DEFAULT_SIMULATED_RELAYER_ADDRESS as account } from "../../constants";
 import { InternalGasPriceEstimate } from "../types";
+import { GasPriceEstimateOptions } from "../oracle";
+import { fixedPointAdjustment } from "../../utils";
 
-export async function eip1559(provider: PublicClient, _chainId?: number): Promise<InternalGasPriceEstimate> {
-  const { baseFeePerGas, priorityFeePerGas } = await estimateGas(provider, {
-    account,
-    to: account,
-    value: BigInt(1),
+/**
+ * @notice The Linea viem provider calls the linea_estimateGas RPC endpoint to estimate gas. Linea is unique
+ * in that the recommended fee per gas is hardcoded to 7 wei while the priority fee is dynamic based on the
+ * compressed transaction size, layer 1 verification costs and capacity, gas price ratio between layer 1 and layer 2,
+ * the transaction's gas usage, the minimum gas price on layer 2,
+ * and a minimum margin (for error) for gas price estimation.
+ * Source: https://docs.linea.build/get-started/how-to/gas-fees#how-gas-works-on-linea
+ * @dev Because the Linea priority fee is more volatile than the base fee, the base fee multiplier will be applied
+ * to the priority fee.
+ * @param provider Viem PublicClient
+ * @param _chainId Unused in this adapter
+ * @param baseFeeMultiplier Amount to multiply priority fee, since Linea's base fee is hardcoded while its priority
+ * fee is dynamic
+ * @param _unsignedTx Should contain any params passed to linea_estimateGas, which are listed
+ * here: https://docs.linea.build/api/reference/linea-estimategas#parameters
+ * @returns
+ */
+export async function eip1559(
+  provider: PublicClient,
+  opts: GasPriceEstimateOptions
+): Promise<InternalGasPriceEstimate> {
+  const { unsignedTx, baseFeeMultiplier } = opts;
+  const { baseFeePerGas, priorityFeePerGas: _priorityFeePerGas } = await estimateGas(provider, {
+    account: (unsignedTx?.from as Address) ?? account,
+    to: (unsignedTx?.to as Address) ?? account,
+    value: BigInt(unsignedTx?.value?.toString() ?? "1"),
+    data: (unsignedTx?.data as Hex) ?? "0x",
   });
+  const priorityFeePerGas =
+    (_priorityFeePerGas * BigInt(baseFeeMultiplier.toString())) / BigInt(fixedPointAdjustment.toString());
 
   return {
     maxFeePerGas: baseFeePerGas + priorityFeePerGas,

package/src/gasPriceOracle/adapters/linea.ts

@@ -5,7 +5,12 @@
 import { providers } from "ethers";
 import { GasPriceEstimate } from "../types";
 import * as ethereum from "./ethereum";
+import { GasPriceEstimateOptions } from "../oracle";
 
-export function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
-  return ethereum.legacy(provider, chainId);
+export function eip1559(provider: providers.Provider, opts: GasPriceEstimateOptions): Promise<GasPriceEstimate> {
+  // We use the legacy method to call `eth_gasPrice` which empirically returns a more accurate
+  // gas price estimate than `eth_maxPriorityFeePerGas` or ethersProvider.getFeeData in the EIP1559 "raw" or "bad"
+  // cases. Based on testing, `eth_gasPrice` returns the closest price to the Linea-specific `linea_estimateGas`
+  // endpoint which the Viem Linea adapter queries.
+  return ethereum.legacy(provider, opts);
 }

package/src/gasPriceOracle/adapters/polygon.ts

@@ -1,10 +1,11 @@
 import { providers } from "ethers";
 import { BaseHTTPAdapter, BaseHTTPAdapterArgs } from "../../priceClient/adapters/baseAdapter";
-import { BigNumber, bnZero, isDefined, parseUnits } from "../../utils";
+import { BigNumber, bnZero, fixedPointAdjustment, isDefined, parseUnits } from "../../utils";
 import { CHAIN_IDs } from "../../constants";
 import { GasPriceEstimate } from "../types";
 import { gasPriceError } from "../util";
 import { eip1559 } from "./ethereum";
+import { GasPriceEstimateOptions } from "../oracle";
 
 type Polygon1559GasPrice = {
   maxPriorityFee: number | string;
@@ -27,7 +28,7 @@ type GasStationArgs = BaseHTTPAdapterArgs & {
 
 const { POLYGON } = CHAIN_IDs;
 
-class PolygonGasStation extends BaseHTTPAdapter {
+export class PolygonGasStation extends BaseHTTPAdapter {
   readonly chainId: number;
 
   constructor({ chainId = POLYGON, host, timeout = 1500, retries = 1 }: GasStationArgs = {}) {
@@ -67,15 +68,55 @@ class PolygonGasStation extends BaseHTTPAdapter {
   }
 }
 
-export async function gasStation(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate> {
-  const gasStation = new PolygonGasStation({ chainId: chainId, timeout: 2000, retries: 0 });
+class MockRevertingPolygonGasStation extends PolygonGasStation {
+  getFeeData(): Promise<GasPriceEstimate> {
+    throw new Error();
+  }
+}
+
+export const MockPolygonGasStationBaseFee = () => parseUnits("12", 9);
+export const MockPolygonGasStationPriorityFee = () => parseUnits("1", 9);
+
+class MockPolygonGasStation extends PolygonGasStation {
+  getFeeData(): Promise<GasPriceEstimate> {
+    return Promise.resolve({
+      maxPriorityFeePerGas: MockPolygonGasStationPriorityFee(),
+      maxFeePerGas: MockPolygonGasStationBaseFee().add(MockPolygonGasStationPriorityFee()),
+    });
+  }
+}
+
+/**
+ * @notice Returns the gas price suggested by the Polygon GasStation API or reconstructs it using
+ * the eip1559() method as a fallback.
+ * @param provider Ethers Provider.
+ * @returns GasPriceEstimate
+ */
+export async function gasStation(
+  provider: providers.Provider,
+  opts: GasPriceEstimateOptions
+): Promise<GasPriceEstimate> {
+  const { chainId, baseFeeMultiplier } = opts;
+  let gasStation: PolygonGasStation;
+  if (process.env.TEST_POLYGON_GAS_STATION === "true") {
+    gasStation = new MockPolygonGasStation();
+  } else if (process.env.TEST_REVERTING_POLYGON_GAS_STATION === "true") {
+    gasStation = new MockRevertingPolygonGasStation();
+  } else {
+    gasStation = new PolygonGasStation({ chainId: chainId, timeout: 2000, retries: 0 });
+  }
   let maxPriorityFeePerGas: BigNumber;
   let maxFeePerGas: BigNumber;
   try {
     ({ maxPriorityFeePerGas, maxFeePerGas } = await gasStation.getFeeData());
+    // Assume that the maxFeePerGas already includes the priority fee, so back out the priority fee before applying
+    // the baseFeeMultiplier.
+    const baseFeeMinusPriorityFee = maxFeePerGas.sub(maxPriorityFeePerGas);
+    const scaledBaseFee = baseFeeMinusPriorityFee.mul(baseFeeMultiplier).div(fixedPointAdjustment);
+    maxFeePerGas = scaledBaseFee.add(maxPriorityFeePerGas);
   } catch (err) {
     // Fall back to the RPC provider. May be less accurate.
-    ({ maxPriorityFeePerGas, maxFeePerGas } = await eip1559(provider, chainId));
+    ({ maxPriorityFeePerGas, maxFeePerGas } = await eip1559(provider, opts));
 
     // Per the GasStation docs, the minimum priority fee on Polygon is 30 Gwei.
     // https://docs.polygon.technology/tools/gas/polygon-gas-station/#interpretation

package/src/gasPriceOracle/oracle.ts

@@ -1,37 +1,61 @@
 import assert from "assert";
 import { Transport } from "viem";
-import { providers } from "ethers";
+import { PopulatedTransaction, providers } from "ethers";
 import { CHAIN_IDs } from "../constants";
-import { BigNumber, chainIsOPStack } from "../utils";
+import { BigNumber, chainIsOPStack, fixedPointAdjustment, toBNWei } from "../utils";
 import { GasPriceEstimate } from "./types";
 import { getPublicClient } from "./util";
 import * as arbitrum from "./adapters/arbitrum";
 import * as ethereum from "./adapters/ethereum";
 import * as linea from "./adapters/linea";
 import * as polygon from "./adapters/polygon";
-import * as arbitrumViem from "./adapters/arbitrum-viem";
 import * as lineaViem from "./adapters/linea-viem";
-import * as polygonViem from "./adapters/polygon-viem";
+
+export interface GasPriceEstimateOptions {
+  // baseFeeMultiplier Multiplier applied to base fee for EIP1559 gas prices (or total fee for legacy).
+  baseFeeMultiplier: BigNumber;
+  // legacyFallback In the case of an unrecognized chain, fall back to type 0 gas estimation.
+  legacyFallback: boolean;
+  // chainId The chain ID to query for gas prices. If omitted can be inferred by provider.
+  chainId: number;
+  // unsignedTx The unsigned transaction used for simulation by Linea's Viem provider to produce the priority gas fee.
+  unsignedTx?: PopulatedTransaction;
+  // transport Viem Transport object to use for querying gas fees used for testing.
+  transport?: Transport;
+}
+
+const GAS_PRICE_ESTIMATE_DEFAULTS = {
+  legacyFallback: true,
+};
 
 /**
  * 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.
- * @returns Am object of type GasPriceEstimate.
+ * @param {opts} GasPriceEstimateOptions optional parameters.
+ * @returns An  object of type GasPriceEstimate.
  */
 export async function getGasPriceEstimate(
   provider: providers.Provider,
-  chainId?: number,
-  transport?: Transport,
-  legacyFallback = true
+  opts: Partial<GasPriceEstimateOptions> = {}
 ): Promise<GasPriceEstimate> {
-  chainId ?? ({ chainId } = await provider.getNetwork());
+  const baseFeeMultiplier = opts.baseFeeMultiplier ?? toBNWei("1");
+  assert(
+    baseFeeMultiplier.gte(toBNWei("1.0")) && baseFeeMultiplier.lte(toBNWei("5")),
+    `Require 1.0 < base fee multiplier (${baseFeeMultiplier}) <= 5.0 for a total gas multiplier within [+1.0, +5.0]`
+  );
+  const chainId = opts.chainId ?? (await provider.getNetwork()).chainId;
+  const optsWithDefaults: GasPriceEstimateOptions = {
+    ...GAS_PRICE_ESTIMATE_DEFAULTS,
+    baseFeeMultiplier,
+    ...opts,
+    chainId,
+  };
 
+  // We only use the unsignedTx in the viem flow.
   const useViem = process.env[`NEW_GAS_PRICE_ORACLE_${chainId}`] === "true";
   return useViem
-    ? getViemGasPriceEstimate(chainId, transport)
-    : getEthersGasPriceEstimate(provider, chainId, legacyFallback);
+    ? _getViemGasPriceEstimate(chainId, optsWithDefaults)
+    : _getEthersGasPriceEstimate(provider, optsWithDefaults);
 }
 
 /**
@@ -39,13 +63,14 @@ export async function getGasPriceEstimate(
  * @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.
- * @returns Am object of type GasPriceEstimate.
+ * @returns An object of type GasPriceEstimate.
  */
-function getEthersGasPriceEstimate(
+function _getEthersGasPriceEstimate(
   provider: providers.Provider,
-  chainId: number,
-  legacyFallback = true
+  opts: GasPriceEstimateOptions
 ): Promise<GasPriceEstimate> {
+  const { chainId, legacyFallback } = opts;
+
   const gasPriceFeeds = {
     [CHAIN_IDs.ALEPH_ZERO]: arbitrum.eip1559,
     [CHAIN_IDs.ARBITRUM]: arbitrum.eip1559,
@@ -60,39 +85,39 @@ function getEthersGasPriceEstimate(
   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, opts);
 }
 
 /**
  * Provide an estimate for the current gas price for a particular chain.
  * @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.
+ * @param transport An optional Viem Transport object for custom gas price retrieval.
+ * @param unsignedTx Only used in Linea provider to estimate priority gas fee.
+ * @returns An object of type GasPriceEstimate.
  */
-export async function getViemGasPriceEstimate(
+export async function _getViemGasPriceEstimate(
   providerOrChainId: providers.Provider | number,
-  transport?: Transport
+  opts: GasPriceEstimateOptions
 ): Promise<GasPriceEstimate> {
+  const { baseFeeMultiplier, transport } = opts;
+
   const chainId =
     typeof providerOrChainId === "number" ? providerOrChainId : (await providerOrChainId.getNetwork()).chainId;
   const viemProvider = getPublicClient(chainId, transport);
 
   const gasPriceFeeds = {
-    [CHAIN_IDs.ALEPH_ZERO]: arbitrumViem.eip1559,
-    [CHAIN_IDs.ARBITRUM]: arbitrumViem.eip1559,
     [CHAIN_IDs.LINEA]: lineaViem.eip1559,
-    [CHAIN_IDs.POLYGON]: polygonViem.gasStation,
-  } as const;
+  };
 
   let maxFeePerGas: bigint;
   let maxPriorityFeePerGas: bigint;
   if (gasPriceFeeds[chainId]) {
-    ({ maxFeePerGas, maxPriorityFeePerGas } = await gasPriceFeeds[chainId](viemProvider, chainId));
+    ({ maxFeePerGas, maxPriorityFeePerGas } = await gasPriceFeeds[chainId](viemProvider, opts));
   } else {
     let gasPrice: bigint | undefined;
     ({ maxFeePerGas, maxPriorityFeePerGas, gasPrice } = await viemProvider.estimateFeesPerGas());
 
-    maxFeePerGas ??= gasPrice!;
+    maxFeePerGas ??= (gasPrice! * BigInt(baseFeeMultiplier.toString())) / BigInt(fixedPointAdjustment.toString());
     maxPriorityFeePerGas ??= BigInt(0);
   }
 

package/src/relayFeeCalculator/chain-queries/alephZero.ts

@@ -1,36 +1,8 @@
-import assert from "assert";
-import { getDeployedAddress } from "../../utils/DeploymentUtils";
-import { DEFAULT_LOGGER, Logger } from "../relayFeeCalculator";
-import { providers } from "ethers";
-import { CHAIN_IDs, DEFAULT_SIMULATED_RELAYER_ADDRESS, TOKEN_SYMBOLS_MAP } from "../../constants";
+import { CHAIN_IDs } from "../../constants";
 import { Coingecko } from "../../coingecko/Coingecko";
-import { isDefined } from "../../utils";
 import { QueryBase } from "./baseQuery";
 
 export class AlephZeroQueries extends QueryBase {
-  constructor(
-    provider: providers.Provider,
-    symbolMapping = TOKEN_SYMBOLS_MAP,
-    spokePoolAddress = getDeployedAddress("SpokePool", CHAIN_IDs.ALEPH_ZERO),
-    simulatedRelayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS,
-    coingeckoProApiKey?: string,
-    logger: Logger = DEFAULT_LOGGER,
-    gasMarkup = 0
-  ) {
-    assert(isDefined(spokePoolAddress));
-    super(
-      provider,
-      symbolMapping,
-      spokePoolAddress,
-      simulatedRelayerAddress,
-      gasMarkup,
-      logger,
-      coingeckoProApiKey,
-      undefined,
-      "usd"
-    );
-  }
-
   override async getTokenPrice(tokenSymbol: string): Promise<number> {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     const coingeckoInstance = Coingecko.get(this.logger, this.coingeckoProApiKey);