@across-protocol/sdk 3.0.0

package/dist/cjs/utils/CachingUtils.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDepositKey = exports.setDepositInCache = exports.getDepositInCache = exports.shouldCache = void 0;
+var tslib_1 = require("tslib");
+var constants_1 = require("../constants");
+var LogUtils_1 = require("./LogUtils");
+var ReviverUtils_1 = require("./ReviverUtils");
+var SpokeUtils_1 = require("./SpokeUtils");
+var TimeUtils_1 = require("./TimeUtils");
+var TypeGuards_1 = require("./TypeGuards");
+function shouldCache(eventTimestamp, latestTime, cachingMaxAge) {
+    (0, LogUtils_1.assert)(eventTimestamp.toString().length === 10, "eventTimestamp must be in seconds");
+    (0, LogUtils_1.assert)(latestTime.toString().length === 10, "eventTimestamp must be in seconds");
+    return latestTime - eventTimestamp >= cachingMaxAge;
+}
+exports.shouldCache = shouldCache;
+function getDepositInCache(key, cache) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var depositRaw;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, cache.get(key)];
+                case 1:
+                    depositRaw = _a.sent();
+                    return [2, (0, TypeGuards_1.isDefined)(depositRaw) ? JSON.parse(depositRaw, (0, ReviverUtils_1.composeRevivers)(ReviverUtils_1.objectWithBigNumberReviver)) : undefined];
+            }
+        });
+    });
+}
+exports.getDepositInCache = getDepositInCache;
+function setDepositInCache(deposit, currentChainTime, cache, expirySeconds, timeToCache) {
+    if (expirySeconds === void 0) { expirySeconds = constants_1.DEFAULT_CACHING_TTL; }
+    if (timeToCache === void 0) { timeToCache = constants_1.DEFAULT_CACHING_SAFE_LAG; }
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var currentTimeInSeconds;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    currentTimeInSeconds = (0, TimeUtils_1.getCurrentTime)();
+                    if (deposit.quoteTimestamp > currentTimeInSeconds || currentChainTime > currentTimeInSeconds) {
+                        return [2];
+                    }
+                    if (!shouldCache(deposit.quoteTimestamp, currentChainTime, timeToCache)) return [3, 2];
+                    return [4, cache.set(getDepositKey(deposit), JSON.stringify(deposit), expirySeconds)];
+                case 1:
+                    _a.sent();
+                    _a.label = 2;
+                case 2: return [2];
+            }
+        });
+    });
+}
+exports.setDepositInCache = setDepositInCache;
+function getDepositKey(bridgeEvent) {
+    var relayHash = (0, SpokeUtils_1.getRelayHashFromEvent)(bridgeEvent);
+    return "deposit_".concat(bridgeEvent.originChainId, "_").concat(bridgeEvent.depositId, "_").concat(relayHash);
+}
+exports.getDepositKey = getDepositKey;
+//# sourceMappingURL=CachingUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CachingUtils.js","sourceRoot":"","sources":["../../../src/utils/CachingUtils.ts"],"names":[],"mappings":";;;;AAAA,0CAA6E;AAE7E,uCAAoC;AACpC,+CAA6E;AAC7E,2CAAqD;AACrD,yCAA6C;AAC7C,2CAAyC;AAEzC,SAAgB,WAAW,CAAC,cAAsB,EAAE,UAAkB,EAAE,aAAqB;IAC3F,IAAA,iBAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,mCAAmC,CAAC,CAAC;IACrF,IAAA,iBAAM,EAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,mCAAmC,CAAC,CAAC;IACjF,OAAO,UAAU,GAAG,cAAc,IAAI,aAAa,CAAC;AACtD,CAAC;AAJD,kCAIC;AAQD,SAAsB,iBAAiB,CAAC,GAAW,EAAE,KAAgC;;;;;wBAChE,WAAM,KAAK,CAAC,GAAG,CAAS,GAAG,CAAC,EAAA;;oBAAzC,UAAU,GAAG,SAA4B;oBAC/C,WAAO,IAAA,sBAAS,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,IAAA,8BAAe,EAAC,yCAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAC;;;;CAChH;AAHD,8CAGC;AAED,SAAsB,iBAAiB,CACrC,OAAgB,EAChB,gBAAwB,EACxB,KAAgC,EAChC,aAAmC,EACnC,WAAsC;IADtC,8BAAA,EAAA,gBAAgB,+BAAmB;IACnC,4BAAA,EAAA,cAAc,oCAAwB;;;;;;oBAEhC,oBAAoB,GAAG,IAAA,0BAAc,GAAE,CAAC;oBAG9C,IAAI,OAAO,CAAC,cAAc,GAAG,oBAAoB,IAAI,gBAAgB,GAAG,oBAAoB,EAAE;wBAC5F,WAAO;qBACR;yBAIG,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,EAAE,WAAW,CAAC,EAAlE,cAAkE;oBACpE,WAAM,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAA;;oBAA/E,SAA+E,CAAC;;;;;;CAEnF;AAnBD,8CAmBC;AAQD,SAAgB,aAAa,CAAC,WAA6C;IACzE,IAAM,SAAS,GAAG,IAAA,kCAAqB,EAAC,WAAW,CAAC,CAAC;IACrD,OAAO,kBAAW,WAAW,CAAC,aAAa,cAAI,WAAW,CAAC,SAAS,cAAI,SAAS,CAAE,CAAC;AACtF,CAAC;AAHD,sCAGC"}

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

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

