@across-protocol/sdk 3.0.0

package/dist/esm/utils/ArrayUtils.js

@@ -0,0 +1,196 @@
+import { __awaiter, __generator } from "tslib";
+/**
+ * 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 function dedupArray(array) {
+    return Array.from(new Set(array));
+}
+/**
+ * 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 function chunk(array, chunkSize) {
+    var chunks = [];
+    for (var i = 0; i < array.length; i += chunkSize) {
+        chunks.push(array.slice(i, i + chunkSize));
+    }
+    return chunks;
+}
+/**
+ * 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 function findLastIndex(array, predicate) {
+    for (var i = array.length - 1; i >= 0; i--) {
+        if (predicate(array[i], i, array)) {
+            return i;
+        }
+    }
+    return -1;
+}
+/**
+ * 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 function findLast(array, predicate) {
+    var index = findLastIndex(array, predicate);
+    return index >= 0 ? array[index] : 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 function filterAsync(array, predicate) {
+    return __awaiter(this, void 0, void 0, function () {
+        var results;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, Promise.all(array.map(predicate))];
+                case 1:
+                    results = _a.sent();
+                    return [2 /*return*/, array.filter(function (_, index) { return results[index]; })];
+            }
+        });
+    });
+}
+/**
+ * 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 function mapAsync(array, mapper) {
+    return Promise.all(array.map(mapper));
+}
+/**
+ * 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 function reduceAsync(array, reducer, initialValue) {
+    return __awaiter(this, void 0, void 0, function () {
+        var accumulator, i;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    accumulator = initialValue;
+                    i = 0;
+                    _a.label = 1;
+                case 1:
+                    if (!(i < array.length)) return [3 /*break*/, 4];
+                    return [4 /*yield*/, reducer(accumulator, array[i], i, array)];
+                case 2:
+                    accumulator = _a.sent();
+                    _a.label = 3;
+                case 3:
+                    i++;
+                    return [3 /*break*/, 1];
+                case 4: return [2 /*return*/, accumulator];
+            }
+        });
+    });
+}
+/**
+ * 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 function forEachAsync(array, callback) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, mapAsync(array, callback)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+/**
+ * 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 function someAsync(array, predicate) {
+    return __awaiter(this, void 0, void 0, function () {
+        var results;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, mapAsync(array, predicate)];
+                case 1:
+                    results = _a.sent();
+                    return [2 /*return*/, results.some(function (value) { return value; })];
+            }
+        });
+    });
+}
+/**
+ * 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 function everyAsync(array, predicate) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _this = this;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, someAsync(array, function (value, index, obj) { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0: return [4 /*yield*/, predicate(value, index, obj)];
+                            case 1: return [2 /*return*/, !(_a.sent())];
+                        }
+                    }); }); })];
+                case 1: return [2 /*return*/, !(_a.sent())];
+            }
+        });
+    });
+}
+/**
+ * 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 function includesAsync(array, predicate) {
+    return someAsync(array, predicate);
+}
+/**
+ * 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 function isArrayOf(array, predicate) {
+    return Array.isArray(array) && array.every(predicate);
+}
+//# sourceMappingURL=ArrayUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayUtils.js","sourceRoot":"","sources":["../../../src/utils/ArrayUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAI,KAAU;IACtC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,KAAU,EAAE,SAAiB;IACpD,IAAM,MAAM,GAAU,EAAE,CAAC;IAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE;QAChD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;KAC5C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAI,KAAU,EAAE,SAAyD;IACpG,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1C,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE;YACjC,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAI,KAAU,EAAE,SAAyD;IAC/F,IAAM,KAAK,GAAG,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC9C,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,WAAW,CAC/B,KAAU,EACV,SAAkE;;;;;wBAElD,qBAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAA;;oBAAjD,OAAO,GAAG,SAAuC;oBACvD,sBAAO,KAAK,CAAC,MAAM,CAAC,UAAC,CAAC,EAAE,KAAK,IAAK,OAAA,OAAO,CAAC,KAAK,CAAC,EAAd,CAAc,CAAC,EAAC;;;;CACnD;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAO,KAAU,EAAE,MAAyD;IAClG,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,WAAW,CAC/B,KAAU,EACV,OAAwF,EACxF,YAAe;;;;;;oBAEX,WAAW,GAAG,YAAY,CAAC;oBACtB,CAAC,GAAG,CAAC;;;yBAAE,CAAA,CAAC,GAAG,KAAK,CAAC,MAAM,CAAA;oBAChB,qBAAM,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAA;;oBAA5D,WAAW,GAAG,SAA8C,CAAC;;;oBAD7B,CAAC,EAAE,CAAA;;wBAGrC,sBAAO,WAAW,EAAC;;;;CACpB;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,YAAY,CAChC,KAAU,EACV,QAA8D;;;;wBAE9D,qBAAM,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAA;;oBAA/B,SAA+B,CAAC;;;;;CACjC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,SAAS,CAC7B,KAAU,EACV,SAAkE;;;;;wBAElD,qBAAM,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,EAAA;;oBAA1C,OAAO,GAAG,SAAgC;oBAChD,sBAAO,OAAO,CAAC,IAAI,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,EAAL,CAAK,CAAC,EAAC;;;;CACvC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,UAAU,CAC9B,KAAU,EACV,SAAkE;;;;;wBAEzD,qBAAM,SAAS,CAAC,KAAK,EAAE,UAAO,KAAK,EAAE,KAAK,EAAE,GAAG;;oCAAO,qBAAM,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,EAAA;oCAApC,sBAAA,CAAC,CAAC,SAAkC,CAAC,EAAA;;6BAAA,CAAC,EAAA;wBAAnG,sBAAO,CAAC,CAAC,SAA0F,CAAC,EAAC;;;;CACtG;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAU,EACV,SAAkE;IAElE,OAAO,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAI,KAAc,EAAE,SAAyC;IACpF,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACxD,CAAC"}

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

@@ -0,0 +1,31 @@
+/**
+ * @file Responsible for providing utility functions for working with BigNumbers.
+ * @module utils/BigNumberUtils
+ * @author Across Protocol
+ */
+import { ethers } from "ethers";
+export type BigNumberish = ethers.BigNumberish;
+export type BN = ethers.BigNumber;
+export declare const bnZero: ethers.BigNumber, bnOne: ethers.BigNumber, bnUint256Max: ethers.BigNumber;
+export declare const bnUint32Max: ethers.BigNumber;
+/**
+ * Converts a stringified number into a BigNumber with 18 decimal places.
+ * @param num The number to parse.
+ * @returns The parsed BigNumber.
+ */
+export declare function toWei(num: BigNumberish): BN;
+/**
+ * Converts a stringified number into a BigNumber with 9 decimal places.
+ * @param num The number to parse.
+ * @returns The parsed BigNumber.
+ */
+export declare function toGWei(num: BigNumberish): BN;
+/**
+ * Converts a stringified number into a BigNumber.
+ * If the string version of the num contains a `.` then it is a number which needs to be parsed to a string int.
+ * @param num The number to parse.
+ * @param rounding The rounding method to use if the number has a decimal point. Defaults to "floor" or rounding down. Valid values are "floor", "round", and "ceil".
+ * @returns The parsed BigNumber.
+ * @note This is a temporary function until we can backport support for decimal points to @across-protocol/sdk.
+ */
+export declare const toBN: (num: BigNumberish, rounding?: "floor" | "round" | "ceil") => BN;

