@across-protocol/sdk 3.0.0

package/dist/esm/utils/DepositUtils.js

@@ -0,0 +1,138 @@
+import { __awaiter, __generator } from "tslib";
+import assert from "assert";
+import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE } from "../constants";
+import { getNetworkName } from "./NetworkUtils";
+import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
+import { validateFillForDeposit } from "./FlowUtils";
+import { getCurrentTime } from "./TimeUtils";
+import { isDefined } from "./TypeGuards";
+import { isDepositFormedCorrectly } from "./ValidatorUtils";
+// Load a deposit for a fill if the fill's deposit ID is outside this client's search range.
+// This can be used by the Dataworker to determine whether to give a relayer a refund for a fill
+// of a deposit older or younger than its fixed lookback.
+export var InvalidFill;
+(function (InvalidFill) {
+    InvalidFill[InvalidFill["DepositIdInvalid"] = 0] = "DepositIdInvalid";
+    InvalidFill[InvalidFill["DepositIdNotFound"] = 1] = "DepositIdNotFound";
+    InvalidFill[InvalidFill["FillMismatch"] = 2] = "FillMismatch";
+})(InvalidFill || (InvalidFill = {}));
+/**
+ * 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 function queryHistoricalDepositForFill(spokePoolClient, fill, cache) {
+    return __awaiter(this, void 0, void 0, function () {
+        var depositId, lowId, highId, deposit_1, deposit, cachedDeposit;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (fill.originChainId !== spokePoolClient.chainId) {
+                        throw new Error("OriginChainId mismatch (".concat(fill.originChainId, " != ").concat(spokePoolClient.chainId, ")"));
+                    }
+                    // We need to update client so we know the first and last deposit ID's queried for this spoke pool client, as well
+                    // as the global first and last deposit ID's for this spoke pool.
+                    if (!spokePoolClient.isUpdated) {
+                        throw new Error("SpokePoolClient must be updated before querying historical deposits");
+                    }
+                    depositId = fill.depositId;
+                    lowId = spokePoolClient.firstDepositIdForSpokePool, highId = spokePoolClient.lastDepositIdForSpokePool;
+                    if (depositId < lowId || depositId > highId) {
+                        return [2 /*return*/, {
+                                found: false,
+                                code: InvalidFill.DepositIdInvalid,
+                                reason: "Deposit ID ".concat(depositId, " is outside of SpokePool bounds [").concat(lowId, ",").concat(highId, "]."),
+                            }];
+                    }
+                    (lowId = spokePoolClient.earliestDepositIdQueried, highId = spokePoolClient.latestDepositIdQueried);
+                    if (depositId >= lowId && depositId <= highId) {
+                        deposit_1 = spokePoolClient.getDeposit(depositId);
+                        if (isDefined(deposit_1) && validateFillForDeposit(fill, deposit_1)) {
+                            return [2 /*return*/, { found: true, deposit: deposit_1 }];
+                        }
+                        return [2 /*return*/, {
+                                found: false,
+                                code: isDefined(deposit_1) ? InvalidFill.FillMismatch : InvalidFill.DepositIdNotFound,
+                                reason: "Deposit ID ".concat(depositId, " not found in SpokePoolClient event buffer."),
+                            }];
+                    }
+                    if (!cache) return [3 /*break*/, 2];
+                    return [4 /*yield*/, getDepositInCache(getDepositKey(fill), cache)];
+                case 1:
+                    cachedDeposit = _a.sent();
+                    // We only want to warn and remove the cached deposit if it
+                    //    A: exists
+                    //    B: is not formed correctly
+                    if (isDefined(cachedDeposit) && !isDepositFormedCorrectly(cachedDeposit)) {
+                        spokePoolClient.logger.warn({
+                            at: "[SDK]:DepositUtils#queryHistoricalDepositForFill",
+                            message: "Cached deposit was not formed correctly, removing from cache",
+                            fill: fill,
+                            cachedDeposit: cachedDeposit,
+                        });
+                        // By setting this value to undefined, we eventually have to pull
+                        // the deposit from our spoke pool client. Because this new deposit
+                        // is formed correctly, we will cache it below.
+                        cachedDeposit = undefined;
+                    }
+                    _a.label = 2;
+                case 2:
+                    if (!isDefined(cachedDeposit)) return [3 /*break*/, 3];
+                    deposit = cachedDeposit;
+                    return [3 /*break*/, 6];
+                case 3: return [4 /*yield*/, spokePoolClient.findDeposit(fill.depositId, fill.destinationChainId, fill.depositor)];
+                case 4:
+                    deposit = _a.sent();
+                    if (!cache) return [3 /*break*/, 6];
+                    return [4 /*yield*/, setDepositInCache(deposit, getCurrentTime(), cache, DEFAULT_CACHING_TTL)];
+                case 5:
+                    _a.sent();
+                    _a.label = 6;
+                case 6:
+                    if (validateFillForDeposit(fill, deposit)) {
+                        return [2 /*return*/, { found: true, deposit: deposit }];
+                    }
+                    return [2 /*return*/, {
+                            found: false,
+                            code: InvalidFill.FillMismatch,
+                            reason: "Fill is not valid for ".concat(getNetworkName(deposit.originChainId), " deposit ").concat(depositId),
+                        }];
+            }
+        });
+    });
+}
+/**
+ * Determines if a message is empty or not.
+ * @param message The message to check.
+ * @returns True if the message is empty, false otherwise.
+ */
+export function isMessageEmpty(message) {
+    if (message === void 0) { message = EMPTY_MESSAGE; }
+    return message === "" || message === "0x";
+}
+/**
+ * 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 function isDepositSpedUp(deposit) {
+    return isDefined(deposit.speedUpSignature) && isDefined(deposit.updatedOutputAmount);
+}
+/**
+ * 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 function resolveDepositMessage(deposit) {
+    var message = isDepositSpedUp(deposit) ? deposit.updatedMessage : deposit.message;
+    assert(isDefined(message)); // Appease tsc about the updatedMessage being possibly undefined.
+    return message;
+}
+//# sourceMappingURL=DepositUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DepositUtils.js","sourceRoot":"","sources":["../../../src/utils/DepositUtils.ts"],"names":[],"mappings":";AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACrF,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAE5D,4FAA4F;AAC5F,gGAAgG;AAChG,yDAAyD;AAEzD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,qEAAoB,CAAA;IACpB,uEAAiB,CAAA;IACjB,6DAAY,CAAA;AACd,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAMD;;;;;;;;;;;GAWG;AACH,MAAM,UAAgB,6BAA6B,CACjD,eAAgC,EAChC,IAA4B,EAC5B,KAAiC;;;;;;oBAEjC,IAAI,IAAI,CAAC,aAAa,KAAK,eAAe,CAAC,OAAO,EAAE;wBAClD,MAAM,IAAI,KAAK,CAAC,kCAA2B,IAAI,CAAC,aAAa,iBAAO,eAAe,CAAC,OAAO,MAAG,CAAC,CAAC;qBACjG;oBAED,kHAAkH;oBAClH,iEAAiE;oBACjE,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE;wBAC9B,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;qBACxF;oBAEO,SAAS,GAAK,IAAI,UAAT,CAAU;oBACO,KAAK,GAAwC,eAAe,2BAAvD,EAA6B,MAAM,GAAK,eAAe,0BAApB,CAAqB;oBAC/F,IAAI,SAAS,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,EAAE;wBAC3C,sBAAO;gCACL,KAAK,EAAE,KAAK;gCACZ,IAAI,EAAE,WAAW,CAAC,gBAAgB;gCAClC,MAAM,EAAE,qBAAc,SAAS,8CAAoC,KAAK,cAAI,MAAM,OAAI;6BACvF,EAAC;qBACH;oBAED,CAA6B,KAAK,GAAqC,eAAe,yBAApD,EAA0B,MAAM,GAAK,eAAe,uBAApB,CAAqB,CAAC;oBACxF,IAAI,SAAS,IAAI,KAAK,IAAI,SAAS,IAAI,MAAM,EAAE;wBACvC,YAAU,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;wBACtD,IAAI,SAAS,CAAC,SAAO,CAAC,IAAI,sBAAsB,CAAC,IAAI,EAAE,SAAO,CAAC,EAAE;4BAC/D,sBAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,WAAA,EAAE,EAAC;yBACjC;wBAED,sBAAO;gCACL,KAAK,EAAE,KAAK;gCACZ,IAAI,EAAE,SAAS,CAAC,SAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,iBAAiB;gCACnF,MAAM,EAAE,qBAAc,SAAS,gDAA6C;6BAC7E,EAAC;qBACH;yBAGG,KAAK,EAAL,wBAAK;oBACS,qBAAM,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,EAAA;;oBAAnE,aAAa,GAAG,SAAmD,CAAC;oBACpE,2DAA2D;oBAC3D,eAAe;oBACf,gCAAgC;oBAChC,IAAI,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,EAAE;wBACxE,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC;4BAC1B,EAAE,EAAE,kDAAkD;4BACtD,OAAO,EAAE,8DAA8D;4BACvE,IAAI,MAAA;4BACJ,aAAa,eAAA;yBACd,CAAC,CAAC;wBACH,iEAAiE;wBACjE,mEAAmE;wBACnE,+CAA+C;wBAC/C,aAAa,GAAG,SAAS,CAAC;qBAC3B;;;yBAGC,SAAS,CAAC,aAAa,CAAC,EAAxB,wBAAwB;oBAC1B,OAAO,GAAG,aAAiC,CAAC;;wBAElC,qBAAM,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAA;;oBAApG,OAAO,GAAG,SAA0F,CAAC;yBACjG,KAAK,EAAL,wBAAK;oBACP,qBAAM,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,mBAAmB,CAAC,EAAA;;oBAA9E,SAA8E,CAAC;;;oBAInF,IAAI,sBAAsB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;wBACzC,sBAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,SAAA,EAAE,EAAC;qBACjC;oBAED,sBAAO;4BACL,KAAK,EAAE,KAAK;4BACZ,IAAI,EAAE,WAAW,CAAC,YAAY;4BAC9B,MAAM,EAAE,gCAAyB,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,sBAAY,SAAS,CAAE;yBAC9F,EAAC;;;;CACH;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAAuB;IAAvB,wBAAA,EAAA,uBAAuB;IACpD,OAAO,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,IAAI,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,OAAgB;IAC9C,OAAO,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AACvF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAgB;IACpD,IAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACpF,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,iEAAiE;IAC7F,OAAO,OAAO,CAAC;AACjB,CAAC"}

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

@@ -0,0 +1,32 @@
+import { Result } from "@ethersproject/abi";
+import { SortableEvent } from "../interfaces";
+import { Contract, Event, EventFilter } from "ethers";
+export declare function spreadEvent(args?: Result): any;
+export interface EventSearchConfig {
+    fromBlock: number;
+    toBlock: number;
+    maxBlockLookBack?: number;
+}
+export declare function paginatedEventQuery(contract: Contract, filter: EventFilter, searchConfig: EventSearchConfig, retryCount?: number): Promise<Event[]>;
+/**
+ * @dev Warning: this is a specialized function!! Its functionality is not obvious.
+ * This function attempts to return block ranges to repeat ranges as much as possible. To do so, it may include blocks that
+ * are outside the provided range. The guarantee is that it will always include _at least_ the blocks requested.
+ * @param eventSearchConfig contains fromBlock, toBlock, and maxBlockLookBack.
+ * The range is inclusive, so the results will include events in the fromBlock and in the toBlock.
+ * maxBlockLookback defined the maximum number of blocks to search. Because the range is inclusive, the maximum diff
+ * in the returned pairs is maxBlockLookBack - 1. This is a bit non-intuitive here, but this is meant so that this
+ * parameter more closely aligns with the more commonly understood definition of a max query range that node providers
+ * use.
+ * @returns an array of disjoint fromBlock, toBlock ranges that should be queried. These cover at least the entire
+ * input range, but can include blocks outside of the desired range, so results should be filtered. Results
+ * are ordered from smallest to largest.
+ */
+export declare function getPaginatedBlockRanges({ fromBlock, toBlock, maxBlockLookBack, }: EventSearchConfig): [number, number][];
+export declare function spreadEventWithBlockNumber(event: Event): SortableEvent;
+export declare function sortEventsAscending<T extends SortableEvent>(events: T[]): T[];
+export declare function sortEventsAscendingInPlace<T extends SortableEvent>(events: T[]): T[];
+export declare function sortEventsDescending<T extends SortableEvent>(events: T[]): T[];
+export declare function sortEventsDescendingInPlace<T extends SortableEvent>(events: T[]): T[];
+export declare function isEventOlder<T extends SortableEvent>(ex: T, ey: T): boolean;
+export declare function getTransactionHashes(events: SortableEvent[]): string[];

