@across-protocol/sdk 3.3.31 → 3.4.0

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

@@ -1,6 +1,7 @@
 import { L2Provider } from "@eth-optimism/sdk/dist/interfaces/l2-provider";
-import { providers } from "ethers";
-import assert from "assert";
+import { isL2Provider as isOptimismL2Provider } from "@eth-optimism/sdk/dist/l2-provider";
+
+import { PopulatedTransaction, providers, VoidSigner } from "ethers";
 import { Coingecko } from "../../coingecko";
 import { CHAIN_IDs, DEFAULT_SIMULATED_RELAYER_ADDRESS } from "../../constants";
 import { Deposit } from "../../interfaces";
@@ -8,14 +9,16 @@ import { SpokePool, SpokePool__factory } from "../../typechain";
 import {
   BigNumberish,
   TransactionCostEstimate,
-  estimateTotalGasRequiredByUnsignedTransaction,
-  fixedPointAdjustment,
   populateV3Relay,
+  BigNumber,
   toBNWei,
+  bnZero,
+  assert,
+  chainIsOPStack,
 } from "../../utils";
 import { Logger, QueryInterface } from "../relayFeeCalculator";
 import { Transport } from "viem";
-
+import { getGasPriceEstimate } from "../../gasPriceOracle/oracle";
 type Provider = providers.Provider;
 type OptimismProvider = L2Provider<Provider>;
 type SymbolMappingType = Record<
@@ -38,7 +41,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 +51,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,
@@ -65,7 +66,6 @@ export class QueryBase implements QueryInterface {
    * @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).
    */
@@ -75,37 +75,90 @@ export class QueryBase implements QueryInterface {
     options: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
-      omitMarkup: boolean;
+      baseFeeMultiplier: BigNumber;
       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, baseFeeMultiplier, transport } = options;
 
     const tx = await populateV3Relay(this.spokePool, deposit, relayer);
     const {
       nativeGasCost,
       tokenGasCost,
       gasPrice: impliedGasPrice,
-    } = await estimateTotalGasRequiredByUnsignedTransaction(tx, relayer, this.provider, {
+    } = await this.estimateGas(tx, relayer, this.provider, {
       gasPrice,
       gasUnits,
+      baseFeeMultiplier,
       transport,
     });
 
     return {
-      nativeGasCost: nativeGasCost.mul(gasTotalMultiplier).div(fixedPointAdjustment),
-      tokenGasCost: tokenGasCost.mul(gasTotalMultiplier).div(fixedPointAdjustment),
+      nativeGasCost,
+      tokenGasCost,
       gasPrice: impliedGasPrice,
     };
   }
 
