@across-protocol/sdk 3.0.0

package/dist/esm/utils/NetworkUtils.js

@@ -0,0 +1,109 @@
+import { CHAIN_IDs, MAINNET_CHAIN_IDs, PUBLIC_NETWORKS, TESTNET_CHAIN_IDs } from "../constants";
+var hreNetworks = {
+    666: "Hardhat1",
+    1337: "Hardhat2",
+};
+/**
+ * Resolves a network name from a network id.
+ * @param networkId The network id to resolve the name for
+ * @returns The network name for the network id. If the network id is not found, returns "unknown"
+ */
+export function getNetworkName(networkId) {
+    var _a, _b, _c;
+    networkId = Number(networkId);
+    return (_c = (_b = (_a = PUBLIC_NETWORKS[networkId]) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : hreNetworks[networkId]) !== null && _c !== void 0 ? _c : "unknown";
+}
+/**
+ * Resolves a native token symbol from a chain id.
+ * @param chainId The chain id to resolve the native token symbol for
+ * @returns The native token symbol for the chain id. If the chain id is not found, returns "ETH"
+ */
+export function getNativeTokenSymbol(chainId) {
+    var _a, _b;
+    return (_b = (_a = PUBLIC_NETWORKS[Number(chainId)]) === null || _a === void 0 ? void 0 : _a.nativeToken) !== null && _b !== void 0 ? _b : "ETH";
+}
+/**
+ * Determines whether a chain ID is part of the production network.
+ * @param chainId Chain ID to query.
+ * @returns true if the chain ID is part of the production network, otherwise false.
+ */
+export function chainIsProd(chainId) {
+    return Object.values(MAINNET_CHAIN_IDs).includes(chainId);
+}
+/**
+ * Determines whether a chain ID is part of the production network.
+ * @param chainId Chain ID to query.
+ * @returns true if the chain ID is part of the production network, otherwise false.
+ */
+export function chainIsTestnet(chainId) {
+    return Object.values(TESTNET_CHAIN_IDs).includes(chainId);
+}
+/**
+ * Determines whether a chain ID is a Polygon implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a Polygon chain (mainnet or testnet), otherwise false.
+ */
+export function chainIsMatic(chainId) {
+    return [CHAIN_IDs.POLYGON, CHAIN_IDs.POLYGON_AMOY].includes(chainId);
+}
+/**
+ * Determines whether a chain ID is an Optimism OP Stack implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an OP stack, otherwise false.
+ */
+export function chainIsOPStack(chainId) {
+    return [
+        CHAIN_IDs.OPTIMISM,
+        CHAIN_IDs.BASE,
+        CHAIN_IDs.MODE,
+        CHAIN_IDs.OPTIMISM_GOERLI,
+        CHAIN_IDs.BASE_GOERLI,
+        CHAIN_IDs.OPTIMISM_SEPOLIA,
+        CHAIN_IDs.BASE_SEPOLIA,
+        CHAIN_IDs.MODE_SEPOLIA,
+    ].includes(chainId);
+}
+/**
+ * Determines whether a chain ID is an Arbitrum implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an Arbitrum chain, otherwise false.
+ */
+export function chainIsArbitrum(chainId) {
+    return [CHAIN_IDs.ARBITRUM, CHAIN_IDs.ARBITRUM_GOERLI, CHAIN_IDs.ARBITRUM_SEPOLIA].includes(chainId);
+}
+/**
+ * Determines whether a chain ID is a Linea implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a Linea chain, otherwise false.
+ */
+export function chainIsLinea(chainId) {
+    return [CHAIN_IDs.LINEA, CHAIN_IDs.LINEA_GOERLI].includes(chainId);
+}
+/**
+ * Determines whether a chain ID has the capacity for having its USDC bridged via CCTP.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a CCTP-bridging enabled chain, otherwise false.
+ */
+export function chainIsCCTPEnabled(chainId) {
+    return [
+        // Mainnets
+        CHAIN_IDs.BASE,
+        CHAIN_IDs.OPTIMISM,
+        CHAIN_IDs.ARBITRUM,
+        CHAIN_IDs.POLYGON,
+        // Testnets
+        CHAIN_IDs.BASE_SEPOLIA,
+        CHAIN_IDs.OPTIMISM_SEPOLIA,
+        CHAIN_IDs.ARBITRUM_SEPOLIA,
+        CHAIN_IDs.POLYGON_AMOY,
+    ].includes(chainId);
+}
+/**
+ * Determines if a chain ID requires a manual L1 -> L2 finalization step.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId requires manual L1 -> L2 finalization, otherwise false.
+ */
+export function chainRequiresL1ToL2Finalization(chainId) {
+    return chainIsCCTPEnabled(chainId) || chainIsLinea(chainId);
+}
+//# sourceMappingURL=NetworkUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkUtils.js","sourceRoot":"","sources":["../../../src/utils/NetworkUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEhG,IAAM,WAAW,GAA2B;IAC1C,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,UAAU;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,SAA0B;;IACvD,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC9B,OAAO,MAAA,MAAA,MAAA,eAAe,CAAC,SAAS,CAAC,0CAAE,IAAI,mCAAI,WAAW,CAAC,SAAS,CAAC,mCAAI,SAAS,CAAC;AACjF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAwB;;IAC3D,OAAO,MAAA,MAAA,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,0CAAE,WAAW,mCAAI,KAAK,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,OAAe;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,OAAO;QACL,SAAS,CAAC,QAAQ;QAClB,SAAS,CAAC,IAAI;QACd,SAAS,CAAC,IAAI;QACd,SAAS,CAAC,eAAe;QACzB,SAAS,CAAC,WAAW;QACrB,SAAS,CAAC,gBAAgB;QAC1B,SAAS,CAAC,YAAY;QACtB,SAAS,CAAC,YAAY;KACvB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,OAAe;IAC7C,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,eAAe,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACvG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAChD,OAAO;QACL,WAAW;QACX,SAAS,CAAC,IAAI;QACd,SAAS,CAAC,QAAQ;QAClB,SAAS,CAAC,QAAQ;QAClB,SAAS,CAAC,OAAO;QACjB,WAAW;QACX,SAAS,CAAC,YAAY;QACtB,SAAS,CAAC,gBAAgB;QAC1B,SAAS,CAAC,gBAAgB;QAC1B,SAAS,CAAC,YAAY;KACvB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAAC,OAAe;IAC7D,OAAO,kBAAkB,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAC9D,CAAC"}

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

@@ -0,0 +1,12 @@
+/**
+ * A typeguard for a number with the added check that the number is an integer.
+ * @param value The value to check.
+ * @returns True if the value is a number and an integer, false otherwise.
+ */
+export declare function isInteger(value: unknown): value is number;
+/**
+ * A typeguard for a number with added checks that the number is an integer and is greater to zero.
+ * @param value The value to check.
+ * @returns True if the value is a number, an integer, and greater than zero, false otherwise.
+ */
+export declare function isPositiveInteger(value: unknown): value is number;

package/dist/esm/utils/NumberUtils.js

@@ -0,0 +1,17 @@
+/**
+ * A typeguard for a number with the added check that the number is an integer.
+ * @param value The value to check.
+ * @returns True if the value is a number and an integer, false otherwise.
+ */
+export function isInteger(value) {
+    return !Number.isNaN(Number(value)) && Number.isInteger(value);
+}
+/**
+ * A typeguard for a number with added checks that the number is an integer and is greater to zero.
+ * @param value The value to check.
+ * @returns True if the value is a number, an integer, and greater than zero, false otherwise.
+ */
+export function isPositiveInteger(value) {
+    return isInteger(value) && value > 0;
+}
+//# sourceMappingURL=NumberUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NumberUtils.js","sourceRoot":"","sources":["../../../src/utils/NumberUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;AACvC,CAAC"}

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

@@ -0,0 +1,10 @@
+export declare function assign(obj: any, keyPath: any[], value: any): void;
+export declare function groupObjectCountsByThreeProps(objects: any[], primaryProp: string, secondaryProp: string, tertiaryProp: string): any;
+export declare function groupObjectCountsByTwoProps(objects: any[], primaryProp: string, getSecondaryProp: (obj: any) => string): any;
+export declare function groupObjectCountsByProp(objects: any[], getProp: (obj: any) => string): any;
+/**
+ * Filter out falsy keys from an object. Falsy keys are keys with values of false, null, undefined, 0, or empty string.
+ * @param obj The object to filter
+ * @returns A new object with falsy keys removed
+ */
+export declare function filterFalsyKeys(obj: Record<string | number, unknown>): Record<string | number, unknown>;

package/dist/esm/utils/ObjectUtils.js

@@ -0,0 +1,72 @@
+import { __assign, __spreadArray } from "tslib";
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// Append value along the keyPath to object. For example assign(deposits, ['1337', '31337'], [{depositId:1}]) will create
+// deposits = {1337:{31337:[{depositId:1}]}}. Note that if the path into the object exists then this will append. This
+// function respects the destination type; if it is an object then deep merge and if an array effectively will push.
+export function assign(obj, keyPath, value) {
+    var lastKeyIndex = keyPath.length - 1;
+    for (var i = 0; i < lastKeyIndex; ++i) {
+        var key = keyPath[i];
+        if (!(key in obj)) {
+            obj[key] = {};
+        }
+        obj = obj[key];
+    }
+    // If the object at the deep path does not exist then set to the value.
+    if (!obj[keyPath[lastKeyIndex]] || typeof obj[keyPath[lastKeyIndex]] == "string") {
+        obj[keyPath[lastKeyIndex]] = value;
+    }
+    // If the object at the deep path is an array then append array wise.
+    else if (Array.isArray(value)) {
+        obj[keyPath[lastKeyIndex]] = __spreadArray(__spreadArray([], obj[keyPath[lastKeyIndex]], true), value, true);
+    }
+    // If the value is false bool then set to false. This special case is needed as {...false} = {} which causes issues.
+    else if (value === false) {
+        obj[keyPath[lastKeyIndex]] = false;
+    }
+    // If the object at the deep path is an object then append object wise.
+    else {
+        obj[keyPath[lastKeyIndex]] = __assign(__assign({}, obj[keyPath[lastKeyIndex]]), value);
+    }
+}
+// Refactor to be more generalized with N props
+export function groupObjectCountsByThreeProps(objects, primaryProp, secondaryProp, tertiaryProp) {
+    return objects.reduce(function (result, obj) {
+        var _a, _b;
+        result[obj[primaryProp]] = (_a = result[obj[primaryProp]]) !== null && _a !== void 0 ? _a : {};
+        result[obj[primaryProp]][obj[secondaryProp]] = (_b = result[obj[primaryProp]][obj[secondaryProp]]) !== null && _b !== void 0 ? _b : {};
+        var existingCount = result[obj[primaryProp]][obj[secondaryProp]][obj[tertiaryProp]];
+        result[obj[primaryProp]][obj[secondaryProp]][obj[tertiaryProp]] =
+            existingCount === undefined ? 1 : existingCount + 1;
+        return result;
+    }, {});
+}
+export function groupObjectCountsByTwoProps(objects, primaryProp, getSecondaryProp) {
+    return objects.reduce(function (result, obj) {
+        var _a;
+        result[obj[primaryProp]] = (_a = result[obj[primaryProp]]) !== null && _a !== void 0 ? _a : {};
+        var existingCount = result[obj[primaryProp]][getSecondaryProp(obj)];
+        result[obj[primaryProp]][getSecondaryProp(obj)] = existingCount === undefined ? 1 : existingCount + 1;
+        return result;
+    }, {});
+}
+export function groupObjectCountsByProp(objects, getProp) {
+    return objects.reduce(function (result, obj) {
+        var existingCount = result[getProp(obj)];
+        result[getProp(obj)] = existingCount === undefined ? 1 : existingCount + 1;
+        return result;
+    }, {});
+}
+/**
+ * Filter out falsy keys from an object. Falsy keys are keys with values of false, null, undefined, 0, or empty string.
+ * @param obj The object to filter
+ * @returns A new object with falsy keys removed
+ */
+export function filterFalsyKeys(obj) {
+    return Object.fromEntries(Object.entries(obj).filter(function (_a) {
+        var v = _a[1];
+        return v;
+    }));
+}
+//# sourceMappingURL=ObjectUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectUtils.js","sourceRoot":"","sources":["../../../src/utils/ObjectUtils.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,uDAAuD;AACvD,yHAAyH;AACzH,sHAAsH;AACtH,oHAAoH;AACpH,MAAM,UAAU,MAAM,CAAC,GAAQ,EAAE,OAAc,EAAE,KAAU;IACzD,IAAM,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,EAAE,CAAC,EAAE;QACrC,IAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;SACf;QACD,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KAChB;IACD,uEAAuE;IACvE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,QAAQ,EAAE;QAChF,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC;KACpC;IACD,qEAAqE;SAChE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC7B,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,mCAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,SAAK,KAAK,OAAC,CAAC;KACxE;IACD,oHAAoH;SAC/G,IAAI,KAAK,KAAK,KAAK,EAAE;QACxB,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC;KACpC;IACD,uEAAuE;SAClE;QACH,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,yBAAQ,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAK,KAAK,CAAE,CAAC;KAC1E;AACH,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,6BAA6B,CAC3C,OAAc,EACd,WAAmB,EACnB,aAAqB,EACrB,YAAoB;IAEpB,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1D,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,mCAAI,EAAE,CAAC;QAClG,IAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QACtF,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC7D,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AACD,MAAM,UAAU,2BAA2B,CACzC,OAAc,EACd,WAAmB,EACnB,gBAAsC;IAEtC,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1D,IAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QACtG,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,OAAc,EAAE,OAA6B;IACnF,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;QAChC,IAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,GAAqC;IACnE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;YAAF,CAAC,QAAA;QAAM,OAAA,CAAC;IAAD,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC"}

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

@@ -0,0 +1,15 @@
+import { Reviver } from "./TypeUtils";
+/**
+ * A reviver composer that takes a list of revivers and returns a single reviver that applies all of them.
+ * @param revivers The revivers to compose.
+ * @returns A single reviver that applies all of the revivers passed in. If no revivers are passed in, the identity
+ * function is returned.
+ */
+export declare function composeRevivers(...revivers: Reviver[]): Reviver;
+/**
+ * Reviver function that converts a stringified BigNumber object to a BigNumber object.
+ * @param _ The key to the value being revived. Unused.
+ * @param value The value being revived.
+ * @returns The revived value. If the value is not a stringified BigNumber object, it is returned as-is.
+ */
+export declare function objectWithBigNumberReviver(_: unknown, value: unknown): unknown;

package/dist/esm/utils/ReviverUtils.js

@@ -0,0 +1,33 @@
+import { toBN } from "./BigNumberUtils";
+import { isDefined } from "./TypeGuards";
+/**
+ * A reviver composer that takes a list of revivers and returns a single reviver that applies all of them.
+ * @param revivers The revivers to compose.
+ * @returns A single reviver that applies all of the revivers passed in. If no revivers are passed in, the identity
+ * function is returned.
+ */
+export function composeRevivers() {
+    var revivers = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        revivers[_i] = arguments[_i];
+    }
+    // Filter out undefined revivers.
+    revivers = revivers.filter(isDefined);
+    // Return a single reviver that applies all of the revivers passed in. If no revivers are passed in, the identity
+    // function is implicitly returned.
+    return function (key, value) { return revivers.reduce(function (acc, reviver) { return reviver(key, acc); }, value); };
+}
+/**
+ * Reviver function that converts a stringified BigNumber object to a BigNumber object.
+ * @param _ The key to the value being revived. Unused.
+ * @param value The value being revived.
+ * @returns The revived value. If the value is not a stringified BigNumber object, it is returned as-is.
+ */
+export function objectWithBigNumberReviver(_, value) {
+    if (value === null || typeof value !== "object") {
+        return value;
+    }
+    var resolvedValue = value;
+    return resolvedValue.type === "BigNumber" ? toBN(resolvedValue.hex) : resolvedValue;
+}
+//# sourceMappingURL=ReviverUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ReviverUtils.js","sourceRoot":"","sources":["../../../src/utils/ReviverUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;;;;GAKG;AACH,MAAM,UAAU,eAAe;IAAC,kBAAsB;SAAtB,UAAsB,EAAtB,qBAAsB,EAAtB,IAAsB;QAAtB,6BAAsB;;IACpD,iCAAiC;IACjC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACtC,iHAAiH;IACjH,mCAAmC;IACnC,OAAO,UAAC,GAAW,EAAE,KAAc,IAAK,OAAA,QAAQ,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,OAAO,IAAK,OAAA,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAjB,CAAiB,EAAE,KAAK,CAAC,EAA3D,CAA2D,CAAC;AACtG,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,CAAU,EAAE,KAAc;IACnE,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC/C,OAAO,KAAK,CAAC;KACd;IACD,IAAM,aAAa,GAAG,KAAsC,CAAC;IAC7D,OAAO,aAAa,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;AACtF,CAAC"}

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