package/dist/esm/utils/EventUtils.js

@@ -0,0 +1,194 @@
+import { __assign, __awaiter, __generator, __spreadArray } from "tslib";
+import { delay } from "./common";
+var maxRetries = 3;
+var retrySleepTime = 10;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function spreadEvent(args) {
+    if (args === void 0) { args = {}; }
+    var keys = Object.keys(args).filter(function (key) { return isNaN(+key); }); // Extract non-numeric keys.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    var returnedObject = {};
+    keys.forEach(function (key) {
+        switch (typeof args[key]) {
+            case "boolean": // fallthrough
+            case "number":
+            case "string":
+                returnedObject[key] = args[key];
+                break;
+            case "object":
+                if (Array.isArray(args[key])) {
+                    returnedObject[key] =
+                        Object.keys(args[key]).filter(function (key) { return isNaN(+key); }).length > 0
+                            ? spreadEvent(args[key]) // Record/array hybrid...
+                            : args[key]; // Just an array
+                }
+                else {
+                    returnedObject[key] = args[key];
+                }
+                break;
+        }
+    });
+    // ID information, if included in an event, should be cast to a number rather than a BigNumber.
+    if (returnedObject.groupIndex) {
+        returnedObject.groupIndex = Number(returnedObject.groupIndex);
+    }
+    if (returnedObject.leafId) {
+        returnedObject.leafId = Number(returnedObject.leafId);
+    }
+    if (returnedObject.chainId) {
+        returnedObject.chainId = Number(returnedObject.chainId);
+    }
+    if (returnedObject.destinationChainId) {
+        returnedObject.destinationChainId = Number(returnedObject.destinationChainId);
+    }
+    if (returnedObject.originChainId) {
+        returnedObject.originChainId = Number(returnedObject.originChainId);
+    }
+    if (returnedObject.repaymentChainId) {
+        returnedObject.repaymentChainId = Number(returnedObject.repaymentChainId);
+    }
+    if (returnedObject.l2ChainId) {
+        returnedObject.l2ChainId = Number(returnedObject.l2ChainId);
+    }
+    if (returnedObject.rootBundleId) {
+        returnedObject.rootBundleId = Number(returnedObject.rootBundleId);
+    }
+    return returnedObject;
+}
+export function paginatedEventQuery(contract, filter, searchConfig, retryCount) {
+    if (retryCount === void 0) { retryCount = 0; }
+    return __awaiter(this, void 0, void 0, function () {
+        var paginatedRanges, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!(searchConfig.maxBlockLookBack === 0)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, contract.queryFilter(filter, searchConfig.fromBlock, searchConfig.toBlock)];
+                case 1: return [2 /*return*/, _a.sent()];
+                case 2:
+                    paginatedRanges = getPaginatedBlockRanges(searchConfig);
+                    _a.label = 3;
+                case 3:
+                    _a.trys.push([3, 5, , 10]);
+                    return [4 /*yield*/, Promise.all(paginatedRanges.map(function (_a) {
+                            var fromBlock = _a[0], toBlock = _a[1];
+                            return contract.queryFilter(filter, fromBlock, toBlock);
+                        }))];
+                case 4: return [2 /*return*/, ((_a.sent())
+                        .flat()
+                        // Filter events by block number because ranges can include blocks that are outside the range specified for caching reasons.
+                        .filter(function (event) { return event.blockNumber >= searchConfig.fromBlock && event.blockNumber <= searchConfig.toBlock; }))];
+                case 5:
+                    error_1 = _a.sent();
+                    if (!(retryCount < maxRetries)) return [3 /*break*/, 8];
+                    return [4 /*yield*/, delay(retrySleepTime)];
+                case 6:
+                    _a.sent();
+                    return [4 /*yield*/, paginatedEventQuery(contract, filter, searchConfig, retryCount + 1)];
+                case 7: return [2 /*return*/, _a.sent()];
+                case 8: throw error_1;
+                case 9: return [3 /*break*/, 10];
+                case 10: return [2 /*return*/];
+            }
+        });
+    });
+}
+/**
+ * @dev Warning: this is a specialized function!! Its functionality is not obvious.
+ * This function attempts to return block ranges to repeat ranges as much as possible. To do so, it may include blocks that
+ * are outside the provided range. The guarantee is that it will always include _at least_ the blocks requested.
+ * @param eventSearchConfig contains fromBlock, toBlock, and maxBlockLookBack.
+ * The range is inclusive, so the results will include events in the fromBlock and in the toBlock.
+ * maxBlockLookback defined the maximum number of blocks to search. Because the range is inclusive, the maximum diff
+ * in the returned pairs is maxBlockLookBack - 1. This is a bit non-intuitive here, but this is meant so that this
+ * parameter more closely aligns with the more commonly understood definition of a max query range that node providers
+ * use.
+ * @returns an array of disjoint fromBlock, toBlock ranges that should be queried. These cover at least the entire
+ * input range, but can include blocks outside of the desired range, so results should be filtered. Results
+ * are ordered from smallest to largest.
+ */
+export function getPaginatedBlockRanges(_a) {
+    var fromBlock = _a.fromBlock, toBlock = _a.toBlock, maxBlockLookBack = _a.maxBlockLookBack;
+    // If the maxBlockLookBack is undefined, we can look back as far as we like. Just return the entire range.
+    if (maxBlockLookBack === undefined) {
+        return [[fromBlock, toBlock]];
+    }
+    // If the fromBlock is > toBlock, then return no ranges.
+    if (fromBlock > toBlock) {
+        return [];
+    }
+    // A maxBlockLookBack of 0 is not allowed.
+    if (maxBlockLookBack <= 0) {
+        throw new Error("Cannot set maxBlockLookBack <= 0");
+    }
+    // Floor the requestedFromBlock to the nearest smaller multiple of the maxBlockLookBack to enhance caching.
+    // This means that a range like 5 - 45 with a maxBlockLookBack of 20 would look like:
+    // 0-19, 20-39, 40-45.
+    // This allows us to get the max number of repeated node queries. The maximum number of "nonstandard" queries per
+    // call of this function is 1.
+    var flooredStartBlock = Math.floor(fromBlock / maxBlockLookBack) * maxBlockLookBack;
+    // Note: range is inclusive, so we have to add one to the number of blocks to query.
+    var iterations = Math.ceil((toBlock + 1 - flooredStartBlock) / maxBlockLookBack);
+    var ranges = [];
+    for (var i = 0; i < iterations; i++) {
+        // Each inner range start is just a multiple of the maxBlockLookBack added to the start block.
+        var innerFromBlock = flooredStartBlock + maxBlockLookBack * i;
+        // The innerFromBlock is just the max range from the innerFromBlock or the outer toBlock, whichever is smaller.
+        // The end block should never be larger than the outer toBlock. This is to avoid querying blocks that are in the
+        // future.
+        var innerToBlock = Math.min(innerFromBlock + maxBlockLookBack - 1, toBlock);
+        ranges.push([innerFromBlock, innerToBlock]);
+    }
+    return ranges;
+}
+export function spreadEventWithBlockNumber(event) {
+    return __assign(__assign({}, spreadEvent(event.args)), { blockNumber: event.blockNumber, transactionIndex: event.transactionIndex, logIndex: event.logIndex, transactionHash: event.transactionHash });
+}
+// This copies the array and sorts it, returning a new array with the new ordering.
+export function sortEventsAscending(events) {
+    return sortEventsAscendingInPlace(__spreadArray([], events, true));
+}
+// This sorts the events in place, meaning it modifies the passed array and returns a reference to the same array.
+// Note: this method should only be used in cases where modifications are acceptable.
+export function sortEventsAscendingInPlace(events) {
+    return events.sort(function (ex, ey) {
+        if (ex.blockNumber !== ey.blockNumber) {
+            return ex.blockNumber - ey.blockNumber;
+        }
+        if (ex.transactionIndex !== ey.transactionIndex) {
+            return ex.transactionIndex - ey.transactionIndex;
+        }
+        return ex.logIndex - ey.logIndex;
+    });
+}
+// This copies the array and sorts it, returning a new array with the new ordering.
+export function sortEventsDescending(events) {
+    return sortEventsDescendingInPlace(__spreadArray([], events, true));
+}
+// This sorts the events in place, meaning it modifies the passed array and returns a reference to the same array.
+// Note: this method should only be used in cases where modifications are acceptable.
+export function sortEventsDescendingInPlace(events) {
+    return events.sort(function (ex, ey) {
+        if (ex.blockNumber !== ey.blockNumber) {
+            return ey.blockNumber - ex.blockNumber;
+        }
+        if (ex.transactionIndex !== ey.transactionIndex) {
+            return ey.transactionIndex - ex.transactionIndex;
+        }
+        return ey.logIndex - ex.logIndex;
+    });
+}
+// Returns true if ex is older than ey.
+export function isEventOlder(ex, ey) {
+    if (ex.blockNumber !== ey.blockNumber) {
+        return ex.blockNumber < ey.blockNumber;
+    }
+    if (ex.transactionIndex !== ey.transactionIndex) {
+        return ex.transactionIndex < ey.transactionIndex;
+    }
+    return ex.logIndex < ey.logIndex;
+}
+export function getTransactionHashes(events) {
+    return __spreadArray([], Array.from(new Set(events.map(function (e) { return e.transactionHash; }))), true);
+}
+//# sourceMappingURL=EventUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EventUtils.js","sourceRoot":"","sources":["../../../src/utils/EventUtils.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAIjC,IAAM,UAAU,GAAG,CAAC,CAAC;AACrB,IAAM,cAAc,GAAG,EAAE,CAAC;AAE1B,8DAA8D;AAC9D,MAAM,UAAU,WAAW,CAAC,IAA2B;IAA3B,qBAAA,EAAA,OAAe,EAAY;IACrD,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,UAAC,GAAW,IAAK,OAAA,KAAK,CAAC,CAAC,GAAG,CAAC,EAAX,CAAW,CAAC,CAAC,CAAC,4BAA4B;IAEjG,8DAA8D;IAC9D,IAAM,cAAc,GAAQ,EAAE,CAAC;IAC/B,IAAI,CAAC,OAAO,CAAC,UAAC,GAAW;QACvB,QAAQ,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE;YACxB,KAAK,SAAS,CAAC,CAAC,cAAc;YAC9B,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;oBAC5B,cAAc,CAAC,GAAG,CAAC;wBACjB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,UAAC,GAAW,IAAK,OAAA,KAAK,CAAC,CAAC,GAAG,CAAC,EAAX,CAAW,CAAC,CAAC,MAAM,GAAG,CAAC;4BACpE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,yBAAyB;4BAClD,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAgB;iBAClC;qBAAM;oBACL,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;iBACjC;gBACD,MAAM;SACT;IACH,CAAC,CAAC,CAAC;IAEH,+FAA+F;IAC/F,IAAI,cAAc,CAAC,UAAU,EAAE;QAC7B,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;KAC/D;IACD,IAAI,cAAc,CAAC,MAAM,EAAE;QACzB,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;KACvD;IACD,IAAI,cAAc,CAAC,OAAO,EAAE;QAC1B,cAAc,CAAC,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;KACzD;IACD,IAAI,cAAc,CAAC,kBAAkB,EAAE;QACrC,cAAc,CAAC,kBAAkB,GAAG,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;KAC/E;IACD,IAAI,cAAc,CAAC,aAAa,EAAE;QAChC,cAAc,CAAC,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;KACrE;IACD,IAAI,cAAc,CAAC,gBAAgB,EAAE;QACnC,cAAc,CAAC,gBAAgB,GAAG,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;KAC3E;IACD,IAAI,cAAc,CAAC,SAAS,EAAE;QAC5B,cAAc,CAAC,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;KAC7D;IACD,IAAI,cAAc,CAAC,YAAY,EAAE;QAC/B,cAAc,CAAC,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;KACnE;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAQD,MAAM,UAAgB,mBAAmB,CACvC,QAAkB,EAClB,MAAmB,EACnB,YAA+B,EAC/B,UAAc;IAAd,2BAAA,EAAA,cAAc;;;;;;yBAGV,CAAA,YAAY,CAAC,gBAAgB,KAAK,CAAC,CAAA,EAAnC,wBAAmC;oBAC9B,qBAAM,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAA;wBAAvF,sBAAO,SAAgF,EAAC;;oBAMpF,eAAe,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;;;;oBAKxD,qBAAM,OAAO,CAAC,GAAG,CACf,eAAe,CAAC,GAAG,CAAC,UAAC,EAAoB;gCAAnB,SAAS,QAAA,EAAE,OAAO,QAAA;4BAAM,OAAA,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;wBAAhD,CAAgD,CAAC,CAChG,EAAA;wBAJL,sBAAO,CACL,CACE,SAEC,CACF;yBACE,IAAI,EAAE;wBACP,4HAA4H;yBAC3H,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,WAAW,IAAI,YAAY,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,IAAI,YAAY,CAAC,OAAO,EAAxF,CAAwF,CAAC,CAC/G,EAAC;;;yBAEE,CAAA,UAAU,GAAG,UAAU,CAAA,EAAvB,wBAAuB;oBACzB,qBAAM,KAAK,CAAC,cAAc,CAAC,EAAA;;oBAA3B,SAA2B,CAAC;oBACrB,qBAAM,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,GAAG,CAAC,CAAC,EAAA;wBAAhF,sBAAO,SAAyE,EAAC;wBAEjF,MAAM,OAAK,CAAC;;;;;;CAGjB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CAAC,EAIpB;QAHlB,SAAS,eAAA,EACT,OAAO,aAAA,EACP,gBAAgB,sBAAA;IAEhB,0GAA0G;IAC1G,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAClC,OAAO,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;KAC/B;IAED,wDAAwD;IACxD,IAAI,SAAS,GAAG,OAAO,EAAE;QACvB,OAAO,EAAE,CAAC;KACX;IAED,0CAA0C;IAC1C,IAAI,gBAAgB,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IAED,2GAA2G;IAC3G,qFAAqF;IACrF,sBAAsB;IACtB,iHAAiH;IACjH,8BAA8B;IAC9B,IAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;IAEtF,oFAAoF;IACpF,IAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,gBAAgB,CAAC,CAAC;IAEnF,IAAM,MAAM,GAAuB,EAAE,CAAC;IACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE;QACnC,8FAA8F;QAC9F,IAAM,cAAc,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,CAAC,CAAC;QAEhE,+GAA+G;QAC/G,gHAAgH;QAChH,UAAU;QACV,IAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,gBAAgB,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;QAC9E,MAAM,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;KAC7C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAAY;IACrD,6BACK,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,KAC1B,WAAW,EAAE,KAAK,CAAC,WAAW,EAC9B,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,EACxC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,eAAe,EAAE,KAAK,CAAC,eAAe,IACtC;AACJ,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,mBAAmB,CAA0B,MAAW;IACtE,OAAO,0BAA0B,mBAAK,MAAM,QAAE,CAAC;AACjD,CAAC;AAED,kHAAkH;AAClH,qFAAqF;AACrF,MAAM,UAAU,0BAA0B,CAA0B,MAAW;IAC7E,OAAO,MAAM,CAAC,IAAI,CAAC,UAAC,EAAE,EAAE,EAAE;QACxB,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,EAAE;YACrC,OAAO,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;SACxC;QACD,IAAI,EAAE,CAAC,gBAAgB,KAAK,EAAE,CAAC,gBAAgB,EAAE;YAC/C,OAAO,EAAE,CAAC,gBAAgB,GAAG,EAAE,CAAC,gBAAgB,CAAC;SAClD;QACD,OAAO,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,oBAAoB,CAA0B,MAAW;IACvE,OAAO,2BAA2B,mBAAK,MAAM,QAAE,CAAC;AAClD,CAAC;AAED,kHAAkH;AAClH,qFAAqF;AACrF,MAAM,UAAU,2BAA2B,CAA0B,MAAW;IAC9E,OAAO,MAAM,CAAC,IAAI,CAAC,UAAC,EAAE,EAAE,EAAE;QACxB,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,EAAE;YACrC,OAAO,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;SACxC;QACD,IAAI,EAAE,CAAC,gBAAgB,KAAK,EAAE,CAAC,gBAAgB,EAAE;YAC/C,OAAO,EAAE,CAAC,gBAAgB,GAAG,EAAE,CAAC,gBAAgB,CAAC;SAClD;QACD,OAAO,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,uCAAuC;AACvC,MAAM,UAAU,YAAY,CAA0B,EAAK,EAAE,EAAK;IAChE,IAAI,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,EAAE;QACrC,OAAO,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;KACxC;IACD,IAAI,EAAE,CAAC,gBAAgB,KAAK,EAAE,CAAC,gBAAgB,EAAE;QAC/C,OAAO,EAAE,CAAC,gBAAgB,GAAG,EAAE,CAAC,gBAAgB,CAAC;KAClD;IACD,OAAO,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAuB;IAC1D,yBAAW,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,eAAe,EAAjB,CAAiB,CAAC,CAAC,CAAC,QAAE;AACxE,CAAC"}

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

