@across-protocol/sdk 3.0.0

package/dist/esm/utils/common.d.ts

@@ -0,0 +1,204 @@
+import { L2Provider } from "@eth-optimism/sdk/dist/interfaces/l2-provider";
+import Decimal from "decimal.js";
+import { BigNumber, PopulatedTransaction, providers } from "ethers";
+import { TypedMessage } from "../interfaces/TypedData";
+import { BigNumberish, BN } from "./BigNumberUtils";
+export type Decimalish = string | number | Decimal;
+export declare const AddressZero = "0x0000000000000000000000000000000000000000";
+export declare const MAX_BIG_INT: BigNumber;
+/**
+ * toBNWei.
+ *
+ * @param {BigNumberish} num
+ * @param {number} decimals
+ * @returns {BN}
+ */
+export declare const toBNWei: (num: BigNumberish, decimals?: number) => BN;
+/**
+ * fromWei.
+ *
+ * @param {BigNumberish} num
+ * @param {number} decimals
+ * @returns {string}
+ */
+export declare const fromWei: (num: BigNumberish, decimals?: number) => string;
+/**
+ * min.
+ *
+ * @param {BigNumberish} a
+ * @param {BigNumberish} b
+ * @returns {BN}
+ */
+export declare function min(a: BigNumberish, b: BigNumberish): BN;
+/**
+ * max.
+ *
+ * @param {BigNumberish} a
+ * @param {BigNumberish} b
+ * @returns {BN}
+ */
+export declare function max(a: BigNumberish, b: BigNumberish): BN;
+export declare const fixedPointAdjustment: BigNumber;
+/**
+ * Convert an amount of native gas token into a token given price and token decimals.
+ *
+ * @param {BigNumberish} fromAmount - Amount of native gas token to convert.
+ * @param {string | number} [ price=1 ] - The price as native gas token per token, ie how much native gas token can 1 token buy.
+ * @param {} [ toDecimals=18 ] - Number of decimals for the token currency.
+ * @param {} [ nativeDecimals=18 ] - Number of decimals for the native token currency.
+ * @returns {string} The number of tokens denominated in token decimals in the smallest unit (wei).
+ */
+export declare function nativeToToken(fromAmount: BigNumberish, price?: string | number, toDecimals?: number, nativeDecimals?: number): string;
+/**
+ * Convert a gas amount and gas price to wei.
+ *
+ * @param {number} gas - gas amount.
+ * @param {BigNumberish} gasPrice - gas price in gwei.
+ * @returns {BigNumber} - total fees in wei.
+ */
+export declare const gasCost: (gas: BigNumberish, gasPrice: BigNumberish) => BigNumber;
+/**
+ * getGasFees. Low level pure function call to calculate gas fees.
+ *
+ * @param {number} gas - The gast cost for transfer, use constants defined in file.
+ * @param {BigNumberish} gasPrice - Estimated gas price in wei.
+ * @param {string | number} [price = 1] - The price of the token in native gas token, how much native gas token can 1 token buy.
+ * @param {number} [decimals=18] - Number of decimals of token.
+ * @returns {string} - The value of fees native to the token provided, in its smallest unit.
+ */
+export declare function calculateGasFees(gas: number, gasPrice: BigNumberish, price?: string | number, decimals?: number): string;
+/**
+ * percent.
+ *
+ * @param {BigNumberish} numerator
+ * @param {BigNumberish} denominator
+ * @returns {BN}
+ */
+export declare function percent(numerator: BigNumberish, denominator: BigNumberish): BN;
+/**
+ * calcContinuousCompoundInterest. From https://www.calculatorsoup.com/calculators/financial/compound-interest-calculator.php?given_data=find_r&A=2&P=1&n=0&t=1&given_data_last=find_r&action=solve
+ * Returns a yearly interest rate if start/end amount had been continuously compounded over the period elapsed. Multiply result by 100 for a %.
+ *
+ * @param {string} startAmount
+ * @param {string} endAmount
+ * @param {string} periodsElapsed
+ * @param {string} periodsPerYear
+ */
+export declare const calcContinuousCompoundInterest: (startAmount: Decimalish, endAmount: Decimalish, periodsElapsed: Decimalish, periodsPerYear: Decimalish) => string;
+/**
+ * calcPeriodicCompoundInterest. Taken from https://www.calculatorsoup.com/calculators/financial/compound-interest-calculator.php?given_data=find_r&A=2&P=1&n=365&t=1&given_data_last=find_r&action=solve
+ * This will return a periodically compounded interest rate for 1 year. Multiply result by 100 for a %.
+ *
+ * @param {string} startAmount - Starting amount or price
+ * @param {string} endAmount - Ending amount or price
+ * @param {string} periodsElapsed - How many periods elapsed for the start and end amount.
+ * @param {string} periodsPerYear - How many periods in 1 year.
+ */
+export declare const calcPeriodicCompoundInterest: (startAmount: Decimalish, endAmount: Decimalish, periodsElapsed: Decimalish, periodsPerYear: Decimalish) => string;
+/**
+ * calcApr. Simple apr calculation based on extrapolating the difference for a short period over a year.
+ *
+ * @param {Decimalish} startAmount - Starting amount or price
+ * @param {Decimalish} endAmount - Ending amount or price
+ * @param {Decimalish} periodsElapsed - periods elapsed from start to end
+ * @param {Decimalish} periodsPerYear - periods per year
+ */
+export declare const calcApr: (startAmount: Decimalish, endAmount: Decimalish, periodsElapsed: Decimalish, periodsPerYear: Decimalish) => string;
+/**
+ * Takes two values and returns a list of number intervals
+ *
+ * @example
+ * ```js
+ * getSamplesBetween(1, 9, 3) //returns [[1, 3], [4, 7], [8, 9]]
+ * ```
+ */
+export declare const getSamplesBetween: (min: number, max: number, size: number) => number[][];
+/**
+ * A promise that resolves after a specified number of seconds
+ * @param seconds The number of seconds to wait
+ */
+export declare function delay(seconds: number): Promise<unknown>;
+/**
+ * Attempt to retry a function call a number of times with a delay between each attempt
+ * @param call The function to call
+ * @param times The number of times to retry
+ * @param delayS The number of seconds to delay between each attempt
+ * @returns The result of the function call.
+ */
+export declare function retry<T>(call: () => Promise<T>, times: number, delayS: number): Promise<T>;
+export type TransactionCostEstimate = {
+    nativeGasCost: BigNumber;
+    tokenGasCost: BigNumber;
+};
+/**
+ * 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 gasMarkup Markup on the estimated gas cost. For example, 0.2 will increase this resulting value 1.2x.
+ * @param gasPrice A manually provided gas price - if set, this function will not resolve the current gas price.
+ * @returns Estimated cost in units of gas and the underlying gas token (gasPrice * estimatedGasUnits).
+ */
+export declare function estimateTotalGasRequiredByUnsignedTransaction(unsignedTx: PopulatedTransaction, senderAddress: string, provider: providers.Provider | L2Provider<providers.Provider>, gasMarkup: number, gasPrice?: BigNumberish): Promise<TransactionCostEstimate>;
+export type UpdateDepositDetailsMessageType = {
+    UpdateDepositDetails: [
+        {
+            name: "depositId";
+            type: "uint32";
+        },
+        {
+            name: "originChainId";
+            type: "uint256";
+        },
+        {
+            name: "updatedRelayerFeePct";
+            type: "int64";
+        },
+        {
+            name: "updatedRecipient";
+            type: "address";
+        },
+        {
+            name: "updatedMessage";
+            type: "bytes";
+        }
+    ];
+};
+export type UpdateV3DepositDetailsMessageType = {
+    UpdateDepositDetails: [
+        {
+            name: "depositId";
+            type: "uint32";
+        },
+        {
+            name: "originChainId";
+            type: "uint256";
+        },
+        {
+            name: "updatedOutputAmount";
+            type: "uint256";
+        },
+        {
+            name: "updatedRecipient";
+            type: "address";
+        },
+        {
+            name: "updatedMessage";
+            type: "bytes";
+        }
+    ];
+};
+/**
+ * Utility function to get EIP-712 compliant typed data that can be signed with the JSON-RPC method
+ * `eth_signedTypedDataV4` in MetaMask (https://docs.metamask.io/guide/signing-data.html). The resulting signature
+ * can then be used to call the method `speedUpDeposit` of a `SpokePool.sol` contract.
+ * @param depositId The deposit ID to speed up.
+ * @param originChainId The chain ID of the origin chain.
+ * @param updatedRelayerFeePct The new relayer fee percentage.
+ * @param updatedRecipient The new recipient address.
+ * @param updatedMessage The new message that should be provided to the recipient.
+ * @return EIP-712 compliant typed data.
+ */
+export declare function getUpdateDepositTypedData(depositId: number, originChainId: number, updatedRelayerFeePct: BigNumber, updatedRecipient: string, updatedMessage: string): TypedMessage<UpdateDepositDetailsMessageType>;
+export declare function getUpdateV3DepositTypedData(depositId: number, originChainId: number, updatedOutputAmount: BigNumber, updatedRecipient: string, updatedMessage: string): TypedMessage<UpdateV3DepositDetailsMessageType>;
+export declare function randomAddress(): string;