package/dist/cjs/utils/DeploymentUtils.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeployedBlockNumber = exports.getDeployedAddress = exports.getContractInfoFromAddress = void 0;
+var DeploymentUtils_1 = require("@across-protocol/contracts/dist/src/DeploymentUtils");
+Object.defineProperty(exports, "getContractInfoFromAddress", { enumerable: true, get: function () { return DeploymentUtils_1.getContractInfoFromAddress; } });
+Object.defineProperty(exports, "getDeployedAddress", { enumerable: true, get: function () { return DeploymentUtils_1.getDeployedAddress; } });
+Object.defineProperty(exports, "getDeployedBlockNumber", { enumerable: true, get: function () { return DeploymentUtils_1.getDeployedBlockNumber; } });
+//# sourceMappingURL=DeploymentUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DeploymentUtils.js","sourceRoot":"","sources":["../../../src/utils/DeploymentUtils.ts"],"names":[],"mappings":";;;AAAA,uFAI6D;AAH3D,6HAAA,0BAA0B,OAAA;AAC1B,qHAAA,kBAAkB,OAAA;AAClB,yHAAA,sBAAsB,OAAA"}

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

@@ -0,0 +1,19 @@
+import { SpokePoolClient } from "../clients";
+import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillRequest } from "../interfaces";
+export declare enum InvalidFill {
+    DepositIdInvalid = 0,
+    DepositIdNotFound = 1,
+    FillMismatch = 2
+}
+export type DepositSearchResult = {
+    found: true;
+    deposit: DepositWithBlock;
+} | {
+    found: false;
+    code: InvalidFill;
+    reason: string;
+};
+export declare function queryHistoricalDepositForFill(spokePoolClient: SpokePoolClient, fill: Fill | SlowFillRequest, cache?: CachingMechanismInterface): Promise<DepositSearchResult>;
+export declare function isMessageEmpty(message?: string): boolean;
+export declare function isDepositSpedUp(deposit: Deposit): boolean;
+export declare function resolveDepositMessage(deposit: Deposit): string;

