@across-protocol/sdk 3.0.0

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

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

package/dist/types/utils/DepositUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DepositUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/DepositUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,yBAAyB,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAY5G,oBAAY,WAAW;IACrB,gBAAgB,IAAI;IACpB,iBAAiB,IAAA;IACjB,YAAY,IAAA;CACb;AAED,MAAM,MAAM,mBAAmB,GAC3B;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAA;CAAE,GAC1C;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,wBAAsB,6BAA6B,CACjD,eAAe,EAAE,eAAe,EAChC,IAAI,EAAE,IAAI,GAAG,eAAe,EAC5B,KAAK,CAAC,EAAE,yBAAyB,GAChC,OAAO,CAAC,mBAAmB,CAAC,CAyE9B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,SAAgB,GAAG,OAAO,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAI9D"}

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

@@ -0,0 +1,33 @@
+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[];
+//# sourceMappingURL=EventUtils.d.ts.map

package/dist/types/utils/EventUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/EventUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAMtD,wBAAgB,WAAW,CAAC,IAAI,GAAE,MAAqB,GAAG,GAAG,CAoD5D;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,WAAW,EACnB,YAAY,EAAE,iBAAiB,EAC/B,UAAU,SAAI,GACb,OAAO,CAAC,KAAK,EAAE,CAAC,CA8BlB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,SAAS,EACT,OAAO,EACP,gBAAgB,GACjB,EAAE,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAuCxC;AAED,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,KAAK,GAAG,aAAa,CAQtE;AAGD,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAE7E;AAID,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAUpF;AAGD,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAE9E;AAID,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAUrF;AAGD,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,OAAO,CAQ3E;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,EAAE,CAEtE"}

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

@@ -0,0 +1,9 @@
+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;
+//# sourceMappingURL=FlowUtils.d.ts.map

package/dist/types/utils/FlowUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlowUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/FlowUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAmB,MAAM,eAAe,CAAC;AAG1E,eAAO,MAAM,4BAA4B,oGAO/B,CAAC;AAEX,eAAO,MAAM,0BAA0B,2NAS7B,CAAC;AAEX,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CASnE;AAED,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,SAAS,GAAG;IAAE,kBAAkB,EAAE,MAAM,CAAA;CAAE,EAAE,6BAA6B;AACpF,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAMT"}

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

@@ -0,0 +1,62 @@
+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;
+//# sourceMappingURL=FormattingUtils.d.ts.map

package/dist/types/utils/FormattingUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormattingUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/FormattingUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,EAAE,EAAQ,MAAM,kBAAkB,CAAC;AAO5C,eAAO,MAAM,qBAAqB,QAC3B,MAAM,GAAG,MAAM,iBACL,MAAM,gBACP,MAAM,WACX,OAAO,YACN,OAAO,KAChB,MAsBF,CAAC;AAEF,eAAO,MAAM,oBAAoB,yBACT,MAAM,yBACL,MAAM,uDAIX,MAAM,GAAG,EAAE,KAAG,MAQjC,CAAC;AACF,eAAO,MAAM,YAAY,kBAAmB,EAAE,KAAG,MAGhD,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,SAAI,EAAE,SAAS,SAAO,GAAG,MAAM,CAqBzF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,EAAE,GAAG,MAAM,CAEzC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAGvE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAE/D;AAGD,eAAO,MAAM,SAAS,QAAS,MAAM,GAAG,EAAE,KAAG,MAK5C,CAAC;AAUF,eAAO,MAAM,eAAe,iBAAkB,MAAM,cAAc,MAAM,gBAAe,MAAM,GAAG,MAAM,GAAG,EAAE,KAAK,EAa/G,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAEpE"}

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

