improve: use SS for type validation

src/interfaces/index.ts

@@ -56,6 +56,7 @@ export type RelayData = interfaces.RelayData;
 export type Deposit = interfaces.Deposit;
 export type DepositWithBlock = interfaces.DepositWithBlock;
 export type Fill = interfaces.Fill;
+export type RelayExecutionEventInfo = interfaces.RelayExecutionEventInfo;
 export type FillWithBlock = interfaces.FillWithBlock;
 export type SpeedUp = interfaces.SpeedUp;
 export type SlowFillRequest = interfaces.SlowFillRequest;

test/Dataworker.loadData.slowFill.ts

@@ -576,7 +576,7 @@ describe("Dataworker: Load bundle data: Computing slow fills", async function ()
 
   it("Slow fill request for deposit that isn't eligible for slow fill", async function () {
     const invalidOutputToken = erc20_1;
-    const _depositObject = await depositV3(
+    const depositObject = await depositV3(
       spokePool_1,
       destinationChainId,
       depositor,
@@ -585,14 +585,7 @@ describe("Dataworker: Load bundle data: Computing slow fills", async function ()
       invalidOutputToken.address,
       amountToDeposit
     );
-    const depositObject = {
-      ..._depositObject,
-      inputToken: toAddressType(_depositObject.inputToken, originChainId),
-      outputToken: toAddressType(_depositObject.outputToken, destinationChainId),
-      depositor: toAddressType(_depositObject.depositor, originChainId),
-      recipient: toAddressType(_depositObject.recipient, destinationChainId),
-      exclusiveRelayer: toAddressType(_depositObject.exclusiveRelayer, destinationChainId),
-    };
+
     await spokePoolClient_1.update();
 
     await requestSlowFill(spokePool_2, relayer, depositObject);
@@ -621,7 +614,7 @@ describe("Dataworker: Load bundle data: Computing slow fills", async function ()
     await mockConfigStore.update();
     (spokePoolClient_1 as any).configStoreClient = mockConfigStore;
     (spokePoolClient_2 as any).configStoreClient = mockConfigStore;
-    const _depositObject = await depositV3(
+    const depositObject = await depositV3(
       spokePool_1,
       destinationChainId,
       depositor,
@@ -630,14 +623,7 @@ describe("Dataworker: Load bundle data: Computing slow fills", async function ()
       erc20_2.address,
       amountToDeposit
     );
-    const depositObject = {
-      ..._depositObject,
-      inputToken: toAddressType(_depositObject.inputToken, originChainId),
-      outputToken: toAddressType(_depositObject.outputToken, destinationChainId),
-      depositor: toAddressType(_depositObject.depositor, originChainId),
-      recipient: toAddressType(_depositObject.recipient, destinationChainId),
-      exclusiveRelayer: toAddressType(_depositObject.exclusiveRelayer, destinationChainId),
-    };
+
     await spokePoolClient_1.update();
     expect(mockConfigStore.liteChainIndicesUpdates.length).to.equal(1);
     expect(mockConfigStore.liteChainIndicesUpdates[0].timestamp).to.be.lt(depositObject.quoteTimestamp);
@@ -667,7 +653,7 @@ describe("Dataworker: Load bundle data: Computing slow fills", async function ()
     await mockConfigStore.update();
     (spokePoolClient_1 as any).configStoreClient = mockConfigStore;
     (spokePoolClient_2 as any).configStoreClient = mockConfigStore;
-    const _depositObject = await depositV3(
+    const depositObject = await depositV3(
       spokePool_1,
       destinationChainId,
       depositor,
@@ -676,14 +662,7 @@ describe("Dataworker: Load bundle data: Computing slow fills", async function ()
       erc20_2.address,
       amountToDeposit
     );
-    const depositObject = {
-      ..._depositObject,
-      inputToken: toAddressType(_depositObject.inputToken, originChainId),
-      outputToken: toAddressType(_depositObject.outputToken, destinationChainId),
-      depositor: toAddressType(_depositObject.depositor, originChainId),
-      recipient: toAddressType(_depositObject.recipient, destinationChainId),
-      exclusiveRelayer: toAddressType(_depositObject.exclusiveRelayer, destinationChainId),
-    };
+
     await spokePoolClient_1.update();
     expect(mockConfigStore.liteChainIndicesUpdates.length).to.equal(1);
     expect(mockConfigStore.liteChainIndicesUpdates[0].timestamp).to.be.lt(depositObject.quoteTimestamp);

test/Dataworker.loadData.unexecutableSlowFill.ts

@@ -238,8 +238,10 @@ describe("Dataworker: Load bundle data: Computing unexecutable slow fills", asyn
     await spokePoolClient_1.update();
     const deposits = spokePoolClient_1.getDeposits();
     expect(deposits.length).to.equal(3);
-    const eligibleSlowFills = depositsWithSlowFillRequests.filter((x) => erc20_2.address === x.outputToken);
-    const ineligibleSlowFills = depositsWithSlowFillRequests.filter((x) => erc20_2.address !== x.outputToken);
+    const eligibleSlowFills = depositsWithSlowFillRequests.filter((x) => erc20_2.address === x.outputToken.toNative());
+    const ineligibleSlowFills = depositsWithSlowFillRequests.filter(
+      (x) => erc20_2.address !== x.outputToken.toNative()
+    );
 
     // Generate slow fill requests for the slow fill-eligible deposits
     await requestSlowFill(spokePool_2, relayer, eligibleSlowFills[0]);

test/Relayer.BasicFill.ts

@@ -442,7 +442,7 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
 
       // Make two deposits - one with the relayer as exclusiveRelayer, and one with a random address.
       // Verify that the relayer can immediately fill the first deposit, and both after the exclusivity window.
-      for (const exclusiveRelayer of [randomAddress(), relayerAddress]) {
+      for (const exclusiveRelayer of [randomAddress(), relayerAddress.toNative()]) {
         const deposit = await depositV3(
           spokePool_1,
           destinationChainId,
@@ -463,18 +463,15 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
 
       deposits.forEach((deposit) => {
         const depositHash = spokePoolClients[deposit.destinationChainId].getDepositHash(deposit);
-        const status =
-          deposit.exclusiveRelayer === relayerAddress.toEvmAddress() ? FillStatus.Filled : FillStatus.Unfilled;
+        const status = deposit.exclusiveRelayer.eq(relayerAddress) ? FillStatus.Filled : FillStatus.Unfilled;
         expect(fillStatus[depositHash] ?? FillStatus.Unfilled).to.equal(status);
       });
 
       txnReceipts = await relayerInstance.checkForUnfilledDepositsAndFill();
       expect((await txnReceipts[destinationChainId]).length).to.equal(0);
       expect(lastSpyLogIncludes(spy, "0 unfilled deposits found")).to.be.true;
 
-      const exclusiveDeposit = deposits.find(
-        ({ exclusiveRelayer }) => exclusiveRelayer !== relayerAddress.toEvmAddress()
-      );
+      const exclusiveDeposit = deposits.find(({ exclusiveRelayer }) => exclusiveRelayer.eq(relayerAddress));
       expect(exclusiveDeposit).to.exist;
       await spokePool_2.setCurrentTime(exclusiveDeposit!.exclusivityDeadline + 1);
       await updateAllClients();
@@ -591,10 +588,7 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
         outputToken,
         outputAmount
       );
-      const fillAmount = profitClient.getFillAmountInUsd({
-        ...deposit1,
-        outputToken: toAddressType(deposit1.outputToken, destinationChainId),
-      })!;
+      const fillAmount = profitClient.getFillAmountInUsd(deposit1)!;
       expect(fillAmount).to.exist;
 
       // Simple escalating confirmation requirements; cap off with a default upper limit.
@@ -644,14 +638,7 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
       await updateAllClients();
 
       originChainCommitment = relayerInstance.computeOriginChainCommitment(originChainId, 0, Number.MAX_SAFE_INTEGER);
-      expect(
-        originChainCommitment.eq(
-          getFillAmount(
-            { ...deposit1, outputToken: toAddressType(deposit1.outputToken, destinationChainId) },
-            tokenPrice
-          )
-        )
-      ).to.be.true;
+      expect(originChainCommitment.eq(getFillAmount(deposit1, tokenPrice))).to.be.true;
 
       let originChainLimits = relayerInstance.computeOriginChainLimits(originChainId);
       expect(isChainOvercommitted(originChainLimits)).to.be.false;
@@ -955,7 +942,7 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
           spokePool_1,
           {
             ...deposit,
-            updatedRecipient: update.recipient,
+            updatedRecipient: toAddressType(update.recipient, destinationChainId),
             updatedOutputAmount: update.outputAmount,
             updatedMessage: update.message,
           },
@@ -1022,7 +1009,12 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
       const updatedRecipient = randomAddress();
       await updateDeposit(
         spokePool_1,
-        { ...deposit, updatedRecipient, updatedOutputAmount, updatedMessage },
+        {
+          ...deposit,
+          updatedRecipient: toAddressType(updatedRecipient, destinationChainId),
+          updatedOutputAmount,
+          updatedMessage,
+        },
         depositor
       );
 
@@ -1039,7 +1031,12 @@ describe("Relayer: Check for Unfilled Deposits and Fill", async function () {
       updatedMessage = EMPTY_MESSAGE;
       await updateDeposit(
         spokePool_1,
-        { ...deposit, updatedRecipient, updatedOutputAmount, updatedMessage },
+        {
+          ...deposit,
+          updatedRecipient: toAddressType(updatedRecipient, destinationChainId),
+          updatedOutputAmount,
+          updatedMessage,
+        },
         depositor
       );
 

test/Relayer.SlowFill.ts

@@ -38,7 +38,7 @@ import {
   winston,
   deployMulticall3,
 } from "./utils";
-import { SvmAddress, EvmAddress, toAddressType } from "../src/utils";
+import { SvmAddress, EvmAddress } from "../src/utils";
 
 import { Relayer } from "../src/relayer/Relayer";
 import { RelayerConfig } from "../src/relayer/RelayerConfig"; // Tested
@@ -241,14 +241,7 @@ describe("Relayer: Initiates slow fill requests", async function () {
 
     // Verify that the slowFill request was received by the destination SpokePoolClient.
     await Promise.all([spokePoolClient_1.update(), spokePoolClient_2.update(), hubPoolClient.update()]);
-    const slowFillRequest = spokePoolClient_2.getSlowFillRequest({
-      ...deposit,
-      inputToken: toAddressType(inputToken, originChainId),
-      outputToken: toAddressType(outputToken, destinationChainId),
-      depositor: toAddressType(deposit.depositor, originChainId),
-      recipient: toAddressType(deposit.recipient, destinationChainId),
-      exclusiveRelayer: toAddressType(deposit.exclusiveRelayer, destinationChainId),
-    });
+    const slowFillRequest = spokePoolClient_2.getSlowFillRequest(deposit);
     expect(slowFillRequest).to.exist;
 
     const txnReceipts = await relayerInstance.checkForUnfilledDepositsAndFill();

test/Relayer.UnfilledDeposits.ts

@@ -43,6 +43,8 @@ import {
   randomAddress,
   setupTokensForWallet,
   deployMulticall3,
+  depositIntoPrimitiveTypes,
+  fillIntoPrimitiveTypes,
 } from "./utils";
 // Tested
 import { Relayer } from "../src/relayer/Relayer";
@@ -233,14 +235,7 @@ describe("Relayer: Unfilled Deposits", async function () {
       unfilledDeposits.map((unfilledDeposit) => {
         return {
           ...unfilledDeposit,
-          deposit: {
-            ...unfilledDeposit.deposit,
-            inputToken: unfilledDeposit.deposit.inputToken.toEvmAddress(),
-            outputToken: unfilledDeposit.deposit.outputToken.toEvmAddress(),
-            depositor: unfilledDeposit.deposit.depositor.toEvmAddress(),
-            recipient: unfilledDeposit.deposit.recipient.toEvmAddress(),
-            exclusiveRelayer: unfilledDeposit.deposit.exclusiveRelayer.toEvmAddress(),
-          },
+          deposit: depositIntoPrimitiveTypes(unfilledDeposit.deposit),
         };
       })
     )
@@ -249,7 +244,7 @@ describe("Relayer: Unfilled Deposits", async function () {
         [...deposits]
           .sort((a, b) => (a.destinationChainId > b.destinationChainId ? 1 : -1))
           .map((deposit) => ({
-            deposit,
+            deposit: depositIntoPrimitiveTypes(deposit),
             unfilledAmount: deposit.outputAmount,
             invalidFills: [],
             version: configStoreClient.configStoreVersion,
@@ -287,14 +282,7 @@ describe("Relayer: Unfilled Deposits", async function () {
       unfilledDeposits.map((unfilledDeposit) => {
         return {
           ...unfilledDeposit,
-          deposit: {
-            ...unfilledDeposit.deposit,
-            inputToken: unfilledDeposit.deposit.inputToken.toEvmAddress(),
-            outputToken: unfilledDeposit.deposit.outputToken.toEvmAddress(),
-            depositor: unfilledDeposit.deposit.depositor.toEvmAddress(),
-            recipient: unfilledDeposit.deposit.recipient.toEvmAddress(),
-            exclusiveRelayer: unfilledDeposit.deposit.exclusiveRelayer.toEvmAddress(),
-          },
+          deposit: depositIntoPrimitiveTypes(unfilledDeposit.deposit),
         };
       })
     )
@@ -303,7 +291,7 @@ describe("Relayer: Unfilled Deposits", async function () {
         deposits
           .filter(({ depositId }) => depositId !== filledDeposit!.depositId)
           .map((deposit) => ({
-            deposit,
+            deposit: depositIntoPrimitiveTypes(deposit),
             unfilledAmount: deposit.outputAmount,
             invalidFills: [],
             version: configStoreClient.configStoreVersion,
@@ -333,15 +321,12 @@ describe("Relayer: Unfilled Deposits", async function () {
     unfilledDeposits = _getAllUnfilledDeposits();
     expect(
       unfilledDeposits.map((unfilledDeposit) => {
+        const depositV3PrimitiveEvmArgs = depositIntoPrimitiveTypes(unfilledDeposit.deposit);
         return {
           ...unfilledDeposit,
           deposit: {
             ...unfilledDeposit.deposit,
-            inputToken: unfilledDeposit.deposit.inputToken.toEvmAddress(),
-            outputToken: unfilledDeposit.deposit.outputToken.toEvmAddress(),
-            depositor: unfilledDeposit.deposit.depositor.toEvmAddress(),
-            recipient: unfilledDeposit.deposit.recipient.toEvmAddress(),
-            exclusiveRelayer: unfilledDeposit.deposit.exclusiveRelayer.toEvmAddress(),
+            ...depositV3PrimitiveEvmArgs,
           },
           invalidFills: [
             {
@@ -366,12 +351,14 @@ describe("Relayer: Unfilled Deposits", async function () {
         {
           deposit: {
             ...deposit,
+            ...depositIntoPrimitiveTypes(deposit),
             depositId: sdkUtils.toBN(deposit.depositId),
           },
           unfilledAmount: deposit.outputAmount,
           invalidFills: [
             {
               ...invalidFill,
+              ...fillIntoPrimitiveTypes(invalidFill),
               depositId: sdkUtils.toBN(invalidFill.depositId),
             },
           ],
@@ -516,14 +503,7 @@ describe("Relayer: Unfilled Deposits", async function () {
         outputAmount,
         { quoteTimestamp }
       );
-      deposits.push({
-        ...deposit,
-        inputToken: toAddressType(deposit.inputToken, originChainId),
-        outputToken: toAddressType(deposit.outputToken, destinationChainId),
-        depositor: toAddressType(deposit.depositor, originChainId),
-        recipient: toAddressType(deposit.recipient, destinationChainId),
-        exclusiveRelayer: toAddressType(deposit.exclusiveRelayer, destinationChainId),
-      });
+      deposits.push(deposit);
 
       // Modify the HubPool LP balance to ensure that subsequent deposits will receive a different LP fee.
       const lpTokenBalance = await lpToken.balanceOf(owner.address);
@@ -621,11 +601,7 @@ describe("Relayer: Unfilled Deposits", async function () {
           ...unfilledDeposit,
           deposit: {
             ...unfilledDeposit.deposit,
-            inputToken: unfilledDeposit.deposit.inputToken.toEvmAddress(),
-            outputToken: unfilledDeposit.deposit.outputToken.toEvmAddress(),
-            depositor: unfilledDeposit.deposit.depositor.toEvmAddress(),
-            recipient: unfilledDeposit.deposit.recipient.toEvmAddress(),
-            exclusiveRelayer: unfilledDeposit.deposit.exclusiveRelayer.toEvmAddress(),
+            ...depositIntoPrimitiveTypes(unfilledDeposit.deposit),
           },
           invalidFills: [
             {
@@ -649,13 +625,14 @@ describe("Relayer: Unfilled Deposits", async function () {
       .to.deep.equal([
         {
           deposit: {
-            ...deposit,
+            ...depositIntoPrimitiveTypes(deposit),
             depositId: sdkUtils.toBN(deposit.depositId),
           },
           unfilledAmount: deposit.outputAmount,
           invalidFills: [
             {
               ...invalidFill,
+              ...fillIntoPrimitiveTypes(invalidFill),
               depositId: sdkUtils.toBN(invalidFill.depositId),
             },
           ],