package/dist/cjs/utils/DepositUtils.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveDepositMessage = exports.isDepositSpedUp = exports.isMessageEmpty = exports.queryHistoricalDepositForFill = exports.InvalidFill = void 0;
+var tslib_1 = require("tslib");
+var assert_1 = tslib_1.__importDefault(require("assert"));
+var constants_1 = require("../constants");
+var NetworkUtils_1 = require("./NetworkUtils");
+var CachingUtils_1 = require("./CachingUtils");
+var FlowUtils_1 = require("./FlowUtils");
+var TimeUtils_1 = require("./TimeUtils");
+var TypeGuards_1 = require("./TypeGuards");
+var ValidatorUtils_1 = require("./ValidatorUtils");
+var InvalidFill;
+(function (InvalidFill) {
+    InvalidFill[InvalidFill["DepositIdInvalid"] = 0] = "DepositIdInvalid";
+    InvalidFill[InvalidFill["DepositIdNotFound"] = 1] = "DepositIdNotFound";
+    InvalidFill[InvalidFill["FillMismatch"] = 2] = "FillMismatch";
+})(InvalidFill || (exports.InvalidFill = InvalidFill = {}));
+function queryHistoricalDepositForFill(spokePoolClient, fill, cache) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var depositId, lowId, highId, deposit_1, deposit, cachedDeposit;
+        return tslib_1.__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, ")"));
+                    }
+                    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, {
+                                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 ((0, TypeGuards_1.isDefined)(deposit_1) && (0, FlowUtils_1.validateFillForDeposit)(fill, deposit_1)) {
+                            return [2, { found: true, deposit: deposit_1 }];
+                        }
+                        return [2, {
+                                found: false,
+                                code: (0, TypeGuards_1.isDefined)(deposit_1) ? InvalidFill.FillMismatch : InvalidFill.DepositIdNotFound,
+                                reason: "Deposit ID ".concat(depositId, " not found in SpokePoolClient event buffer."),
+                            }];
+                    }
+                    if (!cache) return [3, 2];
+                    return [4, (0, CachingUtils_1.getDepositInCache)((0, CachingUtils_1.getDepositKey)(fill), cache)];
+                case 1:
+                    cachedDeposit = _a.sent();
+                    if ((0, TypeGuards_1.isDefined)(cachedDeposit) && !(0, ValidatorUtils_1.isDepositFormedCorrectly)(cachedDeposit)) {
+                        spokePoolClient.logger.warn({
+                            at: "[SDK]:DepositUtils#queryHistoricalDepositForFill",
+                            message: "Cached deposit was not formed correctly, removing from cache",
+                            fill: fill,
+                            cachedDeposit: cachedDeposit,
+                        });
+                        cachedDeposit = undefined;
+                    }
+                    _a.label = 2;
+                case 2:
+                    if (!(0, TypeGuards_1.isDefined)(cachedDeposit)) return [3, 3];
+                    deposit = cachedDeposit;
+                    return [3, 6];
+                case 3: return [4, spokePoolClient.findDeposit(fill.depositId, fill.destinationChainId, fill.depositor)];
+                case 4:
+                    deposit = _a.sent();
+                    if (!cache) return [3, 6];
+                    return [4, (0, CachingUtils_1.setDepositInCache)(deposit, (0, TimeUtils_1.getCurrentTime)(), cache, constants_1.DEFAULT_CACHING_TTL)];
+                case 5:
+                    _a.sent();
+                    _a.label = 6;
+                case 6:
+                    if ((0, FlowUtils_1.validateFillForDeposit)(fill, deposit)) {
+                        return [2, { found: true, deposit: deposit }];
+                    }
+                    return [2, {
+                            found: false,
+                            code: InvalidFill.FillMismatch,
+                            reason: "Fill is not valid for ".concat((0, NetworkUtils_1.getNetworkName)(deposit.originChainId), " deposit ").concat(depositId),
+                        }];
+            }
+        });
+    });
+}
+exports.queryHistoricalDepositForFill = queryHistoricalDepositForFill;
+function isMessageEmpty(message) {
+    if (message === void 0) { message = constants_1.EMPTY_MESSAGE; }
+    return message === "" || message === "0x";
+}
+exports.isMessageEmpty = isMessageEmpty;
+function isDepositSpedUp(deposit) {
+    return (0, TypeGuards_1.isDefined)(deposit.speedUpSignature) && (0, TypeGuards_1.isDefined)(deposit.updatedOutputAmount);
+}
+exports.isDepositSpedUp = isDepositSpedUp;
+function resolveDepositMessage(deposit) {
+    var message = isDepositSpedUp(deposit) ? deposit.updatedMessage : deposit.message;
+    (0, assert_1.default)((0, TypeGuards_1.isDefined)(message));
+    return message;
+}
+exports.resolveDepositMessage = resolveDepositMessage;
+//# sourceMappingURL=DepositUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DepositUtils.js","sourceRoot":"","sources":["../../../src/utils/DepositUtils.ts"],"names":[],"mappings":";;;;AAAA,0DAA4B;AAE5B,0CAAkE;AAElE,+CAAgD;AAChD,+CAAqF;AACrF,yCAAqD;AACrD,yCAA6C;AAC7C,2CAAyC;AACzC,mDAA4D;AAM5D,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,qEAAoB,CAAA;IACpB,uEAAiB,CAAA;IACjB,6DAAY,CAAA;AACd,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAkBD,SAAsB,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;oBAID,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,WAAO;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,IAAA,sBAAS,EAAC,SAAO,CAAC,IAAI,IAAA,kCAAsB,EAAC,IAAI,EAAE,SAAO,CAAC,EAAE;4BAC/D,WAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,WAAA,EAAE,EAAC;yBACjC;wBAED,WAAO;gCACL,KAAK,EAAE,KAAK;gCACZ,IAAI,EAAE,IAAA,sBAAS,EAAC,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,cAAK;oBACS,WAAM,IAAA,gCAAiB,EAAC,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,KAAK,CAAC,EAAA;;oBAAnE,aAAa,GAAG,SAAmD,CAAC;oBAIpE,IAAI,IAAA,sBAAS,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,yCAAwB,EAAC,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;wBAIH,aAAa,GAAG,SAAS,CAAC;qBAC3B;;;yBAGC,IAAA,sBAAS,EAAC,aAAa,CAAC,EAAxB,cAAwB;oBAC1B,OAAO,GAAG,aAAiC,CAAC;;wBAElC,WAAM,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,cAAK;oBACP,WAAM,IAAA,gCAAiB,EAAC,OAAO,EAAE,IAAA,0BAAc,GAAE,EAAE,KAAK,EAAE,+BAAmB,CAAC,EAAA;;oBAA9E,SAA8E,CAAC;;;oBAInF,IAAI,IAAA,kCAAsB,EAAC,IAAI,EAAE,OAAO,CAAC,EAAE;wBACzC,WAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,SAAA,EAAE,EAAC;qBACjC;oBAED,WAAO;4BACL,KAAK,EAAE,KAAK;4BACZ,IAAI,EAAE,WAAW,CAAC,YAAY;4BAC9B,MAAM,EAAE,gCAAyB,IAAA,6BAAc,EAAC,OAAO,CAAC,aAAa,CAAC,sBAAY,SAAS,CAAE;yBAC9F,EAAC;;;;CACH;AA7ED,sEA6EC;AAOD,SAAgB,cAAc,CAAC,OAAuB;IAAvB,wBAAA,EAAA,UAAU,yBAAa;IACpD,OAAO,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,IAAI,CAAC;AAC5C,CAAC;AAFD,wCAEC;AAOD,SAAgB,eAAe,CAAC,OAAgB;IAC9C,OAAO,IAAA,sBAAS,EAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,IAAA,sBAAS,EAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AACvF,CAAC;AAFD,0CAEC;AAOD,SAAgB,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,IAAA,gBAAM,EAAC,IAAA,sBAAS,EAAC,OAAO,CAAC,CAAC,CAAC;IAC3B,OAAO,OAAO,CAAC;AACjB,CAAC;AAJD,sDAIC"}

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