+  /**
+   * Estimates the total gas cost required to submit an unsigned (populated) transaction on-chain.
+   * @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 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).
+   */
+  async estimateGas(
+    unsignedTx: PopulatedTransaction,
+    senderAddress: string,
+    provider: providers.Provider | L2Provider<providers.Provider>,
+    options: Partial<{
+      gasPrice: BigNumberish;
+      gasUnits: BigNumberish;
+      baseFeeMultiplier: BigNumber;
+      transport: Transport;
+    }> = {}
+  ): Promise<TransactionCostEstimate> {
+    const { gasPrice: _gasPrice, gasUnits, baseFeeMultiplier = toBNWei("1"), transport } = options || {};
+
+    const { chainId } = await provider.getNetwork();
+    const voidSigner = new VoidSigner(senderAddress, provider);
+
+    // Estimate the Gas units required to submit this transaction.
+    const queries = [
+      gasUnits ? Promise.resolve(BigNumber.from(gasUnits)) : voidSigner.estimateGas(unsignedTx),
+      _gasPrice
+        ? Promise.resolve({ maxFeePerGas: _gasPrice })
+        : getGasPriceEstimate(provider, { chainId, baseFeeMultiplier, transport, unsignedTx }),
+    ] as const;
+    const [nativeGasCost, { maxFeePerGas: gasPrice }] = await Promise.all(queries);
+    assert(nativeGasCost.gt(bnZero), "Gas cost should not be 0");
+    let tokenGasCost: BigNumber;
+
+    // OP stack is a special case; gas cost is computed by the SDK, without having to query price.
+    if (chainIsOPStack(chainId)) {
+      assert(isOptimismL2Provider(provider), `Unexpected provider for chain ID ${chainId}.`);
+      const populatedTransaction = await voidSigner.populateTransaction({
+        ...unsignedTx,
+        gasLimit: nativeGasCost, // prevents additional gas estimation call
+      });
+      const l1GasCost = await provider.estimateL1GasCost(populatedTransaction);
+      const l2GasCost = nativeGasCost.mul(gasPrice);
+      tokenGasCost = l1GasCost.add(l2GasCost);
+    } else {
+      tokenGasCost = nativeGasCost.mul(gasPrice);
+    }
+
+    return {
+      nativeGasCost, // Units: gas
+      tokenGasCost, // Units: wei (nativeGasCost * wei/gas)
+      gasPrice: tokenGasCost.div(nativeGasCost), // Units: wei/gas
+    };
+  }
+
   /**
    * Retrieves the current price of a token
    * @param tokenSymbol A valid [CoinGecko-ID](https://api.coingecko.com/api/v3/coins/list)

package/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));
@@ -38,9 +37,10 @@ export class QueryBase__factory {
         symbolMapping,
         spokePoolAddress,
         simulatedRelayerAddress,
-        coingeckoProApiKey,
         logger,
-        gasMarkup
+        coingeckoProApiKey,
+        fixedGasPrice[chainId],
+        "usd"
       );
     }
 
@@ -50,9 +50,10 @@ export class QueryBase__factory {
         symbolMapping,
         spokePoolAddress,
         simulatedRelayerAddress,
-        coingeckoProApiKey,
         logger,
-        gasMarkup
+        coingeckoProApiKey,
+        fixedGasPrice[chainId],
+        "usd"
       );
     }
 
@@ -64,7 +65,6 @@ export class QueryBase__factory {
       symbolMapping,
       spokePoolAddress,
       simulatedRelayerAddress,
-      gasMarkup,
       logger,
       coingeckoProApiKey,
       fixedGasPrice[chainId],

package/src/relayFeeCalculator/chain-queries/polygon.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 PolygonQueries extends QueryBase {
-  constructor(
-    provider: providers.Provider,
-    symbolMapping = TOKEN_SYMBOLS_MAP,
-    spokePoolAddress = getDeployedAddress("SpokePool", CHAIN_IDs.POLYGON),
-    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);

package/src/relayFeeCalculator/relayFeeCalculator.ts

@@ -24,7 +24,12 @@ export interface QueryInterface {
   getGasCosts: (
     deposit: Deposit,
     relayer: string,
-    options?: Partial<{ gasPrice: BigNumberish; gasUnits: BigNumberish; omitMarkup: boolean; transport: Transport }>
+    options?: Partial<{
+      gasPrice: BigNumberish;
+      gasUnits: BigNumberish;
+      baseFeeMultiplier: BigNumber;
+      transport: Transport;
+    }>
   ) => Promise<TransactionCostEstimate>;
   getTokenPrice: (tokenSymbol: string) => Promise<number>;
   getTokenDecimals: (tokenSymbol: string) => number;

package/src/utils/DepositUtils.ts

@@ -125,6 +125,18 @@ export async function queryHistoricalDepositForFill(
   };
 }
 
+/**
+ * Returns true if filling this deposit (as a slow or fast fill) or refunding it would not change any state
+ * on-chain. The dataworker functions can use this to conveniently filter out useless deposits.
+ * @dev The reason we allow a 0-input deposit to have a non-empty message is that the message might be used
+ * to pay the filler in an indirect way so it might have economic value as a fast or slow fill.
+ * @param deposit Deposit to check.
+ * @returns True if deposit's input amount is 0 and message is empty.
+ */
+export function isZeroValueDeposit(deposit: Pick<Deposit, "inputAmount" | "message">): boolean {
+  return deposit.inputAmount.eq(0) && isMessageEmpty(deposit.message);
+}
+
 /**
  * Determines if a message is empty or not.
  * @param message The message to check.

package/src/utils/Multicall.ts

@@ -21,20 +21,15 @@ const NON_DETERMINISTIC_MULTICALL_ADDRESSES = {
   [CHAIN_IDs.ZK_SYNC]: "0xF9cda624FBC7e059355ce98a31693d299FACd963",
 };
 
-// Multicall3 is an OP stack predeploy, so don't specify it here.
+// @notice Multicall3 is an OP stack preinstall, so don't specify it here.
 const DETERMINISTIC_MULTICALL_CHAINS = [
   CHAIN_IDs.ALEPH_ZERO,
   CHAIN_IDs.ARBITRUM,
-  CHAIN_IDs.INK,
   CHAIN_IDs.LINEA,
   CHAIN_IDs.MAINNET,
   CHAIN_IDs.POLYGON,
   CHAIN_IDs.SCROLL,
-  CHAIN_IDs.ZORA,
   // Testnet:
-  CHAIN_IDs.BASE_SEPOLIA,
-  CHAIN_IDs.BLAST_SEPOLIA,
-  CHAIN_IDs.INK_SEPOLIA,
   CHAIN_IDs.POLYGON_AMOY,
   CHAIN_IDs.SCROLL_SEPOLIA,
   CHAIN_IDs.SEPOLIA,

package/src/utils/common.ts

@@ -1,16 +1,7 @@
-import { L2Provider } from "@eth-optimism/sdk/dist/interfaces/l2-provider";
-import { isL2Provider as isOptimismL2Provider } from "@eth-optimism/sdk/dist/l2-provider";
-import assert from "assert";
 import Decimal from "decimal.js";
-import { ethers, PopulatedTransaction, providers, VoidSigner } from "ethers";
-import { getGasPriceEstimate } from "../gasPriceOracle";
-import { BigNumber, BigNumberish, BN, bnZero, formatUnits, parseUnits, toBN } from "./BigNumberUtils";
+import { ethers } from "ethers";
+import { BigNumber, BigNumberish, BN, formatUnits, parseUnits, toBN } from "./BigNumberUtils";
 import { ConvertDecimals } from "./FormattingUtils";
-import { chainIsOPStack } from "./NetworkUtils";
-import { Address, Transport } from "viem";
-import { CHAIN_IDs } from "@across-protocol/constants";
-import { estimateGas } from "viem/linea";
-import { getPublicClient } from "../gasPriceOracle/util";
 
 export type Decimalish = string | number | Decimal;
 export const AddressZero = ethers.constants.AddressZero;
@@ -238,87 +229,6 @@ export type TransactionCostEstimate = {
   gasPrice: BigNumber; // Units: wei/gas
 };
 
-/**
- * Estimates the total gas cost required to submit an unsigned (populated) transaction on-chain.
- * @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 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>,
-  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);
-
-  // Estimate the Gas units required to submit this transaction.
-  const queries = [
-    gasUnits ? Promise.resolve(BigNumber.from(gasUnits)) : voidSigner.estimateGas(unsignedTx),
-    _gasPrice ? Promise.resolve({ maxFeePerGas: _gasPrice }) : getGasPriceEstimate(provider, chainId, transport),
-  ] as const;
-  let [nativeGasCost, { maxFeePerGas: gasPrice }] = await Promise.all(queries);
-  assert(nativeGasCost.gt(bnZero), "Gas cost should not be 0");
-  let tokenGasCost: BigNumber;
-
-  // OP stack is a special case; gas cost is computed by the SDK, without having to query price.
-  if (chainIsOPStack(chainId)) {
-    assert(isOptimismL2Provider(provider), `Unexpected provider for chain ID ${chainId}.`);
-    const populatedTransaction = await voidSigner.populateTransaction({
-      ...unsignedTx,
-      gasLimit: nativeGasCost, // prevents additional gas estimation call
-    });
-    const l1GasCost = await provider.estimateL1GasCost(populatedTransaction);
-    const l2GasCost = nativeGasCost.mul(gasPrice);
-    tokenGasCost = l1GasCost.add(l2GasCost);
-  } else {
-    if (chainId === CHAIN_IDs.LINEA && process.env[`NEW_GAS_PRICE_ORACLE_${chainId}`] === "true") {
-      // Permit linea_estimateGas via NEW_GAS_PRICE_ORACLE_59144=true
-      let baseFeePerGas: BigNumber, priorityFeePerGas: BigNumber;
-      ({
-        gasLimit: nativeGasCost,
-        baseFeePerGas,
-        priorityFeePerGas,
-      } = await getLineaGasFees(chainId, transport, unsignedTx));
-      gasPrice = baseFeePerGas.add(priorityFeePerGas);
-    }
-
-    tokenGasCost = nativeGasCost.mul(gasPrice);
-  }
-
-  return {
-    nativeGasCost, // Units: gas
-    tokenGasCost, // Units: wei (nativeGasCost * wei/gas)
-    gasPrice: tokenGasCost.div(nativeGasCost), // Units: wei/gas
-  };
-}
-
-async function getLineaGasFees(chainId: number, transport: Transport | undefined, unsignedTx: PopulatedTransaction) {
-  const { gasLimit, baseFeePerGas, priorityFeePerGas } = await estimateGas(getPublicClient(chainId, transport), {
-    account: unsignedTx.from as Address,
-    to: unsignedTx.to as Address,
-    value: BigInt(unsignedTx.value?.toString() || "1"),
-  });
-
-  return {
-    gasLimit: BigNumber.from(gasLimit.toString()),
-    baseFeePerGas: BigNumber.from(baseFeePerGas.toString()),
-    priorityFeePerGas: BigNumber.from(priorityFeePerGas.toString()),
-  };
-}
-
 export function randomAddress() {
   return ethers.utils.getAddress(ethers.utils.hexlify(ethers.utils.randomBytes(20)));
 }

package/dist/cjs/gasPriceOracle/adapters/arbitrum-viem.d.ts

@@ -1,3 +0,0 @@
-import { PublicClient } from "viem";
-import { InternalGasPriceEstimate } from "../types";
-export declare function eip1559(provider: PublicClient, _chainId: number): Promise<InternalGasPriceEstimate>;

package/dist/cjs/gasPriceOracle/adapters/arbitrum-viem.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.eip1559 = void 0;
-var tslib_1 = require("tslib");
-var MAX_PRIORITY_FEE_PER_GAS = BigInt(1);
-function eip1559(provider, _chainId) {
-    return tslib_1.__awaiter(this, void 0, void 0, function () {
-        var _a, _maxFeePerGas, maxPriorityFeePerGas, maxFeePerGas;
-        return tslib_1.__generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4, provider.estimateFeesPerGas()];
-                case 1:
-                    _a = _b.sent(), _maxFeePerGas = _a.maxFeePerGas, maxPriorityFeePerGas = _a.maxPriorityFeePerGas;
-                    maxFeePerGas = BigInt(_maxFeePerGas) - maxPriorityFeePerGas + MAX_PRIORITY_FEE_PER_GAS;
-                    return [2, { maxFeePerGas: maxFeePerGas, maxPriorityFeePerGas: MAX_PRIORITY_FEE_PER_GAS }];
-            }
-        });
-    });
-}
-exports.eip1559 = eip1559;
-//# sourceMappingURL=arbitrum-viem.js.map

package/dist/cjs/gasPriceOracle/adapters/arbitrum-viem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"arbitrum-viem.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/arbitrum-viem.ts"],"names":[],"mappings":";;;;AAGA,IAAM,wBAAwB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;AAK3C,SAAsB,OAAO,CAAC,QAAsB,EAAE,QAAgB;;;;;wBACN,WAAM,QAAQ,CAAC,kBAAkB,EAAE,EAAA;;oBAA3F,KAAwD,SAAmC,EAA3E,aAAa,kBAAA,EAAE,oBAAoB,0BAAA;oBACnD,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,oBAAoB,GAAG,wBAAwB,CAAC;oBAC7F,WAAO,EAAE,YAAY,cAAA,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,EAAC;;;;CACzE;AAJD,0BAIC"}

package/dist/cjs/gasPriceOracle/adapters/ethereum-viem.d.ts

@@ -1,4 +0,0 @@
-import { PublicClient } from "viem";
-import { InternalGasPriceEstimate } from "../types";
-export declare function eip1559(provider: PublicClient, _chainId: number): Promise<InternalGasPriceEstimate>;
-export declare function legacy(provider: PublicClient, _chainId: number, _test?: number): Promise<InternalGasPriceEstimate>;

package/dist/cjs/gasPriceOracle/adapters/ethereum-viem.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.legacy = exports.eip1559 = void 0;
-var tslib_1 = require("tslib");
-function eip1559(provider, _chainId) {
-    return provider.estimateFeesPerGas();
-}
-exports.eip1559 = eip1559;
-function legacy(provider, _chainId, _test) {
-    return tslib_1.__awaiter(this, void 0, void 0, function () {
-        var gasPrice;
-        return tslib_1.__generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4, provider.getGasPrice()];
-                case 1:
-                    gasPrice = _a.sent();
-                    return [2, {
-                            maxFeePerGas: gasPrice,
-                            maxPriorityFeePerGas: BigInt(0),
-                        }];
-            }
-        });
-    });
-}
-exports.legacy = legacy;
-//# sourceMappingURL=ethereum-viem.js.map

package/dist/cjs/gasPriceOracle/adapters/ethereum-viem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ethereum-viem.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/ethereum-viem.ts"],"names":[],"mappings":";;;;AAGA,SAAgB,OAAO,CAAC,QAAsB,EAAE,QAAgB;IAC9D,OAAO,QAAQ,CAAC,kBAAkB,EAAE,CAAC;AACvC,CAAC;AAFD,0BAEC;AAED,SAAsB,MAAM,CAC1B,QAAsB,EACtB,QAAgB,EAChB,KAAc;;;;;wBAEG,WAAM,QAAQ,CAAC,WAAW,EAAE,EAAA;;oBAAvC,QAAQ,GAAG,SAA4B;oBAE7C,WAAO;4BACL,YAAY,EAAE,QAAQ;4BACtB,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC;yBAChC,EAAC;;;;CACH;AAXD,wBAWC"}

package/dist/cjs/gasPriceOracle/adapters/polygon-viem.d.ts

@@ -1,3 +0,0 @@
-import { PublicClient } from "viem";
-import { InternalGasPriceEstimate } from "../types";
-export declare function gasStation(provider: PublicClient, chainId: number): Promise<InternalGasPriceEstimate>;

package/dist/cjs/gasPriceOracle/adapters/polygon-viem.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gasStation = void 0;
-var tslib_1 = require("tslib");
-var baseAdapter_1 = require("../../priceClient/adapters/baseAdapter");
-var utils_1 = require("../../utils");
-var constants_1 = require("../../constants");
-var util_1 = require("../util");
-var ethereum_viem_1 = require("./ethereum-viem");
-var POLYGON = constants_1.CHAIN_IDs.POLYGON;
-var GWEI = BigInt(1000000000);
-var PolygonGasStation = (function (_super) {
-    tslib_1.__extends(PolygonGasStation, _super);
-    function PolygonGasStation(_a) {
-        var _this = this;
-        var _b = _a === void 0 ? {} : _a, _c = _b.chainId, chainId = _c === void 0 ? POLYGON : _c, host = _b.host, _d = _b.timeout, timeout = _d === void 0 ? 1500 : _d, _e = _b.retries, retries = _e === void 0 ? 1 : _e;
-        host = (host !== null && host !== void 0 ? host : chainId === POLYGON) ? "gasstation.polygon.technology" : "gasstation-testnet.polygon.technology";
-        _this = _super.call(this, "Polygon Gas Station", host, { timeout: timeout, retries: retries }) || this;
-        _this.chainId = chainId;
-        return _this;
-    }
-    PolygonGasStation.prototype.getFeeData = function (strategy) {
-        if (strategy === void 0) { strategy = "fast"; }
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var gas, gasPrice, maxPriorityFeePerGas, maxFeePerGas;
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4, this.query("v2", {})];
-                    case 1:
-                        gas = _a.sent();
-                        gasPrice = gas === null || gas === void 0 ? void 0 : gas[strategy];
-                        if (!this.isPolygon1559GasPrice(gasPrice)) {
-                            (0, util_1.gasPriceError)("getFeeData()", this.chainId, gasPrice);
-                        }
-                        maxPriorityFeePerGas = BigInt(gasPrice.maxPriorityFee) * GWEI;
-                        maxFeePerGas = BigInt(gasPrice.maxFee) * GWEI;
-                        return [2, { maxPriorityFeePerGas: maxPriorityFeePerGas, maxFeePerGas: maxFeePerGas }];
-                }
-            });
-        });
-    };
-    PolygonGasStation.prototype.isPolygon1559GasPrice = function (gasPrice) {
-        if (!(0, utils_1.isDefined)(gasPrice)) {
-            return false;
-        }
-        var _gasPrice = gasPrice;
-        return [_gasPrice.maxPriorityFee, _gasPrice.maxFee].every(function (field) { return ["number", "string"].includes(typeof field); });
-    };
-    return PolygonGasStation;
-}(baseAdapter_1.BaseHTTPAdapter));
-function gasStation(provider, chainId) {
-    return tslib_1.__awaiter(this, void 0, void 0, function () {
-        var gasStation, maxPriorityFeePerGas, maxFeePerGas, err_1, minPriorityFee, priorityDelta;
-        var _a, _b;
-        return tslib_1.__generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    gasStation = new PolygonGasStation({ chainId: chainId, timeout: 2000, retries: 0 });
-                    _c.label = 1;
-                case 1:
-                    _c.trys.push([1, 3, , 5]);
-                    return [4, gasStation.getFeeData()];
-                case 2:
-                    (_a = _c.sent(), maxPriorityFeePerGas = _a.maxPriorityFeePerGas, maxFeePerGas = _a.maxFeePerGas);
-                    return [3, 5];
-                case 3:
-                    err_1 = _c.sent();
-                    return [4, (0, ethereum_viem_1.eip1559)(provider, chainId)];
-                case 4:
-                    (_b = _c.sent(), maxPriorityFeePerGas = _b.maxPriorityFeePerGas, maxFeePerGas = _b.maxFeePerGas);
-                    minPriorityFee = BigInt(30) * GWEI;
-                    if (minPriorityFee > maxPriorityFeePerGas) {
-                        priorityDelta = minPriorityFee - maxPriorityFeePerGas;
-                        maxPriorityFeePerGas = minPriorityFee;
-                        maxFeePerGas = maxFeePerGas + priorityDelta;
-                    }
-                    return [3, 5];
-                case 5: return [2, { maxPriorityFeePerGas: maxPriorityFeePerGas, maxFeePerGas: maxFeePerGas }];
-            }
-        });
-    });
-}
-exports.gasStation = gasStation;
-//# sourceMappingURL=polygon-viem.js.map

package/dist/cjs/gasPriceOracle/adapters/polygon-viem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"polygon-viem.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/polygon-viem.ts"],"names":[],"mappings":";;;;AACA,sEAA8F;AAC9F,qCAAwC;AACxC,6CAA4C;AAE5C,gCAAwC;AACxC,iDAA0C;AAqBlC,IAAA,OAAO,GAAK,qBAAS,QAAd,CAAe;AAE9B,IAAM,IAAI,GAAG,MAAM,CAAC,UAAa,CAAC,CAAC;AACnC;IAAgC,6CAAe;IAG7C,2BAAY,EAA6E;QAAzF,iBAKC;YALW,qBAA2E,EAAE,KAAA,EAA3E,eAAiB,EAAjB,OAAO,mBAAG,OAAO,KAAA,EAAE,IAAI,UAAA,EAAE,eAAc,EAAd,OAAO,mBAAG,IAAI,KAAA,EAAE,eAAW,EAAX,OAAO,mBAAG,CAAC,KAAA;QAChE,IAAI,GAAG,CAAA,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,OAAO,KAAK,OAAO,EAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,uCAAuC,CAAC;gBAE/G,kBAAM,qBAAqB,EAAE,IAAI,EAAE,EAAE,OAAO,SAAA,EAAE,OAAO,SAAA,EAAE,CAAC;QACxD,KAAI,CAAC,OAAO,GAAG,OAAO,CAAC;;IACzB,CAAC;IAEK,sCAAU,GAAhB,UAAiB,QAAkD;QAAlD,yBAAA,EAAA,iBAAkD;;;;;4BACrD,WAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,EAAA;;wBAAhC,GAAG,GAAG,SAA0B;wBAEhC,QAAQ,GAAI,GAA4B,aAA5B,GAAG,uBAAH,GAAG,CAA4B,QAAQ,CAAC,CAAC;wBAC3D,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE;4BAEzC,IAAA,oBAAa,EAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;yBACvD;wBAEK,oBAAoB,GAAG,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;wBAC9D,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;wBAEpD,WAAO,EAAE,oBAAoB,sBAAA,EAAE,YAAY,cAAA,EAAE,EAAC;;;;KAC/C;IAES,iDAAqB,GAA/B,UAAgC,QAAiB;QAC/C,IAAI,CAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,EAAE;YACxB,OAAO,KAAK,CAAC;SACd;QACD,IAAM,SAAS,GAAG,QAA+B,CAAC;QAClD,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK,IAAK,OAAA,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAA3C,CAA2C,CAAC,CAAC;IACpH,CAAC;IACH,wBAAC;AAAD,CAAC,AAhCD,CAAgC,6BAAe,GAgC9C;AAED,SAAsB,UAAU,CAAC,QAAsB,EAAE,OAAe;;;;;;;oBAChE,UAAU,GAAG,IAAI,iBAAiB,CAAC,EAAE,OAAO,SAAA,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;;;;oBAIrC,WAAM,UAAU,CAAC,UAAU,EAAE,EAAA;;oBAAvE,CAAC,KAAyC,SAA6B,EAApE,oBAAoB,0BAAA,EAAE,YAAY,kBAAA,CAAmC,CAAC;;;;oBAG/B,WAAM,IAAA,uBAAO,EAAC,QAAQ,EAAE,OAAO,CAAC,EAAA;;oBAA1E,CAAC,KAAyC,SAAgC,EAAvE,oBAAoB,0BAAA,EAAE,YAAY,kBAAA,CAAsC,CAAC;oBAItE,cAAc,GAAG,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;oBACzC,IAAI,cAAc,GAAG,oBAAoB,EAAE;wBACnC,aAAa,GAAG,cAAc,GAAG,oBAAoB,CAAC;wBAC5D,oBAAoB,GAAG,cAAc,CAAC;wBACtC,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC;qBAC7C;;wBAGH,WAAO,EAAE,oBAAoB,sBAAA,EAAE,YAAY,cAAA,EAAE,EAAC;;;;CAC/C;AArBD,gCAqBC"}

package/dist/cjs/package.json

@@ -1 +0,0 @@
-{"type":"commonjs"}

package/dist/esm/gasPriceOracle/adapters/arbitrum-viem.d.ts

@@ -1,3 +0,0 @@
-import { PublicClient } from "viem";
-import { InternalGasPriceEstimate } from "../types";
-export declare function eip1559(provider: PublicClient, _chainId: number): Promise<InternalGasPriceEstimate>;

package/dist/esm/gasPriceOracle/adapters/arbitrum-viem.js

@@ -1,20 +0,0 @@
-import { __awaiter, __generator } from "tslib";
-var MAX_PRIORITY_FEE_PER_GAS = BigInt(1);
-// Arbitrum Nitro implements EIP-1559 pricing, but the priority fee is always refunded to the caller.
-// Swap it for 1 Wei to avoid inaccurate transaction cost estimates.
-// Reference: https://developer.arbitrum.io/faqs/gas-faqs#q-priority
-export function eip1559(provider, _chainId) {
-    return __awaiter(this, void 0, void 0, function () {
-        var _a, _maxFeePerGas, maxPriorityFeePerGas, maxFeePerGas;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, provider.estimateFeesPerGas()];
-                case 1:
-                    _a = _b.sent(), _maxFeePerGas = _a.maxFeePerGas, maxPriorityFeePerGas = _a.maxPriorityFeePerGas;
-                    maxFeePerGas = BigInt(_maxFeePerGas) - maxPriorityFeePerGas + MAX_PRIORITY_FEE_PER_GAS;
-                    return [2 /*return*/, { maxFeePerGas: maxFeePerGas, maxPriorityFeePerGas: MAX_PRIORITY_FEE_PER_GAS }];
-            }
-        });
-    });
-}
-//# sourceMappingURL=arbitrum-viem.js.map