package/dist/esm/utils/common.js

@@ -0,0 +1,325 @@
+import { __awaiter, __generator } from "tslib";
+import { isL2Provider as isOptimismL2Provider } from "@eth-optimism/sdk/dist/l2-provider";
+import assert from "assert";
+import Decimal from "decimal.js";
+import { BigNumber, ethers, VoidSigner } from "ethers";
+import { getGasPriceEstimate } from "../gasPriceOracle";
+import { toBN } from "./BigNumberUtils";
+import { ConvertDecimals } from "./FormattingUtils";
+import { chainIsOPStack } from "./NetworkUtils";
+export var AddressZero = ethers.constants.AddressZero;
+export var MAX_BIG_INT = BigNumber.from(Number.MAX_SAFE_INTEGER.toString());
+/**
+ * toBNWei.
+ *
+ * @param {BigNumberish} num
+ * @param {number} decimals
+ * @returns {BN}
+ */
+export var toBNWei = function (num, decimals) { return ethers.utils.parseUnits(num.toString(), decimals); };
+/**
+ * fromWei.
+ *
+ * @param {BigNumberish} num
+ * @param {number} decimals
+ * @returns {string}
+ */
+export var fromWei = function (num, decimals) {
+    return ethers.utils.formatUnits(num.toString(), decimals);
+};
+/**
+ * min.
+ *
+ * @param {BigNumberish} a
+ * @param {BigNumberish} b
+ * @returns {BN}
+ */
+export function min(a, b) {
+    var bna = toBN(a);
+    var bnb = toBN(b);
+    return bna.lte(bnb) ? bna : bnb;
+}
+/**
+ * max.
+ *
+ * @param {BigNumberish} a
+ * @param {BigNumberish} b
+ * @returns {BN}
+ */
+export function max(a, b) {
+    var bna = toBN(a);
+    var bnb = toBN(b);
+    return bna.gte(bnb) ? bna : bnb;
+}
+export var fixedPointAdjustment = toBNWei("1");
+/**
+ * Convert an amount of native gas token into a token given price and token decimals.
+ *
+ * @param {BigNumberish} fromAmount - Amount of native gas token to convert.
+ * @param {string | number} [ price=1 ] - The price as native gas token per token, ie how much native gas token can 1 token buy.
+ * @param {} [ toDecimals=18 ] - Number of decimals for the token currency.
+ * @param {} [ nativeDecimals=18 ] - Number of decimals for the native token currency.
+ * @returns {string} The number of tokens denominated in token decimals in the smallest unit (wei).
+ */
+export function nativeToToken(fromAmount, price, toDecimals, nativeDecimals) {
+    if (price === void 0) { price = 1; }
+    if (toDecimals === void 0) { toDecimals = 18; }
+    if (nativeDecimals === void 0) { nativeDecimals = 18; }
+    var priceWei = toBNWei(price);
+    var toAmount = toBNWei(fromAmount).div(priceWei);
+    return ConvertDecimals(nativeDecimals, toDecimals)(toAmount).toString();
+}
+/**
+ * Convert a gas amount and gas price to wei.
+ *
+ * @param {number} gas - gas amount.
+ * @param {BigNumberish} gasPrice - gas price in gwei.
+ * @returns {BigNumber} - total fees in wei.
+ */
+export var gasCost = function (gas, gasPrice) {
+    return BigNumber.from(gas).mul(gasPrice);
+};
+/**
+ * getGasFees. Low level pure function call to calculate gas fees.
+ *
+ * @param {number} gas - The gast cost for transfer, use constants defined in file.
+ * @param {BigNumberish} gasPrice - Estimated gas price in wei.
+ * @param {string | number} [price = 1] - The price of the token in native gas token, how much native gas token can 1 token buy.
+ * @param {number} [decimals=18] - Number of decimals of token.
+ * @returns {string} - The value of fees native to the token provided, in its smallest unit.
+ */
+export function calculateGasFees(gas, gasPrice, price, decimals) {
+    if (price === void 0) { price = 1; }
+    if (decimals === void 0) { decimals = 18; }
+    var amountNative = gasCost(gas, gasPrice);
+    return nativeToToken(amountNative, price, decimals);
+}
+/**
+ * percent.
+ *
+ * @param {BigNumberish} numerator
+ * @param {BigNumberish} denominator
+ * @returns {BN}
+ */
+export function percent(numerator, denominator) {
+    return fixedPointAdjustment.mul(numerator).div(denominator);
+}
+/**
+ * calcContinuousCompoundInterest. From https://www.calculatorsoup.com/calculators/financial/compound-interest-calculator.php?given_data=find_r&A=2&P=1&n=0&t=1&given_data_last=find_r&action=solve
+ * Returns a yearly interest rate if start/end amount had been continuously compounded over the period elapsed. Multiply result by 100 for a %.
+ *
+ * @param {string} startAmount
+ * @param {string} endAmount
+ * @param {string} periodsElapsed
+ * @param {string} periodsPerYear
+ */
+export var calcContinuousCompoundInterest = function (startAmount, endAmount, periodsElapsed, periodsPerYear) {
+    var years = new Decimal(periodsPerYear).div(periodsElapsed);
+    return new Decimal(endAmount).div(startAmount).ln().div(years).toString();
+};
+/**
+ * calcPeriodicCompoundInterest. Taken from https://www.calculatorsoup.com/calculators/financial/compound-interest-calculator.php?given_data=find_r&A=2&P=1&n=365&t=1&given_data_last=find_r&action=solve
+ * This will return a periodically compounded interest rate for 1 year. Multiply result by 100 for a %.
+ *
+ * @param {string} startAmount - Starting amount or price
+ * @param {string} endAmount - Ending amount or price
+ * @param {string} periodsElapsed - How many periods elapsed for the start and end amount.
+ * @param {string} periodsPerYear - How many periods in 1 year.
+ */
+export var calcPeriodicCompoundInterest = function (startAmount, endAmount, periodsElapsed, periodsPerYear) {
+    var n = new Decimal(periodsPerYear);
+    var A = new Decimal(endAmount);
+    var P = new Decimal(startAmount);
+    var t = new Decimal(periodsPerYear).div(periodsElapsed);
+    var one = new Decimal(1);
+    return n
+        .mul(A.div(P)
+        .pow(one.div(n.div(t)))
+        .sub(one))
+        .toFixed(18);
+};
+/**
+ * calcApr. Simple apr calculation based on extrapolating the difference for a short period over a year.
+ *
+ * @param {Decimalish} startAmount - Starting amount or price
+ * @param {Decimalish} endAmount - Ending amount or price
+ * @param {Decimalish} periodsElapsed - periods elapsed from start to end
+ * @param {Decimalish} periodsPerYear - periods per year
+ */
+export var calcApr = function (startAmount, endAmount, periodsElapsed, periodsPerYear) {
+    return new Decimal(endAmount).sub(startAmount).div(startAmount).mul(periodsPerYear).div(periodsElapsed).toFixed(18);
+};
+/**
+ * Takes two values and returns a list of number intervals
+ *
+ * @example
+ * ```js
+ * getSamplesBetween(1, 9, 3) //returns [[1, 3], [4, 7], [8, 9]]
+ * ```
+ */
+export var getSamplesBetween = function (min, max, size) {
+    var keepIterate = true;
+    var intervals = [];
+    while (keepIterate) {
+        var to = Math.min(min + size - 1, max);
+        intervals.push([min, to]);
+        min = to + 1;
+        if (min >= max)
+            keepIterate = false;
+    }
+    return intervals;
+};
+/**
+ * A promise that resolves after a specified number of seconds
+ * @param seconds The number of seconds to wait
+ */
+export function delay(seconds) {
+    return new Promise(function (resolve) { return setTimeout(resolve, seconds * 1000); });
+}
+/**
+ * Attempt to retry a function call a number of times with a delay between each attempt
+ * @param call The function to call
+ * @param times The number of times to retry
+ * @param delayS The number of seconds to delay between each attempt
+ * @returns The result of the function call.
+ */
+export function retry(call, times, delayS) {
+    var _this = this;
+    var promiseChain = call();
+    for (var i = 0; i < times; i++)
+        promiseChain = promiseChain.catch(function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, delay(delayS)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, call()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        }); });
+    return promiseChain;
+}
+/**
+ * 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 gasMarkup Markup on the estimated gas cost. For example, 0.2 will increase this resulting value 1.2x.
+ * @param gasPrice A manually provided gas price - if set, this function will not resolve the current gas price.
+ * @returns Estimated cost in units of gas and the underlying gas token (gasPrice * estimatedGasUnits).
+ */
+export function estimateTotalGasRequiredByUnsignedTransaction(unsignedTx, senderAddress, provider, gasMarkup, gasPrice) {
+    return __awaiter(this, void 0, void 0, function () {
+        var gasTotalMultiplier, chainId, voidSigner, nativeGasCost, tokenGasCost, populatedTransaction, gasPriceEstimate;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    assert(gasMarkup > -1 && gasMarkup <= 4, "Require -1.0 < Gas Markup (".concat(gasMarkup, ") <= 4.0 for a total gas multiplier within (0, +5.0]"));
+                    gasTotalMultiplier = toBNWei(1.0 + gasMarkup);
+                    return [4 /*yield*/, provider.getNetwork()];
+                case 1:
+                    chainId = (_a.sent()).chainId;
+                    voidSigner = new VoidSigner(senderAddress, provider);
+                    return [4 /*yield*/, voidSigner.estimateGas(unsignedTx)];
+                case 2:
+                    nativeGasCost = _a.sent();
+                    if (!chainIsOPStack(chainId)) return [3 /*break*/, 5];
+                    assert(isOptimismL2Provider(provider), "Unexpected provider for chain ID ".concat(chainId, "."));
+                    assert(gasPrice === undefined, "Gas price (".concat(gasPrice, ") supplied for Optimism gas estimation (unused)."));
+                    return [4 /*yield*/, voidSigner.populateTransaction(unsignedTx)];
+                case 3:
+                    populatedTransaction = _a.sent();
+                    return [4 /*yield*/, provider.estimateTotalGasCost(populatedTransaction)];
+                case 4:
+                    tokenGasCost = _a.sent();
+                    return [3 /*break*/, 8];
+                case 5:
+                    if (!!gasPrice) return [3 /*break*/, 7];
+                    return [4 /*yield*/, getGasPriceEstimate(provider)];
+                case 6:
+                    gasPriceEstimate = _a.sent();
+                    gasPrice = gasPriceEstimate.maxFeePerGas;
+                    _a.label = 7;
+                case 7:
+                    tokenGasCost = nativeGasCost.mul(gasPrice);
+                    _a.label = 8;
+                case 8:
+                    // Scale the results by the computed multiplier.
+                    nativeGasCost = nativeGasCost.mul(gasTotalMultiplier).div(fixedPointAdjustment);
+                    tokenGasCost = tokenGasCost.mul(gasTotalMultiplier).div(fixedPointAdjustment);
+                    return [2 /*return*/, {
+                            nativeGasCost: nativeGasCost,
+                            tokenGasCost: tokenGasCost,
+                        }];
+            }
+        });
+    });
+}
+/**
+ * Utility function to get EIP-712 compliant typed data that can be signed with the JSON-RPC method
+ * `eth_signedTypedDataV4` in MetaMask (https://docs.metamask.io/guide/signing-data.html). The resulting signature
+ * can then be used to call the method `speedUpDeposit` of a `SpokePool.sol` contract.
+ * @param depositId The deposit ID to speed up.
+ * @param originChainId The chain ID of the origin chain.
+ * @param updatedRelayerFeePct The new relayer fee percentage.
+ * @param updatedRecipient The new recipient address.
+ * @param updatedMessage The new message that should be provided to the recipient.
+ * @return EIP-712 compliant typed data.
+ */
+export function getUpdateDepositTypedData(depositId, originChainId, updatedRelayerFeePct, updatedRecipient, updatedMessage) {
+    return {
+        types: {
+            UpdateDepositDetails: [
+                { name: "depositId", type: "uint32" },
+                { name: "originChainId", type: "uint256" },
+                { name: "updatedRelayerFeePct", type: "int64" },
+                { name: "updatedRecipient", type: "address" },
+                { name: "updatedMessage", type: "bytes" },
+            ],
+        },
+        primaryType: "UpdateDepositDetails",
+        domain: {
+            name: "ACROSS-V2",
+            version: "1.0.0",
+            chainId: originChainId,
+        },
+        message: {
+            depositId: depositId,
+            originChainId: originChainId,
+            updatedRelayerFeePct: updatedRelayerFeePct,
+            updatedRecipient: updatedRecipient,
+            updatedMessage: updatedMessage,
+        },
+    };
+}
+export function getUpdateV3DepositTypedData(depositId, originChainId, updatedOutputAmount, updatedRecipient, updatedMessage) {
+    return {
+        types: {
+            UpdateDepositDetails: [
+                { name: "depositId", type: "uint32" },
+                { name: "originChainId", type: "uint256" },
+                { name: "updatedOutputAmount", type: "uint256" },
+                { name: "updatedRecipient", type: "address" },
+                { name: "updatedMessage", type: "bytes" },
+            ],
+        },
+        primaryType: "UpdateDepositDetails",
+        domain: {
+            name: "ACROSS-V2",
+            version: "1.0.0",
+            chainId: originChainId,
+        },
+        message: {
+            depositId: depositId,
+            originChainId: originChainId,
+            updatedOutputAmount: updatedOutputAmount,
+            updatedRecipient: updatedRecipient,
+            updatedMessage: updatedMessage,
+        },
+    };
+}
+export function randomAddress() {
+    return ethers.utils.getAddress(ethers.utils.hexlify(ethers.utils.randomBytes(20)));
+}
+//# sourceMappingURL=common.js.map

