@across-protocol/sdk 3.0.0

package/dist/esm/utils/BlockUtils.js

@@ -0,0 +1,294 @@
+import { __awaiter, __generator } from "tslib";
+import assert from "assert";
+import { clamp, sortedIndexBy } from "lodash";
+import { getNetworkName } from "./NetworkUtils";
+import { isDefined } from "./TypeGuards";
+import { getCurrentTime } from "./TimeUtils";
+import { shouldCache } from "./CachingUtils";
+import { DEFAULT_CACHING_SAFE_LAG } from "../constants";
+// Archive requests typically commence at 128 blocks past the head of the chain.
+// Round down to 120 blocks to avoid slipping into archive territory.
+var defaultBlockRange = 120;
+// Default offset to the high block number. This is subtracted from the block number of the high block
+// when it is queried from the network, rather than having been specified by the caller. This is useful
+// since the supplied Provider instance may be backed by multiple RPC providers, which can lead to some
+// providers running slower than others and taking time to synchronise on the latest block.
+var defaultHighBlockOffset = 10;
+// Retain computations for 15 minutes.
+var cacheTTL = 60 * 15;
+var now = getCurrentTime(); // Seed the cache with initial values.
+var blockTimes = {
+    1: { average: 12.5, timestamp: now, blockRange: 1 },
+    10: { average: 2, timestamp: now, blockRange: 1 },
+    8453: { average: 2, timestamp: now, blockRange: 1 },
+    34443: { average: 2, timestamp: now, blockRange: 1 },
+    59144: { average: 3, timestamp: now, blockRange: 1 },
+};
+/**
+ * @description Compute the average block time over a block range.
+ * @returns Average number of seconds per block.
+ */
+export function averageBlockTime(provider, _a) {
+    var _b = _a === void 0 ? {} : _a, highBlock = _b.highBlock, highBlockOffset = _b.highBlockOffset, blockRange = _b.blockRange;
+    return __awaiter(this, void 0, void 0, function () {
+        var chainId, cache, now, earliestBlockNumber, _c, firstBlock, lastBlock, average;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0: return [4 /*yield*/, provider.getNetwork()];
+                case 1:
+                    chainId = (_d.sent()).chainId;
+                    cache = blockTimes[chainId];
+                    now = getCurrentTime();
+                    if (isDefined(cache) && now < cache.timestamp + cacheTTL) {
+                        return [2 /*return*/, { average: cache.average, blockRange: cache.blockRange }];
+                    }
+                    if (!!isDefined(highBlock)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, provider.getBlockNumber()];
+                case 2:
+                    highBlock = _d.sent();
+                    highBlock -= highBlockOffset !== null && highBlockOffset !== void 0 ? highBlockOffset : defaultHighBlockOffset;
+                    _d.label = 3;
+                case 3:
+                    blockRange !== null && blockRange !== void 0 ? blockRange : (blockRange = defaultBlockRange);
+                    earliestBlockNumber = highBlock - blockRange;
+                    return [4 /*yield*/, Promise.all([
+                            provider.getBlock(earliestBlockNumber),
+                            provider.getBlock(highBlock),
+                        ])];
+                case 4:
+                    _c = _d.sent(), firstBlock = _c[0], lastBlock = _c[1];
+                    [firstBlock, lastBlock].forEach(function (block) {
+                        if (!isDefined(block === null || block === void 0 ? void 0 : block.timestamp)) {
+                            var network = getNetworkName(chainId);
+                            var blockNumber = block === firstBlock ? earliestBlockNumber : highBlock;
+                            throw new Error("BlockFinder: Failed to fetch block ".concat(blockNumber, " on ").concat(network));
+                        }
+                    });
+                    average = (lastBlock.timestamp - firstBlock.timestamp) / blockRange;
+                    blockTimes[chainId] = { timestamp: now, average: average, blockRange: blockRange };
+                    return [2 /*return*/, { average: average, blockRange: blockRange }];
+            }
+        });
+    });
+}
+function estimateBlocksElapsed(seconds, cushionPercentage, provider) {
+    if (cushionPercentage === void 0) { cushionPercentage = 0.0; }
+    return __awaiter(this, void 0, void 0, function () {
+        var cushionMultiplier, average;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    cushionMultiplier = cushionPercentage + 1.0;
+                    return [4 /*yield*/, averageBlockTime(provider)];
+                case 1:
+                    average = (_a.sent()).average;
+                    return [2 /*return*/, Math.floor((seconds * cushionMultiplier) / average)];
+            }
+        });
+    });
+}
+var BlockFinder = /** @class */ (function () {
+    function BlockFinder(provider, blocks) {
+        if (blocks === void 0) { blocks = []; }
+        this.provider = provider;
+        this.blocks = blocks;
+    }
+    /**
+     * @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.
+     */
+    BlockFinder.prototype.getBlockForTimestamp = function (timestamp, hints) {
+        if (hints === void 0) { hints = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var block, initialBlock, cushion, incrementDistance, _a, _b, multiplier, distance, blockNumber, block, index;
+            var _this = this;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        timestamp = Number(timestamp);
+                        assert(timestamp !== undefined && timestamp !== null, "timestamp must be provided");
+                        if (!(this.blocks.length === 0 || this.blocks[this.blocks.length - 1].timestamp < timestamp)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.getLatestBlock()];
+                    case 1:
+                        block = _c.sent();
+                        if (timestamp >= block.timestamp)
+                            return [2 /*return*/, block];
+                        _c.label = 2;
+                    case 2: 
+                    // Prime the BlockFinder cache with any supplied hints.
+                    // If the hint is accurate, then this will bypass the subsequent estimation.
+                    return [4 /*yield*/, Promise.all(Object.values(hints)
+                            .filter(function (blockNumber) { return isDefined(blockNumber); })
+                            .map(function (blockNumber) { return _this.getBlock(blockNumber); }))];
+                    case 3:
+                        // Prime the BlockFinder cache with any supplied hints.
+                        // If the hint is accurate, then this will bypass the subsequent estimation.
+                        _c.sent();
+                        if (!(this.blocks[0].timestamp > timestamp)) return [3 /*break*/, 8];
+                        initialBlock = this.blocks[0];
+                        cushion = 1;
+                        _b = (_a = Math).max;
+                        // Ensure the increment block distance is _at least_ a single block to prevent an infinite loop.
+                        return [4 /*yield*/, estimateBlocksElapsed(initialBlock.timestamp - timestamp, cushion, this.provider)];
+                    case 4:
+                        incrementDistance = _b.apply(_a, [
+                            // Ensure the increment block distance is _at least_ a single block to prevent an infinite loop.
+                            _c.sent(), 1]);
+                        multiplier = 1;
+                        _c.label = 5;
+                    case 5:
+                        distance = multiplier * incrementDistance;
+                        blockNumber = Math.max(0, initialBlock.number - distance);
+                        return [4 /*yield*/, this.getBlock(blockNumber)];
+                    case 6:
+                        block = _c.sent();
+                        if (block.timestamp <= timestamp)
+                            return [3 /*break*/, 8]; // Found an earlier block.
+                        assert(blockNumber > 0, "timestamp is before block 0"); // Block 0 was not earlier than this timestamp. The row.
+                        _c.label = 7;
+                    case 7:
+                        multiplier++;
+                        return [3 /*break*/, 5];
+                    case 8:
+                        index = sortedIndexBy(this.blocks, { timestamp: timestamp }, "timestamp");
+                        return [2 /*return*/, this.findBlock(this.blocks[index - 1], this.blocks[index], timestamp)];
+                }
+            });
+        });
+    };
+    // Grabs the most recent block and caches it.
+    BlockFinder.prototype.getLatestBlock = function () {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var block, index;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.provider.getBlock("latest")];
+                    case 1:
+                        block = _b.sent();
+                        index = sortedIndexBy(this.blocks, block, "number");
+                        if (((_a = this.blocks[index]) === null || _a === void 0 ? void 0 : _a.number) !== block.number)
+                            this.blocks.splice(index, 0, block);
+                        return [2 /*return*/, this.blocks[index]];
+                }
+            });
+        });
+    };
+    // Grabs the block for a particular number and caches it.
+    BlockFinder.prototype.getBlock = function (number) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var index, block;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        index = sortedIndexBy(this.blocks, { number: number }, "number");
+                        if (((_a = this.blocks[index]) === null || _a === void 0 ? void 0 : _a.number) === number)
+                            return [2 /*return*/, this.blocks[index]]; // Return early if block already exists.
+                        return [4 /*yield*/, this.provider.getBlock(number)];
+                    case 1:
+                        block = _c.sent();
+                        // Recompute the index after the async call since the state of this.blocks could have changed!
+                        index = sortedIndexBy(this.blocks, { number: number }, "number");
+                        // Rerun this check to avoid duplicate insertion.
+                        if (((_b = this.blocks[index]) === null || _b === void 0 ? void 0 : _b.number) === number)
+                            return [2 /*return*/, this.blocks[index]];
+                        this.blocks.splice(index, 0, block); // A simple insert at index.
+                        return [2 /*return*/, block];
+                }
+            });
+        });
+    };
+    // Return the latest block, between startBlock and endBlock, whose timestamp is <= timestamp.
+    // Effectively, this is an interpolation search algorithm to minimize block requests.
+    // Note: startBlock and endBlock _must_ be different blocks.
+    BlockFinder.prototype.findBlock = function (_startBlock, _endBlock, timestamp) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, startBlock, endBlock, totalTimeDifference, totalBlockDistance, blockPercentile, estimatedBlock, newBlock;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = [_startBlock, _endBlock], startBlock = _a[0], endBlock = _a[1];
+                        // In the case of equality, the endBlock is expected to be passed as the one whose timestamp === the requested
+                        // timestamp.
+                        if (endBlock.timestamp === timestamp)
+                            return [2 /*return*/, endBlock];
+                        // If there's no equality, but the blocks are adjacent, return the startBlock, since we want the returned block's
+                        // timestamp to be <= the requested timestamp.
+                        if (endBlock.number === startBlock.number + 1)
+                            return [2 /*return*/, startBlock];
+                        assert(endBlock.number !== startBlock.number, "startBlock cannot equal endBlock");
+                        assert(timestamp < endBlock.timestamp && timestamp > startBlock.timestamp, "timestamp not in between start and end blocks");
+                        totalTimeDifference = endBlock.timestamp - startBlock.timestamp;
+                        totalBlockDistance = endBlock.number - startBlock.number;
+                        blockPercentile = (timestamp - startBlock.timestamp) / totalTimeDifference;
+                        estimatedBlock = startBlock.number + Math.round(blockPercentile * totalBlockDistance);
+                        return [4 /*yield*/, this.getBlock(clamp(estimatedBlock, startBlock.number + 1, endBlock.number - 1))];
+                    case 1:
+                        newBlock = _b.sent();
+                        // Depending on whether the new block is below or above the timestamp, narrow the search space accordingly.
+                        if (newBlock.timestamp < timestamp) {
+                            return [2 /*return*/, this.findBlock(newBlock, endBlock, timestamp)];
+                        }
+                        else {
+                            return [2 /*return*/, this.findBlock(startBlock, newBlock, timestamp)];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return BlockFinder;
+}());
+export { BlockFinder };
+/**
+ * @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 function getCachedBlockForTimestamp(chainId, timestamp, blockFinder, cache, hints) {
+    return __awaiter(this, void 0, void 0, function () {
+        var resolver, key, result, blockNumber;
+        var _this = this;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    resolver = function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0: return [4 /*yield*/, blockFinder.getBlockForTimestamp(timestamp, hints)];
+                            case 1: return [2 /*return*/, (_a.sent()).number];
+                        }
+                    }); }); };
+                    // If no redis client, then request block from blockFinder.
+                    if (!isDefined(cache)) {
+                        return [2 /*return*/, resolver()];
+                    }
+                    key = "".concat(chainId, "_block_number_").concat(timestamp);
+                    if (!shouldCache(timestamp, getCurrentTime(), DEFAULT_CACHING_SAFE_LAG)) return [3 /*break*/, 6];
+                    return [4 /*yield*/, cache.get(key)];
+                case 1:
+                    result = _a.sent();
+                    if (!(result !== null)) return [3 /*break*/, 2];
+                    return [2 /*return*/, parseInt(result)];
+                case 2: return [4 /*yield*/, resolver()];
+                case 3:
+                    blockNumber = _a.sent();
+                    // Expire key after 90 days.
+                    return [4 /*yield*/, cache.set(key, blockNumber.toString(), 60 * 60 * 24 * 90)];
+                case 4:
+                    // Expire key after 90 days.
+                    _a.sent(); // 90 days
+                    return [2 /*return*/, blockNumber];
+                case 5: return [3 /*break*/, 7];
+                case 6: return [2 /*return*/, resolver()];
+                case 7: return [2 /*return*/];
+            }
+        });
+    });
+}
+//# sourceMappingURL=BlockUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BlockUtils.js","sourceRoot":"","sources":["../../../src/utils/BlockUtils.ts"],"names":[],"mappings":";AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAcxD,gFAAgF;AAChF,qEAAqE;AACrE,IAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,sGAAsG;AACtG,uGAAuG;AACvG,uGAAuG;AACvG,2FAA2F;AAC3F,IAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,sCAAsC;AACtC,IAAM,QAAQ,GAAG,EAAE,GAAG,EAAE,CAAC;AACzB,IAAM,GAAG,GAAG,cAAc,EAAE,CAAC,CAAC,sCAAsC;AACpE,IAAM,UAAU,GAA4C;IAC1D,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE;IACnD,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE;IACjD,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE;IACnD,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE;IACpD,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE;CACrD,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAgB,gBAAgB,CACpC,QAAkB,EAClB,EAAqD;QAArD,qBAAmD,EAAE,KAAA,EAAnD,SAAS,eAAA,EAAE,eAAe,qBAAA,EAAE,UAAU,gBAAA;;;;;wBAGvB,qBAAM,QAAQ,CAAC,UAAU,EAAE,EAAA;;oBAAtC,OAAO,GAAG,CAAC,SAA2B,CAAC,CAAC,OAAO;oBAE/C,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;oBAC5B,GAAG,GAAG,cAAc,EAAE,CAAC;oBAC7B,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,GAAG,QAAQ,EAAE;wBACxD,sBAAO,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,EAAC;qBACjE;yBAIG,CAAC,SAAS,CAAC,SAAS,CAAC,EAArB,wBAAqB;oBACX,qBAAM,QAAQ,CAAC,cAAc,EAAE,EAAA;;oBAA3C,SAAS,GAAG,SAA+B,CAAC;oBAC5C,SAAS,IAAI,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,sBAAsB,CAAC;;;oBAEzD,UAAU,aAAV,UAAU,cAAV,UAAU,IAAV,UAAU,GAAK,iBAAiB,EAAC;oBAE3B,mBAAmB,GAAG,SAAS,GAAG,UAAU,CAAC;oBACnB,qBAAM,OAAO,CAAC,GAAG,CAAC;4BAChD,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC;4BACtC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;yBAC7B,CAAC,EAAA;;oBAHI,KAA0B,SAG9B,EAHK,UAAU,QAAA,EAAE,SAAS,QAAA;oBAI5B,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,UAAC,KAAwB;wBACvD,IAAI,CAAC,SAAS,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,CAAC,EAAE;4BAChC,IAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;4BACxC,IAAM,WAAW,GAAG,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;4BAC3E,MAAM,IAAI,KAAK,CAAC,6CAAsC,WAAW,iBAAO,OAAO,CAAE,CAAC,CAAC;yBACpF;oBACH,CAAC,CAAC,CAAC;oBAEG,OAAO,GAAG,CAAC,SAAS,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;oBAC1E,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,SAAA,EAAE,UAAU,YAAA,EAAE,CAAC;oBAE9D,sBAAO,EAAE,OAAO,SAAA,EAAE,UAAU,YAAA,EAAE,EAAC;;;;CAChC;AAED,SAAe,qBAAqB,CAAC,OAAe,EAAE,iBAAuB,EAAE,QAAkB;IAA3C,kCAAA,EAAA,uBAAuB;;;;;;oBACrE,iBAAiB,GAAG,iBAAiB,GAAG,GAAG,CAAC;oBAC9B,qBAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAA;;oBAA5C,OAAO,GAAK,CAAA,SAAgC,CAAA,QAArC;oBACf,sBAAO,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,iBAAiB,CAAC,GAAG,OAAO,CAAC,EAAC;;;;CAC5D;AAOD;IACE,qBACmB,QAAkB,EAClB,MAAoB;QAApB,uBAAA,EAAA,WAAoB;QADpB,aAAQ,GAAR,QAAQ,CAAU;QAClB,WAAM,GAAN,MAAM,CAAc;IACpC,CAAC;IAEJ;;;;OAIG;IACU,0CAAoB,GAAjC,UAAkC,SAA0B,EAAE,KAA4B;QAA5B,sBAAA,EAAA,UAA4B;;;;;;;wBACxF,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;wBAC9B,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,4BAA4B,CAAC,CAAC;6BAEhF,CAAA,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,SAAS,CAAA,EAArF,wBAAqF;wBACzE,qBAAM,IAAI,CAAC,cAAc,EAAE,EAAA;;wBAAnC,KAAK,GAAG,SAA2B;wBACzC,IAAI,SAAS,IAAI,KAAK,CAAC,SAAS;4BAAE,sBAAO,KAAK,EAAC;;;oBAGjD,uDAAuD;oBACvD,4EAA4E;oBAC5E,qBAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;6BACjB,MAAM,CAAC,UAAC,WAAW,IAAK,OAAA,SAAS,CAAC,WAAW,CAAC,EAAtB,CAAsB,CAAC;6BAC/C,GAAG,CAAC,UAAC,WAAW,IAAK,OAAA,KAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAA1B,CAA0B,CAAC,CACpD,EAAA;;wBAND,uDAAuD;wBACvD,4EAA4E;wBAC5E,SAIC,CAAC;6BAGE,CAAA,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,SAAS,CAAA,EAApC,wBAAoC;wBAChC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;wBAK9B,OAAO,GAAG,CAAC,CAAC;wBACQ,KAAA,CAAA,KAAA,IAAI,CAAA,CAAC,GAAG,CAAA;wBAChC,gGAAgG;wBAChG,qBAAM,qBAAqB,CAAC,YAAY,CAAC,SAAS,GAAG,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAA;;wBAFnF,iBAAiB,GAAG;4BACxB,gGAAgG;4BAChG,SAAuF,EACvF,CAAC,EACF;wBAGQ,UAAU,GAAG,CAAC;;;wBACf,QAAQ,GAAG,UAAU,GAAG,iBAAiB,CAAC;wBAC1C,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC;wBAClD,qBAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAA;;wBAAxC,KAAK,GAAG,SAAgC;wBAC9C,IAAI,KAAK,CAAC,SAAS,IAAI,SAAS;4BAAE,wBAAM,CAAC,0BAA0B;wBACnE,MAAM,CAAC,WAAW,GAAG,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAAC,wDAAwD;;;wBALvF,UAAU,EAAE,CAAA;;;wBAUnC,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,SAAS,WAAA,EAAW,EAAE,WAAW,CAAC,CAAC;wBAC9E,sBAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,EAAC;;;;KAC9E;IAED,6CAA6C;IAC/B,oCAAc,GAA5B;;;;;;4BACgB,qBAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAA;;wBAA9C,KAAK,GAAG,SAAsC;wBAC9C,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;wBAC1D,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0CAAE,MAAM,MAAK,KAAK,CAAC,MAAM;4BAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;wBACrF,sBAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC;;;;KAC3B;IAED,yDAAyD;IAC3C,8BAAQ,GAAtB,UAAuB,MAAc;;;;;;;wBAC/B,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,MAAM,QAAA,EAAW,EAAE,QAAQ,CAAC,CAAC;wBACtE,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0CAAE,MAAM,MAAK,MAAM;4BAAE,sBAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,CAAC,wCAAwC;wBAChG,qBAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAA;;wBAA5C,KAAK,GAAG,SAAoC;wBAElD,8FAA8F;wBAC9F,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,MAAM,QAAA,EAAW,EAAE,QAAQ,CAAC,CAAC;wBAElE,iDAAiD;wBACjD,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0CAAE,MAAM,MAAK,MAAM;4BAAE,sBAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC;wBACrE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,4BAA4B;wBACjE,sBAAO,KAAK,EAAC;;;;KACd;IAED,6FAA6F;IAC7F,qFAAqF;IACrF,4DAA4D;IAC9C,+BAAS,GAAvB,UAAwB,WAAkB,EAAE,SAAgB,EAAE,SAAiB;;;;;;wBACvE,KAAyB,CAAC,WAAW,EAAE,SAAS,CAAC,EAAhD,UAAU,QAAA,EAAE,QAAQ,QAAA,CAA6B;wBACxD,8GAA8G;wBAC9G,aAAa;wBACb,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS;4BAAE,sBAAO,QAAQ,EAAC;wBAEtD,iHAAiH;wBACjH,8CAA8C;wBAC9C,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC;4BAAE,sBAAO,UAAU,EAAC;wBAEjE,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,kCAAkC,CAAC,CAAC;wBAClF,MAAM,CACJ,SAAS,GAAG,QAAQ,CAAC,SAAS,IAAI,SAAS,GAAG,UAAU,CAAC,SAAS,EAClE,+CAA+C,CAChD,CAAC;wBAGI,mBAAmB,GAAG,QAAQ,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;wBAChE,kBAAkB,GAAG,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;wBACzD,eAAe,GAAG,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,mBAAmB,CAAC;wBAC3E,cAAc,GAAG,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,kBAAkB,CAAC,CAAC;wBAG3E,qBAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAA;;wBAAjG,QAAQ,GAAG,SAAsF;wBAEvG,2GAA2G;wBAC3G,IAAI,QAAQ,CAAC,SAAS,GAAG,SAAS,EAAE;4BAClC,sBAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAC;yBACtD;6BAAM;4BACL,sBAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAC;yBACxD;;;;;KACF;IACH,kBAAC;AAAD,CAAC,AAnHD,IAmHC;;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,0BAA0B,CAC9C,OAAe,EACf,SAAiB,EACjB,WAAwB,EACxB,KAAiC,EACjC,KAAwB;;;;;;;oBAIlB,QAAQ,GAAG;;oCAAa,qBAAM,WAAW,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC,EAAA;oCAAzD,sBAAA,CAAC,SAAwD,CAAC,CAAC,MAAM,EAAA;;6BAAA,CAAC;oBAE/F,2DAA2D;oBAC3D,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;wBACrB,sBAAO,QAAQ,EAAE,EAAC;qBACnB;oBAKK,GAAG,GAAG,UAAG,OAAO,2BAAiB,SAAS,CAAE,CAAC;yBAE/C,WAAW,CAAC,SAAS,EAAE,cAAc,EAAE,EAAE,wBAAwB,CAAC,EAAlE,wBAAkE;oBAErD,qBAAM,KAAK,CAAC,GAAG,CAAS,GAAG,CAAC,EAAA;;oBAArC,MAAM,GAAG,SAA4B;yBAEvC,CAAA,MAAM,KAAK,IAAI,CAAA,EAAf,wBAAe;oBACjB,sBAAO,QAAQ,CAAC,MAAM,CAAC,EAAC;wBAIJ,qBAAM,QAAQ,EAAE,EAAA;;oBAA9B,WAAW,GAAG,SAAgB;oBACpC,4BAA4B;oBAC5B,qBAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,QAAQ,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAA;;oBAD/D,4BAA4B;oBAC5B,SAA+D,CAAC,CAAC,UAAU;oBAC3E,sBAAO,WAAW,EAAC;;wBAKrB,sBAAO,QAAQ,EAAE,EAAC;;;;;CAErB"}

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

