@across-protocol/sdk 4.1.31 → 4.1.33

package/dist/esm/clients/SpokePoolClient/EVMSpokePoolClient.js

@@ -0,0 +1,174 @@
+import { __assign, __awaiter, __extends, __generator, __spreadArray } from "tslib";
+import { BigNumber, getNetworkName, InvalidFill, toBN } from "../../utils";
+import { paginatedEventQuery, sortEventsAscendingInPlace, spreadEventWithBlockNumber, } from "../../utils/EventUtils";
+import { isUpdateFailureReason } from "../BaseAbstractClient";
+import { knownEventNames, SpokePoolClient } from "./SpokePoolClient";
+import { findDepositBlock, getMaxFillDeadlineInRange as getMaxFillDeadline, getTimeAt as _getTimeAt, relayFillStatus, isZeroAddress, getTimestampForBlock as _getTimestampForBlock, } from "../../utils/SpokeUtils";
+/**
+ * An EVM-specific SpokePoolClient.
+ */
+var EVMSpokePoolClient = /** @class */ (function (_super) {
+    __extends(EVMSpokePoolClient, _super);
+    function EVMSpokePoolClient(logger, spokePool, hubPoolClient, chainId, deploymentBlock, eventSearchConfig) {
+        if (eventSearchConfig === void 0) { eventSearchConfig = { fromBlock: 0, maxBlockLookBack: 0 }; }
+        var _this = _super.call(this, logger, hubPoolClient, chainId, deploymentBlock, eventSearchConfig) || this;
+        _this.spokePool = spokePool;
+        return _this;
+    }
+    EVMSpokePoolClient.prototype.relayFillStatus = function (relayData, blockTag, destinationChainId) {
+        return relayFillStatus(this.spokePool, relayData, blockTag, destinationChainId);
+    };
+    EVMSpokePoolClient.prototype.getMaxFillDeadlineInRange = function (startBlock, endBlock) {
+        return getMaxFillDeadline(this.spokePool, startBlock, endBlock);
+    };
+    EVMSpokePoolClient.prototype._availableEventsOnSpoke = function (eventNames) {
+        var _this = this;
+        if (eventNames === void 0) { eventNames = knownEventNames; }
+        return Object.fromEntries(this.spokePool.interface.fragments
+            .filter(function (_a) {
+            var name = _a.name, type = _a.type;
+            return type === "event" && eventNames.includes(name);
+        })
+            .map(function (_a) {
+            var name = _a.name;
+            return [name, _this.spokePool.filters[name]()];
+        }));
+    };
+    EVMSpokePoolClient.prototype._queryableEventNames = function () {
+        return Object.keys(this._availableEventsOnSpoke(knownEventNames));
+    };
+    EVMSpokePoolClient.prototype._update = function (eventsToQuery) {
+        return __awaiter(this, void 0, void 0, function () {
+            var searchConfig, reason, eventSearchConfigs, spokePool, timerStart, multicallFunctions, _a, multicallOutput, events, currentTime, errMsg;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.updateSearchConfig(this.spokePool.provider)];
+                    case 1:
+                        searchConfig = _b.sent();
+                        if (isUpdateFailureReason(searchConfig)) {
+                            reason = searchConfig;
+                            return [2 /*return*/, { success: false, reason: reason }];
+                        }
+                        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._availableEventsOnSpoke()[eventName],
+                                searchConfig: _searchConfig,
+                            };
+                        });
+                        spokePool = this.spokePool;
+                        this.log("debug", "Updating SpokePool client for chain ".concat(this.chainId), {
+                            eventsToQuery: eventsToQuery,
+                            searchConfig: searchConfig,
+                            spokePool: spokePool.address,
+                        });
+                        timerStart = Date.now();
+                        multicallFunctions = ["getCurrentTime"];
+                        return [4 /*yield*/, Promise.all(__spreadArray([
+                                spokePool.callStatic.multicall(multicallFunctions.map(function (f) { return spokePool.interface.encodeFunctionData(f); }), { blockTag: searchConfig.toBlock })
+                            ], eventSearchConfigs.map(function (config) { return paginatedEventQuery(_this.spokePool, config.filter, config.searchConfig); }), true))];
+                    case 2:
+                        _a = _b.sent(), multicallOutput = _a[0], events = _a.slice(1);
+                        this.log("debug", "Time to query new events from RPC for ".concat(this.chainId, ": ").concat(Date.now() - timerStart, " ms"));
+                        currentTime = multicallFunctions.map(function (fn, idx) { return spokePool.interface.decodeFunctionResult(fn, multicallOutput[idx])[0]; })[0];
+                        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(),
+                                searchEndBlock: searchConfig.toBlock,
+                                events: events,
+                            }];
+                }
+            });
+        });
+    };
+    EVMSpokePoolClient.prototype.getTimeAt = function (blockNumber) {
+        return _getTimeAt(this.spokePool, blockNumber);
+    };
+    EVMSpokePoolClient.prototype.findDeposit = function (depositId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var deposit, upperBound, fromBlock, chain, reason, toBlock, tStart, maxBlockLookBack, query, tStop, event, _a;
+            var _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        deposit = this.getDeposit(depositId);
+                        if (deposit) {
+                            return [2 /*return*/, { found: true, deposit: deposit }];
+                        }
+                        upperBound = this.latestBlockSearched || undefined;
+                        return [4 /*yield*/, findDepositBlock(this.spokePool, depositId, this.deploymentBlock, upperBound)];
+                    case 1:
+                        fromBlock = _c.sent();
+                        chain = getNetworkName(this.chainId);
+                        if (!fromBlock) {
+                            reason = "Unable to find ".concat(chain, " depositId ").concat(depositId) +
+                                " within blocks [".concat(this.deploymentBlock, ", ").concat(upperBound !== null && upperBound !== void 0 ? upperBound : "latest", "].");
+                            return [2 /*return*/, { found: false, code: InvalidFill.DepositIdNotFound, reason: reason }];
+                        }
+                        toBlock = fromBlock;
+                        tStart = Date.now();
+                        maxBlockLookBack = this.eventSearchConfig.maxBlockLookBack;
+                        return [4 /*yield*/, Promise.all([
+                                paginatedEventQuery(this.spokePool, this.spokePool.filters.V3FundsDeposited(null, null, null, null, null, depositId), { fromBlock: fromBlock, toBlock: toBlock, maxBlockLookBack: maxBlockLookBack }),
+                                paginatedEventQuery(this.spokePool, this.spokePool.filters.FundsDeposited(null, null, null, null, null, depositId), { fromBlock: fromBlock, toBlock: toBlock, maxBlockLookBack: maxBlockLookBack }),
+                            ])];
+                    case 2:
+                        query = (_c.sent()).flat();
+                        tStop = Date.now();
+                        event = query.find(function (_a) {
+                            var args = _a.args;
+                            return args["depositId"].eq(depositId);
+                        });
+                        if (event === undefined) {
+                            return [2 /*return*/, {
+                                    found: false,
+                                    code: InvalidFill.DepositIdNotFound,
+                                    reason: "".concat(chain, " depositId ").concat(depositId, " not found at block ").concat(fromBlock, "."),
+                                }];
+                        }
+                        _a = [__assign({}, spreadEventWithBlockNumber(event))];
+                        _b = { originChainId: this.chainId };
+                        return [4 /*yield*/, this.getBlockNumber(Number(event.args["quoteTimestamp"]))];
+                    case 3:
+                        deposit = __assign.apply(void 0, _a.concat([(_b.quoteBlockNumber = _c.sent(), _b.fromLiteChain = true, _b.toLiteChain = true, _b)]));
+                        if (isZeroAddress(deposit.outputToken)) {
+                            deposit.outputToken = this.getDestinationTokenForDeposit(deposit);
+                        }
+                        deposit.fromLiteChain = this.isOriginLiteChain(deposit);
+                        deposit.toLiteChain = this.isDestinationLiteChain(deposit);
+                        this.logger.debug({
+                            at: "SpokePoolClient#findDeposit",
+                            message: "Located V3 deposit outside of SpokePoolClient's search range",
+                            deposit: deposit,
+                            elapsedMs: tStop - tStart,
+                        });
+                        return [2 /*return*/, { found: true, deposit: deposit }];
+                }
+            });
+        });
+    };
+    EVMSpokePoolClient.prototype.getTimestampForBlock = function (blockNumber) {
+        return _getTimestampForBlock(this.spokePool.provider, blockNumber);
+    };
+    return EVMSpokePoolClient;
+}(SpokePoolClient));
+export { EVMSpokePoolClient };
+//# sourceMappingURL=EVMSpokePoolClient.js.map

