@across-protocol/sdk 3.0.0

package/dist/esm/relayFeeCalculator/chain-queries/polygon.d.ts

@@ -0,0 +1,152 @@
+import { Logger } from "../relayFeeCalculator";
+import { providers } from "ethers";
+import { QueryBase } from "./baseQuery";
+export declare class PolygonQueries extends QueryBase {
+    constructor(provider: providers.Provider, symbolMapping?: {
+        ACX: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BAL: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BADGER: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BOBA: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        DAI: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        ETH: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        MATIC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        POOL: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        SNX: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        UMA: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        "USDC.e": {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDbC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDT: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WBTC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WETH: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WMATIC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        OP: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+    }, spokePoolAddress?: string, simulatedRelayerAddress?: string, coingeckoProApiKey?: string, logger?: Logger, gasMarkup?: number);
+    getTokenPrice(tokenSymbol: string): Promise<number>;
+}

package/dist/esm/relayFeeCalculator/chain-queries/polygon.js

@@ -0,0 +1,40 @@
+import { __awaiter, __extends, __generator } from "tslib";
+import { getDeployedAddress } from "../../utils/DeploymentUtils";
+import { DEFAULT_LOGGER } from "../relayFeeCalculator";
+import { CHAIN_IDs, DEFAULT_SIMULATED_RELAYER_ADDRESS, TOKEN_SYMBOLS_MAP } from "../../constants";
+import { Coingecko } from "../../coingecko/Coingecko";
+import { QueryBase } from "./baseQuery";
+var PolygonQueries = /** @class */ (function (_super) {
+    __extends(PolygonQueries, _super);
+    function PolygonQueries(provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, coingeckoProApiKey, logger, gasMarkup) {
+        if (symbolMapping === void 0) { symbolMapping = TOKEN_SYMBOLS_MAP; }
+        if (spokePoolAddress === void 0) { spokePoolAddress = getDeployedAddress("SpokePool", CHAIN_IDs.POLYGON); }
+        if (simulatedRelayerAddress === void 0) { simulatedRelayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS; }
+        if (logger === void 0) { logger = DEFAULT_LOGGER; }
+        if (gasMarkup === void 0) { gasMarkup = 0; }
+        return _super.call(this, provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, gasMarkup, logger, coingeckoProApiKey, undefined, "usd") || this;
+    }
+    PolygonQueries.prototype.getTokenPrice = function (tokenSymbol) {
+        return __awaiter(this, void 0, void 0, function () {
+            var coingeckoInstance, _a, tokenPrice, _b, maticPrice;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!this.symbolMapping[tokenSymbol])
+                            throw new Error("".concat(tokenSymbol, " does not exist in mapping"));
+                        coingeckoInstance = Coingecko.get(this.logger, this.coingeckoProApiKey);
+                        return [4 /*yield*/, coingeckoInstance.getCurrentPriceByContract(this.symbolMapping[tokenSymbol].addresses[CHAIN_IDs.MAINNET], "usd")];
+                    case 1:
+                        _a = _c.sent(), tokenPrice = _a[1];
+                        return [4 /*yield*/, coingeckoInstance.getCurrentPriceByContract(this.symbolMapping["MATIC"].addresses[CHAIN_IDs.MAINNET], "usd")];
+                    case 2:
+                        _b = _c.sent(), maticPrice = _b[1];
+                        return [2 /*return*/, Number((tokenPrice / maticPrice).toFixed(this.symbolMapping["MATIC"].decimals))];
+                }
+            });
+        });
+    };
+    return PolygonQueries;
+}(QueryBase));
+export { PolygonQueries };
+//# sourceMappingURL=polygon.js.map