@@ -0,0 +1,64 @@
+import { Contract, PopulatedTransaction, providers } from "ethers";
+import { Deposit, Fill, FillStatus, RelayData, SlowFillRequest } from "../interfaces";
+import { SpokePoolClient } from "../clients";
+type BlockTag = providers.BlockTag;
+/**
+ * @param spokePool SpokePool Contract instance.
+ * @param deposit V3Deopsit instance.
+ * @param repaymentChainId Optional repaymentChainId (defaults to destinationChainId).
+ * @returns An Ethers UnsignedTransaction instance.
+ */
+export declare function populateV3Relay(spokePool: Contract, deposit: Deposit, relayer: string, repaymentChainId?: number): Promise<PopulatedTransaction>;
+/**
+ * Find the block range that contains the deposit ID. This is a binary search that searches for the block range
+ * that contains the deposit ID.
+ * @param targetDepositId The target deposit ID to search for.
+ * @param initLow The initial lower bound of the block range to search.
+ * @param initHigh The initial upper bound of the block range to search.
+ * @param maxSearches The maximum number of searches to perform. This is used to prevent infinite loops.
+ * @returns The block range that contains the deposit ID.
+ * @note  // We want to find the block range that satisfies these conditions:
+ *        // - the low block has deposit count <= targetDepositId
+ *        // - the high block has a deposit count > targetDepositId.
+ *        // This way the caller can search for a FundsDeposited event between [low, high] that will always
+ *        // contain the event emitted when deposit ID was incremented to targetDepositId + 1. This is the same transaction
+ *        // where the deposit with deposit ID = targetDepositId was created.
+ */
+export declare function getBlockRangeForDepositId(targetDepositId: number, initLow: number, initHigh: number, maxSearches: number, spokePool: SpokePoolClient): Promise<{
+    low: number;
+    high: number;
+}>;
+/**
+ * Finds the deposit id at a specific block number.
+ * @param blockTag The block number to search for the deposit ID at.
+ * @returns The deposit ID.
+ */
+export declare function getDepositIdAtBlock(contract: Contract, blockTag: number): Promise<number>;
+/**
+ * Compute the RelayData hash for a fill. This can be used to determine the fill status.
+ * @param relayData RelayData information that is used to complete a fill.
+ * @param destinationChainId Supplementary destination chain ID required by V3 hashes.
+ * @returns The corresponding RelayData hash.
+ */
+export declare function getRelayDataHash(relayData: RelayData, destinationChainId: number): string;
+export declare function getRelayHashFromEvent(e: Deposit | Fill | SlowFillRequest): string;
+/**
+ * Find the amount filled for a deposit at a particular block.
+ * @param spokePool SpokePool contract instance.
+ * @param relayData Deposit information that is used to complete a fill.
+ * @param blockTag Block tag (numeric or "latest") to query at.
+ * @returns The amount filled for the specified deposit at the requested block (or latest).
+ */
+export declare function relayFillStatus(spokePool: Contract, relayData: RelayData, blockTag?: number | "latest", destinationChainId?: number): Promise<FillStatus>;
+export declare function fillStatusArray(spokePool: Contract, relayData: RelayData[], blockTag?: BlockTag): Promise<(FillStatus | undefined)[]>;
+/**
+ * Find the block at which a fill was completed.
+ * @todo After SpokePool upgrade, this function can be simplified to use the FillStatus enum.
+ * @param spokePool SpokePool contract instance.
+ * @param relayData Deposit information that is used to complete a fill.
+ * @param lowBlockNumber The lower bound of the search. Must be bounded by SpokePool deployment.
+ * @param highBlocknumber Optional upper bound for the search.
+ * @returns The block number at which the relay was completed, or undefined.
+ */
+export declare function findFillBlock(spokePool: Contract, relayData: RelayData, lowBlockNumber: number, highBlockNumber?: number): Promise<number | undefined>;
+export {};