package/dist/esm/clients/SpokePoolClient/EVMSpokePoolClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EVMSpokePoolClient.js","sourceRoot":"","sources":["../../../../src/clients/SpokePoolClient/EVMSpokePoolClient.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAuB,cAAc,EAAE,WAAW,EAAgB,IAAI,EAAE,MAAM,aAAa,CAAC;AAC9G,OAAO,EAEL,mBAAmB,EACnB,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,eAAe,EAAmB,MAAM,mBAAmB,CAAC;AAGtF,OAAO,EACL,gBAAgB,EAChB,yBAAyB,IAAI,kBAAkB,EAC/C,SAAS,IAAI,UAAU,EACvB,eAAe,EACf,aAAa,EACb,oBAAoB,IAAI,qBAAqB,GAC9C,MAAM,wBAAwB,CAAC;AAGhC;;GAEG;AACH;IAAwC,sCAAe;IACrD,4BACE,MAAsB,EACN,SAAmB,EACnC,aAAmC,EACnC,OAAe,EACf,eAAuB,EACvB,iBAAqG;QAArG,kCAAA,EAAA,sBAAkE,SAAS,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE;QANvG,YAQE,kBAAM,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,EAAE,iBAAiB,CAAC,SAC1E;QAPiB,eAAS,GAAT,SAAS,CAAU;;IAOrC,CAAC;IAEe,4CAAe,GAA/B,UACE,SAAoB,EACpB,QAA4B,EAC5B,kBAA2B;QAE3B,OAAO,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;IAClF,CAAC;IAEe,sDAAyB,GAAzC,UAA0C,UAAkB,EAAE,QAAgB;QAC5E,OAAO,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAEO,oDAAuB,GAA/B,UAAgC,UAAsC;QAAtE,iBAMC;QAN+B,2BAAA,EAAA,4BAAsC;QACpE,OAAO,MAAM,CAAC,WAAW,CACvB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS;aAC/B,MAAM,CAAC,UAAC,EAAc;gBAAZ,IAAI,UAAA,EAAE,IAAI,UAAA;YAAO,OAAA,IAAI,KAAK,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;QAA7C,CAA6C,CAAC;aACzE,GAAG,CAAC,UAAC,EAAQ;gBAAN,IAAI,UAAA;YAAO,OAAA,CAAC,IAAI,EAAE,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAAtC,CAAsC,CAAC,CAC7D,CAAC;IACJ,CAAC;IAEe,iDAAoB,GAApC;QACE,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC,CAAC;IACpE,CAAC;IAEwB,oCAAO,GAAhC,UAAiC,aAAuB;;;;;;4BACjC,qBAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAA;;wBAArE,YAAY,GAAG,SAAsD;wBAC3E,IAAI,qBAAqB,CAAC,YAAY,CAAC,EAAE;4BACjC,MAAM,GAAG,YAAY,CAAC;4BAC5B,sBAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,QAAA,EAAE,EAAC;yBACnC;wBAEK,kBAAkB,GAAG,aAAa,CAAC,GAAG,CAAC,UAAC,SAAS;4BACrD,IAAI,CAAC,KAAI,CAAC,oBAAoB,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gCACpD,MAAM,IAAI,KAAK,CAAC,2EAAoE,SAAS,CAAE,CAAC,CAAC;6BAClG;4BAED,IAAM,aAAa,gBAAQ,YAAY,CAAE,CAAC,CAAC,eAAe;4BAE1D,8GAA8G;4BAC9G,uFAAuF;4BACvF,mGAAmG;4BACnG,IAAI,SAAS,KAAK,qBAAqB,IAAI,CAAC,KAAI,CAAC,SAAS,EAAE;gCAC1D,aAAa,CAAC,SAAS,GAAG,KAAI,CAAC,eAAe,CAAC;6BAChD;4BAED,OAAO;gCACL,MAAM,EAAE,KAAI,CAAC,uBAAuB,EAAE,CAAC,SAAS,CAAC;gCACjD,YAAY,EAAE,aAAa;6BAC5B,CAAC;wBACJ,CAAC,CAAC,CAAC;wBAEK,SAAS,GAAK,IAAI,UAAT,CAAU;wBAC3B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,8CAAuC,IAAI,CAAC,OAAO,CAAE,EAAE;4BACvE,aAAa,eAAA;4BACb,YAAY,cAAA;4BACZ,SAAS,EAAE,SAAS,CAAC,OAAO;yBAC7B,CAAC,CAAC;wBAEG,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBACxB,kBAAkB,GAAG,CAAC,gBAAgB,CAAC,CAAC;wBACT,qBAAM,OAAO,CAAC,GAAG;gCACpD,SAAS,CAAC,UAAU,CAAC,SAAS,CAC5B,kBAAkB,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAzC,CAAyC,CAAC,EACxE,EAAE,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,CACnC;+BACE,kBAAkB,CAAC,GAAG,CAAC,UAAC,MAAM,IAAK,OAAA,mBAAmB,CAAC,KAAI,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,YAAY,CAAC,EAAvE,CAAuE,CAAC,QAC9G,EAAA;;wBANI,KAA+B,SAMnC,EANK,eAAe,QAAA,EAAK,MAAM,cAAA;wBAOjC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,gDAAyC,IAAI,CAAC,OAAO,eAAK,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,QAAK,CAAC,CAAC;wBAEnG,WAAW,GAAI,kBAAkB,CAAC,GAAG,CAC1C,UAAC,EAAE,EAAE,GAAG,IAAK,OAAA,SAAS,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAArE,CAAqE,CACnF,GAFiB,CAEhB;wBAEF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;4BACrE,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC;gCAC/C,CAAC,CAAC,uBAAgB,WAAW,gBAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAE;gCAC3D,CAAC,CAAC,0CAAmC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAE,CAAC;4BACrE,MAAM,IAAI,KAAK,CAAC,mCAA4B,MAAM,CAAE,CAAC,CAAC;yBACvD;wBAED,mEAAmE;wBACnE,MAAM,CAAC,OAAO,CAAC,UAAC,MAAM,IAAK,OAAA,0BAA0B,CAAC,MAAM,CAAC,EAAlC,CAAkC,CAAC,CAAC;wBAE/D,sBAAO;gCACL,OAAO,EAAE,IAAI;gCACb,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;gCACnC,cAAc,EAAE,YAAY,CAAC,OAAO;gCACpC,MAAM,QAAA;6BACP,EAAC;;;;KACH;IAEe,sCAAS,GAAzB,UAA0B,WAAmB;QAC3C,OAAO,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACjD,CAAC;IAEqB,wCAAW,GAAjC,UAAkC,SAAoB;;;;;;;wBAChD,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;wBACzC,IAAI,OAAO,EAAE;4BACX,sBAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,SAAA,EAAE,EAAC;yBACjC;wBAGK,UAAU,GAAG,IAAI,CAAC,mBAAmB,IAAI,SAAS,CAAC;wBACvC,qBAAM,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC,EAAA;;wBAA/F,SAAS,GAAG,SAAmF;wBAC/F,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBAC3C,IAAI,CAAC,SAAS,EAAE;4BACR,MAAM,GACV,yBAAkB,KAAK,wBAAc,SAAS,CAAE;gCAChD,0BAAmB,IAAI,CAAC,eAAe,eAAK,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,QAAQ,OAAI,CAAC;4BACzE,sBAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,iBAAiB,EAAE,MAAM,QAAA,EAAE,EAAC;yBACtE;wBAEK,OAAO,GAAG,SAAS,CAAC;wBACpB,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBAElB,gBAAgB,GAAK,IAAI,CAAC,iBAAiB,iBAA3B,CAA4B;wBAElD,qBAAM,OAAO,CAAC,GAAG,CAAC;gCAChB,mBAAmB,CACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,EAChF,EAAE,SAAS,WAAA,EAAE,OAAO,SAAA,EAAE,gBAAgB,kBAAA,EAAE,CACzC;gCACD,mBAAmB,CACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,EAC9E,EAAE,SAAS,WAAA,EAAE,OAAO,SAAA,EAAE,gBAAgB,kBAAA,EAAE,CACzC;6BACF,CAAC,EAAA;;wBAZE,KAAK,GAAG,CACZ,SAWE,CACH,CAAC,IAAI,EAAE;wBACF,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBAEnB,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAC,EAAQ;gCAAN,IAAI,UAAA;4BAAO,OAAA,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC;wBAA/B,CAA+B,CAAC,CAAC;wBACxE,IAAI,KAAK,KAAK,SAAS,EAAE;4BACvB,sBAAO;oCACL,KAAK,EAAE,KAAK;oCACZ,IAAI,EAAE,WAAW,CAAC,iBAAiB;oCACnC,MAAM,EAAE,UAAG,KAAK,wBAAc,SAAS,iCAAuB,SAAS,MAAG;iCAC3E,EAAC;yBACH;2CAGI,0BAA0B,CAAC,KAAK,CAAC;+BACpC,aAAa,EAAE,IAAI,CAAC,OAAO;wBACT,qBAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAA;;wBAHnF,OAAO,GAAG,mCAGR,mBAAgB,GAAE,SAA+D,EACjF,gBAAa,GAAE,IAAI,EACnB,cAAW,GAAE,IAAI,QACE,CAAC;wBAEtB,IAAI,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;4BACtC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;yBACnE;wBACD,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;wBACxD,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;wBAE3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;4BAChB,EAAE,EAAE,6BAA6B;4BACjC,OAAO,EAAE,8DAA8D;4BACvE,OAAO,SAAA;4BACP,SAAS,EAAE,KAAK,GAAG,MAAM;yBAC1B,CAAC,CAAC;wBAEH,sBAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,SAAA,EAAE,EAAC;;;;KACjC;IAEe,iDAAoB,GAApC,UAAqC,WAAmB;QACtD,OAAO,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACrE,CAAC;IACH,yBAAC;AAAD,CAAC,AApLD,CAAwC,eAAe,GAoLtD"}