@@ -0,0 +1,18 @@
+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[]>;
+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/cjs/utils/EventUtils.js

@@ -0,0 +1,169 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTransactionHashes = exports.isEventOlder = exports.sortEventsDescendingInPlace = exports.sortEventsDescending = exports.sortEventsAscendingInPlace = exports.sortEventsAscending = exports.spreadEventWithBlockNumber = exports.getPaginatedBlockRanges = exports.paginatedEventQuery = exports.spreadEvent = void 0;
+var tslib_1 = require("tslib");
+var common_1 = require("./common");
+var maxRetries = 3;
+var retrySleepTime = 10;
+function spreadEvent(args) {
+    if (args === void 0) { args = {}; }
+    var keys = Object.keys(args).filter(function (key) { return isNaN(+key); });
+    var returnedObject = {};
+    keys.forEach(function (key) {
+        switch (typeof args[key]) {
+            case "boolean":
+            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])
+                            : args[key];
+                }
+                else {
+                    returnedObject[key] = args[key];
+                }
+                break;
+        }
+    });
+    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;
+}
+exports.spreadEvent = spreadEvent;
+function paginatedEventQuery(contract, filter, searchConfig, retryCount) {
+    if (retryCount === void 0) { retryCount = 0; }
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var paginatedRanges, error_1;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!(searchConfig.maxBlockLookBack === 0)) return [3, 2];
+                    return [4, contract.queryFilter(filter, searchConfig.fromBlock, searchConfig.toBlock)];
+                case 1: return [2, _a.sent()];
+                case 2:
+                    paginatedRanges = getPaginatedBlockRanges(searchConfig);
+                    _a.label = 3;
+                case 3:
+                    _a.trys.push([3, 5, , 10]);
+                    return [4, Promise.all(paginatedRanges.map(function (_a) {
+                            var fromBlock = _a[0], toBlock = _a[1];
+                            return contract.queryFilter(filter, fromBlock, toBlock);
+                        }))];
+                case 4: return [2, ((_a.sent())
+                        .flat()
+                        .filter(function (event) { return event.blockNumber >= searchConfig.fromBlock && event.blockNumber <= searchConfig.toBlock; }))];
+                case 5:
+                    error_1 = _a.sent();
+                    if (!(retryCount < maxRetries)) return [3, 8];
+                    return [4, (0, common_1.delay)(retrySleepTime)];
+                case 6:
+                    _a.sent();
+                    return [4, paginatedEventQuery(contract, filter, searchConfig, retryCount + 1)];
+                case 7: return [2, _a.sent()];
+                case 8: throw error_1;
+                case 9: return [3, 10];
+                case 10: return [2];
+            }
+        });
+    });
+}
+exports.paginatedEventQuery = paginatedEventQuery;
+function getPaginatedBlockRanges(_a) {
+    var fromBlock = _a.fromBlock, toBlock = _a.toBlock, maxBlockLookBack = _a.maxBlockLookBack;
+    if (maxBlockLookBack === undefined) {
+        return [[fromBlock, toBlock]];
+    }
+    if (fromBlock > toBlock) {
+        return [];
+    }
+    if (maxBlockLookBack <= 0) {
+        throw new Error("Cannot set maxBlockLookBack <= 0");
+    }
+    var flooredStartBlock = Math.floor(fromBlock / maxBlockLookBack) * maxBlockLookBack;
+    var iterations = Math.ceil((toBlock + 1 - flooredStartBlock) / maxBlockLookBack);
+    var ranges = [];
+    for (var i = 0; i < iterations; i++) {
+        var innerFromBlock = flooredStartBlock + maxBlockLookBack * i;
+        var innerToBlock = Math.min(innerFromBlock + maxBlockLookBack - 1, toBlock);
+        ranges.push([innerFromBlock, innerToBlock]);
+    }
+    return ranges;
+}
+exports.getPaginatedBlockRanges = getPaginatedBlockRanges;
+function spreadEventWithBlockNumber(event) {
+    return tslib_1.__assign(tslib_1.__assign({}, spreadEvent(event.args)), { blockNumber: event.blockNumber, transactionIndex: event.transactionIndex, logIndex: event.logIndex, transactionHash: event.transactionHash });
+}
+exports.spreadEventWithBlockNumber = spreadEventWithBlockNumber;
+function sortEventsAscending(events) {
+    return sortEventsAscendingInPlace(tslib_1.__spreadArray([], events, true));
+}
+exports.sortEventsAscending = sortEventsAscending;
+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;
+    });
+}
+exports.sortEventsAscendingInPlace = sortEventsAscendingInPlace;
+function sortEventsDescending(events) {
+    return sortEventsDescendingInPlace(tslib_1.__spreadArray([], events, true));
+}
+exports.sortEventsDescending = sortEventsDescending;
+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;
+    });
+}
+exports.sortEventsDescendingInPlace = sortEventsDescendingInPlace;
+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;
+}
+exports.isEventOlder = isEventOlder;
+function getTransactionHashes(events) {
+    return tslib_1.__spreadArray([], Array.from(new Set(events.map(function (e) { return e.transactionHash; }))), true);
+}
+exports.getTransactionHashes = getTransactionHashes;
+//# sourceMappingURL=EventUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EventUtils.js","sourceRoot":"","sources":["../../../src/utils/EventUtils.ts"],"names":[],"mappings":";;;;AACA,mCAAiC;AAIjC,IAAM,UAAU,GAAG,CAAC,CAAC;AACrB,IAAM,cAAc,GAAG,EAAE,CAAC;AAG1B,SAAgB,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;IAGpE,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;YACf,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;4BACxB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBACjB;qBAAM;oBACL,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;iBACjC;gBACD,MAAM;SACT;IACH,CAAC,CAAC,CAAC;IAGH,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;AApDD,kCAoDC;AAQD,SAAsB,mBAAmB,CACvC,QAAkB,EAClB,MAAmB,EACnB,YAA+B,EAC/B,UAAc;IAAd,2BAAA,EAAA,cAAc;;;;;;yBAGV,CAAA,YAAY,CAAC,gBAAgB,KAAK,CAAC,CAAA,EAAnC,cAAmC;oBAC9B,WAAM,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAA;wBAAvF,WAAO,SAAgF,EAAC;;oBAMpF,eAAe,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;;;;oBAKxD,WAAM,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,WAAO,CACL,CACE,SAEC,CACF;yBACE,IAAI,EAAE;yBAEN,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,cAAuB;oBACzB,WAAM,IAAA,cAAK,EAAC,cAAc,CAAC,EAAA;;oBAA3B,SAA2B,CAAC;oBACrB,WAAM,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,GAAG,CAAC,CAAC,EAAA;wBAAhF,WAAO,SAAyE,EAAC;wBAEjF,MAAM,OAAK,CAAC;;;;;;CAGjB;AAnCD,kDAmCC;AAgBD,SAAgB,uBAAuB,CAAC,EAIpB;QAHlB,SAAS,eAAA,EACT,OAAO,aAAA,EACP,gBAAgB,sBAAA;IAGhB,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAClC,OAAO,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;KAC/B;IAGD,IAAI,SAAS,GAAG,OAAO,EAAE;QACvB,OAAO,EAAE,CAAC;KACX;IAGD,IAAI,gBAAgB,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IAOD,IAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;IAGtF,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;QAEnC,IAAM,cAAc,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,CAAC,CAAC;QAKhE,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;AA3CD,0DA2CC;AAED,SAAgB,0BAA0B,CAAC,KAAY;IACrD,6CACK,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;AARD,gEAQC;AAGD,SAAgB,mBAAmB,CAA0B,MAAW;IACtE,OAAO,0BAA0B,2BAAK,MAAM,QAAE,CAAC;AACjD,CAAC;AAFD,kDAEC;AAID,SAAgB,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;AAVD,gEAUC;AAGD,SAAgB,oBAAoB,CAA0B,MAAW;IACvE,OAAO,2BAA2B,2BAAK,MAAM,QAAE,CAAC;AAClD,CAAC;AAFD,oDAEC;AAID,SAAgB,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;AAVD,kEAUC;AAGD,SAAgB,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;AARD,oCAQC;AAED,SAAgB,oBAAoB,CAAC,MAAuB;IAC1D,iCAAW,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;AAFD,oDAEC"}

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