package/dist/esm/utils/BigNumberUtils.js

@@ -0,0 +1,52 @@
+/**
+ * @file Responsible for providing utility functions for working with BigNumbers.
+ * @module utils/BigNumberUtils
+ * @author Across Protocol
+ */
+var _a;
+import { ethers, BigNumber } from "ethers";
+export var bnZero = (_a = ethers.constants, _a.Zero), bnOne = _a.One, bnUint256Max = _a.MaxUint256;
+export var bnUint32Max = BigNumber.from("0xffffffff");
+/**
+ * Converts a stringified number into a BigNumber with 18 decimal places.
+ * @param num The number to parse.
+ * @returns The parsed BigNumber.
+ */
+export function toWei(num) {
+    return ethers.utils.parseEther(num.toString());
+}
+/**
+ * Converts a stringified number into a BigNumber with 9 decimal places.
+ * @param num The number to parse.
+ * @returns The parsed BigNumber.
+ */
+export function toGWei(num) {
+    return ethers.utils.parseUnits(num.toString(), 9);
+}
+/**
+ * Converts a stringified number into a BigNumber.
+ * If the string version of the num contains a `.` then it is a number which needs to be parsed to a string int.
+ * @param num The number to parse.
+ * @param rounding The rounding method to use if the number has a decimal point. Defaults to "floor" or rounding down. Valid values are "floor", "round", and "ceil".
+ * @returns The parsed BigNumber.
+ * @note This is a temporary function until we can backport support for decimal points to @across-protocol/sdk.
+ */
+export var toBN = function (num, rounding) {
+    if (rounding === void 0) { rounding = "floor"; }
+    // If the string version of the num contains a `.` then it is a number which needs to be parsed to a string int.
+    if (num.toString().includes(".")) {
+        // Destructure the integer and decimal parts of the number.
+        var _a = num.toString().split("."), integer = _a[0], decimal = _a[1];
+        // We can determine if we need to round in a losseless way. First we need to check
+        // if the number just has a decimal point with no decimal places. If it does, we
+        // can just return the integer. However, if it has a decimal point with decimal
+        // places, then we can automatically round up if ceil is specified or if round is
+        // specified and the first decimal is greater than or equal to 5.
+        var roundUp = decimal.length > 0 && (rounding === "ceil" || (rounding === "round" && parseInt(decimal[0]) >= 5));
+        // If we need to round up, we can just add 1 to the integer.
+        return BigNumber.from(integer).add(roundUp ? 1 : 0);
+    }
+    // Otherwise, it is a string int and we can parse it directly.
+    return BigNumber.from(num.toString());
+};
+//# sourceMappingURL=BigNumberUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BigNumberUtils.js","sourceRoot":"","sources":["../../../src/utils/BigNumberUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAK3C,MAAM,CAAS,IAAM,MAAM,IAAd,KAAyD,MAAM,CAAC,SAAS,UAA3D,EAAO,KAAK,SAAA,EAAc,YAAY,gBAAA,CAAsB;AAEvF,MAAM,CAAC,IAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,GAAiB;IACrC,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAiB;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,IAAM,IAAI,GAAG,UAAC,GAAiB,EAAE,QAA8C;IAA9C,yBAAA,EAAA,kBAA8C;IACpF,gHAAgH;IAChH,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAChC,2DAA2D;QACrD,IAAA,KAAqB,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAA7C,OAAO,QAAA,EAAE,OAAO,QAA6B,CAAC;QACrD,kFAAkF;QAClF,gFAAgF;QAChF,+EAA+E;QAC/E,iFAAiF;QACjF,iEAAiE;QACjE,IAAM,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,KAAK,MAAM,IAAI,CAAC,QAAQ,KAAK,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnH,4DAA4D;QAC5D,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KACrD;IACD,8DAA8D;IAC9D,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;AACxC,CAAC,CAAC"}

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

