@across-protocol/sdk 3.0.0

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

@@ -0,0 +1,326 @@
+import { BlockTag } from "@ethersproject/abstract-provider";
+import { BigNumber, providers, Signer } from "ethers";
+import { L1Token } from "../interfaces";
+type SignerOrProvider = providers.Provider | Signer;
+export declare function fetchTokenInfo(address: string, signerOrProvider: SignerOrProvider): Promise<L1Token>;
+export declare const getL2TokenAddresses: (l1TokenAddress: string, l1ChainId?: number) => {
+    [chainId: number]: string;
+} | undefined;
+/**
+ * Resolve a token symbol to an L1Token description on a particular chain ID.
+ * @notice Not to be confused with the HubPool's internal view on the supported origin/destination token for a chain.
+ * @param symbol Symbol to query.
+ * @param chainId Chain ID to query on.
+ * @returns Symbol, decimals and contract address on the requested chain.
+ */
+export declare function resolveSymbolOnChain(chainId: number, symbol: string): L1Token;
+/**
+ * Returns the contract address for a given token symbol and chainId.
+ * @param symbol A case-insensitive token symbol.
+ * @param chainId The chainId to resolve the contract address for.
+ * @param tokenMapping A parameter to determine where to source token information. Defaults to the constants variant.
+ * @returns The contract address for the given token symbol and chainId, or undefined if the token symbol is not supported.
+ */
+export declare const resolveContractFromSymbol: (symbol: string, chainId: string, tokenMapping?: {
+    ACX: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    BAL: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    BADGER: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    BOBA: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    DAI: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    ETH: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    MATIC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    POOL: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    SNX: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    UMA: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    USDC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    "USDC.e": {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    USDbC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    USDT: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    WBTC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    WETH: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    WMATIC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    OP: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+}) => string | undefined;
+export declare function getTokenInformationFromAddress(address: string, tokenMapping?: {
+    ACX: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    BAL: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    BADGER: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    BOBA: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    DAI: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    ETH: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    MATIC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    POOL: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    SNX: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    UMA: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    USDC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    "USDC.e": {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    USDbC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    USDT: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    WBTC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    WETH: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    WMATIC: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+    OP: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+    };
+}): L1Token | undefined;
+/**
+ * Retrieves the ERC20 balance for a given address and token address.
+ * @param address The address to retrieve the balance for.
+ * @param tokenAddress The token address
+ * @param signerOrProvider A valid ethers.js Signer or Provider object.
+ * @param blockTag The block tag to retrieve the balance at.
+ * @returns The balance of the given address for the given token address.
+ */
+export declare function getTokenBalance(address: string, tokenAddress: string, signerOrProvider: SignerOrProvider, blockTag?: BlockTag): Promise<BigNumber>;
+export {};
+//# sourceMappingURL=TokenUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TokenUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TokenUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAY,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAMxC,KAAK,gBAAgB,GAAG,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;AAEpD,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1G;AAED,eAAO,MAAM,mBAAmB,mBACd,MAAM;;aAMvB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAY7E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,WAC5B,MAAM,WACL,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAEd,MAAM,GAAG,SAIX,CAAC;AAEF,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAoB,GAAG,OAAO,GAAG,SAAS,CAWrH;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,gBAAgB,EAClC,QAAQ,GAAE,QAAmB,GAC5B,OAAO,CAAC,SAAS,CAAC,CAGpB"}

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

@@ -0,0 +1,4 @@
+export declare function isPromiseFulfilled<T>(promiseSettledResult: PromiseSettledResult<T>): promiseSettledResult is PromiseFulfilledResult<T>;
+export declare function isPromiseRejected<T>(promiseSettledResult: PromiseSettledResult<T>): promiseSettledResult is PromiseRejectedResult;
+export declare function isDefined<T>(input: T | null | undefined): input is T;
+//# sourceMappingURL=TypeGuards.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TypeGuards.d.ts","sourceRoot":"","sources":["../../../src/utils/TypeGuards.ts"],"names":[],"mappings":"AAAA,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC5C,oBAAoB,IAAI,sBAAsB,CAAC,CAAC,CAAC,CAEnD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC5C,oBAAoB,IAAI,qBAAqB,CAE/C;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAEpE"}

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

@@ -0,0 +1,6 @@
+import { SpokePoolClient } from "../clients";
+export type MakeOptional<Type, Key extends keyof Type> = Omit<Type, Key> & Partial<Pick<Type, Key>>;
+export type AnyObject = Record<string, unknown>;
+export type SpokePoolClients = Record<number, SpokePoolClient>;
+export type Reviver = (key: string, value: unknown) => unknown;
+//# sourceMappingURL=TypeUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TypeUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TypeUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,MAAM,YAAY,CAAC,IAAI,EAAE,GAAG,SAAS,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AAEpG,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAE/D,MAAM,MAAM,OAAO,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC"}

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

@@ -0,0 +1,5 @@
+import { Fill, SlowFillLeaf } from "../interfaces";
+import { BN } from "./BigNumberUtils";
+export declare function isSlowFill(fill: Fill): boolean;
+export declare function getSlowFillLeafLpFeePct(leaf: SlowFillLeaf): BN;
+//# sourceMappingURL=V3Utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"V3Utils.d.ts","sourceRoot":"","sources":["../../../src/utils/V3Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAGtC,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAE9C;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,YAAY,GAAG,EAAE,CAG9D"}

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

@@ -0,0 +1,3 @@
+import { DepositWithBlock } from "../interfaces";
+export declare function isDepositFormedCorrectly(deposit: unknown): deposit is DepositWithBlock;
+//# sourceMappingURL=ValidatorUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ValidatorUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/ValidatorUtils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAiCjD,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,gBAAgB,CAEtF"}

package/dist/types/utils/abi/index.d.ts

@@ -0,0 +1,19 @@
+import { ContractInterface } from "ethers";
+/**
+ * @dev To retrieve a new ABI, the following is useful:
+ * CONTRACT_ADDRESS="0x1234..."
+ * URL="http://api.etherscan.io/api?module=contract&action=getabi&format=raw&address=${CONTRACT_ADDRESS}"
+ * curl -s "${URL}" | python -m json.tool > "./src/utils/abi/contracts/new-contract.json"
+ */
+/**
+ * @notice Obtain the path to the local ABI JSON store.
+ * @returns Fully-qualified path to the local ABI JSON store.
+ */
+export declare function getABIDir(): string;
+/**
+ * @notice Retrieve an ABI desription from the set of known contracts.
+ * @param contractName Name of the contract ABI to retrieve.
+ * @returns Contract ABI as an ethers ContractInterface type.
+ */
+export declare function getABI(contractName: string): Promise<ContractInterface>;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/abi/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utils/abi/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAG3C;;;;;GAKG;AAEH;;;GAGG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED;;;;GAIG;AACH,wBAAsB,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAQ7E"}

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

@@ -0,0 +1,205 @@
+import { L2Provider } from "@eth-optimism/sdk/dist/interfaces/l2-provider";
+import Decimal from "decimal.js";
+import { BigNumber, PopulatedTransaction, providers } from "ethers";
+import { TypedMessage } from "../interfaces/TypedData";
+import { BigNumberish, BN } from "./BigNumberUtils";
+export type Decimalish = string | number | Decimal;
+export declare const AddressZero = "0x0000000000000000000000000000000000000000";
+export declare const MAX_BIG_INT: BigNumber;
+/**
+ * toBNWei.
+ *
+ * @param {BigNumberish} num
+ * @param {number} decimals
+ * @returns {BN}
+ */
+export declare const toBNWei: (num: BigNumberish, decimals?: number) => BN;
+/**
+ * fromWei.
+ *
+ * @param {BigNumberish} num
+ * @param {number} decimals
+ * @returns {string}
+ */
+export declare const fromWei: (num: BigNumberish, decimals?: number) => string;
+/**
+ * min.
+ *
+ * @param {BigNumberish} a
+ * @param {BigNumberish} b
+ * @returns {BN}
+ */
+export declare function min(a: BigNumberish, b: BigNumberish): BN;
+/**
+ * max.
+ *
+ * @param {BigNumberish} a
+ * @param {BigNumberish} b
+ * @returns {BN}
+ */
+export declare function max(a: BigNumberish, b: BigNumberish): BN;
+export declare const fixedPointAdjustment: BigNumber;
+/**
+ * Convert an amount of native gas token into a token given price and token decimals.
+ *
+ * @param {BigNumberish} fromAmount - Amount of native gas token to convert.
+ * @param {string | number} [ price=1 ] - The price as native gas token per token, ie how much native gas token can 1 token buy.
+ * @param {} [ toDecimals=18 ] - Number of decimals for the token currency.
+ * @param {} [ nativeDecimals=18 ] - Number of decimals for the native token currency.
+ * @returns {string} The number of tokens denominated in token decimals in the smallest unit (wei).
+ */
+export declare function nativeToToken(fromAmount: BigNumberish, price?: string | number, toDecimals?: number, nativeDecimals?: number): string;
+/**
+ * Convert a gas amount and gas price to wei.
+ *
+ * @param {number} gas - gas amount.
+ * @param {BigNumberish} gasPrice - gas price in gwei.
+ * @returns {BigNumber} - total fees in wei.
+ */
+export declare const gasCost: (gas: BigNumberish, gasPrice: BigNumberish) => BigNumber;
+/**
+ * getGasFees. Low level pure function call to calculate gas fees.
+ *
+ * @param {number} gas - The gast cost for transfer, use constants defined in file.
+ * @param {BigNumberish} gasPrice - Estimated gas price in wei.
+ * @param {string | number} [price = 1] - The price of the token in native gas token, how much native gas token can 1 token buy.
+ * @param {number} [decimals=18] - Number of decimals of token.
+ * @returns {string} - The value of fees native to the token provided, in its smallest unit.
+ */
+export declare function calculateGasFees(gas: number, gasPrice: BigNumberish, price?: string | number, decimals?: number): string;
+/**
+ * percent.
+ *
+ * @param {BigNumberish} numerator
+ * @param {BigNumberish} denominator
+ * @returns {BN}
+ */
+export declare function percent(numerator: BigNumberish, denominator: BigNumberish): BN;
+/**
+ * calcContinuousCompoundInterest. From https://www.calculatorsoup.com/calculators/financial/compound-interest-calculator.php?given_data=find_r&A=2&P=1&n=0&t=1&given_data_last=find_r&action=solve
+ * Returns a yearly interest rate if start/end amount had been continuously compounded over the period elapsed. Multiply result by 100 for a %.
+ *
+ * @param {string} startAmount
+ * @param {string} endAmount
+ * @param {string} periodsElapsed
+ * @param {string} periodsPerYear
+ */
+export declare const calcContinuousCompoundInterest: (startAmount: Decimalish, endAmount: Decimalish, periodsElapsed: Decimalish, periodsPerYear: Decimalish) => string;
+/**
+ * calcPeriodicCompoundInterest. Taken from https://www.calculatorsoup.com/calculators/financial/compound-interest-calculator.php?given_data=find_r&A=2&P=1&n=365&t=1&given_data_last=find_r&action=solve
+ * This will return a periodically compounded interest rate for 1 year. Multiply result by 100 for a %.
+ *
+ * @param {string} startAmount - Starting amount or price
+ * @param {string} endAmount - Ending amount or price
+ * @param {string} periodsElapsed - How many periods elapsed for the start and end amount.
+ * @param {string} periodsPerYear - How many periods in 1 year.
+ */
+export declare const calcPeriodicCompoundInterest: (startAmount: Decimalish, endAmount: Decimalish, periodsElapsed: Decimalish, periodsPerYear: Decimalish) => string;
+/**
+ * calcApr. Simple apr calculation based on extrapolating the difference for a short period over a year.
+ *
+ * @param {Decimalish} startAmount - Starting amount or price
+ * @param {Decimalish} endAmount - Ending amount or price
+ * @param {Decimalish} periodsElapsed - periods elapsed from start to end
+ * @param {Decimalish} periodsPerYear - periods per year
+ */
+export declare const calcApr: (startAmount: Decimalish, endAmount: Decimalish, periodsElapsed: Decimalish, periodsPerYear: Decimalish) => string;
+/**
+ * Takes two values and returns a list of number intervals
+ *
+ * @example
+ * ```js
+ * getSamplesBetween(1, 9, 3) //returns [[1, 3], [4, 7], [8, 9]]
+ * ```
+ */
+export declare const getSamplesBetween: (min: number, max: number, size: number) => number[][];
+/**
+ * A promise that resolves after a specified number of seconds
+ * @param seconds The number of seconds to wait
+ */
+export declare function delay(seconds: number): Promise<unknown>;
+/**
+ * Attempt to retry a function call a number of times with a delay between each attempt
+ * @param call The function to call
+ * @param times The number of times to retry
+ * @param delayS The number of seconds to delay between each attempt
+ * @returns The result of the function call.
+ */
+export declare function retry<T>(call: () => Promise<T>, times: number, delayS: number): Promise<T>;
+export type TransactionCostEstimate = {
+    nativeGasCost: BigNumber;
+    tokenGasCost: BigNumber;
+};
+/**
+ * Estimates the total gas cost required to submit an unsigned (populated) transaction on-chain.
+ * @param unsignedTx The unsigned transaction that this function will estimate.
+ * @param senderAddress The address that the transaction will be submitted from.
+ * @param provider A valid ethers provider - will be used to reason the gas price.
+ * @param gasMarkup Markup on the estimated gas cost. For example, 0.2 will increase this resulting value 1.2x.
+ * @param gasPrice A manually provided gas price - if set, this function will not resolve the current gas price.
+ * @returns Estimated cost in units of gas and the underlying gas token (gasPrice * estimatedGasUnits).
+ */
+export declare function estimateTotalGasRequiredByUnsignedTransaction(unsignedTx: PopulatedTransaction, senderAddress: string, provider: providers.Provider | L2Provider<providers.Provider>, gasMarkup: number, gasPrice?: BigNumberish): Promise<TransactionCostEstimate>;
+export type UpdateDepositDetailsMessageType = {
+    UpdateDepositDetails: [
+        {
+            name: "depositId";
+            type: "uint32";
+        },
+        {
+            name: "originChainId";
+            type: "uint256";
+        },
+        {
+            name: "updatedRelayerFeePct";
+            type: "int64";
+        },
+        {
+            name: "updatedRecipient";
+            type: "address";
+        },
+        {
+            name: "updatedMessage";
+            type: "bytes";
+        }
+    ];
+};
+export type UpdateV3DepositDetailsMessageType = {
+    UpdateDepositDetails: [
+        {
+            name: "depositId";
+            type: "uint32";
+        },
+        {
+            name: "originChainId";
+            type: "uint256";
+        },
+        {
+            name: "updatedOutputAmount";
+            type: "uint256";
+        },
+        {
+            name: "updatedRecipient";
+            type: "address";
+        },
+        {
+            name: "updatedMessage";
+            type: "bytes";
+        }
+    ];
+};
+/**
+ * Utility function to get EIP-712 compliant typed data that can be signed with the JSON-RPC method
+ * `eth_signedTypedDataV4` in MetaMask (https://docs.metamask.io/guide/signing-data.html). The resulting signature
+ * can then be used to call the method `speedUpDeposit` of a `SpokePool.sol` contract.
+ * @param depositId The deposit ID to speed up.
+ * @param originChainId The chain ID of the origin chain.
+ * @param updatedRelayerFeePct The new relayer fee percentage.
+ * @param updatedRecipient The new recipient address.
+ * @param updatedMessage The new message that should be provided to the recipient.
+ * @return EIP-712 compliant typed data.
+ */
+export declare function getUpdateDepositTypedData(depositId: number, originChainId: number, updatedRelayerFeePct: BigNumber, updatedRecipient: string, updatedMessage: string): TypedMessage<UpdateDepositDetailsMessageType>;
+export declare function getUpdateV3DepositTypedData(depositId: number, originChainId: number, updatedOutputAmount: BigNumber, updatedRecipient: string, updatedMessage: string): TypedMessage<UpdateV3DepositDetailsMessageType>;
+export declare function randomAddress(): string;
+//# sourceMappingURL=common.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/utils/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAG3E,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,SAAS,EAAU,oBAAoB,EAAE,SAAS,EAAc,MAAM,QAAQ,CAAC;AAExF,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,EAAE,EAAQ,MAAM,kBAAkB,CAAC;AAI1D,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnD,eAAO,MAAM,WAAW,+CAA+B,CAAC;AACxD,eAAO,MAAM,WAAW,WAAqD,CAAC;AAE9E;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,aAAa,MAAM,KAAG,EAAuD,CAAC;AAEvH;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,aAAa,MAAM,KAAG,MACX,CAAC;AAErD;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,EAAE,CAIxD;AACD;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,EAAE,CAIxD;AAED,eAAO,MAAM,oBAAoB,WAAe,CAAC;AAEjD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,YAAY,EACxB,KAAK,GAAE,MAAM,GAAG,MAAU,EAC1B,UAAU,SAAK,EACf,cAAc,SAAK,GAClB,MAAM,CAIR;AAED;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,YAAY,YAAY,YAAY,KAAG,SAEnE,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,YAAY,EACtB,KAAK,GAAE,MAAM,GAAG,MAAU,EAC1B,QAAQ,SAAK,GACZ,MAAM,CAGR;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,GAAG,EAAE,CAE9E;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,8BAA8B,gBAC5B,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAGF,CAAC;AACF;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,gBAC1B,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAaF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,gBACL,UAAU,aACZ,UAAU,kBACL,UAAU,kBACV,UAAU,KACzB,MAEF,CAAC;AACF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,QAAS,MAAM,OAAO,MAAM,QAAQ,MAAM,eAYvE,CAAC;AAEF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAEpC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ1F;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,SAAS,CAAC;IACzB,YAAY,EAAE,SAAS,CAAC;CACzB,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,6CAA6C,CACjE,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,CAAC,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,EAC7D,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,YAAY,GACtB,OAAO,CAAC,uBAAuB,CAAC,CAmClC;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,oBAAoB,EAAE;QACpB;YACE,IAAI,EAAE,WAAW,CAAC;YAClB,IAAI,EAAE,QAAQ,CAAC;SAChB;QACD;YAAE,IAAI,EAAE,eAAe,CAAC;YAAC,IAAI,EAAE,SAAS,CAAA;SAAE;QAC1C;YAAE,IAAI,EAAE,sBAAsB,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE;QAC/C;YAAE,IAAI,EAAE,kBAAkB,CAAC;YAAC,IAAI,EAAE,SAAS,CAAA;SAAE;QAC7C;YAAE,IAAI,EAAE,gBAAgB,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE;KAC1C,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,oBAAoB,EAAE;QACpB;YAAE,IAAI,EAAE,WAAW,CAAC;YAAC,IAAI,EAAE,QAAQ,CAAA;SAAE;QACrC;YAAE,IAAI,EAAE,eAAe,CAAC;YAAC,IAAI,EAAE,SAAS,CAAA;SAAE;QAC1C;YAAE,IAAI,EAAE,qBAAqB,CAAC;YAAC,IAAI,EAAE,SAAS,CAAA;SAAE;QAChD;YAAE,IAAI,EAAE,kBAAkB,CAAC;YAAC,IAAI,EAAE,SAAS,CAAA;SAAE;QAC7C;YAAE,IAAI,EAAE,gBAAgB,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE;KAC1C,CAAC;CACH,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,oBAAoB,EAAE,SAAS,EAC/B,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,GACrB,YAAY,CAAC,+BAA+B,CAAC,CAyB/C;AAED,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,mBAAmB,EAAE,SAAS,EAC9B,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,GACrB,YAAY,CAAC,iCAAiC,CAAC,CAyBjD;AAED,wBAAgB,aAAa,WAE5B"}

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

@@ -0,0 +1,30 @@
+export * from "./common";
+export * from "./abi";
+export * from "./ArrayUtils";
+export * from "./BlockUtils";
+export * from "./EventUtils";
+export * from "./ObjectUtils";
+export * from "./TimeUtils";
+export * from "./TypeGuards";
+export * from "./TypeUtils";
+export * from "./TokenUtils";
+export * from "./LogUtils";
+export * from "./FlowUtils";
+export * from "./BundleUtils";
+export * from "./JSONUtils";
+export * from "./IPFSUtils";
+export * from "./NumberUtils";
+export * from "./DeploymentUtils";
+export * from "./FormattingUtils";
+export * from "./BlockExplorerUtils";
+export * from "./BigNumberUtils";
+export * from "./CachingUtils";
+export * from "./NetworkUtils";
+export * from "./Multicall";
+export * from "./ReviverUtils";
+export * from "./DepositUtils";
+export * from "./ValidatorUtils";
+export * from "./AddressUtils";
+export * from "./SpokeUtils";
+export * from "./V3Utils";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}