package/dist/esm/relayFeeCalculator/chain-queries/polygon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polygon.js","sourceRoot":"","sources":["../../../../src/relayFeeCalculator/chain-queries/polygon.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAU,MAAM,uBAAuB,CAAC;AAE/D,OAAO,EAAE,SAAS,EAAE,iCAAiC,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAClG,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;IAAoC,kCAAS;IAC3C,wBACE,QAA4B,EAC5B,aAAiC,EACjC,gBAAqE,EACrE,uBAA2D,EAC3D,kBAA2B,EAC3B,MAA+B,EAC/B,SAAa;QALb,8BAAA,EAAA,iCAAiC;QACjC,iCAAA,EAAA,mBAAmB,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC;QACrE,wCAAA,EAAA,2DAA2D;QAE3D,uBAAA,EAAA,uBAA+B;QAC/B,0BAAA,EAAA,aAAa;eAEb,kBACE,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,SAAS,EACT,KAAK,CACN;IACH,CAAC;IAEc,sCAAa,GAA5B,UAA6B,WAAmB;;;;;;wBAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;4BAAE,MAAM,IAAI,KAAK,CAAC,UAAG,WAAW,+BAA4B,CAAC,CAAC;wBAC5F,iBAAiB,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;wBACvD,qBAAM,iBAAiB,CAAC,yBAAyB,CACtE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,EAC5D,KAAK,CACN,EAAA;;wBAHK,KAAiB,SAGtB,EAHQ,UAAU,QAAA;wBAKI,qBAAM,iBAAiB,CAAC,yBAAyB,CACtE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,EACxD,KAAK,CACN,EAAA;;wBAHK,KAAiB,SAGtB,EAHQ,UAAU,QAAA;wBAInB,sBAAO,MAAM,CAAC,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAC;;;;KACxF;IACH,qBAAC;AAAD,CAAC,AArCD,CAAoC,SAAS,GAqC5C"}

package/dist/esm/relayFeeCalculator/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./relayFeeCalculator";
+export * from "./chain-queries";

package/dist/esm/relayFeeCalculator/index.js

@@ -0,0 +1,3 @@
+export * from "./relayFeeCalculator";
+export * from "./chain-queries";
+//# sourceMappingURL=index.js.map

package/dist/esm/relayFeeCalculator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/relayFeeCalculator/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC"}

package/dist/esm/relayFeeCalculator/relayFeeCalculator.d.ts