@@ -0,0 +1,29 @@
+import { AcrossConfigStoreClient, HubPoolClient } from "../clients";
+import { ProposedRootBundle } from "../interfaces";
+/**
+ * Return block number for `chain` in `bundleEvaluationBlockNumbers` using the mapping
+ * in `chainIdListForBundleEvaluationBlockNumbers` to figure out which index in `bundleEvaluationBlockNumbers`
+ * the block for `chain` is
+ * @param bundleEvaluationBlockNumbers Usually, the bundle end blocks proposed in a root bundle.
+ * @param chain The chain to look up block for
+ * @param chainIdListForBundleEvaluationBlockNumbers The hardcoded sequence of chain IDs. For example:
+ * [1, 10, 137, 288, 42161] implies that if we're looking for the block for chain 137, it's at index 2 in
+ * `bundleEvaluationBlockNumbers`.
+ * @returns The block for `chain` in `bundleEvaluationBlockNumbers`.
+ */
+export declare function getBlockForChain(bundleEvaluationBlockNumbers: number[], chain: number, chainIdListForBundleEvaluationBlockNumbers: number[]): number;
+/**
+ * Similar concept as `getBlockForChain`, but returns the block range for `chain` in `blockRanges`.
+ * @param blockRanges
+ * @param chain
+ * @param chainIdListForBundleEvaluationBlockNumbers
+ * @returns
+ */
+export declare function getBlockRangeForChain(blockRanges: number[][], chain: number, chainIdListForBundleEvaluationBlockNumbers: number[]): number[];
+/**
+ * Return bundle block range for `rootBundle` whose bundle end blocks were included in the proposal.
+ * This amounts to reconstructing the bundle range start block.
+ * @param rootBundle Root bundle to return bundle block range for
+ * @returns blockRanges: number[][], [[startBlock, endBlock], [startBlock, endBlock], ...]
+ */
+export declare function getImpliedBundleBlockRanges(hubPoolClient: HubPoolClient, configStoreClient: AcrossConfigStoreClient, rootBundle: ProposedRootBundle): number[][];