@@ -0,0 +1,25 @@
+import PinataClient from "@pinata/sdk";
+/**
+ * Build an IPFS client for interacting with the IPFS API
+ * @param APIKey The project ID
+ * @param secretAPIKey The project secret
+ * @returns An IPFS client for interacting with Pinata
+ */
+export declare function buildIPFSClient(APIKey: string, secretAPIKey: string): PinataClient;
+/**
+ * Retrieves a value from an IPFS gateway
+ * @param contentHash The content hash of the value to retrieve
+ * @param publicGatewayURL The URL of the public IPFS gateway to use
+ * @returns The value retrieved from the IPFS gateway
+ * @throws Error if the value could not be retrieved
+ */
+export declare function retrieveValueFromIPFS(contentHash: string, publicGatewayURL: string): Promise<string>;
+/**
+ * Pins a value to the IPFS network
+ * @param key A key to use for pinning the value. This is a metadata field.
+ * @param content The value to pin
+ * @param client The IPFS client to use
+ * @returns The content hash of the pinned value
+ */
+export declare function storeValueInIPFS(key: string, content: string, client: PinataClient): Promise<string>;
+//# sourceMappingURL=IPFSUtils.d.ts.map

package/dist/types/utils/IPFSUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPFSUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/IPFSUtils.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AAGvC;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,YAAY,CAElF;AAED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAW1G;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAO1G"}

package/dist/types/utils/JSONUtils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This function converts a JSON string into a JSON object. The caveat is that if
+ * the parser detects a number, it will convert it to a string and floor it to
+ * an integer. This function will not throw but instead return an undefined value
+ * if the JSON string is invalid.
+ * @param jsonString The JSON string to parse
+ * @returns The parsed JSON object or undefined if the JSON string is invalid
+ */
+export declare function parseJSONWithNumericString(jsonString: string): unknown | undefined;
+/**
+ * This function converts an object into a JSON string. The caveat is that if
+ * the parser detects a BigNumber or BN, it will convert it to a string.
+ * @param obj The object to stringify
+ * @returns The stringified JSON object
+ * @throws Error if the object cannot be stringified
+ */
+export declare function stringifyJSONWithNumericString(obj: unknown): string;
+/**
+ * A replacer for use in `JSON.stringify` that converts big numbers to numeric strings.
+ * @param _key Unused
+ * @param value The value to convert
+ * @returns The converted value
+ */
+export declare function jsonReplacerWithBigNumbers(_key: string, value: unknown): unknown;
+/**
+ * A reviver for use in `JSON.parse` that converts numeric strings to big numbers.
+ * @param _key Unused
+ * @param value The value to convert
+ * @returns The converted value
+ */
+export declare function jsonReviverWithBigNumbers(_key: string, value: unknown): unknown;
+//# sourceMappingURL=JSONUtils.d.ts.map

package/dist/types/utils/JSONUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/JSONUtils.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAWlF;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAOnE;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAoBhF;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAU/E"}

package/dist/types/utils/LogUtils.d.ts

@@ -0,0 +1,21 @@
+import { Logger } from "winston";
+export type DefaultLogLevels = "debug" | "info" | "warn" | "error";
+type LogParamType = {
+    level: DefaultLogLevels;
+    message: string;
+    at: {
+        location: string;
+        function: string;
+    };
+    data?: Record<string | number, unknown>;
+};
+export declare function formattedLog(logger: Logger | undefined, { level, message, at: { location, function: fnName }, data }: LogParamType): void;
+/**
+ * Asserts the truth of a condition. If the condition is false, an error is thrown with the provided message.
+ * @param condition The condition to assert.
+ * @param message The message to throw if the condition is false.
+ * @throws Error if the condition is false.
+ */
+export declare function assert(condition: boolean, message: string): void;
+export {};
+//# sourceMappingURL=LogUtils.d.ts.map

package/dist/types/utils/LogUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/LogUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEnE,KAAK,YAAY,GAAG;IAClB,KAAK,EAAE,gBAAgB,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE;QACF,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;CACzC,CAAC;AAEF,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,GACzE,IAAI,CAQN;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAIhE"}

