@across-protocol/sdk 4.0.0-beta.0 → 4.0.0-beta.1

package/src/clients/SpokePoolClient.ts

@@ -12,6 +12,8 @@ import {
   getRelayDataHash,
   isDefined,
   toBN,
+  bnOne,
+  isUnsafeDepositId,
 } from "../utils";
 import {
   paginatedEventQuery,
@@ -46,8 +48,8 @@ type SpokePoolUpdateSuccess = {
   success: true;
   currentTime: number;
   oldestTime: number;
-  firstDepositId: number;
-  latestDepositId: number;
+  firstDepositId: BigNumber;
+  latestDepositId: BigNumber;
   events: Log[][];
   searchEndBlock: number;
 };
@@ -67,7 +69,7 @@ export class SpokePoolClient extends BaseAbstractClient {
   protected depositHashes: { [depositHash: string]: DepositWithBlock } = {};
   protected duplicateDepositHashes: { [depositHash: string]: DepositWithBlock[] } = {};
   protected depositHashesToFills: { [depositHash: string]: FillWithBlock[] } = {};
-  protected speedUps: { [depositorAddress: string]: { [depositId: number]: SpeedUpWithBlock[] } } = {};
+  protected speedUps: { [depositorAddress: string]: { [depositId: string]: SpeedUpWithBlock[] } } = {};
   protected slowFillRequests: { [relayDataHash: string]: SlowFillRequestWithBlock } = {};
   protected depositRoutes: { [originToken: string]: { [DestinationChainId: number]: boolean } } = {};
   protected tokensBridged: TokensBridged[] = [];
@@ -75,10 +77,10 @@ export class SpokePoolClient extends BaseAbstractClient {
   protected relayerRefundExecutions: RelayerRefundExecutionWithBlock[] = [];
   protected queryableEventNames: string[] = [];
   protected configStoreClient: AcrossConfigStoreClient | undefined;
-  public earliestDepositIdQueried = Number.MAX_SAFE_INTEGER;
-  public latestDepositIdQueried = 0;
-  public firstDepositIdForSpokePool = Number.MAX_SAFE_INTEGER;
-  public lastDepositIdForSpokePool = Number.MAX_SAFE_INTEGER;
+  public earliestDepositIdQueried = MAX_BIG_INT;
+  public latestDepositIdQueried = bnZero;
+  public firstDepositIdForSpokePool = MAX_BIG_INT;
+  public lastDepositIdForSpokePool = MAX_BIG_INT;
   public fills: { [OriginChainId: number]: FillWithBlock[] } = {};
 
   /**
@@ -248,7 +250,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    */
   public appendMaxSpeedUpSignatureToDeposit(deposit: DepositWithBlock): DepositWithBlock {
     const { depositId, depositor } = deposit;
-    const speedups = this.speedUps[depositor]?.[depositId];
+    const speedups = this.speedUps[depositor]?.[depositId.toString()];
     if (!isDefined(speedups) || speedups.length === 0) {
       return deposit;
     }
@@ -281,7 +283,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    * @param depositId The unique ID of the deposit being queried.
    * @returns The corresponding deposit if found, undefined otherwise.
    */
-  public getDeposit(depositId: number): DepositWithBlock | undefined {
+  public getDeposit(depositId: BigNumber): DepositWithBlock | undefined {
     const depositHash = this.getDepositHash({ depositId, originChainId: this.chainId });
     return this.depositHashes[depositHash];
   }
@@ -311,7 +313,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    * Retrieves speed up requests grouped by depositor and depositId.
    * @returns A mapping of depositor addresses to deposit ids with their corresponding speed up requests.
    */
-  public getSpeedUps(): { [depositorAddress: string]: { [depositId: number]: SpeedUpWithBlock[] } } {
+  public getSpeedUps(): { [depositorAddress: string]: { [depositId: string]: SpeedUpWithBlock[] } } {
     return this.speedUps;
   }
 
@@ -381,7 +383,7 @@ export class SpokePoolClient extends BaseAbstractClient {
     );
 
     // Log any invalid deposits with same deposit id but different params.
-    const invalidFillsForDeposit = invalidFills.filter((x) => x.depositId === deposit.depositId);
+    const invalidFillsForDeposit = invalidFills.filter((x) => x.depositId.eq(deposit.depositId));
     if (invalidFillsForDeposit.length > 0) {
       this.logger.warn({
         at: "SpokePoolClient",
@@ -412,7 +414,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    * @note This hash is used to match deposits and fills together.
    * @note This hash takes the form of: `${depositId}-${originChainId}`.
    */
-  public getDepositHash(event: { depositId: number; originChainId: number }): string {
+  public getDepositHash(event: { depositId: BigNumber; originChainId: number }): string {
     return `${event.depositId}-${event.originChainId}`;
   }
 
@@ -421,7 +423,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    * @param blockTag The block number to search for the deposit ID at.
    * @returns The deposit ID.
    */
-  public _getDepositIdAtBlock(blockTag: number): Promise<number> {
+  public _getDepositIdAtBlock(blockTag: number): Promise<BigNumber> {
     return getDepositIdAtBlock(this.spokePool as SpokePool, blockTag);
   }
 
@@ -454,10 +456,11 @@ export class SpokePoolClient extends BaseAbstractClient {
    */
   protected async _update(eventsToQuery: string[]): Promise<SpokePoolUpdate> {
     // Find the earliest known depositId. This assumes no deposits were placed in the deployment block.
-    let firstDepositId: number = this.firstDepositIdForSpokePool;
-    if (firstDepositId === Number.MAX_SAFE_INTEGER) {
+    let firstDepositId = this.firstDepositIdForSpokePool;
+    if (firstDepositId.eq(MAX_BIG_INT)) {
       firstDepositId = await this.spokePool.numberOfDeposits({ blockTag: this.deploymentBlock });
-      if (isNaN(firstDepositId) || firstDepositId < 0) {
+      firstDepositId = BigNumber.from(firstDepositId); // Cast input to a big number.
+      if (!BigNumber.isBigNumber(firstDepositId) || firstDepositId.lt(bnZero)) {
         throw new Error(`SpokePoolClient::update: Invalid first deposit id (${firstDepositId})`);
       }
     }
@@ -507,9 +510,10 @@ export class SpokePoolClient extends BaseAbstractClient {
     ]);
     this.log("debug", `Time to query new events from RPC for ${this.chainId}: ${Date.now() - timerStart} ms`);
 
-    const [currentTime, numberOfDeposits] = multicallFunctions.map(
+    const [currentTime, _numberOfDeposits] = multicallFunctions.map(
       (fn, idx) => spokePool.interface.decodeFunctionResult(fn, multicallOutput[idx])[0]
     );
+    const _latestDepositId = BigNumber.from(_numberOfDeposits).sub(bnOne);
 
     if (!BigNumber.isBigNumber(currentTime) || currentTime.lt(this.currentTime)) {
       const errMsg = BigNumber.isBigNumber(currentTime)
@@ -526,7 +530,7 @@ export class SpokePoolClient extends BaseAbstractClient {
       currentTime: currentTime.toNumber(), // uint32
       oldestTime: oldestTime.toNumber(),
       firstDepositId,
-      latestDepositId: Math.max(numberOfDeposits - 1, 0),
+      latestDepositId: _latestDepositId.gt(bnZero) ? _latestDepositId : bnZero,
       searchEndBlock: searchConfig.toBlock,
       events,
     };
@@ -596,10 +600,10 @@ export class SpokePoolClient extends BaseAbstractClient {
         }
         assign(this.depositHashes, [this.getDepositHash(deposit)], deposit);
 
-        if (deposit.depositId < this.earliestDepositIdQueried) {
+        if (deposit.depositId.lt(this.earliestDepositIdQueried) && !isUnsafeDepositId(deposit.depositId)) {
           this.earliestDepositIdQueried = deposit.depositId;
         }
-        if (deposit.depositId > this.latestDepositIdQueried) {
+        if (deposit.depositId.gt(this.latestDepositIdQueried) && !isUnsafeDepositId(deposit.depositId)) {
           this.latestDepositIdQueried = deposit.depositId;
         }
       }
@@ -611,7 +615,7 @@ export class SpokePoolClient extends BaseAbstractClient {
 
       for (const event of speedUpEvents) {
         const speedUp = { ...spreadEventWithBlockNumber(event), originChainId: this.chainId } as SpeedUpWithBlock;
-        assign(this.speedUps, [speedUp.depositor, speedUp.depositId], [speedUp]);
+        assign(this.speedUps, [speedUp.depositor, speedUp.depositId.toString()], [speedUp]);
 
         // Find deposit hash matching this speed up event and update the deposit data associated with the hash,
         // if the hash+data exists.
@@ -795,7 +799,7 @@ export class SpokePoolClient extends BaseAbstractClient {
     return this.oldestTime;
   }
 
-  async findDeposit(depositId: number, destinationChainId: number): Promise<DepositWithBlock> {
+  async findDeposit(depositId: BigNumber, destinationChainId: number): Promise<DepositWithBlock> {
     // Binary search for event search bounds. This way we can get the blocks before and after the deposit with
     // deposit ID = fill.depositId and use those blocks to optimize the search for that deposit.
     // Stop searches after a maximum # of searches to limit number of eth_call requests. Make an
@@ -824,7 +828,7 @@ export class SpokePoolClient extends BaseAbstractClient {
     );
     const tStop = Date.now();
 
-    const event = query.find(({ args }) => args["depositId"] === depositId);
+    const event = query.find(({ args }) => args["depositId"].eq(depositId));
     if (event === undefined) {
       const srcChain = getNetworkName(this.chainId);
       const dstChain = getNetworkName(destinationChainId);

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -14,7 +14,7 @@ import {
   SlowFillLeaf,
   SpeedUp,
 } from "../../interfaces";
-import { toBN, toBNWei, getCurrentTime, randomAddress } from "../../utils";
+import { toBN, toBNWei, getCurrentTime, randomAddress, BigNumber, bnZero, bnOne, bnMax } from "../../utils";
 import { SpokePoolClient, SpokePoolUpdate } from "../SpokePoolClient";
 import { HubPoolClient } from "../HubPoolClient";
 import { EventManager, EventOverrides, getEventManager } from "./MockEvents";
@@ -26,8 +26,8 @@ export class MockSpokePoolClient extends SpokePoolClient {
   public eventManager: EventManager;
   private destinationTokenForChainOverride: Record<number, string> = {};
   // Allow tester to set the numberOfDeposits() returned by SpokePool at a block height.
-  public depositIdAtBlock: number[] = [];
-  public numberOfDeposits = 0;
+  public depositIdAtBlock: BigNumber[] = [];
+  public numberOfDeposits = bnZero;
 
   constructor(
     logger: winston.Logger,
@@ -57,21 +57,21 @@ export class MockSpokePoolClient extends SpokePoolClient {
     this.latestBlockSearched = blockNumber;
   }
 
-  setDepositIds(_depositIds: number[]): void {
+  setDepositIds(_depositIds: BigNumber[]): void {
     this.depositIdAtBlock = [];
     if (_depositIds.length === 0) {
       return;
     }
     let lastDepositId = _depositIds[0];
     for (let i = 0; i < _depositIds.length; i++) {
-      if (_depositIds[i] < lastDepositId) {
+      if (_depositIds[i].lt(lastDepositId)) {
         throw new Error("deposit ID must be equal to or greater than previous");
       }
       this.depositIdAtBlock[i] = _depositIds[i];
       lastDepositId = _depositIds[i];
     }
   }
-  _getDepositIdAtBlock(blockTag: number): Promise<number> {
+  _getDepositIdAtBlock(blockTag: number): Promise<BigNumber> {
     return Promise.resolve(this.depositIdAtBlock[blockTag]);
   }
 
@@ -96,13 +96,13 @@ export class MockSpokePoolClient extends SpokePoolClient {
     // Update latestDepositIdQueried.
     const idx = eventsToQuery.indexOf("V3FundsDeposited");
     const latestDepositId = (events[idx] ?? []).reduce(
-      (depositId, event) => Math.max(depositId, (event.args["depositId"] ?? 0) as number),
+      (depositId, event) => bnMax(depositId, event.args["depositId"] ?? bnZero),
       this.latestDepositIdQueried
     );
 
     return Promise.resolve({
       success: true,
-      firstDepositId: 0,
+      firstDepositId: bnZero,
       latestDepositId,
       currentTime,
       oldestTime: 0,
@@ -122,7 +122,7 @@ export class MockSpokePoolClient extends SpokePoolClient {
     const { blockNumber, transactionIndex } = deposit;
     let { depositId, depositor, destinationChainId, inputToken, inputAmount, outputToken, outputAmount } = deposit;
     depositId ??= this.numberOfDeposits;
-    this.numberOfDeposits = depositId + 1;
+    this.numberOfDeposits = depositId.add(bnOne);
 
     destinationChainId ??= random(1, 42161, false);
     depositor ??= randomAddress();
@@ -167,7 +167,7 @@ export class MockSpokePoolClient extends SpokePoolClient {
     const { blockNumber, transactionIndex } = fill;
     let { originChainId, depositId, inputToken, inputAmount, outputAmount, fillDeadline, relayer } = fill;
     originChainId ??= random(1, 42161, false);
-    depositId ??= random(1, 100_000, false);
+    depositId ??= BigNumber.from(random(1, 100_000, false));
     inputToken ??= randomAddress();
     inputAmount ??= toBNWei(random(1, 1000, false));
     outputAmount ??= inputAmount;

package/src/constants.ts

@@ -10,7 +10,7 @@ export {
   TOKEN_SYMBOLS_MAP,
 } from "@across-protocol/constants";
 
-export const { AddressZero: ZERO_ADDRESS } = ethersConstants;
+export const { AddressZero: ZERO_ADDRESS, HashZero: ZERO_BYTES } = ethersConstants;
 
 // 2^96 - 1 is a conservative erc20 max allowance.
 export const MAX_SAFE_ALLOWANCE = "79228162514264337593543950335";
@@ -33,7 +33,7 @@ export const TRANSFER_THRESHOLD_MAX_CONFIG_STORE_VERSION = 1;
 export const ARWEAVE_TAG_APP_NAME = "across-protocol";
 
 // A hardcoded version number used, by default, to tag all Arweave records.
-export const ARWEAVE_TAG_APP_VERSION = 2;
+export const ARWEAVE_TAG_APP_VERSION = 3;
 
 /**
  * A default list of chain Ids that the protocol supports. This is outlined
@@ -55,6 +55,8 @@ export const DEFAULT_ARWEAVE_STORAGE_ADDRESS = "Z6hjBM8FHu90lYWB8o5jR1dfX92FlV2W
 
 export const EMPTY_MESSAGE = "0x";
 
+export const EMPTY_MESSAGE_HASH = ethersConstants.HashZero;
+
 export const BRIDGED_USDC_SYMBOLS = [
   TOKEN_SYMBOLS_MAP["USDC.e"].symbol,
   TOKEN_SYMBOLS_MAP.USDbC.symbol,

package/src/interfaces/SpokePool.ts

@@ -10,7 +10,7 @@ export interface RelayData {
   originChainId: number;
   depositor: string;
   recipient: string;
-  depositId: number;
+  depositId: BigNumber;
   inputToken: string;
   inputAmount: BigNumber;
   outputToken: string;
@@ -67,7 +67,7 @@ export interface FillWithBlock extends Fill, SortableEvent {}
 export interface SpeedUp {
   depositor: string;
   depositorSignature: string;
-  depositId: number;
+  depositId: BigNumber;
   originChainId: number;
   updatedRecipient: string;
   updatedOutputAmount: BigNumber;

package/src/utils/BigNumberUtils.ts

@@ -62,3 +62,14 @@ export const toBN = (num: BigNumberish, rounding: "floor" | "round" | "ceil" = "
   // Otherwise, it is a string int and we can parse it directly.
   return BigNumber.from(num.toString());
 };
+
+/**
+ * Compares two BigNumbers and returns the maximum. Order does not matter.
+ *
+ * @param val The first BigNumber to compare.
+ * @param cmp The second BigNumber to compare.
+ * @returns The greater of the two BigNumbers.
+ */
+export const bnMax = (val: BigNumber, cmp: BigNumber) => {
+  return val.gt(cmp) ? val : cmp;
+};

package/src/utils/DepositUtils.ts

@@ -1,6 +1,6 @@
 import assert from "assert";
 import { SpokePoolClient } from "../clients";
-import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE } from "../constants";
+import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE, EMPTY_MESSAGE_HASH } from "../constants";
 import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillRequest } from "../interfaces";
 import { getNetworkName } from "./NetworkUtils";
 import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
@@ -52,7 +52,7 @@ export async function queryHistoricalDepositForFill(
 
   const { depositId } = fill;
   let { firstDepositIdForSpokePool: lowId, lastDepositIdForSpokePool: highId } = spokePoolClient;
-  if (depositId < lowId || depositId > highId) {
+  if (depositId.lt(lowId) || depositId.gt(highId)) {
     return {
       found: false,
       code: InvalidFill.DepositIdInvalid,
@@ -61,7 +61,7 @@ export async function queryHistoricalDepositForFill(
   }
 
   ({ earliestDepositIdQueried: lowId, latestDepositIdQueried: highId } = spokePoolClient);
-  if (depositId >= lowId && depositId <= highId) {
+  if (depositId.gte(lowId) && depositId.lte(highId)) {
     const originChain = getNetworkName(fill.originChainId);
     const deposit = spokePoolClient.getDeposit(depositId);
     if (isDefined(deposit)) {
@@ -137,6 +137,10 @@ export function isZeroValueDeposit(deposit: Pick<Deposit, "inputAmount" | "messa
   return deposit.inputAmount.eq(0) && isMessageEmpty(deposit.message);
 }
 
+export function isZeroValueFillOrSlowFillRequest(e: Pick<Fill | SlowFillRequest, "inputAmount" | "message">): boolean {
+  return e.inputAmount.eq(0) && isFillOrSlowFillRequestMessageEmpty(e.message);
+}
+
 /**
  * Determines if a message is empty or not.
  * @param message The message to check.
@@ -146,6 +150,10 @@ export function isMessageEmpty(message = EMPTY_MESSAGE): boolean {
   return message === "" || message === "0x";
 }
 
+export function isFillOrSlowFillRequestMessageEmpty(message: string): boolean {
+  return message === EMPTY_MESSAGE_HASH;
+}
+
 /**
  * Determines if a deposit was updated via a speed-up transaction.
  * @param deposit Deposit to evaluate.

package/src/utils/EventUtils.ts

@@ -3,6 +3,7 @@ import { Result } from "@ethersproject/abi";
 import { Contract, Event, EventFilter } from "ethers";
 import { Log, SortableEvent } from "../interfaces";
 import { delay } from "./common";
+import { isDefined, toBN, BigNumberish } from "./";
 
 const maxRetries = 3;
 const retrySleepTime = 10;
@@ -58,6 +59,13 @@ export function spreadEvent(args: Result | Record<string, unknown>): { [key: str
   if (returnedObject.rootBundleId) {
     returnedObject.rootBundleId = Number(returnedObject.rootBundleId);
   }
+  // If depositId is included in the event, cast it to a BigNumber. Need to check if it is defined since the deposit ID can
+  // be 0, which would still make this evaluate as false.
+  if (isDefined(returnedObject.depositId)) {
+    // Assuming a numeric output, we can safely cast the unknown to BigNumberish since the depositId will either be a uint32 (and therefore a TypeScript `number`),
+    // or a uint256 (and therefore an ethers BigNumber).
+    returnedObject.depositId = toBN(returnedObject.depositId as BigNumberish);
+  }
 
   return returnedObject;
 }

package/src/utils/SpokeUtils.ts

@@ -1,10 +1,10 @@
 import assert from "assert";
 import { BytesLike, Contract, PopulatedTransaction, providers, utils as ethersUtils } from "ethers";
-import { CHAIN_IDs, MAX_SAFE_DEPOSIT_ID, ZERO_ADDRESS } from "../constants";
+import { CHAIN_IDs, MAX_SAFE_DEPOSIT_ID, ZERO_ADDRESS, ZERO_BYTES } from "../constants";
 import { Deposit, Fill, FillStatus, FillWithBlock, RelayData, SlowFillRequest } from "../interfaces";
 import { SpokePoolClient } from "../clients";
 import { chunk } from "./ArrayUtils";
-import { BigNumber, toBN } from "./BigNumberUtils";
+import { BigNumber, toBN, bnOne, bnZero } from "./BigNumberUtils";
 import { isDefined } from "./TypeGuards";
 import { getNetworkName } from "./NetworkUtils";
 import { paginatedEventQuery, spreadEventWithBlockNumber } from "./EventUtils";
@@ -71,7 +71,7 @@ export function populateV3Relay(
  *        // where the deposit with deposit ID = targetDepositId was created.
  */
 export async function getBlockRangeForDepositId(
-  targetDepositId: number,
+  targetDepositId: BigNumber,
   initLow: number,
   initHigh: number,
   maxSearches: number,
@@ -80,6 +80,12 @@ export async function getBlockRangeForDepositId(
   low: number;
   high: number;
 }> {
+  // We can only perform this search when we have a safe deposit ID.
+  if (isUnsafeDepositId(targetDepositId))
+    throw new Error(
+      `Target deposit ID ${targetDepositId} is deterministic and therefore unresolvable via a binary search.`
+    );
+
   // Resolve the deployment block number.
   const deploymentBlock = spokePool.deploymentBlock;
 
@@ -110,13 +116,13 @@ export async function getBlockRangeForDepositId(
   });
 
   // Define a mapping of block numbers to number of deposits at that block. This saves repeated lookups.
-  const queriedIds: Record<number, number> = {};
+  const queriedIds: Record<number, BigNumber> = {};
 
   // Define a llambda function to get the deposit ID at a block number. This function will first check the
   // queriedIds cache to see if the deposit ID at the block number has already been queried. If not, it will
   // make an eth_call request to get the deposit ID at the block number. It will then cache the deposit ID
   // in the queriedIds cache.
-  const _getDepositIdAtBlock = async (blockNumber: number): Promise<number> => {
+  const _getDepositIdAtBlock = async (blockNumber: number): Promise<BigNumber> => {
     queriedIds[blockNumber] ??= await spokePool._getDepositIdAtBlock(blockNumber);
     return queriedIds[blockNumber];
   };
@@ -129,7 +135,7 @@ export async function getBlockRangeForDepositId(
 
   // If the deposit ID at the initial high block is less than the target deposit ID, then we know that
   // the target deposit ID must be greater than the initial high block, so we can throw an error.
-  if (highestDepositIdInRange <= targetDepositId) {
+  if (highestDepositIdInRange.lte(targetDepositId)) {
     // initLow   = 5: Deposits Num: 10
     //                                     // targetId = 11  <- fail (triggers this error)          // 10 <= 11
     //                                     // targetId = 10  <- fail (triggers this error)          // 10 <= 10
@@ -141,7 +147,7 @@ export async function getBlockRangeForDepositId(
 
   // If the deposit ID at the initial low block is greater than the target deposit ID, then we know that
   // the target deposit ID must be less than the initial low block, so we can throw an error.
-  if (lowestDepositIdInRange > targetDepositId) {
+  if (lowestDepositIdInRange.gt(targetDepositId)) {
     // initLow   = 5: Deposits Num: 10
     // initLow-1 = 4: Deposits Num:  2
     //                                     // targetId = 1 <- fail (triggers this error)
@@ -155,7 +161,6 @@ export async function getBlockRangeForDepositId(
   // Define the low and high block numbers for the binary search.
   let low = initLow;
   let high = initHigh;
-
   // Define the number of searches performed so far.
   let searches = 0;
 
@@ -167,12 +172,12 @@ export async function getBlockRangeForDepositId(
     const midDepositId = await _getDepositIdAtBlock(mid);
 
     // Let's define the latest ID of the current midpoint block.
-    const accountedIdByMidBlock = midDepositId - 1;
+    const accountedIdByMidBlock = midDepositId.sub(bnOne);
 
     // If our target deposit ID is less than the smallest range of our
     // midpoint deposit ID range, then we know that the target deposit ID
     // must be in the lower half of the block range.
-    if (targetDepositId <= accountedIdByMidBlock) {
+    if (targetDepositId.lte(accountedIdByMidBlock)) {
       high = mid;
     }
     // If our target deposit ID is greater than the largest range of our
@@ -201,10 +206,11 @@ export async function getBlockRangeForDepositId(
  * @param blockTag The block number to search for the deposit ID at.
  * @returns The deposit ID.
  */
-export async function getDepositIdAtBlock(contract: Contract, blockTag: number): Promise<number> {
-  const depositIdAtBlock = await contract.numberOfDeposits({ blockTag });
+export async function getDepositIdAtBlock(contract: Contract, blockTag: number): Promise<BigNumber> {
+  const _depositIdAtBlock = await contract.numberOfDeposits({ blockTag });
+  const depositIdAtBlock = toBN(_depositIdAtBlock);
   // Sanity check to ensure that the deposit ID is an integer and is greater than or equal to zero.
-  if (!Number.isInteger(depositIdAtBlock) || depositIdAtBlock < 0) {
+  if (depositIdAtBlock.lt(bnZero)) {
     throw new Error("Invalid deposit count");
   }
   return depositIdAtBlock;
@@ -245,7 +251,7 @@ export function getRelayHashFromEvent(e: Deposit | Fill | SlowFillRequest): stri
   return getRelayDataHash(e, e.destinationChainId);
 }
 
-export function isUnsafeDepositId(depositId: number): boolean {
+export function isUnsafeDepositId(depositId: BigNumber): boolean {
   // SpokePool.unsafeDepositV3() produces a uint256 depositId by hashing the msg.sender, depositor and input
   // uint256 depositNonce. There is a possibility that this resultant uint256 is less than the maxSafeDepositId (i.e.
   // the maximum uint32 value) which makes it possible that an unsafeDepositV3's depositId can collide with a safe
@@ -415,3 +421,8 @@ export async function findFillEvent(
   } as FillWithBlock;
   return fill;
 }
+
+// Determines if the input address (either a bytes32 or bytes20) is the zero address.
+export function isZeroAddress(address: string): boolean {
+  return address === ZERO_ADDRESS || address === ZERO_BYTES;
+}

package/src/utils/ValidatorUtils.ts

@@ -8,7 +8,7 @@ const HexValidator = define<string>("HexValidator", (v) => ethersUtils.isHexStri
 const BigNumberValidator = define<BigNumber>("BigNumberValidator", (v) => BigNumber.isBigNumber(v));
 
 const V3DepositSchema = object({
-  depositId: Min(integer(), 0),
+  depositId: BigNumberValidator,
   depositor: AddressValidator,
   recipient: AddressValidator,
   inputToken: AddressValidator,