Typeguard WIP

src/clients/SpokePoolClient.ts

@@ -18,6 +18,8 @@ import {
   isV2SpeedUp,
   isV3SpeedUp,
   toBN,
+  isValidType,
+  assert,
 } from "../utils";
 import {
   paginatedEventQuery,
@@ -49,6 +51,7 @@ import {
   V2SpeedUp,
   V3DepositWithBlock,
   V3FillWithBlock,
+  V3FundsDepositEventProps,
   V3FundsDepositedEvent,
   V3RelayData,
   V3RelayerRefundExecutionWithBlock,
@@ -1158,7 +1161,7 @@ export class SpokePoolClient extends BaseAbstractClient {
       );
     }
     const partialDeposit = spreadEventWithBlockNumber(event) as V3DepositWithBlock;
-    // @TODO Validate partialDeposit here.
+    assert(isValidType(partialDeposit, V3FundsDepositEventProps), "Invalid FundsDeposited event");
     const { realizedLpFeePct, quoteBlock: quoteBlockNumber } = (await this.batchComputeRealizedLpFeePct([event]))[0]; // Append the realizedLpFeePct.
 
     // Append destination token and realized lp fee to deposit.

src/interfaces/SpokePool.ts

@@ -58,6 +58,31 @@ export interface V3Deposit extends V3RelayData {
   updatedMessage?: string;
 }
 
+export const SortableEventProps = [
+  "blockNumber",
+  "transactionIndex",
+  "logIndex",
+  "transactionHash"
+]
+export const V3RelayDataProps = [
+  "originChainId",
+  "depositor",
+  "recipient",
+  "depositId",
+  "message",
+  "inputToken",
+  "inputAmount",
+  "outputToken",
+  "outputAmount",
+  "fillDeadline",
+  "exclusiveRelayer",
+  "exclusivityDeadline",
+]
+export const V3FundsDepositEventProps = [
+  ...SortableEventProps,
+  ...V3RelayDataProps
+]
+
 export interface V3DepositWithBlock extends V3Deposit, SortableEvent {
   quoteBlockNumber: number;
 }

src/utils/TypeGuards.ts

@@ -13,3 +13,12 @@ export function isPromiseRejected<T>(
 export function isDefined<T>(input: T | null | undefined): input is T {
   return input !== null && input !== undefined;
 }
+
+export function isValidType(input: object, expectedTypeProps: string[]): boolean {
+  for (const prop of expectedTypeProps) {
+    if (!(prop in input)) {
+      return false;
+    }
+  }
+  return true;
+}