package/dist/types/utils/Multicall.d.ts

@@ -0,0 +1,14 @@
+import { Contract, providers, Signer, utils as ethersUtils } from "ethers";
+type Provider = providers.Provider;
+type BlockTag = providers.BlockTag;
+type Result = ethersUtils.Result;
+export type Call3 = {
+    contract: Contract;
+    method: string;
+    args?: any[];
+};
+export declare const multicall3Addresses: Record<number, string>;
+export declare function getMulticall3(chainId: number, signerOrProvider?: Signer | Provider): Promise<Contract | undefined>;
+export declare function aggregate(multicall3: Contract, calls: Call3[], blockTag?: BlockTag): Promise<Result[]>;
+export {};
+//# sourceMappingURL=Multicall.d.ts.map

package/dist/types/utils/Multicall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Multicall.d.ts","sourceRoot":"","sources":["../../../src/utils/Multicall.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGtF,KAAK,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;AACnC,KAAK,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;AACnC,KAAK,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;AAEjC,MAAM,MAAM,KAAK,GAAG;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CACd,CAAC;AAGF,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAsBtD,CAAC;AAEF,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,EACf,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,GACnC,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAO/B;AAED,wBAAsB,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAY5G"}

package/dist/types/utils/NetworkUtils.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Resolves a network name from a network id.
+ * @param networkId The network id to resolve the name for
+ * @returns The network name for the network id. If the network id is not found, returns "unknown"
+ */
+export declare function getNetworkName(networkId: number | string): string;
+/**
+ * Resolves a native token symbol from a chain id.
+ * @param chainId The chain id to resolve the native token symbol for
+ * @returns The native token symbol for the chain id. If the chain id is not found, returns "ETH"
+ */
+export declare function getNativeTokenSymbol(chainId: number | string): string;
+/**
+ * Determines whether a chain ID is part of the production network.
+ * @param chainId Chain ID to query.
+ * @returns true if the chain ID is part of the production network, otherwise false.
+ */
+export declare function chainIsProd(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is part of the production network.
+ * @param chainId Chain ID to query.
+ * @returns true if the chain ID is part of the production network, otherwise false.
+ */
+export declare function chainIsTestnet(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is a Polygon implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a Polygon chain (mainnet or testnet), otherwise false.
+ */
+export declare function chainIsMatic(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is an Optimism OP Stack implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an OP stack, otherwise false.
+ */
+export declare function chainIsOPStack(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is an Arbitrum implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an Arbitrum chain, otherwise false.
+ */
+export declare function chainIsArbitrum(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is a Linea implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a Linea chain, otherwise false.
+ */
+export declare function chainIsLinea(chainId: number): boolean;
+/**
+ * Determines whether a chain ID has the capacity for having its USDC bridged via CCTP.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a CCTP-bridging enabled chain, otherwise false.
+ */
+export declare function chainIsCCTPEnabled(chainId: number): boolean;
+/**
+ * Determines if a chain ID requires a manual L1 -> L2 finalization step.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId requires manual L1 -> L2 finalization, otherwise false.
+ */
+export declare function chainRequiresL1ToL2Finalization(chainId: number): boolean;
+//# sourceMappingURL=NetworkUtils.d.ts.map

package/dist/types/utils/NetworkUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/NetworkUtils.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAErE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAWvD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAExD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAa3D;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAExE"}

package/dist/types/utils/NumberUtils.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A typeguard for a number with the added check that the number is an integer.
+ * @param value The value to check.
+ * @returns True if the value is a number and an integer, false otherwise.
+ */
+export declare function isInteger(value: unknown): value is number;
+/**
+ * A typeguard for a number with added checks that the number is an integer and is greater to zero.
+ * @param value The value to check.
+ * @returns True if the value is a number, an integer, and greater than zero, false otherwise.
+ */
+export declare function isPositiveInteger(value: unknown): value is number;
+//# sourceMappingURL=NumberUtils.d.ts.map

package/dist/types/utils/NumberUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/NumberUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEjE"}

package/dist/types/utils/ObjectUtils.d.ts

@@ -0,0 +1,11 @@
+export declare function assign(obj: any, keyPath: any[], value: any): void;
+export declare function groupObjectCountsByThreeProps(objects: any[], primaryProp: string, secondaryProp: string, tertiaryProp: string): any;
+export declare function groupObjectCountsByTwoProps(objects: any[], primaryProp: string, getSecondaryProp: (obj: any) => string): any;
+export declare function groupObjectCountsByProp(objects: any[], getProp: (obj: any) => string): any;
+/**
+ * Filter out falsy keys from an object. Falsy keys are keys with values of false, null, undefined, 0, or empty string.
+ * @param obj The object to filter
+ * @returns A new object with falsy keys removed
+ */
+export declare function filterFalsyKeys(obj: Record<string | number, unknown>): Record<string | number, unknown>;
+//# sourceMappingURL=ObjectUtils.d.ts.map

package/dist/types/utils/ObjectUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/ObjectUtils.ts"],"names":[],"mappings":"AAKA,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAyBjE;AAGD,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,GAAG,EAAE,EACd,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,GACnB,GAAG,CASL;AACD,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,GAAG,EAAE,EACd,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GACrC,GAAG,CAOL;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,GAAG,CAM1F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAEvG"}

package/dist/types/utils/ReviverUtils.d.ts

@@ -0,0 +1,16 @@
+import { Reviver } from "./TypeUtils";
+/**
+ * A reviver composer that takes a list of revivers and returns a single reviver that applies all of them.
+ * @param revivers The revivers to compose.
+ * @returns A single reviver that applies all of the revivers passed in. If no revivers are passed in, the identity
+ * function is returned.
+ */
+export declare function composeRevivers(...revivers: Reviver[]): Reviver;
+/**
+ * Reviver function that converts a stringified BigNumber object to a BigNumber object.
+ * @param _ The key to the value being revived. Unused.
+ * @param value The value being revived.
+ * @returns The revived value. If the value is not a stringified BigNumber object, it is returned as-is.
+ */
+export declare function objectWithBigNumberReviver(_: unknown, value: unknown): unknown;
+//# sourceMappingURL=ReviverUtils.d.ts.map

package/dist/types/utils/ReviverUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReviverUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/ReviverUtils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAM/D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAM9E"}

package/dist/types/utils/SpokeUtils.d.ts

@@ -0,0 +1,65 @@
+import { Contract, PopulatedTransaction, providers } from "ethers";
+import { Deposit, Fill, FillStatus, RelayData, SlowFillRequest } from "../interfaces";
+import { SpokePoolClient } from "../clients";
+type BlockTag = providers.BlockTag;
+/**
+ * @param spokePool SpokePool Contract instance.
+ * @param deposit V3Deopsit instance.
+ * @param repaymentChainId Optional repaymentChainId (defaults to destinationChainId).
+ * @returns An Ethers UnsignedTransaction instance.
+ */
+export declare function populateV3Relay(spokePool: Contract, deposit: Deposit, relayer: string, repaymentChainId?: number): Promise<PopulatedTransaction>;
+/**
+ * Find the block range that contains the deposit ID. This is a binary search that searches for the block range
+ * that contains the deposit ID.
+ * @param targetDepositId The target deposit ID to search for.
+ * @param initLow The initial lower bound of the block range to search.
+ * @param initHigh The initial upper bound of the block range to search.
+ * @param maxSearches The maximum number of searches to perform. This is used to prevent infinite loops.
+ * @returns The block range that contains the deposit ID.
+ * @note  // We want to find the block range that satisfies these conditions:
+ *        // - the low block has deposit count <= targetDepositId
+ *        // - the high block has a deposit count > targetDepositId.
+ *        // This way the caller can search for a FundsDeposited event between [low, high] that will always
+ *        // contain the event emitted when deposit ID was incremented to targetDepositId + 1. This is the same transaction
+ *        // where the deposit with deposit ID = targetDepositId was created.
+ */
+export declare function getBlockRangeForDepositId(targetDepositId: number, initLow: number, initHigh: number, maxSearches: number, spokePool: SpokePoolClient): Promise<{
+    low: number;
+    high: number;
+}>;
+/**
+ * Finds the deposit id at a specific block number.
+ * @param blockTag The block number to search for the deposit ID at.
+ * @returns The deposit ID.
+ */
+export declare function getDepositIdAtBlock(contract: Contract, blockTag: number): Promise<number>;
+/**
+ * Compute the RelayData hash for a fill. This can be used to determine the fill status.
+ * @param relayData RelayData information that is used to complete a fill.
+ * @param destinationChainId Supplementary destination chain ID required by V3 hashes.
+ * @returns The corresponding RelayData hash.
+ */
+export declare function getRelayDataHash(relayData: RelayData, destinationChainId: number): string;
+export declare function getRelayHashFromEvent(e: Deposit | Fill | SlowFillRequest): string;
+/**
+ * Find the amount filled for a deposit at a particular block.
+ * @param spokePool SpokePool contract instance.
+ * @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).
+ */
+export declare function relayFillStatus(spokePool: Contract, relayData: RelayData, blockTag?: number | "latest", destinationChainId?: number): Promise<FillStatus>;
+export declare function fillStatusArray(spokePool: Contract, relayData: RelayData[], blockTag?: BlockTag): Promise<(FillStatus | undefined)[]>;
+/**
+ * Find the block at which a fill was completed.
+ * @todo After SpokePool upgrade, this function can be simplified to use the FillStatus enum.
+ * @param spokePool SpokePool contract instance.
+ * @param relayData Deposit information that is used to complete a fill.
+ * @param lowBlockNumber The lower bound of the search. Must be bounded by SpokePool deployment.
+ * @param highBlocknumber Optional upper bound for the search.
+ * @returns The block number at which the relay was completed, or undefined.
+ */
+export declare function findFillBlock(spokePool: Contract, relayData: RelayData, lowBlockNumber: number, highBlockNumber?: number): Promise<number | undefined>;
+export {};
+//# sourceMappingURL=SpokeUtils.d.ts.map

package/dist/types/utils/SpokeUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpokeUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/SpokeUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,QAAQ,EAAE,oBAAoB,EAAE,SAAS,EAAwB,MAAM,QAAQ,CAAC;AAE/G,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAM7C,KAAK,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;AAEnC;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,gBAAgB,SAA6B,GAC5C,OAAO,CAAC,oBAAoB,CAAC,CA+B/B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,yBAAyB,CAC7C,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,eAAe,GACzB,OAAO,CAAC;IACT,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd,CAAC,CAmHD;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAO/F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAuBzF;AAED,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,eAAe,GAAG,MAAM,CAEjF;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,SAAS,EAAE,QAAQ,EACnB,SAAS,EAAE,SAAS,EACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,QAAQ,EAC5B,kBAAkB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,UAAU,CAAC,CAYrB;AAED,wBAAsB,eAAe,CACnC,SAAS,EAAE,QAAQ,EACnB,SAAS,EAAE,SAAS,EAAE,EACtB,QAAQ,GAAE,QAAmB,GAC5B,OAAO,CAAC,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC,CA8BrC;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CACjC,SAAS,EAAE,QAAQ,EACnB,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,MAAM,EACtB,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAiD7B"}

package/dist/types/utils/TimeUtils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get time in same unit (seconds) as on-chain block timestamps.
+ * @returns The current time in seconds
+ */
+export declare function getCurrentTime(): number;
+//# sourceMappingURL=TimeUtils.d.ts.map

package/dist/types/utils/TimeUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TimeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAEvC"}