package/dist/esm/utils/BundleUtils.js

@@ -0,0 +1,89 @@
+/**
+ * Return block number for `chain` in `bundleEvaluationBlockNumbers` using the mapping
+ * in `chainIdListForBundleEvaluationBlockNumbers` to figure out which index in `bundleEvaluationBlockNumbers`
+ * the block for `chain` is
+ * @param bundleEvaluationBlockNumbers Usually, the bundle end blocks proposed in a root bundle.
+ * @param chain The chain to look up block for
+ * @param chainIdListForBundleEvaluationBlockNumbers The hardcoded sequence of chain IDs. For example:
+ * [1, 10, 137, 288, 42161] implies that if we're looking for the block for chain 137, it's at index 2 in
+ * `bundleEvaluationBlockNumbers`.
+ * @returns The block for `chain` in `bundleEvaluationBlockNumbers`.
+ */
+export function getBlockForChain(bundleEvaluationBlockNumbers, chain, chainIdListForBundleEvaluationBlockNumbers) {
+    var indexForChain = chainIdListForBundleEvaluationBlockNumbers.indexOf(chain);
+    if (indexForChain === -1) {
+        throw new Error("Could not find chain ".concat(chain, " in chain ID list ").concat(chainIdListForBundleEvaluationBlockNumbers));
+    }
+    var blockForChain = bundleEvaluationBlockNumbers[indexForChain];
+    if (blockForChain === undefined) {
+        throw new Error("Invalid block range for chain ".concat(chain));
+    }
+    return blockForChain;
+}
+/**
+ * Similar concept as `getBlockForChain`, but returns the block range for `chain` in `blockRanges`.
+ * @param blockRanges
+ * @param chain
+ * @param chainIdListForBundleEvaluationBlockNumbers
+ * @returns
+ */
+export function getBlockRangeForChain(blockRanges, chain, chainIdListForBundleEvaluationBlockNumbers) {
+    var indexForChain = chainIdListForBundleEvaluationBlockNumbers.indexOf(chain);
+    if (indexForChain === -1) {
+        throw new Error("Could not find chain ".concat(chain, " in chain ID list ").concat(chainIdListForBundleEvaluationBlockNumbers));
+    }
+    var blockRangeForChain = blockRanges[indexForChain];
+    if (!blockRangeForChain || blockRangeForChain.length !== 2) {
+        throw new Error("Invalid block range for chain ".concat(chain));
+    }
+    return blockRangeForChain;
+}
+/**
+ * Return bundle block range for `rootBundle` whose bundle end blocks were included in the proposal.
+ * This amounts to reconstructing the bundle range start block.
+ * @param rootBundle Root bundle to return bundle block range for
+ * @returns blockRanges: number[][], [[startBlock, endBlock], [startBlock, endBlock], ...]
+ */
+export function getImpliedBundleBlockRanges(hubPoolClient, configStoreClient, rootBundle) {
+    var _a;
+    var prevRootBundle = hubPoolClient.getLatestFullyExecutedRootBundle(rootBundle.blockNumber);
+    // If chain is disabled for this bundle block range, end block should be same as previous bundle.
+    // Otherwise the range should be previous bundle's endBlock + 1 to current bundle's end block.
+    // Get enabled chains at the mainnet start block of the current root bundle.
+    // We'll check each chain represented in the bundleEvaluationBlockNumbers to see if it's enabled and
+    // use that to determine the implied block range.
+    var mainnetStartBlock = (_a = prevRootBundle === null || prevRootBundle === void 0 ? void 0 : prevRootBundle.bundleEvaluationBlockNumbers[0].toNumber()) !== null && _a !== void 0 ? _a : 0;
+    var enabledChainsAtMainnetStartBlock = configStoreClient.getEnabledChains(mainnetStartBlock);
+    // Load all chain indices in order to map bundle evaluation block numbers to enabled chains list.
+    var chainIdIndices = configStoreClient.getChainIdIndicesForBlock(rootBundle.blockNumber);
+    var result = rootBundle.bundleEvaluationBlockNumbers.map(function (endBlock, i) {
+        var _a;
+        var fromBlock = ((_a = prevRootBundle === null || prevRootBundle === void 0 ? void 0 : prevRootBundle.bundleEvaluationBlockNumbers) === null || _a === void 0 ? void 0 : _a[i])
+            ? prevRootBundle.bundleEvaluationBlockNumbers[i].toNumber() + 1
+            : 0;
+        var chainId = chainIdIndices[i];
+        if (!enabledChainsAtMainnetStartBlock.includes(chainId)) {
+            return [endBlock.toNumber(), endBlock.toNumber()];
+        }
+        return [fromBlock, endBlock.toNumber()];
+    });
+    // Lastly, sanity check the results to catch errors early:
+    // 1. If the chain is enabled, the start block should be strictly less than to the end block.
+    // 2. If the chain is disabled, the start block should be equal to the end block.
+    result.forEach(function (_a, i) {
+        var start = _a[0], end = _a[1];
+        var chainId = chainIdIndices[i];
+        if (enabledChainsAtMainnetStartBlock.includes(chainId)) {
+            if (start >= end) {
+                throw new Error("Invalid block range for enabled chain ".concat(chainId, ": start block ").concat(start, " is greater than or equal to end block ").concat(end));
+            }
+        }
+        else {
+            if (start !== end) {
+                throw new Error("Invalid block range for disabled chain ".concat(chainId, ": start block ").concat(start, " is not equal to end block ").concat(end));
+            }
+        }
+    });
+    return result;
+}
+//# sourceMappingURL=BundleUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BundleUtils.js","sourceRoot":"","sources":["../../../src/utils/BundleUtils.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,4BAAsC,EACtC,KAAa,EACb,0CAAoD;IAEpD,IAAM,aAAa,GAAG,0CAA0C,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,+BAAwB,KAAK,+BAAqB,0CAA0C,CAAE,CAAC,CAAC;KACjH;IACD,IAAM,aAAa,GAAG,4BAA4B,CAAC,aAAa,CAAC,CAAC;IAClE,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,wCAAiC,KAAK,CAAE,CAAC,CAAC;KAC3D;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,WAAuB,EACvB,KAAa,EACb,0CAAoD;IAEpD,IAAM,aAAa,GAAG,0CAA0C,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,+BAAwB,KAAK,+BAAqB,0CAA0C,CAAE,CAAC,CAAC;KACjH;IACD,IAAM,kBAAkB,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IACtD,IAAI,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1D,MAAM,IAAI,KAAK,CAAC,wCAAiC,KAAK,CAAE,CAAC,CAAC;KAC3D;IACD,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,aAA4B,EAC5B,iBAA0C,EAC1C,UAA8B;;IAE9B,IAAM,cAAc,GAAG,aAAa,CAAC,gCAAgC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC9F,iGAAiG;IACjG,8FAA8F;IAE9F,4EAA4E;IAC5E,oGAAoG;IACpG,iDAAiD;IACjD,IAAM,iBAAiB,GAAG,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,4BAA4B,CAAC,CAAC,EAAE,QAAQ,EAAE,mCAAI,CAAC,CAAC;IAC1F,IAAM,gCAAgC,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IAE/F,iGAAiG;IACjG,IAAM,cAAc,GAAG,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3F,IAAM,MAAM,GAAG,UAAU,CAAC,4BAA4B,CAAC,GAAG,CAAC,UAAC,QAAQ,EAAE,CAAC;;QACrE,IAAM,SAAS,GAAG,CAAA,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,4BAA4B,0CAAG,CAAC,CAAC;YACjE,CAAC,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC;YAC/D,CAAC,CAAC,CAAC,CAAC;QACN,IAAM,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,CAAC,gCAAgC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;SACnD;QACD,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,0DAA0D;IAC1D,6FAA6F;IAC7F,iFAAiF;IACjF,MAAM,CAAC,OAAO,CAAC,UAAC,EAAY,EAAE,CAAC;YAAd,KAAK,QAAA,EAAE,GAAG,QAAA;QACzB,IAAM,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,gCAAgC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YACtD,IAAI,KAAK,IAAI,GAAG,EAAE;gBAChB,MAAM,IAAI,KAAK,CACb,gDAAyC,OAAO,2BAAiB,KAAK,oDAA0C,GAAG,CAAE,CACtH,CAAC;aACH;SACF;aAAM;YACL,IAAI,KAAK,KAAK,GAAG,EAAE;gBACjB,MAAM,IAAI,KAAK,CACb,iDAA0C,OAAO,2BAAiB,KAAK,wCAA8B,GAAG,CAAE,CAC3G,CAAC;aACH;SACF;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,17 @@
+import { CachingMechanismInterface, Deposit, Fill, SlowFillRequest } from "../interfaces";
+export declare function shouldCache(eventTimestamp: number, latestTime: number, cachingMaxAge: number): boolean;
+/**
+ * Calls the cache's get method and returns the result if it is defined, otherwise returns undefined.
+ * @param key The key to get from the cache.
+ * @param cache The cache to get the key from.
+ * @returns The value associated with the key in the cache, or undefined if the key is not in the cache.
+ */
+export declare function getDepositInCache(key: string, cache: CachingMechanismInterface): Promise<Deposit | undefined>;
+export declare function setDepositInCache(deposit: Deposit, currentChainTime: number, cache: CachingMechanismInterface, expirySeconds?: number, timeToCache?: number): Promise<void>;
+/**
+ * Resolves the key for caching a bridge event.
+ * @param bridgeEvent The depositId, and originChainId are used to generate the key for v2, and the
+ * full V3 relay hash is used for v3 events..
+ * @returns The key for caching the event.
+ */
+export declare function getDepositKey(bridgeEvent: Deposit | Fill | SlowFillRequest): string;