package/dist/{types/clients → esm/clients/SpokePoolClient}/SpokePoolClient.d.ts

@@ -1,28 +1,27 @@
-import { Contract, EventFilter } from "ethers";
 import winston from "winston";
-import { AnyObject, BigNumber, DefaultLogLevels, DepositSearchResult, EventSearchConfig, MakeOptional } from "../utils";
-import { Deposit, DepositWithBlock, Fill, FillStatus, FillWithBlock, Log, RelayData, RelayerRefundExecutionWithBlock, RootBundleRelayWithBlock, SlowFillRequestWithBlock, SpeedUpWithBlock, TokensBridged } from "../interfaces";
-import { BaseAbstractClient, UpdateFailureReason } from "./BaseAbstractClient";
-import { HubPoolClient } from "./HubPoolClient";
-import { AcrossConfigStoreClient } from "./AcrossConfigStoreClient";
-type SpokePoolUpdateSuccess = {
+import { AnyObject, BigNumber, DefaultLogLevels, DepositSearchResult, EventSearchConfig, MakeOptional } from "../../utils";
+import { Deposit, DepositWithBlock, Fill, FillStatus, FillWithBlock, Log, RelayData, RelayerRefundExecutionWithBlock, RootBundleRelayWithBlock, SlowFillRequestWithBlock, SpeedUpWithBlock, TokensBridged } from "../../interfaces";
+import { BaseAbstractClient, UpdateFailureReason } from "../BaseAbstractClient";
+import { AcrossConfigStoreClient } from "../AcrossConfigStoreClient";
+import { HubPoolClient } from "../HubPoolClient";
+export type SpokePoolUpdateSuccess = {
     success: true;
     currentTime: number;
     events: Log[][];
     searchEndBlock: number;
 };
-type SpokePoolUpdateFailure = {
+export type SpokePoolUpdateFailure = {
     success: false;
     reason: UpdateFailureReason;
 };
 export type SpokePoolUpdate = SpokePoolUpdateSuccess | SpokePoolUpdateFailure;
+export declare const knownEventNames: string[];
 /**
  * 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.
  */
-export declare class SpokePoolClient extends BaseAbstractClient {
+export declare abstract class SpokePoolClient extends BaseAbstractClient {
     readonly logger: winston.Logger;
-    readonly spokePool: Contract;
     readonly hubPoolClient: HubPoolClient | null;
     readonly chainId: number;
     deploymentBlock: number;
@@ -52,7 +51,6 @@ export declare class SpokePoolClient extends BaseAbstractClient {
     protected tokensBridged: TokensBridged[];
     protected rootBundleRelays: RootBundleRelayWithBlock[];
     protected relayerRefundExecutions: RelayerRefundExecutionWithBlock[];
-    protected queryableEventNames: string[];
     protected configStoreClient: AcrossConfigStoreClient | undefined;
     protected invalidFills: Set<string>;
     fills: {
@@ -61,16 +59,12 @@ export declare class SpokePoolClient extends BaseAbstractClient {
     /**
      * 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.
      */
-    constructor(logger: winston.Logger, spokePool: Contract, hubPoolClient: HubPoolClient | null, chainId: number, deploymentBlock: number, eventSearchConfig?: MakeOptional<EventSearchConfig, "toBlock">);
-    _queryableEventNames(): {
-        [eventName: string]: EventFilter;
-    };
+    protected constructor(logger: winston.Logger, hubPoolClient: HubPoolClient | null, chainId: number, deploymentBlock: number, eventSearchConfig?: MakeOptional<EventSearchConfig, "toBlock">);
     /**
      * Retrieves a list of unique deposits from the SpokePool contract destined for the given destination chain ID.
      * @param destinationChainId The destination chain ID.
@@ -224,27 +218,6 @@ export declare class SpokePoolClient extends BaseAbstractClient {
         depositId: BigNumber;
         originChainId: number;
     }): string;
-    /**
-     * @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
-     */
-    getMaxFillDeadlineInRange(startBlock: number, endBlock: number): Promise<number>;
-    /**
-     * 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.
-     */
-    protected _update(eventsToQuery: string[]): Promise<SpokePoolUpdate>;
     /**
      * 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.
@@ -286,18 +259,6 @@ export declare class SpokePoolClient extends BaseAbstractClient {
      * @returns The current time, which will be 0 if there has been no update() yet.
      */
     getCurrentTime(): number;
-    /**
-     * Retrieves the SpokePool chain time at a particular block.
-     * @returns The time at the specified block tag.
-     */
-    getTimeAt(blockNumber: number): Promise<number>;
-    /**
-     * For a given origin chain depositId, resolve the corresponding Deposit.
-     * Note: This method can only be used for depositIds within the non-deterministic range (0 < depositId < 2^32 - 1).
-     * @param depositId Deposit ID of the deposit to resolve.
-     * @returns A DepositSearchResult instance.
-     */
-    findDeposit(depositId: BigNumber): Promise<DepositSearchResult>;
     /**
      * Determines whether a deposit originates from a lite chain.
      * @param deposit The deposit to evaluate.
@@ -313,12 +274,53 @@ export declare class SpokePoolClient extends BaseAbstractClient {
      */
     protected isDestinationLiteChain(deposit: DepositWithBlock): boolean;
     /**
-     * Find the amount filled for a deposit at a particular block.
-     * @param relayData Deposit information that is used to complete a fill.
-     * @param blockTag Block tag (numeric or "latest") to query at.
-     * @returns The amount filled for the specified deposit at the requested block (or latest).
+     * Returns a list of event names that are queryable for the SpokePoolClient.
+     * @returns A list of event names that are queryable for the SpokePoolClient.
+     */
+    abstract _queryableEventNames(): string[];
+    /**
+     * 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.
+     */
+    protected abstract _update(eventsToQuery: string[]): Promise<SpokePoolUpdate>;
+    /**
+     * @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
+     */
+    abstract getMaxFillDeadlineInRange(startBlock: number, endBlock: number): Promise<number>;
+    /**
+     * Retrieves the timestamp for a given block number.
+     * @param blockTag The block number to retrieve the timestamp for.
+     * @returns The timestamp for the given block number.
+     */
+    abstract getTimestampForBlock(blockTag: number): Promise<number>;
+    /**
+     * Retrieves the time from the SpokePool contract at a particular block.
+     * @returns The time at the specified block tag.
+     */
+    abstract getTimeAt(blockNumber: number): Promise<number>;
+    /**
+     * For a given origin chain depositId, resolve the corresponding Deposit.
+     * Note: This method can only be used for depositIds within the non-deterministic range (0 < depositId < 2^32 - 1).
+     * @param depositId Deposit ID of the deposit to resolve.
+     * @returns A DepositSearchResult instance.
+     */
+    abstract findDeposit(depositId: BigNumber): Promise<DepositSearchResult>;
+    /**
+     * Retrieves the fill status for a given relay data.
+     * @param relayData The relay data to retrieve the fill status for.
+     * @returns The fill status for the given relay data.
      */
-    relayFillStatus(relayData: RelayData, blockTag?: number | "latest", destinationChainId?: number): Promise<FillStatus>;
+    abstract relayFillStatus(relayData: RelayData, blockTag?: number | "latest", destinationChainId?: number): Promise<FillStatus>;
 }
-export {};
-//# sourceMappingURL=SpokePoolClient.d.ts.map