@@ -0,0 +1,21 @@
+/**
+ * Creates a block explorer link for a transaction or address on a given network.
+ * @param txHashOrAddress The transaction hash or address to link to.
+ * @param chainId The chainId to link to.
+ * @returns The block explorer link. This link will be formatted in markdown.
+ */
+export declare function blockExplorerLink(txHashOrAddress: string, chainId: number | string): string;
+/**
+ * Resolves a domain to an block explorer link for a given network.
+ * @param networkId The network to link to.
+ * @returns The block explorer link. If the networkId is not supported, undefined will be returned.
+ */
+export declare function resolveBlockExplorerDomain(networkId: number): string | undefined;
+/**
+ * Generates a list of blockExplorer links for a given list of transaction hashes or addresses.
+ * @param txHashesOrAddresses The list of transaction hashes or addresses to link to.
+ * @param chainId The chainId to link to.
+ * @returns A list of formatted markdown block explorer links to the given transaction hashes or addresses on the given chainId.
+ * @see blockExplorerLink
+ */
+export declare function blockExplorerLinks(txHashesOrAddresses: string[], chainId: number | string): string;

package/dist/esm/utils/BlockExplorerUtils.js

@@ -0,0 +1,91 @@
+import { ethers } from "ethers";
+import { PUBLIC_NETWORKS } from "../constants";
+import { createShortHexString } from "./FormattingUtils";
+import { isDefined } from "./TypeGuards";
+/**
+ * Creates a block explorer link for a transaction or address on a given network.
+ * @param txHashOrAddress The transaction hash or address to link to.
+ * @param chainId The chainId to link to.
+ * @returns The block explorer link. This link will be formatted in markdown.
+ */
+export function blockExplorerLink(txHashOrAddress, chainId) {
+    var _a;
+    return (_a = _createBlockExplorerLinkMarkdown(txHashOrAddress, Number(chainId))) !== null && _a !== void 0 ? _a : "<>";
+}
+/**
+ * Resolves a domain to an block explorer link for a given network.
+ * @param networkId The network to link to.
+ * @returns The block explorer link. If the networkId is not supported, undefined will be returned.
+ */
+export function resolveBlockExplorerDomain(networkId) {
+    var _a;
+    return (_a = PUBLIC_NETWORKS[networkId]) === null || _a === void 0 ? void 0 : _a.blockExplorer;
+}
+/**
+ * Constructs a URL for a given list of domain parts.
+ * @param domain The domain to construct a URL for.
+ * @param parts The relative path of parts to append to the domain. These parts will be joined with a "/".
+ * @returns The constructed URL.
+ * @see resolveBlockExplorerDomain
+ * @example constructURL("https://example.com", ["path", "to", "resource"]) => "https://example.com/path/to/resource"
+ * @example constructURL("https://example.com", ["path", "to", "resource", ""]) => "https://example.com/path/to/resource"
+ * @example constructURL("https://example.com", ["path", "to//", "resource",]) => "https://example.com/path/to/resource"
+ */
+function constructURL(domain, parts) {
+    // Further split the parts by "/" to handle any parts that contain multiple "/".
+    parts = parts.flatMap(function (p) { return p.split("/"); });
+    // Remove any empty parts.
+    parts = parts.filter(function (p) { return p !== ""; });
+    // Join the parts with a "/".
+    var path = parts.join("/");
+    // Remove any trailing "/".
+    return "".concat(domain, "/").concat(path).replace(/\/+$/, "");
+}
+/**
+ * Generates a valid block explorer link for a given transaction hash or address.
+ * @param hex The transaction hash or address to link to.
+ * @param chainId The chainId to link to.
+ * @returns A formatted markdown block explorer link to the given transaction hash or address on the given chainId.
+ */
+function _createBlockExplorerLinkMarkdown(hex, chainId) {
+    if (chainId === void 0) { chainId = 1; }
+    // Attempt to resolve the block explorer domain for the given chainId.
+    var explorerDomain = resolveBlockExplorerDomain(chainId);
+    // If the chainId is not supported, return an unsupported link.
+    if (!isDefined(explorerDomain)) {
+        return "<unsupported chain/hash ".concat(chainId, ":").concat(hex, ">}");
+    }
+    // Ensure that the first two characters are "0x". If they are not, append them.
+    if (hex.substring(0, 2) !== "0x") {
+        hex = "0x".concat(hex);
+    }
+    // Ensure that the hex string is a valid hexadecimal string.
+    if (!ethers.utils.isHexString(hex)) {
+        return null;
+    }
+    // Resolve the short URL string.
+    var shortURLString = createShortHexString(hex);
+    // Iterate over the two possible hex lengths.
+    for (var _i = 0, _a = [
+        [66, "tx"],
+        [42, "address"],
+    ]; _i < _a.length; _i++) {
+        var _b = _a[_i], length_1 = _b[0], route = _b[1];
+        // If the hex string is the correct length, return the link.
+        if (hex.length === length_1) {
+            return "<".concat(constructURL(explorerDomain, [route, hex]), "|").concat(shortURLString, ">");
+        }
+    }
+    return null;
+}
+/**
+ * Generates a list of blockExplorer links for a given list of transaction hashes or addresses.
+ * @param txHashesOrAddresses The list of transaction hashes or addresses to link to.
+ * @param chainId The chainId to link to.
+ * @returns A list of formatted markdown block explorer links to the given transaction hashes or addresses on the given chainId.
+ * @see blockExplorerLink
+ */
+export function blockExplorerLinks(txHashesOrAddresses, chainId) {
+    return txHashesOrAddresses.map(function (hash) { return "".concat(blockExplorerLink(hash, chainId), "\n"); }).join("");
+}
+//# sourceMappingURL=BlockExplorerUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BlockExplorerUtils.js","sourceRoot":"","sources":["../../../src/utils/BlockExplorerUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,eAAuB,EAAE,OAAwB;;IACjF,OAAO,MAAA,gCAAgC,CAAC,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,mCAAI,IAAI,CAAC;AACpF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,SAAiB;;IAC1D,OAAO,MAAA,eAAe,CAAC,SAAS,CAAC,0CAAE,aAAa,CAAC;AACnD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,YAAY,CAAC,MAAc,EAAE,KAAe;IACnD,gFAAgF;IAChF,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAZ,CAAY,CAAC,CAAC;IAC3C,0BAA0B;IAC1B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,KAAK,EAAE,EAAR,CAAQ,CAAC,CAAC;IACtC,6BAA6B;IAC7B,IAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7B,2BAA2B;IAC3B,OAAO,UAAG,MAAM,cAAI,IAAI,CAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAS,gCAAgC,CAAC,GAAW,EAAE,OAAW;IAAX,wBAAA,EAAA,WAAW;IAChE,sEAAsE;IACtE,IAAM,cAAc,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC3D,+DAA+D;IAC/D,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE;QAC9B,OAAO,kCAA2B,OAAO,cAAI,GAAG,OAAI,CAAC;KACtD;IACD,+EAA+E;IAC/E,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,EAAE;QAChC,GAAG,GAAG,YAAK,GAAG,CAAE,CAAC;KAClB;IACD,4DAA4D;IAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IACD,gCAAgC;IAChC,IAAM,cAAc,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IACjD,6CAA6C;IAC7C,KAA8B,UAGP,EAHO,KAAA;QAC5B,CAAC,EAAE,EAAE,IAAI,CAAC;QACV,CAAC,EAAE,EAAE,SAAS,CAAC;KACM,EAHO,cAGP,EAHO,IAGP,EAAE;QAHd,IAAA,WAAe,EAAd,QAAM,QAAA,EAAE,KAAK,QAAA;QAIvB,4DAA4D;QAC5D,IAAI,GAAG,CAAC,MAAM,KAAK,QAAM,EAAE;YACzB,OAAO,WAAI,YAAY,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,cAAI,cAAc,MAAG,CAAC;SAC5E;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,mBAA6B,EAAE,OAAwB;IACxF,OAAO,mBAAmB,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,UAAG,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,OAAI,EAAvC,CAAuC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC7F,CAAC"}

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