@@ -0,0 +1,8 @@
+import { Deposit, Fill, RelayData } from "../interfaces";
+export declare const FILL_DEPOSIT_COMPARISON_KEYS: readonly ["depositId", "originChainId", "destinationChainId", "depositor", "recipient", "message"];
+export declare const V3_DEPOSIT_COMPARISON_KEYS: readonly ["depositId", "originChainId", "destinationChainId", "depositor", "recipient", "message", "inputToken", "inputAmount", "outputToken", "outputAmount", "fillDeadline", "exclusivityDeadline", "exclusiveRelayer"];
+export declare function filledSameDeposit(fillA: Fill, fillB: Fill): boolean;
+export declare function validateFillForDeposit(relayData: RelayData & {
+    destinationChainId: number;
+}, // V3Fill, SlowFillRequest...
+deposit?: Deposit): boolean;

package/dist/esm/utils/FlowUtils.js

@@ -0,0 +1,39 @@
+import { __spreadArray } from "tslib";
+import { getRelayDataHash } from "./SpokeUtils";
+export var FILL_DEPOSIT_COMPARISON_KEYS = [
+    "depositId",
+    "originChainId",
+    "destinationChainId",
+    "depositor",
+    "recipient",
+    "message",
+];
+export var V3_DEPOSIT_COMPARISON_KEYS = __spreadArray(__spreadArray([], FILL_DEPOSIT_COMPARISON_KEYS, true), [
+    "inputToken",
+    "inputAmount",
+    "outputToken",
+    "outputAmount",
+    "fillDeadline",
+    "exclusivityDeadline",
+    "exclusiveRelayer",
+], false);
+export function filledSameDeposit(fillA, fillB) {
+    // Don't bother hashing obvious mismatches.
+    if (fillA.depositId !== fillB.depositId) {
+        return false;
+    }
+    var chainA = fillA.destinationChainId;
+    var chainB = fillB.destinationChainId;
+    return getRelayDataHash(fillA, chainA) === getRelayDataHash(fillB, chainB);
+}
+export function validateFillForDeposit(relayData, // V3Fill, SlowFillRequest...
+deposit) {
+    if (deposit === undefined) {
+        return false;
+    }
+    return validateV3FillForDeposit(relayData, deposit);
+}
+function validateV3FillForDeposit(fill, deposit) {
+    return getRelayDataHash(fill, fill.destinationChainId) === getRelayDataHash(deposit, deposit.destinationChainId);
+}
+//# sourceMappingURL=FlowUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FlowUtils.js","sourceRoot":"","sources":["../../../src/utils/FlowUtils.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,CAAC,IAAM,4BAA4B,GAAG;IAC1C,WAAW;IACX,eAAe;IACf,oBAAoB;IACpB,WAAW;IACX,WAAW;IACX,SAAS;CACD,CAAC;AAEX,MAAM,CAAC,IAAM,0BAA0B,GAAG,gCACrC,4BAA4B;IAC/B,YAAY;IACZ,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,kBAAkB;SACV,CAAC;AAEX,MAAM,UAAU,iBAAiB,CAAC,KAAW,EAAE,KAAW;IACxD,2CAA2C;IAC3C,IAAI,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,EAAE;QACvC,OAAO,KAAK,CAAC;KACd;IAEO,IAAoB,MAAM,GAAK,KAAK,mBAAV,CAAW;IACrC,IAAoB,MAAM,GAAK,KAAK,mBAAV,CAAW;IAC7C,OAAO,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,SAAqD,EAAE,6BAA6B;AACpF,OAAiB;IAEjB,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IAED,OAAO,wBAAwB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,wBAAwB,CAAC,IAA4B,EAAE,OAAgB;IAC9E,OAAO,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,KAAK,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACnH,CAAC"}

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