package/dist/esm/utils/CachingUtils.js

@@ -0,0 +1,66 @@
+import { __awaiter, __generator } from "tslib";
+import { DEFAULT_CACHING_SAFE_LAG, DEFAULT_CACHING_TTL } from "../constants";
+import { assert } from "./LogUtils";
+import { composeRevivers, objectWithBigNumberReviver } from "./ReviverUtils";
+import { getRelayHashFromEvent } from "./SpokeUtils";
+import { getCurrentTime } from "./TimeUtils";
+import { isDefined } from "./TypeGuards";
+export function shouldCache(eventTimestamp, latestTime, cachingMaxAge) {
+    assert(eventTimestamp.toString().length === 10, "eventTimestamp must be in seconds");
+    assert(latestTime.toString().length === 10, "eventTimestamp must be in seconds");
+    return latestTime - eventTimestamp >= cachingMaxAge;
+}
+/**
+ * Calls the cache's get method and returns the result if it is defined, otherwise returns undefined.
+ * @param key The key to get from the cache.
+ * @param cache The cache to get the key from.
+ * @returns The value associated with the key in the cache, or undefined if the key is not in the cache.
+ */
+export function getDepositInCache(key, cache) {
+    return __awaiter(this, void 0, void 0, function () {
+        var depositRaw;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, cache.get(key)];
+                case 1:
+                    depositRaw = _a.sent();
+                    return [2 /*return*/, isDefined(depositRaw) ? JSON.parse(depositRaw, composeRevivers(objectWithBigNumberReviver)) : undefined];
+            }
+        });
+    });
+}
+export function setDepositInCache(deposit, currentChainTime, cache, expirySeconds, timeToCache) {
+    if (expirySeconds === void 0) { expirySeconds = DEFAULT_CACHING_TTL; }
+    if (timeToCache === void 0) { timeToCache = DEFAULT_CACHING_SAFE_LAG; }
+    return __awaiter(this, void 0, void 0, function () {
+        var currentTimeInSeconds;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    currentTimeInSeconds = getCurrentTime();
+                    // We should first confirm that neither the deposit's quoteTimestamp nor the currentChainTime
+                    // are in the future. If they are, we should not cache the deposit.
+                    if (deposit.quoteTimestamp > currentTimeInSeconds || currentChainTime > currentTimeInSeconds) {
+                        return [2 /*return*/];
+                    }
+                    if (!shouldCache(deposit.quoteTimestamp, currentChainTime, timeToCache)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, cache.set(getDepositKey(deposit), JSON.stringify(deposit), expirySeconds)];
+                case 1:
+                    _a.sent();
+                    _a.label = 2;
+                case 2: return [2 /*return*/];
+            }
+        });
+    });
+}
+/**
+ * Resolves the key for caching a bridge event.
+ * @param bridgeEvent The depositId, and originChainId are used to generate the key for v2, and the
+ * full V3 relay hash is used for v3 events..
+ * @returns The key for caching the event.
+ */
+export function getDepositKey(bridgeEvent) {
+    var relayHash = getRelayHashFromEvent(bridgeEvent);
+    return "deposit_".concat(bridgeEvent.originChainId, "_").concat(bridgeEvent.depositId, "_").concat(relayHash);
+}
+//# sourceMappingURL=CachingUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CachingUtils.js","sourceRoot":"","sources":["../../../src/utils/CachingUtils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,UAAU,WAAW,CAAC,cAAsB,EAAE,UAAkB,EAAE,aAAqB;IAC3F,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,mCAAmC,CAAC,CAAC;IACrF,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,mCAAmC,CAAC,CAAC;IACjF,OAAO,UAAU,GAAG,cAAc,IAAI,aAAa,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAgB,iBAAiB,CAAC,GAAW,EAAE,KAAgC;;;;;wBAChE,qBAAM,KAAK,CAAC,GAAG,CAAS,GAAG,CAAC,EAAA;;oBAAzC,UAAU,GAAG,SAA4B;oBAC/C,sBAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,eAAe,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAC;;;;CAChH;AAED,MAAM,UAAgB,iBAAiB,CACrC,OAAgB,EAChB,gBAAwB,EACxB,KAAgC,EAChC,aAAmC,EACnC,WAAsC;IADtC,8BAAA,EAAA,mCAAmC;IACnC,4BAAA,EAAA,sCAAsC;;;;;;oBAEhC,oBAAoB,GAAG,cAAc,EAAE,CAAC;oBAC9C,6FAA6F;oBAC7F,mEAAmE;oBACnE,IAAI,OAAO,CAAC,cAAc,GAAG,oBAAoB,IAAI,gBAAgB,GAAG,oBAAoB,EAAE;wBAC5F,sBAAO;qBACR;yBAIG,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,EAAE,WAAW,CAAC,EAAlE,wBAAkE;oBACpE,qBAAM,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAA;;oBAA/E,SAA+E,CAAC;;;;;;CAEnF;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,WAA6C;IACzE,IAAM,SAAS,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IACrD,OAAO,kBAAW,WAAW,CAAC,aAAa,cAAI,WAAW,CAAC,SAAS,cAAI,SAAS,CAAE,CAAC;AACtF,CAAC"}

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

