@across-protocol/sdk 3.0.0

package/dist/esm/relayFeeCalculator/relayFeeCalculator.js

@@ -0,0 +1,298 @@
+import { __assign, __awaiter, __generator } from "tslib";
+import assert from "assert";
+import { DEFAULT_SIMULATED_RELAYER_ADDRESS, TOKEN_SYMBOLS_MAP } from "../constants";
+import { MAX_BIG_INT, bnZero, fixedPointAdjustment, getTokenInformationFromAddress, isDefined, max, min, nativeToToken, percent, toBN, toBNWei, } from "../utils";
+export var expectedCapitalCostsKeys = ["lowerBound", "upperBound", "cutoff", "decimals"];
+export var DEFAULT_LOGGER = {
+    debug: function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        return console.debug(args);
+    },
+    info: function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        return console.info(args);
+    },
+    warn: function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        return console.warn(args);
+    },
+    error: function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        return console.error(args);
+    },
+};
+// Small amount to simulate filling with. Should be low enough to guarantee a successful fill.
+var safeOutputAmount = toBN(100);
+var RelayFeeCalculator = /** @class */ (function () {
+    function RelayFeeCalculator(config, logger, destinationChainId) {
+        assert(config, "config must be provided");
+        if ("queries" in config) {
+            this.queries = config.queries;
+        }
+        else {
+            assert(destinationChainId !== undefined, "destinationChainId must be provided if queriesMap is provided");
+            assert(config.queriesMap[destinationChainId], "No queries provided for destination chain");
+            this.queries = config.queriesMap[destinationChainId];
+        }
+        this.gasDiscountPercent = config.gasDiscountPercent || 0;
+        this.capitalDiscountPercent = config.capitalDiscountPercent || 0;
+        this.feeLimitPercent = config.feeLimitPercent || 0;
+        this.nativeTokenDecimals = config.nativeTokenDecimals || 18;
+        assert(this.gasDiscountPercent >= 0 && this.gasDiscountPercent <= 100, "gasDiscountPercent must be between 0 and 100 percent");
+        assert(this.capitalDiscountPercent >= 0 && this.capitalDiscountPercent <= 100, "capitalDiscountPercent must be between 0 and 100 percent");
+        assert(this.feeLimitPercent >= 0 && this.feeLimitPercent <= 100, "feeLimitPercent must be between 0 and 100 percent");
+        this.capitalCostsConfig = Object.fromEntries(Object.entries(config.capitalCostsConfig).map(function (_a) {
+            var token = _a[0], capitalCosts = _a[1];
+            return [token.toUpperCase(), RelayFeeCalculator.validateAndTransformCapitalCostsConfigOverride(capitalCosts)];
+        }));
+        assert(Object.keys(this.capitalCostsConfig).length > 0, "capitalCostsConfig must have at least one entry");
+        this.logger = logger || DEFAULT_LOGGER;
+    }
+    /**
+     * 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.
+     */
+    RelayFeeCalculator.capitalCostConfigIsOverride = function (config) {
+        return config.default !== undefined;
+    };
+    /**
+     * Validates a CapitalCostConfigOverride or a CapitalCostConfig.
+     * @param capitalCosts CapitalCostConfig or CapitalCostConfigOverride
+     * @returns CapitalCostConfigOverride
+     */
+    RelayFeeCalculator.validateAndTransformCapitalCostsConfigOverride = function (capitalCosts) {
+        // We need to first convert the config to a baseline type. This is 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.
+        var config = this.capitalCostConfigIsOverride(capitalCosts)
+            ? capitalCosts
+            : { default: capitalCosts };
+        // Validate the default config.
+        this.validateCapitalCostsConfig(config.default);
+        // Iterate over all the route overrides and validate them.
+        for (var _i = 0, _a = Object.values(config.routeOverrides || {}); _i < _a.length; _i++) {
+            var toChainIdRoutes = _a[_i];
+            for (var _b = 0, _c = Object.values(toChainIdRoutes); _b < _c.length; _b++) {
+                var override = _c[_b];
+                this.validateCapitalCostsConfig(override);
+            }
+        }
+        return config;
+    };
+    /**
+     * Validates a CapitalCostConfig.
+     * @param capitalCosts CapitalCostConfig
+     */
+    RelayFeeCalculator.validateCapitalCostsConfig = function (capitalCosts) {
+        assert(toBN(capitalCosts.upperBound).lt(toBNWei("0.01")), "upper bound must be < 1%");
+        assert(toBN(capitalCosts.lowerBound).lte(capitalCosts.upperBound), "lower bound must be <= upper bound");
+        assert(capitalCosts.decimals > 0 && capitalCosts.decimals <= 18, "invalid decimals");
+    };
+    RelayFeeCalculator.prototype.getTokenPrice = function (tokenSymbol) {
+        return this.queries.getTokenPrice(tokenSymbol);
+    };
+    /**
+     * 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.
+     */
+    RelayFeeCalculator.prototype.gasFeePercent = function (deposit, amountToRelay, simulateZeroFill, relayerAddress, _tokenPrice, tokenMapping) {
+        if (simulateZeroFill === void 0) { simulateZeroFill = false; }
+        if (relayerAddress === void 0) { relayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS; }
+        if (tokenMapping === void 0) { tokenMapping = TOKEN_SYMBOLS_MAP; }
+        return __awaiter(this, void 0, void 0, function () {
+            var inputToken, token, simulatedAmount, getGasCosts, getTokenPrice, _a, tokenGasCost, tokenPrice, gasFeesInToken;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (toBN(amountToRelay).eq(bnZero))
+                            return [2 /*return*/, MAX_BIG_INT];
+                        inputToken = deposit.inputToken;
+                        token = getTokenInformationFromAddress(inputToken, tokenMapping);
+                        if (!isDefined(token)) {
+                            throw new Error("Could not find token information for ".concat(inputToken));
+                        }
+                        simulatedAmount = simulateZeroFill ? safeOutputAmount : toBN(amountToRelay);
+                        deposit = __assign(__assign({}, deposit), { outputAmount: simulatedAmount });
+                        getGasCosts = this.queries.getGasCosts(deposit, relayerAddress).catch(function (error) {
+                            _this.logger.error({
+                                at: "sdk/gasFeePercent",
+                                message: "Error while fetching gas costs",
+                                error: error,
+                                simulateZeroFill: simulateZeroFill,
+                                deposit: deposit,
+                            });
+                            throw error;
+                        });
+                        getTokenPrice = this.queries.getTokenPrice(token.symbol).catch(function (error) {
+                            _this.logger.error({
+                                at: "sdk/gasFeePercent",
+                                message: "Error while fetching token price",
+                                error: error,
+                                destinationChainId: deposit.destinationChainId,
+                                inputToken: inputToken,
+                            });
+                            throw error;
+                        });
+                        return [4 /*yield*/, Promise.all([
+                                getGasCosts,
+                                _tokenPrice !== undefined ? _tokenPrice : getTokenPrice,
+                            ])];
+                    case 1:
+                        _a = _b.sent(), tokenGasCost = _a[0].tokenGasCost, tokenPrice = _a[1];
+                        gasFeesInToken = nativeToToken(tokenGasCost, tokenPrice, token.decimals, this.nativeTokenDecimals);
+                        return [2 /*return*/, percent(gasFeesInToken, amountToRelay.toString())];
+                }
+            });
+        });
+    };
+    // Note: these variables are unused now, but may be needed in future versions of this function that are more complex.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    RelayFeeCalculator.prototype.capitalFeePercent = function (_amountToRelay, _tokenSymbol, _originRoute, _destinationRoute) {
+        var _a, _b, _c;
+        // If amount is 0, then the capital fee % should be the max 100%
+        if (toBN(_amountToRelay).eq(toBN(0)))
+            return MAX_BIG_INT;
+        // V0: Ensure that there is a capital fee available for the token.
+        // If not, then we should throw an error because this is indicative
+        // of a misconfiguration.
+        var tokenCostConfig = this.capitalCostsConfig[_tokenSymbol.toUpperCase()];
+        if (!isDefined(tokenCostConfig)) {
+            this.logger.error({
+                at: "sdk/capitalFeePercent",
+                message: "No capital fee available for token ".concat(_tokenSymbol),
+            });
+            throw new Error("No capital cost config available for token ".concat(_tokenSymbol));
+        }
+        // V1: Charge fee that scales with size. This will charge a fee % based on a linear fee curve with a "kink" at a
+        // cutoff in the same units as _amountToRelay. Before the kink, the fee % will increase linearly from a lower
+        // bound to an upper bound. After the kink, the fee % increase will be fixed, and slowly approach the upper bound
+        // for very large amount inputs.
+        else {
+            var config = isDefined(_originRoute) && isDefined(_destinationRoute)
+                ? (_c = (_b = (_a = tokenCostConfig.routeOverrides) === null || _a === void 0 ? void 0 : _a[_originRoute]) === null || _b === void 0 ? void 0 : _b[_destinationRoute]) !== null && _c !== void 0 ? _c : tokenCostConfig.default
+                : tokenCostConfig.default;
+            // Scale amount "y" to 18 decimals.
+            var y = toBN(_amountToRelay).mul(toBNWei("1", 18 - config.decimals));
+            // At a minimum, the fee will be equal to lower bound fee * y
+            var minCharge = toBN(config.lowerBound).mul(y).div(fixedPointAdjustment);
+            // Charge an increasing marginal fee % up to min(cutoff, y). If y is very close to the cutoff, the fee %
+            // will be equal to half the sum of (upper bound + lower bound).
+            var yTriangle = min(config.cutoff, y);
+            // triangleSlope is slope of fee curve from lower bound to upper bound. If cutoff is 0, slope is 0.
+            // triangleCharge is interval of curve from 0 to y for curve = triangleSlope * y
+            var triangleSlope = toBN(config.cutoff).eq(toBN(0))
+                ? toBN(0)
+                : toBN(config.upperBound).sub(config.lowerBound).mul(fixedPointAdjustment).div(config.cutoff);
+            var triangleHeight = triangleSlope.mul(yTriangle).div(fixedPointAdjustment);
+            var triangleCharge = triangleHeight.mul(yTriangle).div(toBNWei(2));
+            // For any amounts above the cutoff, the marginal fee % will not increase but will be fixed at the upper bound
+            // value.
+            var yRemainder = max(toBN(0), y.sub(config.cutoff));
+            var remainderCharge = yRemainder.mul(toBN(config.upperBound).sub(config.lowerBound)).div(fixedPointAdjustment);
+            return minCharge.add(triangleCharge).add(remainderCharge).mul(fixedPointAdjustment).div(y);
+        }
+    };
+    /**
+     * 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
+     */
+    RelayFeeCalculator.prototype.relayerFeeDetails = function (deposit, amountToRelay, simulateZeroFill, relayerAddress, _tokenPrice) {
+        if (simulateZeroFill === void 0) { simulateZeroFill = false; }
+        if (relayerAddress === void 0) { relayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS; }
+        return __awaiter(this, void 0, void 0, function () {
+            var inputToken, token, gasFeePercent, gasFeeTotal, capitalFeePercent, capitalFeeTotal, relayFeePercent, relayFeeTotal, maxGasFeePercent, minDeposit, isAmountTooLow;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        // If the amount to relay is not provided, then we
+                        // should use the full deposit amount.
+                        amountToRelay !== null && amountToRelay !== void 0 ? amountToRelay : (amountToRelay = deposit.outputAmount);
+                        inputToken = deposit.inputToken;
+                        token = getTokenInformationFromAddress(inputToken);
+                        if (!isDefined(token)) {
+                            throw new Error("Could not find token information for ".concat(inputToken));
+                        }
+                        return [4 /*yield*/, this.gasFeePercent(deposit, amountToRelay, simulateZeroFill, relayerAddress, _tokenPrice)];
+                    case 1:
+                        gasFeePercent = _a.sent();
+                        gasFeeTotal = gasFeePercent.mul(amountToRelay).div(fixedPointAdjustment);
+                        capitalFeePercent = this.capitalFeePercent(amountToRelay, token.symbol, deposit.originChainId.toString(), deposit.destinationChainId.toString());
+                        capitalFeeTotal = capitalFeePercent.mul(amountToRelay).div(fixedPointAdjustment);
+                        relayFeePercent = gasFeePercent.add(capitalFeePercent);
+                        relayFeeTotal = gasFeeTotal.add(capitalFeeTotal);
+                        maxGasFeePercent = max(toBNWei(this.feeLimitPercent / 100).sub(capitalFeePercent), toBN(0));
+                        if (maxGasFeePercent.eq(toBN(0))) {
+                            minDeposit = MAX_BIG_INT;
+                            isAmountTooLow = true;
+                        }
+                        else {
+                            minDeposit = gasFeeTotal.mul(fixedPointAdjustment).div(maxGasFeePercent);
+                            isAmountTooLow = toBN(amountToRelay).lt(minDeposit);
+                        }
+                        return [2 /*return*/, {
+                                amountToRelay: amountToRelay.toString(),
+                                tokenSymbol: token.symbol,
+                                gasFeePercent: gasFeePercent.toString(),
+                                gasFeeTotal: gasFeeTotal.toString(),
+                                gasDiscountPercent: this.gasDiscountPercent,
+                                capitalFeePercent: capitalFeePercent.toString(),
+                                capitalFeeTotal: capitalFeeTotal.toString(),
+                                capitalDiscountPercent: this.capitalDiscountPercent,
+                                relayFeePercent: relayFeePercent.toString(),
+                                relayFeeTotal: relayFeeTotal.toString(),
+                                feeLimitPercent: this.feeLimitPercent,
+                                maxGasFeePercent: maxGasFeePercent.toString(),
+                                minDeposit: minDeposit.toString(),
+                                isAmountTooLow: isAmountTooLow,
+                            }];
+                }
+            });
+        });
+    };
+    return RelayFeeCalculator;
+}());
+export { RelayFeeCalculator };
+//# sourceMappingURL=relayFeeCalculator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relayFeeCalculator.js","sourceRoot":"","sources":["../../../src/relayFeeCalculator/relayFeeCalculator.ts"],"names":[],"mappings":";AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,iCAAiC,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEpF,OAAO,EAEL,WAAW,EAEX,MAAM,EACN,oBAAoB,EACpB,8BAA8B,EAC9B,SAAS,EACT,GAAG,EACH,GAAG,EACH,aAAa,EACb,OAAO,EACP,IAAI,EACJ,OAAO,GACR,MAAM,UAAU,CAAC;AASlB,MAAM,CAAC,IAAM,wBAAwB,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AA0D3F,MAAM,CAAC,IAAM,cAAc,GAAW;IACpC,KAAK,EAAE;QAAC,cAAO;aAAP,UAAO,EAAP,qBAAO,EAAP,IAAO;YAAP,yBAAO;;QAAK,OAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;IAAnB,CAAmB;IACvC,IAAI,EAAE;QAAC,cAAO;aAAP,UAAO,EAAP,qBAAO,EAAP,IAAO;YAAP,yBAAO;;QAAK,OAAA,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAAlB,CAAkB;IACrC,IAAI,EAAE;QAAC,cAAO;aAAP,UAAO,EAAP,qBAAO,EAAP,IAAO;YAAP,yBAAO;;QAAK,OAAA,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAAlB,CAAkB;IACrC,KAAK,EAAE;QAAC,cAAO;aAAP,UAAO,EAAP,qBAAO,EAAP,IAAO;YAAP,yBAAO;;QAAK,OAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;IAAnB,CAAmB;CACxC,CAAC;AAEF,8FAA8F;AAC9F,IAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;AAEnC;IAcE,4BAAY,MAAiC,EAAE,MAAe,EAAE,kBAA2B;QACzF,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;QAE1C,IAAI,SAAS,IAAI,MAAM,EAAE;YACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;SAC/B;aAAM;YACL,MAAM,CAAC,kBAAkB,KAAK,SAAS,EAAE,+DAA+D,CAAC,CAAC;YAC1G,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,2CAA2C,CAAC,CAAC;YAC3F,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;SACtD;QAED,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,sBAAsB,GAAG,MAAM,CAAC,sBAAsB,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,IAAI,EAAE,CAAC;QAC5D,MAAM,CACJ,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,IAAI,CAAC,kBAAkB,IAAI,GAAG,EAC9D,sDAAsD,CACvD,CAAC;QACF,MAAM,CACJ,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,IAAI,GAAG,EACtE,0DAA0D,CAC3D,CAAC;QACF,MAAM,CACJ,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,IAAI,CAAC,eAAe,IAAI,GAAG,EACxD,mDAAmD,CACpD,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAC1C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,UAAC,EAAqB;gBAApB,KAAK,QAAA,EAAE,YAAY,QAAA;YACjE,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,kBAAkB,CAAC,8CAA8C,CAAC,YAAY,CAAC,CAAC,CAAC;QAChH,CAAC,CAAC,CACH,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,iDAAiD,CAAC,CAAC;QAC3G,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,cAAc,CAAC;IACzC,CAAC;IAED;;;;;;;;;OASG;IACY,8CAA2B,GAA1C,UACE,MAAqD;QAErD,OAAQ,MAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACI,iEAA8C,GAArD,UACE,YAA2D;QAE3D,uHAAuH;QACvH,8HAA8H;QAC9H,kDAAkD;QAClD,IAAM,MAAM,GAA8B,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC;YACtF,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;QAE9B,+BAA+B;QAC/B,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAChD,0DAA0D;QAC1D,KAA8B,UAA0C,EAA1C,KAAA,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,EAA1C,cAA0C,EAA1C,IAA0C,EAAE;YAArE,IAAM,eAAe,SAAA;YACxB,KAAuB,UAA8B,EAA9B,KAAA,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAA9B,cAA8B,EAA9B,IAA8B,EAAE;gBAAlD,IAAM,QAAQ,SAAA;gBACjB,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;aAC3C;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,6CAA0B,GAAjC,UAAkC,YAA+B;QAC/D,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC;QACtF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,oCAAoC,CAAC,CAAC;QACzG,MAAM,CAAC,YAAY,CAAC,QAAQ,GAAG,CAAC,IAAI,YAAY,CAAC,QAAQ,IAAI,EAAE,EAAE,kBAAkB,CAAC,CAAC;IACvF,CAAC;IAED,0CAAa,GAAb,UAAc,WAAmB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,0CAAa,GAAnB,UACE,OAAgB,EAChB,aAA2B,EAC3B,gBAAwB,EACxB,cAAkD,EAClD,WAAoB,EACpB,YAAgC;QAHhC,iCAAA,EAAA,wBAAwB;QACxB,+BAAA,EAAA,kDAAkD;QAElD,6BAAA,EAAA,gCAAgC;;;;;;;wBAEhC,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC;4BAAE,sBAAO,WAAW,EAAC;wBAE/C,UAAU,GAAK,OAAO,WAAZ,CAAa;wBACzB,KAAK,GAAG,8BAA8B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;wBACvE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;4BACrB,MAAM,IAAI,KAAK,CAAC,+CAAwC,UAAU,CAAE,CAAC,CAAC;yBACvE;wBAIK,eAAe,GAAG,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;wBAClF,OAAO,yBAAQ,OAAO,KAAE,YAAY,EAAE,eAAe,GAAE,CAAC;wBAElD,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK;4BAChF,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gCAChB,EAAE,EAAE,mBAAmB;gCACvB,OAAO,EAAE,gCAAgC;gCACzC,KAAK,OAAA;gCACL,gBAAgB,kBAAA;gCAChB,OAAO,SAAA;6BACR,CAAC,CAAC;4BACH,MAAM,KAAK,CAAC;wBACd,CAAC,CAAC,CAAC;wBACG,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK;4BACzE,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gCAChB,EAAE,EAAE,mBAAmB;gCACvB,OAAO,EAAE,kCAAkC;gCAC3C,KAAK,OAAA;gCACL,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;gCAC9C,UAAU,YAAA;6BACX,CAAC,CAAC;4BACH,MAAM,KAAK,CAAC;wBACd,CAAC,CAAC,CAAC;wBACoC,qBAAM,OAAO,CAAC,GAAG,CAAC;gCACvD,WAAW;gCACX,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa;6BACxD,CAAC,EAAA;;wBAHI,KAAiC,SAGrC,EAHO,YAAY,qBAAA,EAAI,UAAU,QAAA;wBAI7B,cAAc,GAAG,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;wBACzG,sBAAO,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,EAAC;;;;KAC1D;IAED,qHAAqH;IACrH,6DAA6D;IAC7D,8CAAiB,GAAjB,UACE,cAA4B,EAC5B,YAAoB,EACpB,YAA8B,EAC9B,iBAAmC;;QAEnC,gEAAgE;QAChE,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,WAAW,CAAC;QAEzD,kEAAkE;QAClE,mEAAmE;QACnE,yBAAyB;QACzB,IAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE;YAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,EAAE,EAAE,uBAAuB;gBAC3B,OAAO,EAAE,6CAAsC,YAAY,CAAE;aAC9D,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,qDAA8C,YAAY,CAAE,CAAC,CAAC;SAC/E;QACD,gHAAgH;QAChH,6GAA6G;QAC7G,iHAAiH;QACjH,gCAAgC;aAC3B;YACH,IAAM,MAAM,GACV,SAAS,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC,iBAAiB,CAAC;gBACrD,CAAC,CAAC,MAAA,MAAA,MAAA,eAAe,CAAC,cAAc,0CAAG,YAAY,CAAC,0CAAG,iBAAiB,CAAC,mCAAI,eAAe,CAAC,OAAO;gBAChG,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC;YAE9B,mCAAmC;YACnC,IAAM,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YACvE,6DAA6D;YAC7D,IAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;YAE3E,wGAAwG;YACxG,gEAAgE;YAChE,IAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAExC,mGAAmG;YACnG,gFAAgF;YAChF,IAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBACT,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAChG,IAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;YAC9E,IAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAErE,8GAA8G;YAC9G,SAAS;YACT,IAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YACtD,IAAM,eAAe,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;YAEjH,OAAO,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SAC5F;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACG,8CAAiB,GAAvB,UACE,OAAgB,EAChB,aAA4B,EAC5B,gBAAwB,EACxB,cAAkD,EAClD,WAAoB;QAFpB,iCAAA,EAAA,wBAAwB;QACxB,+BAAA,EAAA,kDAAkD;;;;;;wBAGlD,kDAAkD;wBAClD,sCAAsC;wBACtC,aAAa,aAAb,aAAa,cAAb,aAAa,IAAb,aAAa,GAAK,OAAO,CAAC,YAAY,EAAC;wBAC/B,UAAU,GAAK,OAAO,WAAZ,CAAa;wBACzB,KAAK,GAAG,8BAA8B,CAAC,UAAU,CAAC,CAAC;wBACzD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;4BACrB,MAAM,IAAI,KAAK,CAAC,+CAAwC,UAAU,CAAE,CAAC,CAAC;yBACvE;wBAEqB,qBAAM,IAAI,CAAC,aAAa,CAC5C,OAAO,EACP,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,WAAW,CACZ,EAAA;;wBANK,aAAa,GAAG,SAMrB;wBACK,WAAW,GAAG,aAAa,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;wBACzE,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAC9C,aAAa,EACb,KAAK,CAAC,MAAM,EACZ,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,EAChC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CACtC,CAAC;wBACI,eAAe,GAAG,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;wBACjF,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;wBACvD,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;wBAQjD,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBAIlG,IAAI,gBAAgB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;4BAChC,UAAU,GAAG,WAAW,CAAC;4BACzB,cAAc,GAAG,IAAI,CAAC;yBACvB;6BAAM;4BACL,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;4BACzE,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;yBACrD;wBAED,sBAAO;gCACL,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;gCACvC,WAAW,EAAE,KAAK,CAAC,MAAM;gCACzB,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;gCACvC,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;gCACnC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gCAC3C,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE;gCAC/C,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;gCAC3C,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;gCACnD,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;gCAC3C,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;gCACvC,eAAe,EAAE,IAAI,CAAC,eAAe;gCACrC,gBAAgB,EAAE,gBAAgB,CAAC,QAAQ,EAAE;gCAC7C,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;gCACjC,cAAc,gBAAA;6BACf,EAAC;;;;KACH;IACH,yBAAC;AAAD,CAAC,AA1TD,IA0TC"}

