@across-protocol/sdk 3.0.0

package/dist/esm/clients/SpokePoolClient.js

@@ -0,0 +1,780 @@
+import { __assign, __awaiter, __extends, __generator, __spreadArray } from "tslib";
+import { BigNumber } from "ethers";
+import { bnZero, MAX_BIG_INT, assign, getRelayDataHash, isDefined, toBN, } from "../utils";
+import { paginatedEventQuery, sortEventsAscendingInPlace, spreadEvent, spreadEventWithBlockNumber, } from "../utils/EventUtils";
+import { validateFillForDeposit } from "../utils/FlowUtils";
+import { ZERO_ADDRESS } from "../constants";
+import { chainIsCCTPEnabled, getNetworkName } from "../utils/NetworkUtils";
+import { getBlockRangeForDepositId, getDepositIdAtBlock } from "../utils/SpokeUtils";
+import { BaseAbstractClient, isUpdateFailureReason } from "./BaseAbstractClient";
+/**
+ * SpokePoolClient is a client for the SpokePool contract. It is responsible for querying the SpokePool contract
+ * for events and storing them in memory. It also provides some convenience methods for querying the stored events.
+ */
+var SpokePoolClient = /** @class */ (function (_super) {
+    __extends(SpokePoolClient, _super);
+    /**
+     * Creates a new SpokePoolClient.
+     * @param logger A logger instance.
+     * @param spokePool The SpokePool contract instance that this client will query.
+     * @param hubPoolClient An optional HubPoolClient instance. This is used to fetch spoke data that is not stored on the SpokePool contract but is stored on the HubPool contract.
+     * @param chainId The chain ID of the chain that this client is querying.
+     * @param deploymentBlock The block number that the SpokePool contract was deployed at.
+     * @param eventSearchConfig An optional EventSearchConfig object that controls how far back in history the client will search for events. If not provided, the client will only search for events from the deployment block.
+     */
+    function SpokePoolClient(logger, spokePool, 
+    // Can be excluded. This disables some deposit validation.
+    hubPoolClient, chainId, deploymentBlock, eventSearchConfig) {
+        if (eventSearchConfig === void 0) { eventSearchConfig = { fromBlock: 0, maxBlockLookBack: 0 }; }
+        var _this = _super.call(this, eventSearchConfig) || this;
+        _this.logger = logger;
+        _this.spokePool = spokePool;
+        _this.hubPoolClient = hubPoolClient;
+        _this.chainId = chainId;
+        _this.deploymentBlock = deploymentBlock;
+        _this.currentTime = 0;
+        _this.oldestTime = 0;
+        _this.depositHashes = {};
+        _this.depositHashesToFills = {};
+        _this.speedUps = {};
+        _this.slowFillRequests = {};
+        _this.depositRoutes = {};
+        _this.tokensBridged = [];
+        _this.rootBundleRelays = [];
+        _this.relayerRefundExecutions = [];
+        _this.queryableEventNames = [];
+        _this.hasCCTPBridgingEnabled = false;
+        _this.earliestDepositIdQueried = Number.MAX_SAFE_INTEGER;
+        _this.latestDepositIdQueried = 0;
+        _this.firstDepositIdForSpokePool = Number.MAX_SAFE_INTEGER;
+        _this.lastDepositIdForSpokePool = Number.MAX_SAFE_INTEGER;
+        _this.fills = {};
+        _this.firstBlockToSearch = eventSearchConfig.fromBlock;
+        _this.latestBlockSearched = 0;
+        _this.queryableEventNames = Object.keys(_this._queryableEventNames());
+        return _this;
+    }
+    SpokePoolClient.prototype._queryableEventNames = function () {
+        var _this = this;
+        var knownEventNames = [
+            "EnabledDepositRoute",
+            "TokensBridged",
+            "RelayedRootBundle",
+            "ExecutedRelayerRefundRoot",
+            "V3FundsDeposited",
+            "RequestedSpeedUpV3Deposit",
+            "RequestedV3SlowFill",
+            "FilledV3Relay",
+        ];
+        return Object.fromEntries(this.spokePool.interface.fragments
+            .filter(function (_a) {
+            var name = _a.name, type = _a.type;
+            return type === "event" && knownEventNames.includes(name);
+        })
+            .map(function (_a) {
+            var name = _a.name;
+            return [name, _this.spokePool.filters[name]()];
+        }));
+    };
+    /**
+     * Retrieves a list of deposits from the SpokePool contract destined for the given destination chain ID.
+     * @param destinationChainId The destination chain ID.
+     * @returns A list of deposits.
+     */
+    SpokePoolClient.prototype.getDepositsForDestinationChain = function (destinationChainId) {
+        return Object.values(this.depositHashes).filter(function (deposit) { return deposit.destinationChainId === destinationChainId; });
+    };
+    /**
+     * Retrieves a list of deposits from the SpokePool contract that are associated with this spoke pool.
+     * @returns A list of deposits.
+     * @note This method returns all deposits, regardless of destination chain ID in sorted order.
+     */
+    SpokePoolClient.prototype.getDeposits = function (filter) {
+        var deposits = Object.values(this.depositHashes);
+        if (isDefined(filter)) {
+            var fromBlock_1 = filter.fromBlock, toBlock_1 = filter.toBlock;
+            deposits = deposits.filter(function (_a) {
+                var blockNumber = _a.blockNumber;
+                return blockNumber >= fromBlock_1 && toBlock_1 >= blockNumber;
+            });
+        }
+        return sortEventsAscendingInPlace(deposits);
+    };
+    /**
+     * Retrieves a list of the tokens that have been bridged.
+     * @returns A list of tokens.
+     */
+    SpokePoolClient.prototype.getTokensBridged = function () {
+        return this.tokensBridged;
+    };
+    /**
+     * Certain spoke pools can bridge USDC back to the hub via CCTP. Of these spokes, not all
+     * have this feature enabled.
+     * @returns Whether or not this spoke pool is capable of bridging USDC via CCTP back to the hub
+     */
+    SpokePoolClient.prototype.isCCTPBridgingEnabled = function () {
+        return this.hasCCTPBridgingEnabled;
+    };
+    /**
+     * Retrieves a mapping of tokens and their associated destination chain IDs that can be bridged.
+     * @returns A mapping of tokens and their associated destination chain IDs in a nested mapping.
+     */
+    SpokePoolClient.prototype.getDepositRoutes = function () {
+        return this.depositRoutes;
+    };
+    /**
+     * Determines whether a deposit route is enabled for the given origin token and destination chain ID.
+     * @param originToken The origin token address.
+     * @param destinationChainId The destination chain ID.
+     * @returns True if the deposit route is enabled, false otherwise.
+     */
+    SpokePoolClient.prototype.isDepositRouteEnabled = function (originToken, destinationChainId) {
+        var _a, _b;
+        return (_b = (_a = this.depositRoutes[originToken]) === null || _a === void 0 ? void 0 : _a[destinationChainId]) !== null && _b !== void 0 ? _b : false;
+    };
+    /**
+     * Retrieves a list of all the available origin tokens that can be bridged.
+     * @returns A list of origin tokens.
+     */
+    SpokePoolClient.prototype.getAllOriginTokens = function () {
+        return Object.keys(this.depositRoutes);
+    };
+    /**
+     * Retrieves a list of fills from the SpokePool contract.
+     * @returns A list of fills.
+     */
+    SpokePoolClient.prototype.getFills = function () {
+        return sortEventsAscendingInPlace(Object.values(this.fills).flat());
+    };
+    /**
+     * Retrieves a list of fills from a specific origin chain ID.
+     * @param originChainId The origin chain ID.
+     * @returns A list of fills.
+     */
+    SpokePoolClient.prototype.getFillsForOriginChain = function (originChainId) {
+        return this.fills[originChainId] || [];
+    };
+    /**
+     * Retrieves a list of fills from a specific relayer address.
+     * @param relayer The relayer address.
+     * @returns A list of fills.
+     */
+    SpokePoolClient.prototype.getFillsForRelayer = function (relayer) {
+        return this.getFills().filter(function (fill) { return fill.relayer === relayer; });
+    };
+    /**
+     * Retrieves a list of fills from a given block range.
+     * @param startingBlock The starting block number.
+     * @param endingBlock The ending block number.
+     * @returns A list of fills.
+     */
+    SpokePoolClient.prototype.getFillsWithBlockInRange = function (startingBlock, endingBlock) {
+        return this.getFills().filter(function (fill) { return fill.blockNumber >= startingBlock && fill.blockNumber <= endingBlock; });
+    };
+    /**
+     * Retrieves a list of root bundle relays from the SpokePool contract.
+     * @returns A list of root bundle relays.
+     */
+    SpokePoolClient.prototype.getRootBundleRelays = function () {
+        return this.rootBundleRelays;
+    };
+    /**
+     * Retrieves the ID of the latest root bundle.
+     * @returns The ID of the latest root bundle. This will be 0 if no root bundles have been relayed.
+     */
+    SpokePoolClient.prototype.getLatestRootBundleId = function () {
+        var _a;
+        return this.rootBundleRelays.length > 0
+            ? ((_a = this.rootBundleRelays[this.rootBundleRelays.length - 1]) === null || _a === void 0 ? void 0 : _a.rootBundleId) + 1
+            : 0;
+    };
+    /**
+     * Retrieves a list of relayer refund executions from the SpokePool contract.
+     * @returns A list of relayer refund executions.
+     */
+    SpokePoolClient.prototype.getRelayerRefundExecutions = function () {
+        return this.relayerRefundExecutions;
+    };
+    /**
+     * Appends a speed up signature to a specific deposit.
+     * @param deposit The deposit to append the speed up signature to.
+     * @returns A new deposit instance with the speed up signature appended to the deposit.
+     */
+    SpokePoolClient.prototype.appendMaxSpeedUpSignatureToDeposit = function (deposit) {
+        var _a;
+        var depositId = deposit.depositId, depositor = deposit.depositor;
+        var speedups = (_a = this.speedUps[depositor]) === null || _a === void 0 ? void 0 : _a[depositId];
+        if (!isDefined(speedups) || speedups.length === 0) {
+            return deposit;
+        }
+        var maxSpeedUp = speedups.reduce(function (prev, current) {
+            return prev.updatedOutputAmount.lt(current.updatedOutputAmount) ? prev : current;
+        });
+        // We assume that the depositor authorises SpeedUps in isolation of each other, which keeps the relayer
+        // logic simple: find the SpeedUp with the lowest updatedOutputAmount, and use all of its fields.
+        if (maxSpeedUp.updatedOutputAmount.gte(deposit.outputAmount)) {
+            return deposit;
+        }
+        // Return deposit with updated params from the speedup with the lowest updated output amount.
+        var updatedDeposit = __assign(__assign({}, deposit), { speedUpSignature: maxSpeedUp.depositorSignature, updatedOutputAmount: maxSpeedUp.updatedOutputAmount, updatedRecipient: maxSpeedUp.updatedRecipient, updatedMessage: maxSpeedUp.updatedMessage });
+        return updatedDeposit;
+    };
+    /**
+     * Find a deposit based on its deposit ID.
+     * @notice If evaluating a fill, be sure to verify it against the resulting deposit.
+     * @param depositId The unique ID of the deposit being queried.
+     * @returns The corresponding deposit if found, undefined otherwise.
+     */
+    SpokePoolClient.prototype.getDeposit = function (depositId) {
+        var depositHash = this.getDepositHash({ depositId: depositId, originChainId: this.chainId });
+        return this.depositHashes[depositHash];
+    };
+    /**
+     * Find a SlowFillRequested event based on its deposit RelayData.
+     * @param relayData RelayData field for the SlowFill request.
+     * @returns The corresponding SlowFIllRequest event if found, otherwise undefined.
+     */
+    SpokePoolClient.prototype.getSlowFillRequest = function (relayData) {
+        var hash = getRelayDataHash(relayData, this.chainId);
+        return this.slowFillRequests[hash];
+    };
+    /**
+     * Retrieves a list of slow fill requests for deposits from a specific origin chain ID.
+     * @param originChainId The origin chain ID.
+     * @returns A list of slow fill requests.
+     */
+    SpokePoolClient.prototype.getSlowFillRequestsForOriginChain = function (originChainId) {
+        return Object.values(this.slowFillRequests).filter(function (e) { return e.originChainId === originChainId; });
+    };
+    /**
+     * Find a corresponding deposit for a given fill.
+     * @param fill The fill to find a corresponding deposit for.
+     * @returns The corresponding deposit if found, undefined otherwise.
+     */
+    SpokePoolClient.prototype.getDepositForFill = function (fill) {
+        var depositWithMatchingDepositId = this.depositHashes[this.getDepositHash(fill)];
+        return validateFillForDeposit(fill, depositWithMatchingDepositId) ? depositWithMatchingDepositId : undefined;
+    };
+    /**
+     * Find the unfilled amount for a given deposit. This is the full deposit amount minus the total filled amount.
+     * @param deposit The deposit to find the unfilled amount for.
+     * @param fillCount The number of fills that have been applied to this deposit.
+     * @param invalidFills The invalid fills that have been applied to this deposit.
+     * @returns The unfilled amount.
+     */
+    SpokePoolClient.prototype.getValidUnfilledAmountForDeposit = function (deposit) {
+        var outputAmount = deposit.outputAmount;
+        var fillsForDeposit = this.depositHashesToFills[this.getDepositHash(deposit)];
+        // If no fills then the full amount is remaining.
+        if (fillsForDeposit === undefined || fillsForDeposit.length === 0) {
+            return { unfilledAmount: toBN(outputAmount), fillCount: 0, invalidFills: [] };
+        }
+        var _a = fillsForDeposit.reduce(function (groupedFills, fill) {
+            if (validateFillForDeposit(fill, deposit)) {
+                groupedFills.validFills.push(fill);
+            }
+            else {
+                groupedFills.invalidFills.push(fill);
+            }
+            return groupedFills;
+        }, { validFills: [], invalidFills: [] }), validFills = _a.validFills, invalidFills = _a.invalidFills;
+        // Log any invalid deposits with same deposit id but different params.
+        var invalidFillsForDeposit = invalidFills.filter(function (x) { return x.depositId === deposit.depositId; });
+        if (invalidFillsForDeposit.length > 0) {
+            this.logger.warn({
+                at: "SpokePoolClient",
+                chainId: this.chainId,
+                message: "Invalid fills found matching deposit ID",
+                deposit: deposit,
+                invalidFills: Object.fromEntries(invalidFillsForDeposit.map(function (x) { return [x.relayer, x]; })),
+                notificationPath: "across-invalid-fills",
+            });
+        }
+        // If all fills are invalid we can consider this unfilled.
+        if (validFills.length === 0) {
+            return { unfilledAmount: toBN(outputAmount), fillCount: 0, invalidFills: invalidFills };
+        }
+        return {
+            unfilledAmount: bnZero,
+            fillCount: validFills.length,
+            invalidFills: invalidFills,
+        };
+    };
+    /**
+     * Formulate a hash for a given deposit or fill
+     * @param event The deposit or fill to formulate a hash for.
+     * @returns The hash.
+     * @note This hash is used to match deposits and fills together.
+     * @note This hash takes the form of: `${depositId}-${originChainId}`.
+     */
+    SpokePoolClient.prototype.getDepositHash = function (event) {
+        return "".concat(event.depositId, "-").concat(event.originChainId);
+    };
+    /**
+     * 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.
+     */
+    SpokePoolClient.prototype._getBlockRangeForDepositId = function (targetDepositId, initLow, initHigh, maxSearches) {
+        return getBlockRangeForDepositId(targetDepositId, initLow, initHigh, maxSearches, this);
+    };
+    /**
+     * 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.
+     */
+    SpokePoolClient.prototype._getDepositIdAtBlock = function (blockTag) {
+        return getDepositIdAtBlock(this.spokePool, blockTag);
+    };
+    /**
+     * @notice Return maximum of fill deadline buffer at start and end of block range. This is a contract
+     * immutable state variable so we can't query other events to find its updates.
+     * @dev V3 deposits have a fill deadline which can be set to a maximum of fillDeadlineBuffer + deposit.block.timestamp.
+     * Therefore, we cannot evaluate a block range for expired deposits if the spoke pool client doesn't return us
+     * deposits whose block.timestamp is within fillDeadlineBuffer of the end block time. As a conservative check,
+     * we verify that the time between the end block timestamp and the first timestamp queried by the
+     * spoke pool client is greater than the maximum of the fill deadline buffers at the start and end of the block
+     * range. We assume the fill deadline buffer wasn't changed more than once within a bundle.
+     * @param startBlock start block
+     * @param endBlock end block
+     * @returns maximum of fill deadline buffer at start and end block
+     */
+    SpokePoolClient.prototype.getMaxFillDeadlineInRange = function (startBlock, endBlock) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fillDeadlineBuffers;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, Promise.all([
+                            this.spokePool.fillDeadlineBuffer({ blockTag: startBlock }),
+                            this.spokePool.fillDeadlineBuffer({ blockTag: endBlock }),
+                        ])];
+                    case 1:
+                        fillDeadlineBuffers = _a.sent();
+                        return [2 /*return*/, Math.max(fillDeadlineBuffers[0], fillDeadlineBuffers[1])];
+                }
+            });
+        });
+    };
+    /**
+     * Performs an update to refresh the state of this client. This will query the SpokePool contract for new events
+     * and store them in memory. This method is the primary method for updating the state of this client.
+     * @param eventsToQuery An optional list of events to query. If not provided, all events will be queried.
+     * @returns A Promise that resolves to a SpokePoolUpdate object.
+     */
+    SpokePoolClient.prototype._update = function (eventsToQuery) {
+        return __awaiter(this, void 0, void 0, function () {
+            var firstDepositId, searchConfig, reason, hasCCTPBridgingEnabled, cctpBridgeAddress, _a, eventSearchConfigs, timerStart, _b, numberOfDeposits, currentTime, oldestTime, events, errMsg;
+            var _this = this;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        firstDepositId = this.firstDepositIdForSpokePool;
+                        if (!(firstDepositId === Number.MAX_SAFE_INTEGER)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.spokePool.numberOfDeposits({ blockTag: this.deploymentBlock })];
+                    case 1:
+                        firstDepositId = _c.sent();
+                        if (isNaN(firstDepositId) || firstDepositId < 0) {
+                            throw new Error("SpokePoolClient::update: Invalid first deposit id (".concat(firstDepositId, ")"));
+                        }
+                        _c.label = 2;
+                    case 2: return [4 /*yield*/, this.updateSearchConfig(this.spokePool.provider)];
+                    case 3:
+                        searchConfig = _c.sent();
+                        if (isUpdateFailureReason(searchConfig)) {
+                            reason = searchConfig;
+                            return [2 /*return*/, { success: false, reason: reason }];
+                        }
+                        hasCCTPBridgingEnabled = false;
+                        if (!(chainIsCCTPEnabled(this.chainId) && isDefined(this.spokePool.cctpTokenMessenger))) return [3 /*break*/, 5];
+                        _a = String;
+                        return [4 /*yield*/, this.spokePool.cctpTokenMessenger({
+                                blockTag: searchConfig.toBlock,
+                            })];
+                    case 4:
+                        cctpBridgeAddress = _a.apply(void 0, [_c.sent()]);
+                        hasCCTPBridgingEnabled = cctpBridgeAddress.toLowerCase() !== ZERO_ADDRESS.toLowerCase();
+                        _c.label = 5;
+                    case 5:
+                        eventSearchConfigs = eventsToQuery.map(function (eventName) {
+                            if (!_this.queryableEventNames.includes(eventName)) {
+                                throw new Error("SpokePoolClient: Cannot query unrecognised SpokePool event name: ".concat(eventName));
+                            }
+                            var _searchConfig = __assign({}, searchConfig); // shallow copy
+                            // By default, an event's query range is controlled by the `eventSearchConfig` passed in during instantiation.
+                            // However, certain events have special overriding requirements to their search ranges:
+                            // - EnabledDepositRoute: The full history is always required, so override the requested fromBlock.
+                            if (eventName === "EnabledDepositRoute" && !_this.isUpdated) {
+                                _searchConfig.fromBlock = _this.deploymentBlock;
+                            }
+                            return {
+                                filter: _this._queryableEventNames()[eventName],
+                                searchConfig: _searchConfig,
+                            };
+                        });
+                        this.log("debug", "Updating SpokePool client for chain ".concat(this.chainId), {
+                            eventsToQuery: eventsToQuery,
+                            searchConfig: searchConfig,
+                            spokePool: this.spokePool.address,
+                        });
+                        timerStart = Date.now();
+                        return [4 /*yield*/, Promise.all(__spreadArray([
+                                this.spokePool.numberOfDeposits({ blockTag: searchConfig.toBlock }),
+                                this.spokePool.getCurrentTime({ blockTag: searchConfig.toBlock }),
+                                this.spokePool.getCurrentTime({ blockTag: Math.max(searchConfig.fromBlock, this.deploymentBlock) })
+                            ], eventSearchConfigs.map(function (config) { return paginatedEventQuery(_this.spokePool, config.filter, config.searchConfig); }), true))];
+                    case 6:
+                        _b = _c.sent(), numberOfDeposits = _b[0], currentTime = _b[1], oldestTime = _b[2], events = _b.slice(3);
+                        this.log("debug", "Time to query new events from RPC for ".concat(this.chainId, ": ").concat(Date.now() - timerStart, " ms"));
+                        if (!BigNumber.isBigNumber(currentTime) || currentTime.lt(this.currentTime)) {
+                            errMsg = BigNumber.isBigNumber(currentTime)
+                                ? "currentTime: ".concat(currentTime, " < ").concat(toBN(this.currentTime))
+                                : "currentTime is not a BigNumber: ".concat(JSON.stringify(currentTime));
+                            throw new Error("SpokePoolClient::update: ".concat(errMsg));
+                        }
+                        // Sort all events to ensure they are stored in a consistent order.
+                        events.forEach(function (events) { return sortEventsAscendingInPlace(events); });
+                        return [2 /*return*/, {
+                                success: true,
+                                currentTime: currentTime.toNumber(),
+                                oldestTime: oldestTime.toNumber(),
+                                firstDepositId: firstDepositId,
+                                latestDepositId: Math.max(numberOfDeposits - 1, 0),
+                                searchEndBlock: searchConfig.toBlock,
+                                events: events,
+                                hasCCTPBridgingEnabled: hasCCTPBridgingEnabled,
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * A wrapper over the `_update` method that handles errors and logs. This method additionally calls into the
+     * HubPoolClient to update the state of this client with data from the HubPool contract.
+     * @param eventsToQuery An optional list of events to query. If not provided, all events will be queried.
+     * @returns A Promise that resolves to a SpokePoolUpdate object.
+     * @note This method is the primary method for updating the state of this client externally.
+     * @see _update
+     */
+    SpokePoolClient.prototype.update = function (eventsToQuery) {
+        var _a, _b, _c;
+        if (eventsToQuery === void 0) { eventsToQuery = this.queryableEventNames; }
+        return __awaiter(this, void 0, void 0, function () {
+            var update, queryResults, currentTime, oldestTime, searchEndBlock, _i, _d, event_1, depositEvents, dataForQuoteTime, _e, _f, _g, index, event_2, rawDeposit, quoteBlockNumber, deposit, speedUpEvents, _h, speedUpEvents_1, event_3, speedUp, depositHash, depositDataAssociatedWithSpeedUp, slowFillRequests, _j, slowFillRequests_1, event_4, slowFillRequest, relayDataHash, fillEvents, _k, fillEvents_1, event_5, fill, enableDepositsEvents, _l, enableDepositsEvents_1, event_6, enableDeposit, relayedRootBundleEvents, _m, relayedRootBundleEvents_1, event_7, refundEvents, _o, refundEvents_1, event_8, executedRefund;
+            return __generator(this, function (_p) {
+                switch (_p.label) {
+                    case 0:
+                        if (this.hubPoolClient !== null && !this.hubPoolClient.isUpdated) {
+                            throw new Error("HubPoolClient not updated");
+                        }
+                        return [4 /*yield*/, this._update(eventsToQuery)];
+                    case 1:
+                        update = _p.sent();
+                        if (!update.success) {
+                            return [2 /*return*/];
+                        }
+                        queryResults = update.events, currentTime = update.currentTime, oldestTime = update.oldestTime, searchEndBlock = update.searchEndBlock;
+                        if (eventsToQuery.includes("TokensBridged")) {
+                            for (_i = 0, _d = queryResults[eventsToQuery.indexOf("TokensBridged")]; _i < _d.length; _i++) {
+                                event_1 = _d[_i];
+                                this.tokensBridged.push(spreadEventWithBlockNumber(event_1));
+                            }
+                        }
+                        if (!eventsToQuery.includes("V3FundsDeposited")) return [3 /*break*/, 3];
+                        depositEvents = __spreadArray([], ((_a = queryResults[eventsToQuery.indexOf("V3FundsDeposited")]) !== null && _a !== void 0 ? _a : []), true);
+                        if (depositEvents.length > 0) {
+                            this.log("debug", "Using ".concat(depositEvents.length, " newly queried deposit events for chain ").concat(this.chainId), {
+                                earliestEvent: depositEvents[0].blockNumber,
+                            });
+                        }
+                        return [4 /*yield*/, this.batchComputeRealizedLpFeePct(depositEvents)];
+                    case 2:
+                        dataForQuoteTime = _p.sent();
+                        for (_e = 0, _f = Array.from(depositEvents.entries()); _e < _f.length; _e++) {
+                            _g = _f[_e], index = _g[0], event_2 = _g[1];
+                            rawDeposit = spreadEventWithBlockNumber(event_2);
+                            quoteBlockNumber = dataForQuoteTime[index].quoteBlock;
+                            deposit = __assign(__assign({}, rawDeposit), { originChainId: this.chainId, quoteBlockNumber: quoteBlockNumber });
+                            if (deposit.outputToken === ZERO_ADDRESS) {
+                                deposit.outputToken = this.getDestinationTokenForDeposit(deposit);
+                            }
+                            if (this.depositHashes[this.getDepositHash(deposit)] !== undefined) {
+                                continue;
+                            }
+                            assign(this.depositHashes, [this.getDepositHash(deposit)], deposit);
+                            if (deposit.depositId < this.earliestDepositIdQueried) {
+                                this.earliestDepositIdQueried = deposit.depositId;
+                            }
+                            if (deposit.depositId > this.latestDepositIdQueried) {
+                                this.latestDepositIdQueried = deposit.depositId;
+                            }
+                        }
+                        _p.label = 3;
+                    case 3:
+                        // TODO: When validating fills with deposits for the purposes of UBA flows, do we need to consider
+                        // speed ups as well? For example, do we need to also consider that the speed up is before the fill
+                        // timestamp to be applied for the fill? My brain hurts.
+                        // Update deposits with speed up requests from depositor.
+                        if (eventsToQuery.includes("RequestedSpeedUpV3Deposit")) {
+                            speedUpEvents = __spreadArray([], ((_b = queryResults[eventsToQuery.indexOf("RequestedSpeedUpV3Deposit")]) !== null && _b !== void 0 ? _b : []), true);
+                            for (_h = 0, speedUpEvents_1 = speedUpEvents; _h < speedUpEvents_1.length; _h++) {
+                                event_3 = speedUpEvents_1[_h];
+                                speedUp = __assign(__assign({}, spreadEvent(event_3.args)), { originChainId: this.chainId });
+                                assign(this.speedUps, [speedUp.depositor, speedUp.depositId], [speedUp]);
+                                depositHash = this.getDepositHash(speedUp);
+                                depositDataAssociatedWithSpeedUp = this.depositHashes[depositHash];
+                                if (isDefined(depositDataAssociatedWithSpeedUp)) {
+                                    this.depositHashes[depositHash] = this.appendMaxSpeedUpSignatureToDeposit(depositDataAssociatedWithSpeedUp);
+                                }
+                            }
+                        }
+                        if (eventsToQuery.includes("RequestedV3SlowFill")) {
+                            slowFillRequests = queryResults[eventsToQuery.indexOf("RequestedV3SlowFill")];
+                            for (_j = 0, slowFillRequests_1 = slowFillRequests; _j < slowFillRequests_1.length; _j++) {
+                                event_4 = slowFillRequests_1[_j];
+                                slowFillRequest = __assign(__assign({}, spreadEventWithBlockNumber(event_4)), { destinationChainId: this.chainId });
+                                relayDataHash = getRelayDataHash(slowFillRequest, this.chainId);
+                                if (this.slowFillRequests[relayDataHash] !== undefined) {
+                                    continue;
+                                }
+                                this.slowFillRequests[relayDataHash] = slowFillRequest;
+                            }
+                        }
+                        if (eventsToQuery.includes("FilledV3Relay")) {
+                            fillEvents = __spreadArray([], ((_c = queryResults[eventsToQuery.indexOf("FilledV3Relay")]) !== null && _c !== void 0 ? _c : []), true);
+                            if (fillEvents.length > 0) {
+                                this.log("debug", "Using ".concat(fillEvents.length, " newly queried fill events for chain ").concat(this.chainId), {
+                                    earliestEvent: fillEvents[0].blockNumber,
+                                });
+                            }
+                            // @note The type assertions here suppress errors that might arise due to incomplete types. For now, verify via
+                            // test that the types are complete. A broader change in strategy for safely unpacking events will be introduced.
+                            for (_k = 0, fillEvents_1 = fillEvents; _k < fillEvents_1.length; _k++) {
+                                event_5 = fillEvents_1[_k];
+                                fill = __assign(__assign({}, spreadEventWithBlockNumber(event_5)), { destinationChainId: this.chainId });
+                                assign(this.fills, [fill.originChainId], [fill]);
+                                assign(this.depositHashesToFills, [this.getDepositHash(fill)], [fill]);
+                            }
+                        }
+                        if (eventsToQuery.includes("EnabledDepositRoute")) {
+                            enableDepositsEvents = queryResults[eventsToQuery.indexOf("EnabledDepositRoute")];
+                            for (_l = 0, enableDepositsEvents_1 = enableDepositsEvents; _l < enableDepositsEvents_1.length; _l++) {
+                                event_6 = enableDepositsEvents_1[_l];
+                                enableDeposit = spreadEvent(event_6.args);
+                                assign(this.depositRoutes, [enableDeposit.originToken, enableDeposit.destinationChainId], enableDeposit.enabled);
+                            }
+                        }
+                        if (eventsToQuery.includes("RelayedRootBundle")) {
+                            relayedRootBundleEvents = queryResults[eventsToQuery.indexOf("RelayedRootBundle")];
+                            for (_m = 0, relayedRootBundleEvents_1 = relayedRootBundleEvents; _m < relayedRootBundleEvents_1.length; _m++) {
+                                event_7 = relayedRootBundleEvents_1[_m];
+                                this.rootBundleRelays.push(spreadEventWithBlockNumber(event_7));
+                            }
+                        }
+                        if (eventsToQuery.includes("ExecutedRelayerRefundRoot")) {
+                            refundEvents = queryResults[eventsToQuery.indexOf("ExecutedRelayerRefundRoot")];
+                            for (_o = 0, refundEvents_1 = refundEvents; _o < refundEvents_1.length; _o++) {
+                                event_8 = refundEvents_1[_o];
+                                executedRefund = spreadEventWithBlockNumber(event_8);
+                                executedRefund.l2TokenAddress = SpokePoolClient.getExecutedRefundLeafL2Token(executedRefund.chainId, executedRefund.l2TokenAddress);
+                                this.relayerRefundExecutions.push(executedRefund);
+                            }
+                        }
+                        // Next iteration should start off from where this one ended.
+                        this.currentTime = currentTime;
+                        if (this.oldestTime === 0)
+                            this.oldestTime = oldestTime; // Set oldest time only after the first update.
+                        this.firstDepositIdForSpokePool = update.firstDepositId;
+                        this.hasCCTPBridgingEnabled = update.hasCCTPBridgingEnabled;
+                        this.latestBlockSearched = searchEndBlock;
+                        this.lastDepositIdForSpokePool = update.latestDepositId;
+                        this.firstBlockToSearch = searchEndBlock + 1;
+                        this.eventSearchConfig.toBlock = undefined; // Caller can re-set on subsequent updates if necessary
+                        this.isUpdated = true;
+                        this.log("debug", "SpokePool client for chain ".concat(this.chainId, " updated!"), {
+                            nextFirstBlockToSearch: this.firstBlockToSearch,
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves the l2TokenAddress for a given executed refund leaf.
+     * @param chainId The chain ID of the executed refund leaf.
+     * @param eventL2Token The l2TokenAddress of the executed refund leaf.
+     * @returns The l2TokenAddress of the executed refund leaf.
+     */
+    SpokePoolClient.getExecutedRefundLeafL2Token = function (chainId, eventL2Token) {
+        // If execution of WETH refund leaf occurred on an OVM spoke pool, then we'll convert its l2Token from the native
+        // token address to the wrapped token address. This is because the OVM_SpokePool modifies the l2TokenAddress prop
+        // in _bridgeTokensToHubPool before emitting the ExecutedRelayerRefundLeaf event.
+        // Here is the contract code referenced:
+        // - https://github.com/across-protocol/contracts/blob/954528a4620863d1c868e54a370fd8556d5ed05c/contracts/Ovm_SpokePool.sol#L142
+        if ((chainId === 10 || chainId === 8453) &&
+            eventL2Token.toLowerCase() === "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000") {
+            return "0x4200000000000000000000000000000000000006";
+        }
+        else if (chainId === 288 && eventL2Token.toLowerCase() === "0x4200000000000000000000000000000000000006") {
+            return "0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000";
+        }
+        else {
+            return eventL2Token;
+        }
+    };
+    /**
+     * Computes the realized LP fee percentage for a given deposit.
+     * @param depositEvent The deposit event to compute the realized LP fee percentage for.
+     * @returns The realized LP fee percentage.
+     */
+    SpokePoolClient.prototype.computeRealizedLpFeePct = function (depositEvent) {
+        return __awaiter(this, void 0, void 0, function () {
+            var lpFee;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.batchComputeRealizedLpFeePct([depositEvent])];
+                    case 1:
+                        lpFee = (_a.sent())[0];
+                        return [2 /*return*/, lpFee];
+                }
+            });
+        });
+    };
+    /**
+     * Computes the realized LP fee percentage for a batch of deposits.
+     * @dev Computing in batch opens up for efficiencies, e.g. in quoteTimestamp -> blockNumber resolution.
+     * @param depositEvents The array of deposit events to compute the realized LP fee percentage for.
+     * @returns The array of realized LP fee percentages and associated HubPool block numbers.
+     */
+    SpokePoolClient.prototype.batchComputeRealizedLpFeePct = function (depositEvents) {
+        return __awaiter(this, void 0, void 0, function () {
+            var realizedLpFeePct_1, quoteBlock_1, deposits, _a;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        // If no hub pool client, we're using this for testing. Set quote block very high so that if it's ever
+                        // used to look up a configuration for a block, it will always match with the latest configuration.
+                        if (this.hubPoolClient === null) {
+                            realizedLpFeePct_1 = bnZero;
+                            quoteBlock_1 = MAX_BIG_INT.toNumber();
+                            return [2 /*return*/, depositEvents.map(function () {
+                                    return { realizedLpFeePct: realizedLpFeePct_1, quoteBlock: quoteBlock_1 };
+                                })];
+                        }
+                        deposits = depositEvents.map(function (_a) {
+                            var args = _a.args;
+                            // For v3 deposits, leave payment chain ID undefined so we don't compute lp fee since we don't have the
+                            // payment chain ID until we match this deposit with a fill.
+                            var inputToken = args.inputToken, inputAmount = args.inputAmount, quoteTimestamp = args.quoteTimestamp;
+                            return {
+                                inputToken: inputToken,
+                                inputAmount: inputAmount,
+                                originChainId: _this.chainId,
+                                paymentChainId: undefined,
+                                quoteTimestamp: quoteTimestamp,
+                            };
+                        });
+                        if (!(deposits.length > 0)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.hubPoolClient.batchComputeRealizedLpFeePct(deposits)];
+                    case 1:
+                        _a = _b.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        _a = [];
+                        _b.label = 3;
+                    case 3: return [2 /*return*/, _a];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves the destination token for a given deposit.
+     * @param deposit The deposit to retrieve the destination token for.
+     * @returns The destination token.
+     */
+    SpokePoolClient.prototype.getDestinationTokenForDeposit = function (deposit) {
+        // If there is no rate model client return address(0).
+        if (!this.hubPoolClient) {
+            return ZERO_ADDRESS;
+        }
+        return this.hubPoolClient.getL2TokenForDeposit(deposit);
+    };
+    /**
+     * Performs a log for a specific level, message and data.
+     * @param level The log level.
+     * @param message The log message.
+     * @param data Optional data to log.
+     */
+    SpokePoolClient.prototype.log = function (level, message, data) {
+        this.logger[level](__assign({ at: "SpokePoolClient", chainId: this.chainId, message: message }, data));
+    };
+    /**
+     * Retrieves the current time from the SpokePool contract.
+     * @returns The current time, which will be 0 if there has been no update() yet.
+     */
+    SpokePoolClient.prototype.getCurrentTime = function () {
+        return this.currentTime;
+    };
+    /**
+     * Retrieves the oldest time searched on the SpokePool contract.
+     * @returns The oldest time searched, which will be 0 if there has been no update() yet.
+     */
+    SpokePoolClient.prototype.getOldestTime = function () {
+        return this.oldestTime;
+    };
+    SpokePoolClient.prototype.findDeposit = function (depositId, destinationChainId, depositor) {
+        return __awaiter(this, void 0, void 0, function () {
+            var searchBounds, tStart, query, tStop, event, srcChain, dstChain, partialDeposit, quoteBlockNumber, deposit;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this._getBlockRangeForDepositId(depositId, this.deploymentBlock, this.latestBlockSearched, 7)];
+                    case 1:
+                        searchBounds = _a.sent();
+                        tStart = Date.now();
+                        return [4 /*yield*/, paginatedEventQuery(this.spokePool, this.spokePool.filters.V3FundsDeposited(null, null, null, null, destinationChainId, depositId, null, null, null, depositor, null, null, null), {
+                                fromBlock: searchBounds.low,
+                                toBlock: searchBounds.high,
+                                maxBlockLookBack: this.eventSearchConfig.maxBlockLookBack,
+                            })];
+                    case 2:
+                        query = _a.sent();
+                        tStop = Date.now();
+                        event = query.find(function (deposit) { return deposit.args.depositId === depositId; });
+                        if (event === undefined) {
+                            srcChain = getNetworkName(this.chainId);
+                            dstChain = getNetworkName(destinationChainId);
+                            throw new Error("Could not find deposit ".concat(depositId, " for ").concat(dstChain, " fill") +
+                                " between ".concat(srcChain, " blocks [").concat(searchBounds.low, ", ").concat(searchBounds.high, "]"));
+                        }
+                        partialDeposit = spreadEventWithBlockNumber(event);
+                        return [4 /*yield*/, this.computeRealizedLpFeePct(event)];
+                    case 3:
+                        quoteBlockNumber = (_a.sent()).quoteBlock;
+                        deposit = __assign(__assign({}, partialDeposit), { originChainId: this.chainId, quoteBlockNumber: quoteBlockNumber, outputToken: partialDeposit.outputToken === ZERO_ADDRESS
+                                ? this.getDestinationTokenForDeposit(__assign(__assign({}, partialDeposit), { originChainId: this.chainId }))
+                                : partialDeposit.outputToken });
+                        this.logger.debug({
+                            at: "SpokePoolClient#findDeposit",
+                            message: "Located V3 deposit outside of SpokePoolClient's search range",
+                            deposit: deposit,
+                            elapsedMs: tStop - tStart,
+                        });
+                        return [2 /*return*/, deposit];
+                }
+            });
+        });
+    };
+    return SpokePoolClient;
+}(BaseAbstractClient));
+export { SpokePoolClient };
+//# sourceMappingURL=SpokePoolClient.js.map