@@ -0,0 +1 @@
+export { getContractInfoFromAddress, getDeployedAddress, getDeployedBlockNumber, } from "@across-protocol/contracts/dist/src/DeploymentUtils";

package/dist/esm/utils/DeploymentUtils.js

@@ -0,0 +1,2 @@
+export { getContractInfoFromAddress, getDeployedAddress, getDeployedBlockNumber, } from "@across-protocol/contracts/dist/src/DeploymentUtils";
+//# sourceMappingURL=DeploymentUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DeploymentUtils.js","sourceRoot":"","sources":["../../../src/utils/DeploymentUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,qDAAqD,CAAC"}

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

@@ -0,0 +1,46 @@
+import { SpokePoolClient } from "../clients";
+import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillRequest } from "../interfaces";
+export declare enum InvalidFill {
+    DepositIdInvalid = 0,
+    DepositIdNotFound = 1,
+    FillMismatch = 2
+}
+export type DepositSearchResult = {
+    found: true;
+    deposit: DepositWithBlock;
+} | {
+    found: false;
+    code: InvalidFill;
+    reason: string;
+};
+/**
+ * Attempts to resolve a deposit for a fill. If the fill's deposit Id is within the spoke pool client's search range,
+ * the deposit is returned immediately. Otherwise, the deposit is queried first from the provided cache, and if it is
+ * not found in the cache, it is queried from the spoke pool client. If the deposit is found, it is cached before
+ * being returned.
+ * @param spokePoolClient The spoke pool client to use to query the deposit.
+ * @param fill The fill to resolve a deposit for.
+ * @param cache An optional cache to use to store the deposit. Optional.
+ * @returns The deposit for the fill, or undefined if the deposit could not be found.
+ * @throws If the fill's origin chain ID does not match the spoke pool client's chain ID.
+ * @throws If the spoke pool client has not been updated.
+ */
+export declare function queryHistoricalDepositForFill(spokePoolClient: SpokePoolClient, fill: Fill | SlowFillRequest, cache?: CachingMechanismInterface): Promise<DepositSearchResult>;
+/**
+ * Determines if a message is empty or not.
+ * @param message The message to check.
+ * @returns True if the message is empty, false otherwise.
+ */
+export declare function isMessageEmpty(message?: string): boolean;
+/**
+ * Determines if a deposit was updated via a speed-up transaction.
+ * @param deposit Deposit to evaluate.
+ * @returns True if the deposit was updated, otherwise false.
+ */
+export declare function isDepositSpedUp(deposit: Deposit): boolean;
+/**
+ * Resolves the applicable message for a deposit.
+ * @param deposit Deposit to evaluate.
+ * @returns Original or updated message string, depending on whether the depositor updated the deposit.
+ */
+export declare function resolveDepositMessage(deposit: Deposit): string;