package/dist/esm/utils/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/utils/common.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1F,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAmC,UAAU,EAAE,MAAM,QAAQ,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAoB,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,MAAM,CAAC,IAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC;AACxD,MAAM,CAAC,IAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC;AAE9E;;;;;;GAMG;AACH,MAAM,CAAC,IAAM,OAAO,GAAG,UAAC,GAAiB,EAAE,QAAiB,IAAS,OAAA,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,EAAjD,CAAiD,CAAC;AAEvH;;;;;;GAMG;AACH,MAAM,CAAC,IAAM,OAAO,GAAG,UAAC,GAAiB,EAAE,QAAiB;IAC1D,OAAA,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC;AAAlD,CAAkD,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,CAAe,EAAE,CAAe;IAClD,IAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,IAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAClC,CAAC;AACD;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,CAAe,EAAE,CAAe;IAClD,IAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,IAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAClC,CAAC;AAED,MAAM,CAAC,IAAM,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAC3B,UAAwB,EACxB,KAA0B,EAC1B,UAAe,EACf,cAAmB;IAFnB,sBAAA,EAAA,SAA0B;IAC1B,2BAAA,EAAA,eAAe;IACf,+BAAA,EAAA,mBAAmB;IAEnB,IAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,IAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACnD,OAAO,eAAe,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC1E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,IAAM,OAAO,GAAG,UAAC,GAAiB,EAAE,QAAsB;IAC/D,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAW,EACX,QAAsB,EACtB,KAA0B,EAC1B,QAAa;IADb,sBAAA,EAAA,SAA0B;IAC1B,yBAAA,EAAA,aAAa;IAEb,IAAM,YAAY,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5C,OAAO,aAAa,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,SAAuB,EAAE,WAAyB;IACxE,OAAO,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,IAAM,8BAA8B,GAAG,UAC5C,WAAuB,EACvB,SAAqB,EACrB,cAA0B,EAC1B,cAA0B;IAE1B,IAAM,KAAK,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC5E,CAAC,CAAC;AACF;;;;;;;;GAQG;AACH,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAC1C,WAAuB,EACvB,SAAqB,EACrB,cAA0B,EAC1B,cAA0B;IAE1B,IAAM,CAAC,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IACtC,IAAM,CAAC,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,IAAM,CAAC,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACnC,IAAM,CAAC,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC1D,IAAM,GAAG,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B,OAAO,CAAC;SACL,GAAG,CACF,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;SACL,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SACtB,GAAG,CAAC,GAAG,CAAC,CACZ;SACA,OAAO,CAAC,EAAE,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,IAAM,OAAO,GAAG,UACrB,WAAuB,EACvB,SAAqB,EACrB,cAA0B,EAC1B,cAA0B;IAE1B,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AACtH,CAAC,CAAC;AACF;;;;;;;GAOG;AACH,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAC,GAAW,EAAE,GAAW,EAAE,IAAY;IACtE,IAAI,WAAW,GAAG,IAAI,CAAC;IACvB,IAAM,SAAS,GAAG,EAAE,CAAC;IAErB,OAAO,WAAW,EAAE;QAClB,IAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QACzC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1B,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QACb,IAAI,GAAG,IAAI,GAAG;YAAE,WAAW,GAAG,KAAK,CAAC;KACrC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,OAAe;IACnC,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC,EAAnC,CAAmC,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK,CAAI,IAAsB,EAAE,KAAa,EAAE,MAAc;IAA9E,iBAQC;IAPC,IAAI,YAAY,GAAG,IAAI,EAAE,CAAC;IAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;QAC5B,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC;;;4BAChC,qBAAM,KAAK,CAAC,MAAM,CAAC,EAAA;;wBAAnB,SAAmB,CAAC;wBACb,qBAAM,IAAI,EAAE,EAAA;4BAAnB,sBAAO,SAAY,EAAC;;;aACrB,CAAC,CAAC;IACL,OAAO,YAAY,CAAC;AACtB,CAAC;AAOD;;;;;;;;GAQG;AACH,MAAM,UAAgB,6CAA6C,CACjE,UAAgC,EAChC,aAAqB,EACrB,QAA6D,EAC7D,SAAiB,EACjB,QAAuB;;;;;;oBAEvB,MAAM,CACJ,SAAS,GAAG,CAAC,CAAC,IAAI,SAAS,IAAI,CAAC,EAChC,qCAA8B,SAAS,yDAAsD,CAC9F,CAAC;oBACI,kBAAkB,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;oBAChC,qBAAM,QAAQ,CAAC,UAAU,EAAE,EAAA;;oBAAvC,OAAO,GAAK,CAAA,SAA2B,CAAA,QAAhC;oBACT,UAAU,GAAG,IAAI,UAAU,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;oBAGvC,qBAAM,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,EAAA;;oBAAxD,aAAa,GAAG,SAAwC;yBAIxD,cAAc,CAAC,OAAO,CAAC,EAAvB,wBAAuB;oBACzB,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,2CAAoC,OAAO,MAAG,CAAC,CAAC;oBACvF,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,qBAAc,QAAQ,qDAAkD,CAAC,CAAC;oBAC5E,qBAAM,UAAU,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAA;;oBAAvE,oBAAoB,GAAG,SAAgD;oBAC9D,qBAAM,QAAQ,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,EAAA;;oBAAxE,YAAY,GAAG,SAAyD,CAAC;;;yBAErE,CAAC,QAAQ,EAAT,wBAAS;oBACc,qBAAM,mBAAmB,CAAC,QAAQ,CAAC,EAAA;;oBAAtD,gBAAgB,GAAG,SAAmC;oBAC5D,QAAQ,GAAG,gBAAgB,CAAC,YAAY,CAAC;;;oBAE3C,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;;;oBAG7C,gDAAgD;oBAChD,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;oBAChF,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;oBAE9E,sBAAO;4BACL,aAAa,eAAA;4BACb,YAAY,cAAA;yBACb,EAAC;;;;CACH;AAyBD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,yBAAyB,CACvC,SAAiB,EACjB,aAAqB,EACrB,oBAA+B,EAC/B,gBAAwB,EACxB,cAAsB;IAEtB,OAAO;QACL,KAAK,EAAE;YACL,oBAAoB,EAAE;gBACpB,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACrC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1C,EAAE,IAAI,EAAE,sBAAsB,EAAE,IAAI,EAAE,OAAO,EAAE;gBAC/C,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC7C,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;aAC1C;SACF;QACD,WAAW,EAAE,sBAAsB;QACnC,MAAM,EAAE;YACN,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,aAAa;SACvB;QACD,OAAO,EAAE;YACP,SAAS,WAAA;YACT,aAAa,eAAA;YACb,oBAAoB,sBAAA;YACpB,gBAAgB,kBAAA;YAChB,cAAc,gBAAA;SACf;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,SAAiB,EACjB,aAAqB,EACrB,mBAA8B,EAC9B,gBAAwB,EACxB,cAAsB;IAEtB,OAAO;QACL,KAAK,EAAE;YACL,oBAAoB,EAAE;gBACpB,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACrC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1C,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,SAAS,EAAE;gBAChD,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC7C,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;aAC1C;SACF;QACD,WAAW,EAAE,sBAAsB;QACnC,MAAM,EAAE;YACN,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,aAAa;SACvB;QACD,OAAO,EAAE;YACP,SAAS,WAAA;YACT,aAAa,eAAA;YACb,mBAAmB,qBAAA;YACnB,gBAAgB,kBAAA;YAChB,cAAc,gBAAA;SACf;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACrF,CAAC"}

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