@@ -0,0 +1,7 @@
+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;
+}, deposit?: Deposit): boolean;

package/dist/cjs/utils/FlowUtils.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFillForDeposit = exports.filledSameDeposit = exports.V3_DEPOSIT_COMPARISON_KEYS = exports.FILL_DEPOSIT_COMPARISON_KEYS = void 0;
+var tslib_1 = require("tslib");
+var SpokeUtils_1 = require("./SpokeUtils");
+exports.FILL_DEPOSIT_COMPARISON_KEYS = [
+    "depositId",
+    "originChainId",
+    "destinationChainId",
+    "depositor",
+    "recipient",
+    "message",
+];
+exports.V3_DEPOSIT_COMPARISON_KEYS = tslib_1.__spreadArray(tslib_1.__spreadArray([], exports.FILL_DEPOSIT_COMPARISON_KEYS, true), [
+    "inputToken",
+    "inputAmount",
+    "outputToken",
+    "outputAmount",
+    "fillDeadline",
+    "exclusivityDeadline",
+    "exclusiveRelayer",
+], false);
+function filledSameDeposit(fillA, fillB) {
+    if (fillA.depositId !== fillB.depositId) {
+        return false;
+    }
+    var chainA = fillA.destinationChainId;
+    var chainB = fillB.destinationChainId;
+    return (0, SpokeUtils_1.getRelayDataHash)(fillA, chainA) === (0, SpokeUtils_1.getRelayDataHash)(fillB, chainB);
+}
+exports.filledSameDeposit = filledSameDeposit;
+function validateFillForDeposit(relayData, deposit) {
+    if (deposit === undefined) {
+        return false;
+    }
+    return validateV3FillForDeposit(relayData, deposit);
+}
+exports.validateFillForDeposit = validateFillForDeposit;
+function validateV3FillForDeposit(fill, deposit) {
+    return (0, SpokeUtils_1.getRelayDataHash)(fill, fill.destinationChainId) === (0, SpokeUtils_1.getRelayDataHash)(deposit, deposit.destinationChainId);
+}
+//# sourceMappingURL=FlowUtils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FlowUtils.js","sourceRoot":"","sources":["../../../src/utils/FlowUtils.ts"],"names":[],"mappings":";;;;AACA,2CAAgD;AAEnC,QAAA,4BAA4B,GAAG;IAC1C,WAAW;IACX,eAAe;IACf,oBAAoB;IACpB,WAAW;IACX,WAAW;IACX,SAAS;CACD,CAAC;AAEE,QAAA,0BAA0B,GAAG,gDACrC,oCAA4B;IAC/B,YAAY;IACZ,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,kBAAkB;SACV,CAAC;AAEX,SAAgB,iBAAiB,CAAC,KAAW,EAAE,KAAW;IAExD,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,IAAA,6BAAgB,EAAC,KAAK,EAAE,MAAM,CAAC,KAAK,IAAA,6BAAgB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC;AATD,8CASC;AAED,SAAgB,sBAAsB,CACpC,SAAqD,EACrD,OAAiB;IAEjB,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IAED,OAAO,wBAAwB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AATD,wDASC;AAED,SAAS,wBAAwB,CAAC,IAA4B,EAAE,OAAgB;IAC9E,OAAO,IAAA,6BAAgB,EAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAA,6BAAgB,EAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACnH,CAAC"}

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