@@ -0,0 +1,61 @@
+import { ethers } from "ethers";
+import { BN } from "./BigNumberUtils";
+export declare const formatWithMaxDecimals: (num: number | string, decimalPlaces: number, minPrecision: number, roundUp: boolean, showSign: boolean) => string;
+export declare const createFormatFunction: (numDisplayedDecimals: number, minDisplayedPrecision: number, showSign?: boolean, decimals?: number) => (valInWei: string | BN) => string;
+export declare const formatFeePct: (relayerFeePct: BN) => string;
+/**
+ * Shortens a lengthy hexadecimal string to a shorter version with an ellipsis in the middle.
+ * @param hex A hexadecimal string to be shortened.
+ * @param maxLength The maximum length of the shortened string. Defaults to 8.
+ * @param delimiter The delimiter to use in the middle of the shortened string. Defaults to "...".
+ * @returns The shortened hexadecimal string.
+ * @example createShortHexString("0x772871a444c6e4e9903d8533a5a13101b74037158123e6709470f0afbf6e7d94") -> "0x7787...7d94"
+ */
+export declare function createShortHexString(hex: string, maxLength?: number, delimiter?: string): string;
+/**
+ * Converts a utf8 string to a hex string.
+ * @param input The utf8 string to convert.
+ * @returns The hex string.
+ */
+export declare function utf8ToHex(input: string): string;
+/**
+ * Converts a hexadecimal string to a utf8 string.
+ * @param input The hexadecimal string to convert.
+ * @returns The utf8 string.
+ */
+export declare function hexToUtf8(input: string): string;
+/**
+ * Converts a BigNumber to a 32-byte hexadecimal string.
+ *
+ * @param input - The BigNumber to convert.
+ * @returns The 32-byte hexadecimal string representation of the input.
+ */
+export declare function bnToHex(input: BN): string;
+/**
+ * Converts a value from wei to a decimal value with the specified number of decimal places.
+ * @param weiVal - The value in wei to convert.
+ * @param decimals - The number of decimal places to include in the converted value.
+ * @returns The converted value as a string.
+ */
+export declare function convertFromWei(weiVal: string, decimals: number): string;
+/**
+ * Shortens a list of addresses to a shorter version with only the first 10 characters.
+ * @param addresses A list of addresses to shorten.
+ * @returns A list of shortened addresses.
+ * @see createShortHexString
+ */
+export declare function shortenHexStrings(addresses: string[]): string[];
+export declare const formatWei: (num: string | BN) => string;
+export declare const ConvertDecimals: (fromDecimals: number, toDecimals: number) => (amountIn: string | number | BN) => BN;
+/**
+ * Converts a numeric decimal-inclusive string to winston, the base unit of Arweave
+ * @param numericString The numeric string to convert
+ * @returns The winston representation of the numeric string as a BigNumber
+ */
+export declare function parseWinston(numericString: string): ethers.BigNumber;
+/**
+ * Converts a winston value to a numeric string
+ * @param winstonValue The winston value to convert
+ * @returns The numeric string representation of the winston value
+ */
+export declare function formatWinston(winstonValue: ethers.BigNumber): string;