@@ -0,0 +1,29 @@
+export * from "./common";
+export * from "./abi";
+export * from "./ArrayUtils";
+export * from "./BlockUtils";
+export * from "./EventUtils";
+export * from "./ObjectUtils";
+export * from "./TimeUtils";
+export * from "./TypeGuards";
+export * from "./TypeUtils";
+export * from "./TokenUtils";
+export * from "./LogUtils";
+export * from "./FlowUtils";
+export * from "./BundleUtils";
+export * from "./JSONUtils";
+export * from "./IPFSUtils";
+export * from "./NumberUtils";
+export * from "./DeploymentUtils";
+export * from "./FormattingUtils";
+export * from "./BlockExplorerUtils";
+export * from "./BigNumberUtils";
+export * from "./CachingUtils";
+export * from "./NetworkUtils";
+export * from "./Multicall";
+export * from "./ReviverUtils";
+export * from "./DepositUtils";
+export * from "./ValidatorUtils";
+export * from "./AddressUtils";
+export * from "./SpokeUtils";
+export * from "./V3Utils";

package/dist/esm/utils/index.js

@@ -0,0 +1,30 @@
+export * from "./common";
+export * from "./abi";
+export * from "./ArrayUtils";
+export * from "./BlockUtils";
+export * from "./EventUtils";
+export * from "./ObjectUtils";
+export * from "./TimeUtils";
+export * from "./TypeGuards";
+export * from "./TypeUtils";
+export * from "./TokenUtils";
+export * from "./LogUtils";
+export * from "./FlowUtils";
+export * from "./BundleUtils";
+export * from "./JSONUtils";
+export * from "./IPFSUtils";
+export * from "./NumberUtils";
+export * from "./DeploymentUtils";
+export * from "./FormattingUtils";
+export * from "./BlockExplorerUtils";
+export * from "./BigNumberUtils";
+export * from "./CachingUtils";
+export * from "./NetworkUtils";
+export * from "./Multicall";
+export * from "./ReviverUtils";
+export * from "./DepositUtils";
+export * from "./ValidatorUtils";
+export * from "./AddressUtils";
+export * from "./SpokeUtils";
+export * from "./V3Utils";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}