@@ -0,0 +1,15 @@
+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;
+export declare function createShortHexString(hex: string, maxLength?: number, delimiter?: string): string;
+export declare function utf8ToHex(input: string): string;
+export declare function hexToUtf8(input: string): string;
+export declare function bnToHex(input: BN): string;
+export declare function convertFromWei(weiVal: string, decimals: number): string;
+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;
+export declare function parseWinston(numericString: string): ethers.BigNumber;
+export declare function formatWinston(winstonValue: ethers.BigNumber): string;

package/dist/cjs/utils/FormattingUtils.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatWinston = exports.parseWinston = exports.ConvertDecimals = exports.formatWei = exports.shortenHexStrings = exports.convertFromWei = exports.bnToHex = exports.hexToUtf8 = exports.utf8ToHex = exports.createShortHexString = exports.formatFeePct = exports.createFormatFunction = exports.formatWithMaxDecimals = void 0;
+var tslib_1 = require("tslib");
+var ethers_1 = require("ethers");
+var BigNumberUtils_1 = require("./BigNumberUtils");
+var common_1 = require("./common");
+var assert_1 = tslib_1.__importDefault(require("assert"));
+var bignumber_js_1 = require("bignumber.js");
+var formatWithMaxDecimals = function (num, decimalPlaces, minPrecision, roundUp, showSign) {
+    if (roundUp) {
+        bignumber_js_1.BigNumber.set({ ROUNDING_MODE: bignumber_js_1.BigNumber.ROUND_UP });
+    }
+    else {
+        bignumber_js_1.BigNumber.set({ ROUNDING_MODE: bignumber_js_1.BigNumber.ROUND_DOWN });
+    }
+    var fullPrecisionFloat = new bignumber_js_1.BigNumber(num);
+    var positiveSign = showSign && fullPrecisionFloat.gt(0) ? "+" : "";
+    var fixedPrecisionFloat;
+    if (fullPrecisionFloat.abs().gte(new bignumber_js_1.BigNumber(1))) {
+        fixedPrecisionFloat = new bignumber_js_1.BigNumber(fullPrecisionFloat).toFixed(decimalPlaces).toString();
+    }
+    else {
+        fixedPrecisionFloat = new bignumber_js_1.BigNumber(fullPrecisionFloat).toPrecision(minPrecision).toString();
+    }
+    var fixedPrecisionFloatParts = fixedPrecisionFloat.split(".");
+    fixedPrecisionFloatParts[0] = fixedPrecisionFloatParts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ",");
+    return positiveSign + fixedPrecisionFloatParts.join(".");
+};
+exports.formatWithMaxDecimals = formatWithMaxDecimals;
+var createFormatFunction = function (numDisplayedDecimals, minDisplayedPrecision, showSign, decimals) {
+    if (showSign === void 0) { showSign = false; }
+    if (decimals === void 0) { decimals = 18; }
+    return function (valInWei) {
+        return (0, exports.formatWithMaxDecimals)((0, exports.formatWei)((0, exports.ConvertDecimals)(decimals, 18)(valInWei)), numDisplayedDecimals, minDisplayedPrecision, false, showSign);
+    };
+};
+exports.createFormatFunction = createFormatFunction;
+var formatFeePct = function (relayerFeePct) {
+    return (0, exports.createFormatFunction)(2, 4, false, 16)((0, BigNumberUtils_1.toBN)(relayerFeePct).toString());
+};
+exports.formatFeePct = formatFeePct;
+function createShortHexString(hex, maxLength, delimiter) {
+    if (maxLength === void 0) { maxLength = 8; }
+    if (delimiter === void 0) { delimiter = ".."; }
+    if (hex.length <= maxLength) {
+        return hex;
+    }
+    var maxAvailable = maxLength - delimiter.length;
+    if (maxAvailable <= 0) {
+        throw new Error("Invalid max length");
+    }
+    var leftCharacters = Math.floor(maxAvailable / 2 + 0.5);
+    var rightCharacters = Math.floor(maxAvailable / 2);
+    return "".concat(hex.substring(0, leftCharacters)).concat(delimiter).concat(hex.substring(hex.length - rightCharacters));
+}
+exports.createShortHexString = createShortHexString;
+function utf8ToHex(input) {
+    return ethers_1.ethers.utils.formatBytes32String(input);
+}
+exports.utf8ToHex = utf8ToHex;
+function hexToUtf8(input) {
+    return ethers_1.ethers.utils.toUtf8String(input);
+}
+exports.hexToUtf8 = hexToUtf8;
+function bnToHex(input) {
+    return ethers_1.ethers.utils.hexZeroPad(ethers_1.ethers.utils.hexlify((0, BigNumberUtils_1.toBN)(input)), 32);
+}
+exports.bnToHex = bnToHex;
+function convertFromWei(weiVal, decimals) {
+    var formatFunction = (0, exports.createFormatFunction)(2, 4, false, decimals);
+    return formatFunction(weiVal);
+}
+exports.convertFromWei = convertFromWei;
+function shortenHexStrings(addresses) {
+    return addresses.map(function (h) { return createShortHexString(h); });
+}
+exports.shortenHexStrings = shortenHexStrings;
+var formatWei = function (num) {
+    return (0, common_1.fromWei)(num.toString());
+};
+exports.formatWei = formatWei;
+var ConvertDecimals = function (fromDecimals, toDecimals) {
+    (0, assert_1.default)(fromDecimals >= 0, "requires fromDecimals as an integer >= 0");
+    (0, assert_1.default)(toDecimals >= 0, "requires toDecimals as an integer >= 0");
+    return function (amountIn) {
+        var amount = (0, BigNumberUtils_1.toBN)(amountIn.toString());
+        if (amount.isZero())
+            return amount;
+        var diff = fromDecimals - toDecimals;
+        if (diff == 0)
+            return amount;
+        if (diff > 0)
+            return amount.div((0, BigNumberUtils_1.toBN)("10").pow((0, BigNumberUtils_1.toBN)(diff.toString())));
+        return amount.mul((0, BigNumberUtils_1.toBN)("10").pow((0, BigNumberUtils_1.toBN)((-1 * diff).toString())));
+    };
+};
+exports.ConvertDecimals = ConvertDecimals;
+function parseWinston(numericString) {
+    return ethers_1.ethers.utils.parseUnits(numericString, 12);
+}
+exports.parseWinston = parseWinston;
+function formatWinston(winstonValue) {
+    return ethers_1.ethers.utils.formatUnits(winstonValue, 12);
+}
+exports.formatWinston = formatWinston;
+//# sourceMappingURL=FormattingUtils.js.map