package/dist/esm/gasPriceOracle/adapters/arbitrum-viem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"arbitrum-viem.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/arbitrum-viem.ts"],"names":[],"mappings":";AAGA,IAAM,wBAAwB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;AAE3C,qGAAqG;AACrG,oEAAoE;AACpE,oEAAoE;AACpE,MAAM,UAAgB,OAAO,CAAC,QAAsB,EAAE,QAAgB;;;;;wBACN,qBAAM,QAAQ,CAAC,kBAAkB,EAAE,EAAA;;oBAA3F,KAAwD,SAAmC,EAA3E,aAAa,kBAAA,EAAE,oBAAoB,0BAAA;oBACnD,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,oBAAoB,GAAG,wBAAwB,CAAC;oBAC7F,sBAAO,EAAE,YAAY,cAAA,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,EAAC;;;;CACzE"}

package/dist/esm/gasPriceOracle/adapters/ethereum-viem.d.ts

@@ -1,4 +0,0 @@
-import { PublicClient } from "viem";
-import { InternalGasPriceEstimate } from "../types";
-export declare function eip1559(provider: PublicClient, _chainId: number): Promise<InternalGasPriceEstimate>;
-export declare function legacy(provider: PublicClient, _chainId: number, _test?: number): Promise<InternalGasPriceEstimate>;