package/dist/types/apiClient/abstractClient.d.ts

@@ -0,0 +1,67 @@
+import { ethers } from "ethers";
+import { CoingeckoDataReturnType, SuggestedFeeReturnType, BridgeLimitsReturnType, AcrossBridgeStatisticsType } from "./types";
+/**
+ * AbstractApiClient is an abstract class that defines the interface for the API client.
+ */
+export default abstract class AbstractApiClient {
+    /**
+     * serverlessApiUrl is the URL of the serverless API.
+     */
+    private readonly serverlessApiUrl;
+    /**
+     * scraperApiUrl is the URL of the scraper API.
+     */
+    private readonly scraperApiUrl;
+    /**
+     * Creates a new instance of AbstractApiClient.
+     * @param serverlessApiUrl The URL of the serverless API.
+     * @param scraperApiUrl The URL of the scraper API.
+     */
+    protected constructor(serverlessApiUrl: string, scraperApiUrl: string);
+    /**
+     * Returns the URL of the serverless API.
+     * @returns The URL of the serverless API.
+     */
+    protected getServerlessApiUrl(): string;
+    /**
+     * Returns the URL of the scraper API.
+     * @returns The URL of the scraper API.
+     */
+    protected getScraperApiUrl(): string;
+    /**
+     * Returns the coingecko data for the given token.
+     * @param l1Token The token to get the coingecko data for.
+     * @param baseCurrency The base currency to get the coingecko data for.
+     * @returns The coingecko data.
+     * @throws Throws an error if the API call fails.
+     */
+    abstract getCoinGeckoData(l1Token: string, baseCurrency: string): Promise<CoingeckoDataReturnType>;
+    /**
+     * Returns the suggested fees for the given token and amount to transfer to the given chain in a bridge transfer.
+     * @param amount The amount to transfer.
+     * @param originToken The token to transfer.
+     * @param toChainid The chain to transfer to
+     * @param fromChainid The chain to transfer from
+     * @returns The suggested fees.
+     * @throws Throws an error if the API call fails.
+     */
+    abstract getSuggestedFees(amount: ethers.BigNumber, originToken: string, toChainid: number, fromChainid: number): Promise<SuggestedFeeReturnType>;
+    /**
+     * Returns the bridge limits for the given token and chain on Across.
+     * @class
+     * @abstract
+     * @param token The token to get the bridge limits for.
+     * @param fromChainId The chain that the transfer will originate from.
+     * @param toChainId The chain that the transfer will be bridged to.
+     * @returns The bridge limits.
+     * @throws Throws an error if the API call fails.
+     */
+    abstract getBridgeLimits(token: string, fromnumber: string | number, tonumber: string | number): Promise<BridgeLimitsReturnType>;
+    /**
+     * Returns the Across bridge statistics. These are a set of statistics that are used to capture the current state of the bridge.
+     * @returns The Across bridge statistics.
+     * @throws Throws an error if the API call fails.
+     */
+    abstract getAcrossStats(): Promise<AcrossBridgeStatisticsType>;
+}
+//# sourceMappingURL=abstractClient.d.ts.map