@@ -0,0 +1,46 @@
+import type { Block, Provider } from "@ethersproject/abstract-provider";
+import { CachingMechanismInterface } from "../interfaces";
+type Opts = {
+    highBlock?: number;
+    highBlockOffset?: number;
+    blockRange?: number;
+};
+type BlockTimeAverage = {
+    average: number;
+    blockRange: number;
+    timestamp: number;
+};
+/**
+ * @description Compute the average block time over a block range.
+ * @returns Average number of seconds per block.
+ */
+export declare function averageBlockTime(provider: Provider, { highBlock, highBlockOffset, blockRange }?: Opts): Promise<Pick<BlockTimeAverage, "average" | "blockRange">>;
+export type BlockFinderHints = {
+    lowBlock?: number;
+    highBlock?: number;
+};
+export declare class BlockFinder {
+    private readonly provider;
+    private readonly blocks;
+    constructor(provider: Provider, blocks?: Block[]);
+    /**
+     * @notice Gets the latest block whose timestamp is <= the provided timestamp.
+     * @param number Timestamp timestamp to search.
+     * @param hints Optional low and high block to bound the search space.
+     */
+    getBlockForTimestamp(timestamp: number | string, hints?: BlockFinderHints): Promise<Block>;
+    private getLatestBlock;
+    private getBlock;
+    private findBlock;
+}
+/**
+ * @notice Get the block number for a given timestamp fresh from on-chain data if not found in redis cache.
+ * If redis cache is not available, then requests block from blockFinder.
+ * @param chainId Chain to load block finder for.
+ * @param timestamp Approximate timestamp of the to requested block number.
+ * @param blockFinder Caller can optionally pass in a block finder object to use instead of creating a new one
+ * or loading from cache. This is useful for testing primarily.
+ * @returns Block number for the requested timestamp.
+ */
+export declare function getCachedBlockForTimestamp(chainId: number, timestamp: number, blockFinder: BlockFinder, cache?: CachingMechanismInterface, hints?: BlockFinderHints): Promise<number>;
+export {};