@@ -0,0 +1,282 @@
+import { BigNumber } from "ethers";
+import { Deposit } from "../interfaces";
+import { BigNumberish, TransactionCostEstimate } from "../utils";
+export interface QueryInterface {
+    getGasCosts: (deposit: Deposit, relayer: string) => Promise<TransactionCostEstimate>;
+    getTokenPrice: (tokenSymbol: string) => Promise<number>;
+    getTokenDecimals: (tokenSymbol: string) => number;
+}
+export declare const expectedCapitalCostsKeys: string[];
+export interface CapitalCostConfig {
+    lowerBound: string;
+    upperBound: string;
+    cutoff: string;
+    decimals: number;
+}
+type ChainIdAsString = string;
+export interface CapitalCostConfigOverride {
+    default: CapitalCostConfig;
+    routeOverrides?: Record<ChainIdAsString, Record<ChainIdAsString, CapitalCostConfig>>;
+}
+export type RelayCapitalCostConfig = CapitalCostConfigOverride | CapitalCostConfig;
+export interface BaseRelayFeeCalculatorConfig {
+    nativeTokenDecimals?: number;
+    gasDiscountPercent?: number;
+    capitalDiscountPercent?: number;
+    feeLimitPercent?: number;
+    capitalCostsConfig: {
+        [token: string]: CapitalCostConfig | CapitalCostConfigOverride;
+    };
+}
+export interface RelayFeeCalculatorConfigWithQueries extends BaseRelayFeeCalculatorConfig {
+    queries: QueryInterface;
+}
+export interface RelayFeeCalculatorConfigWithMap extends BaseRelayFeeCalculatorConfig {
+    queriesMap: Record<number, QueryInterface>;
+}
+export type RelayFeeCalculatorConfig = RelayFeeCalculatorConfigWithQueries | RelayFeeCalculatorConfigWithMap;
+export interface RelayerFeeDetails {
+    amountToRelay: string;
+    tokenSymbol: string;
+    gasFeePercent: string;
+    gasFeeTotal: string;
+    gasDiscountPercent: number;
+    capitalFeePercent: string;
+    capitalFeeTotal: string;
+    capitalDiscountPercent: number;
+    relayFeePercent: string;
+    relayFeeTotal: string;
+    feeLimitPercent: number;
+    isAmountTooLow: boolean;
+    maxGasFeePercent: string;
+    minDeposit: string;
+}
+export interface LoggingFunction {
+    (data: {
+        at: string;
+        message: string;
+        [key: string]: unknown;
+    }): void;
+}
+export interface Logger {
+    debug: LoggingFunction;
+    info: LoggingFunction;
+    warn: LoggingFunction;
+    error: LoggingFunction;
+}
+export declare const DEFAULT_LOGGER: Logger;
+export declare class RelayFeeCalculator {
+    private queries;
+    private gasDiscountPercent;
+    private capitalDiscountPercent;
+    private feeLimitPercent;
+    private nativeTokenDecimals;
+    private capitalCostsConfig;
+    private logger;
+    constructor(config: RelayFeeCalculatorConfigWithQueries, logger?: Logger);
+    constructor(config: RelayFeeCalculatorConfigWithMap, logger?: Logger, destinationChainId?: number);
+    /**
+     * Type guard to check if a config is a CapitalCostConfigOverride or a CapitalCostConfig.
+     * @param config CapitalCostConfig or CapitalCostConfigOverride
+     * @returns true if the config is a CapitalCostConfigOverride, false otherwise.
+     * @private
+     * @dev This is a type guard that is used to check if a config is a CapitalCostConfigOverride or a CapitalCostConfig.
+     * This is needed because the config can be either a CapitalCostConfig or a CapitalCostConfigOverride. If it's a
+     * CapitalCostConfig, then we need to convert it to a CapitalCostConfigOverride with the default config set with no route
+     * overrides.
+     */
+    private static capitalCostConfigIsOverride;
+    /**
+     * Validates a CapitalCostConfigOverride or a CapitalCostConfig.
+     * @param capitalCosts CapitalCostConfig or CapitalCostConfigOverride
+     * @returns CapitalCostConfigOverride
+     */
+    static validateAndTransformCapitalCostsConfigOverride(capitalCosts: CapitalCostConfigOverride | CapitalCostConfig): CapitalCostConfigOverride;
+    /**
+     * Validates a CapitalCostConfig.
+     * @param capitalCosts CapitalCostConfig
+     */
+    static validateCapitalCostsConfig(capitalCosts: CapitalCostConfig): void;
+    getTokenPrice(tokenSymbol: string): Promise<number>;
+    /**
+     * Calculate the gas fee as a % of the amount to relay.
+     * @param deposit A valid deposit object to reason about
+     * @param amountToRelay The amount that we should fill the deposit for
+     * @param simulateZeroFill Whether to simulate a zero fill for the gas cost simulation
+     *        A fill of 1 wei which would result in a slow/partial fill.
+     *        You should do this if you're not worried about simulating a proper fill of a deposit
+     *        with a message or if you are worried a fill amount that could exceed the balance of
+     *        the relayer.
+     * @param relayerAddress The relayer that will be used for the gas cost simulation
+     * @param _tokenPrice The token price for normalizing fees
+     * @returns The fee as a % of the amount to relay.
+     * @note Setting simulateZeroFill to true will result on the gas costs being estimated
+     *       on a zero fill. However, the percentage will be returned as a percentage of the
+     *       amount to relay. This is useful for determining the maximum gas fee % that a
+     *       relayer may need to make on a regular fill. You will get differing results if
+     *       a message & recipient contract is provided as this function may not simulate with
+     *       the correct parameters to see a full fill.
+     */
+    gasFeePercent(deposit: Deposit, amountToRelay: BigNumberish, simulateZeroFill?: boolean, relayerAddress?: string, _tokenPrice?: number, tokenMapping?: {
+        ACX: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BAL: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BADGER: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        BOBA: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        DAI: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        ETH: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        MATIC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        POOL: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        SNX: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        UMA: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        "USDC.e": {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDbC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        USDT: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WBTC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WETH: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        WMATIC: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+        OP: {
+            name: string;
+            symbol: string;
+            decimals: number;
+            addresses: {
+                [x: number]: string;
+            };
+        };
+    }): Promise<BigNumber>;
+    capitalFeePercent(_amountToRelay: BigNumberish, _tokenSymbol: string, _originRoute?: ChainIdAsString, _destinationRoute?: ChainIdAsString): BigNumber;
+    /**
+     * Retrieves the relayer fee details for a deposit.
+     * @param deposit A valid deposit object to reason about
+     * @param amountToRelay The amount that the relayer would simulate a fill for
+     * @param simulateZeroFill Whether to simulate a zero fill for the gas cost simulation
+     *       For simulateZeroFill: A fill of 1 wei which would result in a slow/partial fill.
+     *       You should do this if you're not worried about simulating a proper fill of a deposit
+     *       with a message or if you are worried a fill amount that could exceed the balance of
+     *       the relayer.
+     * @param relayerAddress The relayer that will be used for the gas cost simulation
+     * @param _tokenPrice The token price for normalizing fees
+     * @returns A resulting `RelayerFeeDetails` object
+     */
+    relayerFeeDetails(deposit: Deposit, amountToRelay?: BigNumberish, simulateZeroFill?: boolean, relayerAddress?: string, _tokenPrice?: number): Promise<RelayerFeeDetails>;
+}
+export {};