package/dist/cjs/utils/FormattingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormattingUtils.js","sourceRoot":"","sources":["../../../src/utils/FormattingUtils.ts"],"names":[],"mappings":";;;;AAAA,iCAAgC;AAChC,mDAA4C;AAC5C,mCAAmC;AACnC,0DAA4B;AAC5B,6CAAyC;AAIlC,IAAM,qBAAqB,GAAG,UACnC,GAAoB,EACpB,aAAqB,EACrB,YAAoB,EACpB,OAAgB,EAChB,QAAiB;IAEjB,IAAI,OAAO,EAAE;QACX,wBAAS,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,wBAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;KACtD;SAAM;QACL,wBAAS,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,wBAAS,CAAC,UAAU,EAAE,CAAC,CAAC;KACxD;IAED,IAAM,kBAAkB,GAAG,IAAI,wBAAS,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAM,YAAY,GAAG,QAAQ,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,IAAI,mBAAmB,CAAC;IAIxB,IAAI,kBAAkB,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,wBAAS,CAAC,CAAC,CAAC,CAAC,EAAE;QAClD,mBAAmB,GAAG,IAAI,wBAAS,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;KAC3F;SAAM;QACL,mBAAmB,GAAG,IAAI,wBAAS,CAAC,kBAAkB,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;KAC9F;IAED,IAAM,wBAAwB,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChE,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;IAChG,OAAO,YAAY,GAAG,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC,CAAC;AA5BW,QAAA,qBAAqB,yBA4BhC;AAEK,IAAM,oBAAoB,GAAG,UAClC,oBAA4B,EAC5B,qBAA6B,EAC7B,QAAgB,EAChB,QAAa;IADb,yBAAA,EAAA,gBAAgB;IAChB,yBAAA,EAAA,aAAa;IAEb,OAAO,UAAC,QAAqB;QAC3B,OAAA,IAAA,6BAAqB,EACnB,IAAA,iBAAS,EAAC,IAAA,uBAAe,EAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAClD,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,EACL,QAAQ,CACT;IAND,CAMC,CAAC;AACN,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B;AACK,IAAM,YAAY,GAAG,UAAC,aAAiB;IAE5C,OAAO,IAAA,4BAAoB,EAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAA,qBAAI,EAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC/E,CAAC,CAAC;AAHW,QAAA,YAAY,gBAGvB;AAUF,SAAgB,oBAAoB,CAAC,GAAW,EAAE,SAAa,EAAE,SAAgB;IAA/B,0BAAA,EAAA,aAAa;IAAE,0BAAA,EAAA,gBAAgB;IAG/E,IAAI,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE;QAC3B,OAAO,GAAG,CAAC;KACZ;IAED,IAAM,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;IAGlD,IAAI,YAAY,IAAI,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KACvC;IAID,IAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;IAE1D,IAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IAErD,OAAO,UAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,SAAG,SAAS,SAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,CAAE,CAAC;AACzG,CAAC;AArBD,oDAqBC;AAOD,SAAgB,SAAS,CAAC,KAAa;IACrC,OAAO,eAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAFD,8BAEC;AAOD,SAAgB,SAAS,CAAC,KAAa;IACrC,OAAO,eAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAFD,8BAEC;AAQD,SAAgB,OAAO,CAAC,KAAS;IAC/B,OAAO,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,eAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAA,qBAAI,EAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACxE,CAAC;AAFD,0BAEC;AAQD,SAAgB,cAAc,CAAC,MAAc,EAAE,QAAgB;IAC7D,IAAM,cAAc,GAAG,IAAA,4BAAoB,EAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAHD,wCAGC;AAQD,SAAgB,iBAAiB,CAAC,SAAmB;IACnD,OAAO,SAAS,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,oBAAoB,CAAC,CAAC,CAAC,EAAvB,CAAuB,CAAC,CAAC;AACvD,CAAC;AAFD,8CAEC;AAGM,IAAM,SAAS,GAAG,UAAC,GAAgB;IAIxC,OAAO,IAAA,gBAAO,EAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;AACjC,CAAC,CAAC;AALW,QAAA,SAAS,aAKpB;AAUK,IAAM,eAAe,GAAG,UAAC,YAAoB,EAAE,UAAkB;IACtE,IAAA,gBAAM,EAAC,YAAY,IAAI,CAAC,EAAE,0CAA0C,CAAC,CAAC;IACtE,IAAA,gBAAM,EAAC,UAAU,IAAI,CAAC,EAAE,wCAAwC,CAAC,CAAC;IAGlE,OAAO,UAAC,QAA8B;QACpC,IAAM,MAAM,GAAG,IAAA,qBAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,IAAI,MAAM,CAAC,MAAM,EAAE;YAAE,OAAO,MAAM,CAAC;QACnC,IAAM,IAAI,GAAG,YAAY,GAAG,UAAU,CAAC;QACvC,IAAI,IAAI,IAAI,CAAC;YAAE,OAAO,MAAM,CAAC;QAC7B,IAAI,IAAI,GAAG,CAAC;YAAE,OAAO,MAAM,CAAC,GAAG,CAAC,IAAA,qBAAI,EAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAA,qBAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC,GAAG,CAAC,IAAA,qBAAI,EAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAA,qBAAI,EAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,eAAe,mBAa1B;AAOF,SAAgB,YAAY,CAAC,aAAqB;IAChD,OAAO,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAFD,oCAEC;AAOD,SAAgB,aAAa,CAAC,YAA8B;IAC1D,OAAO,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAFD,sCAEC"}

package/dist/cjs/utils/IPFSUtils.d.ts

@@ -0,0 +1,4 @@
+import PinataClient from "@pinata/sdk";
+export declare function buildIPFSClient(APIKey: string, secretAPIKey: string): PinataClient;
+export declare function retrieveValueFromIPFS(contentHash: string, publicGatewayURL: string): Promise<string>;
+export declare function storeValueInIPFS(key: string, content: string, client: PinataClient): Promise<string>;