package/dist/esm/gasPriceOracle/adapters/ethereum-viem.js

@@ -1,21 +0,0 @@
-import { __awaiter, __generator } from "tslib";
-export function eip1559(provider, _chainId) {
-    return provider.estimateFeesPerGas();
-}
-export function legacy(provider, _chainId, _test) {
-    return __awaiter(this, void 0, void 0, function () {
-        var gasPrice;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, provider.getGasPrice()];
-                case 1:
-                    gasPrice = _a.sent();
-                    return [2 /*return*/, {
-                            maxFeePerGas: gasPrice,
-                            maxPriorityFeePerGas: BigInt(0),
-                        }];
-            }
-        });
-    });
-}
-//# sourceMappingURL=ethereum-viem.js.map

package/dist/esm/gasPriceOracle/adapters/ethereum-viem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ethereum-viem.js","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/ethereum-viem.ts"],"names":[],"mappings":";AAGA,MAAM,UAAU,OAAO,CAAC,QAAsB,EAAE,QAAgB;IAC9D,OAAO,QAAQ,CAAC,kBAAkB,EAAE,CAAC;AACvC,CAAC;AAED,MAAM,UAAgB,MAAM,CAC1B,QAAsB,EACtB,QAAgB,EAChB,KAAc;;;;;wBAEG,qBAAM,QAAQ,CAAC,WAAW,EAAE,EAAA;;oBAAvC,QAAQ,GAAG,SAA4B;oBAE7C,sBAAO;4BACL,YAAY,EAAE,QAAQ;4BACtB,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC;yBAChC,EAAC;;;;CACH"}

package/dist/esm/gasPriceOracle/adapters/polygon-viem.d.ts

@@ -1,3 +0,0 @@
-import { PublicClient } from "viem";
-import { InternalGasPriceEstimate } from "../types";
-export declare function gasStation(provider: PublicClient, chainId: number): Promise<InternalGasPriceEstimate>;