package/dist/esm/typechain.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file re-exports some of the typechain bindings so that they can be tree-shaken in the final frontend bundle.
+ * Currently, the packages `@across-protocol/contracts` and `@across-protocol/across-token` are not optimized for tree-shaking
+ * and contain modules that are not compatible in a browser environment. This is a temporary solution until we can fix the issue upstream.
+ */
+import type { TypedEvent, TypedEventFilter } from "@across-protocol/contracts/dist/typechain/common";
+export type { TypedEvent, TypedEventFilter };
+export { AcrossMerkleDistributor__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/merkle-distributor/AcrossMerkleDistributor__factory";
+export { AcrossConfigStore__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/AcrossConfigStore__factory";
+export { HubPool__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/HubPool__factory";
+export { SpokePool__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/SpokePool.sol/SpokePool__factory";
+export { ERC20__factory } from "@across-protocol/contracts/dist/typechain/factories/@openzeppelin/contracts/token/ERC20/ERC20__factory";
+export { AcceleratingDistributor__factory } from "@across-protocol/across-token/dist/typechain/factories/AcceleratingDistributor__factory";
+export { ClaimAndStake__factory } from "@across-protocol/across-token/dist/typechain/factories/ClaimAndStake__factory";
+export { MerkleDistributor__factory } from "@across-protocol/across-token/dist/typechain/factories/MerkleDistributor__factory";
+export type { AcrossMerkleDistributor, AcrossMerkleDistributorInterface, } from "@across-protocol/contracts/dist/typechain/contracts/merkle-distributor/AcrossMerkleDistributor";
+export type { AcrossConfigStore, AcrossConfigStoreInterface, } from "@across-protocol/contracts/dist/typechain/contracts/AcrossConfigStore";
+export type { HubPool, HubPoolInterface } from "@across-protocol/contracts/dist/typechain/contracts/HubPool";
+export type { SpokePool, SpokePoolInterface, FundsDepositedEvent, FilledRelayEvent, RequestedSpeedUpDepositEvent, V3FundsDepositedEvent, FilledV3RelayEvent, } from "@across-protocol/contracts/dist/typechain/contracts/SpokePool.sol/SpokePool";
+export type { AcceleratingDistributor, AcceleratingDistributorInterface, } from "@across-protocol/across-token/dist/typechain/AcceleratingDistributor";
+export type { ClaimAndStake, ClaimAndStakeInterface } from "@across-protocol/across-token/dist/typechain/ClaimAndStake";
+export type { MerkleDistributor, MerkleDistributorInterface, } from "@across-protocol/across-token/dist/typechain/MerkleDistributor";

package/dist/esm/typechain.js

@@ -0,0 +1,9 @@
+export { AcrossMerkleDistributor__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/merkle-distributor/AcrossMerkleDistributor__factory";
+export { AcrossConfigStore__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/AcrossConfigStore__factory";
+export { HubPool__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/HubPool__factory";
+export { SpokePool__factory } from "@across-protocol/contracts/dist/typechain/factories/contracts/SpokePool.sol/SpokePool__factory";
+export { ERC20__factory } from "@across-protocol/contracts/dist/typechain/factories/@openzeppelin/contracts/token/ERC20/ERC20__factory";
+export { AcceleratingDistributor__factory } from "@across-protocol/across-token/dist/typechain/factories/AcceleratingDistributor__factory";
+export { ClaimAndStake__factory } from "@across-protocol/across-token/dist/typechain/factories/ClaimAndStake__factory";
+export { MerkleDistributor__factory } from "@across-protocol/across-token/dist/typechain/factories/MerkleDistributor__factory";
+//# sourceMappingURL=typechain.js.map

package/dist/esm/typechain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typechain.js","sourceRoot":"","sources":["../../src/typechain.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gCAAgC,EAAE,MAAM,mHAAmH,CAAC;AACrK,OAAO,EAAE,0BAA0B,EAAE,MAAM,0FAA0F,CAAC;AACtI,OAAO,EAAE,gBAAgB,EAAE,MAAM,gFAAgF,CAAC;AAClH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gGAAgG,CAAC;AACpI,OAAO,EAAE,cAAc,EAAE,MAAM,wGAAwG,CAAC;AAExI,OAAO,EAAE,gCAAgC,EAAE,MAAM,yFAAyF,CAAC;AAC3I,OAAO,EAAE,sBAAsB,EAAE,MAAM,+EAA+E,CAAC;AACvH,OAAO,EAAE,0BAA0B,EAAE,MAAM,mFAAmF,CAAC"}

package/dist/esm/typeguards/error.d.ts

@@ -0,0 +1,3 @@
+import { EthersError } from "../interfaces";
+export declare const isError: (error: unknown) => error is Error;
+export declare const isEthersError: (error?: unknown) => error is EthersError;

package/dist/esm/typeguards/error.js

@@ -0,0 +1,6 @@
+import { ethers } from "ethers";
+export var isError = function (error) { return error instanceof Error; };
+export var isEthersError = function (error) {
+    return (error === null || error === void 0 ? void 0 : error.code) in ethers.utils.Logger.errors;
+};
+//# sourceMappingURL=error.js.map

package/dist/esm/typeguards/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/typeguards/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,MAAM,CAAC,IAAM,OAAO,GAAG,UAAC,KAAc,IAAqB,OAAA,KAAK,YAAY,KAAK,EAAtB,CAAsB,CAAC;AAElF,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,KAAe;IAC3C,OAAA,CAAC,KAAqB,aAArB,KAAK,uBAAL,KAAK,CAAkB,IAAI,KAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM;AAA1D,CAA0D,CAAC"}

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

@@ -0,0 +1 @@
+export * from "./error";

package/dist/esm/typeguards/index.js

@@ -0,0 +1,2 @@
+export * from "./error";
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,8 @@
+import { providers } from "ethers";
+/**
+ * Checks if a contract is deployed at the given address
+ * @param address The ETH address to check
+ * @param provider A valid Ethers.js provider
+ * @returns A boolean indicating if a contract is deployed at the given address or not (true = contract, false = no contract)
+ */
+export declare function isContractDeployedToAddress(address: string, provider: providers.Provider): Promise<boolean>;

package/dist/esm/utils/AddressUtils.js

@@ -0,0 +1,28 @@
+import { __awaiter, __generator } from "tslib";
+import { utils } from "ethers";
+/**
+ * Checks if a contract is deployed at the given address
+ * @param address The ETH address to check
+ * @param provider A valid Ethers.js provider
+ * @returns A boolean indicating if a contract is deployed at the given address or not (true = contract, false = no contract)
+ */
+export function isContractDeployedToAddress(address, provider) {
+    return __awaiter(this, void 0, void 0, function () {
+        var code;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    // A base case for if the address is null or malformed
+                    if (!address || !utils.isAddress(address)) {
+                        return [2 /*return*/, false];
+                    }
+                    return [4 /*yield*/, provider.getCode(address)];
+                case 1:
+                    code = _a.sent();
+                    // If the code is not empty, then there is a contract at this address
+                    return [2 /*return*/, code !== "0x"];
+            }
+        });
+    });
+}
+//# sourceMappingURL=AddressUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AddressUtils.js","sourceRoot":"","sources":["../../../src/utils/AddressUtils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAa,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,UAAgB,2BAA2B,CAAC,OAAe,EAAE,QAA4B;;;;;;oBAC7F,sDAAsD;oBACtD,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;wBACzC,sBAAO,KAAK,EAAC;qBACd;oBAEY,qBAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAA;;oBAAtC,IAAI,GAAG,SAA+B;oBAC5C,qEAAqE;oBACrE,sBAAO,IAAI,KAAK,IAAI,EAAC;;;;CACtB"}

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

@@ -0,0 +1,98 @@
+/**
+ * Deduplicates an array by filtering it via a Set.
+ * @notice Should not be used for deduplicating arrays of complex types.
+ * @param array The array to deduplicate.
+ * @returns A new array, filtered for uniqueness.
+ */
+export declare function dedupArray<T>(array: T[]): T[];
+/**
+ * Splits an arbitrary array into a series of chunks.
+ * @param array The array to chunk.
+ * @param chunkSize The maximum size of any chunk within the array.
+ * @returns A new array of chunked members.
+ */
+export declare function chunk<T>(array: T[], chunkSize: number): T[][];
+/**
+ * Returns the last index of an array that matches the given predicate.
+ * @note Emulates Array.prototype.findLastIndex
+ * @param array The array to search.
+ * @param predicate The predicate function to apply to each element.
+ * @returns The last index of the array that matches the predicate, or -1 if no element matches.
+ */
+export declare function findLastIndex<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => boolean): number;
+/**
+ * Returns the last element of an array that matches the given predicate.
+ * @note Emulates Array.prototype.findLast
+ * @param array The array to search.
+ * @param predicate The predicate function to apply to each element.
+ * @returns The last element of the array that matches the predicate, or undefined if no element matches.
+ */
+export declare function findLast<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => boolean): T | undefined;
+/**
+ * Performs an asynchronous filter operation on an array. This function behaves like Array.prototype.filter, but
+ * accepts an asynchronous predicate function.
+ * @param array The array to filter.
+ * @param predicate The asynchronous predicate function to apply to each element.
+ * @returns A promise that resolves to an array of elements that match the predicate.
+ */
+export declare function filterAsync<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => Promise<boolean>): Promise<T[]>;
+/**
+ * Performs an asynchronous map operation on an array. This function behaves like Array.prototype.map, but accepts an
+ * asynchronous mapper function.
+ * @param array The array to map.
+ * @param mapper The asynchronous mapper function to apply to each element.
+ * @returns A promise that resolves to an array of mapped elements.
+ */
+export declare function mapAsync<T, U>(array: T[], mapper: (value: T, index: number, obj: T[]) => Promise<U>): Promise<U[]>;
+/**
+ * Performs an asynchronous reduce operation on an array. This function behaves like Array.prototype.reduce, but
+ * accepts an asynchronous reducer function.
+ * @param array The array to reduce.
+ * @param reducer The asynchronous reducer function to apply to each element.
+ * @param initialValue The initial value of the accumulator.
+ * @returns A promise that resolves to the final value of the accumulator.
+ */
+export declare function reduceAsync<T, U>(array: T[], reducer: (accumulator: U, currentValue: T, currentIndex: number, obj: T[]) => Promise<U>, initialValue: U): Promise<U>;
+/**
+ * Performs an asynchronous forEach operation on an array. This function behaves like Array.prototype.forEach, but
+ * accepts an asynchronous callback function.
+ * @param array The array to iterate over.
+ * @param callback The asynchronous callback function to apply to each element.
+ * @returns A promise that resolves to void.
+ */
+export declare function forEachAsync<T>(array: T[], callback: (value: T, index: number, obj: T[]) => Promise<void>): Promise<void>;
+/**
+ * Performs an asynchronous some operation on an array. This function behaves like Array.prototype.some, but accepts
+ * an asynchronous predicate function.
+ * @param array The array to search.
+ * @param predicate The asynchronous predicate function to apply to each element.
+ * @returns A promise that resolves to true if any element matches the predicate, or false if no element matches.
+ */
+export declare function someAsync<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => Promise<boolean>): Promise<boolean>;
+/**
+ * Performs an asynchronous every operation on an array. This function behaves like Array.prototype.every, but accepts
+ * an asynchronous predicate function.
+ * @param array The array to test.
+ * @param predicate The asynchronous predicate function to apply to each element.
+ * @returns A promise that resolves to true if all elements match the predicate, or false if any element does not match.
+ * @note This function uses De Morgan's law to convert the predicate to a negated predicate, and then uses someAsync.
+ *       This is done because it is more efficient to short-circuit on the first false value than the first true value.
+ */
+export declare function everyAsync<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => Promise<boolean>): Promise<boolean>;
+/**
+ * Performs an asynchronous includes operation on an array. This function behaves like Array.prototype.includes, but
+ * accepts an asynchronous predicate function.
+ * @param array The array to search.
+ * @param predicate The asynchronous predicate function to apply to each element.
+ * @returns A promise that resolves to true if any element matches the predicate, or false if no element matches.
+ * @note This function uses someAsync.
+ */
+export declare function includesAsync<T>(array: T[], predicate: (value: T, index: number, obj: T[]) => Promise<boolean>): Promise<boolean>;
+/**
+ * A generic type guard for arrays of a specific type.
+ * @param array The array to test.
+ * @param predicate The type guard predicate function to apply to each element.
+ * @returns True if the array is an array of the specified type, or false otherwise.
+ * @note This function uses Array.prototype.every.
+ */
+export declare function isArrayOf<T>(array: unknown, predicate: (value: unknown) => value is T): array is T[];