@across-protocol/sdk 4.2.9-alpha.1 → 4.2.9-alpha.3

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -13,13 +13,12 @@ import {
   isDefined,
   getMessageHash,
   isSlowFill,
-  isValidEvmAddress,
   isZeroAddress,
-  toAddress,
   validateFillForDeposit,
   chainIsEvm,
   chainIsProd,
   Address,
+  toAddressType,
 } from "../../utils";
 import { duplicateEvent, sortEventsAscendingInPlace } from "../../utils/EventUtils";
 import { ZERO_ADDRESS } from "../../constants";
@@ -37,6 +36,7 @@ import {
   SortableEvent,
   SpeedUpWithBlock,
   TokensBridged,
+  RelayExecutionEventInfo,
 } from "../../interfaces";
 import { BaseAbstractClient, UpdateFailureReason } from "../BaseAbstractClient";
 import { AcrossConfigStoreClient } from "../AcrossConfigStoreClient";
@@ -202,8 +202,8 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
    * @param relayer The relayer address.
    * @returns A list of fills.
    */
-  public getFillsForRelayer(relayer: string): FillWithBlock[] {
-    return this.getFills().filter((fill) => fill.relayer === relayer);
+  public getFillsForRelayer(relayer: Address): FillWithBlock[] {
+    return this.getFills().filter((fill) => fill.relayer.eq(relayer));
   }
 
   /**
@@ -251,7 +251,8 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     const { depositId, depositor } = deposit;
 
     // Note: we know depositor cannot be more than 20 bytes since this is guaranteed by contracts.
-    const speedups = this.speedUps[toAddress(depositor)]?.[depositId.toString()];
+    // Additionally, speed ups can only be done on EVM networks.
+    const speedups = this.speedUps[depositor.toEvmAddress()]?.[depositId.toString()];
 
     if (!isDefined(speedups) || speedups.length === 0) {
       return deposit;
@@ -302,9 +303,10 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
    * @param relayData RelayData field for the SlowFill request.
    * @returns The corresponding SlowFillRequest event if found, otherwise undefined.
    */
-  public getSlowFillRequest(relayData: RelayData): SlowFillRequestWithBlock | undefined {
-    const messageHash = getMessageHash(relayData.message);
-    const hash = getRelayEventKey({ ...relayData, messageHash, destinationChainId: this.chainId });
+  public getSlowFillRequest(
+    relayData: Omit<RelayData, "message"> & { messageHash: string }
+  ): SlowFillRequestWithBlock | undefined {
+    const hash = getRelayEventKey({ ...relayData, destinationChainId: this.chainId });
     return this.slowFillRequests[hash];
   }
 
@@ -383,7 +385,8 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
           if (
             this.hubPoolClient &&
             !isSlowFill(fill) &&
-            (!chainIsEvm(repaymentChainId) || !isValidEvmAddress(fill.relayer))
+            chainIsEvm(repaymentChainId) &&
+            !fill.relayer.isValidEvmAddress()
           ) {
             groupedFills.unrepayableFills.push(fill);
           }
@@ -416,7 +419,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
         chainId: this.chainId,
         message: "Invalid fills found matching deposit ID",
         deposit,
-        invalidFills: Object.fromEntries(invalidFillsForDeposit.map((x) => [x.relayer, x])),
+        invalidFills: Object.fromEntries(invalidFillsForDeposit.map((x) => [x.relayer.toAddress(), x])),
         notificationPath: "across-invalid-fills",
       });
     }
@@ -427,7 +430,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
         chainId: this.chainId,
         message: "Unrepayable fills found where we need to switch repayment address and or chain",
         deposit,
-        unrepayableFills: Object.fromEntries(unrepayableFillsForDeposit.map((x) => [x.relayer, x])),
+        unrepayableFills: Object.fromEntries(unrepayableFillsForDeposit.map((x) => [x.relayer.toAddress(), x])),
         notificationPath: "across-unrepayable-fills",
       });
     }
@@ -499,14 +502,36 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     const { events: queryResults, currentTime, searchEndBlock } = update;
 
     if (eventsToQuery.includes("TokensBridged")) {
-      for (const event of queryResults[eventsToQuery.indexOf("TokensBridged")] as TokensBridged[]) {
-        this.tokensBridged.push(event);
+      for (const _event of queryResults[eventsToQuery.indexOf("TokensBridged")]) {
+        const event = _event as TokensBridged & {
+          l2TokenAddress: string;
+        };
+        this.tokensBridged.push({
+          ...event,
+          l2TokenAddress: toAddressType(event.l2TokenAddress, this.chainId),
+        });
       }
     }
 
     // Performs the indexing of a deposit-like spoke pool event.
     const queryDepositEvents = async (eventName: string) => {
-      const depositEvents = (queryResults[eventsToQuery.indexOf(eventName)] ?? []) as DepositWithBlock[];
+      const depositEvents = (queryResults[eventsToQuery.indexOf(eventName)] ?? []).map((_event) => {
+        const event = _event as DepositWithBlock & {
+          depositor: string;
+          recipient: string;
+          inputToken: string;
+          outputToken: string;
+          exclusiveRelayer: string;
+        };
+        return {
+          ...event,
+          depositor: toAddressType(event.depositor, this.chainId),
+          recipient: toAddressType(event.recipient, event.destinationChainId),
+          inputToken: toAddressType(event.inputToken, this.chainId),
+          outputToken: toAddressType(event.outputToken, event.destinationChainId),
+          exclusiveRelayer: toAddressType(event.exclusiveRelayer, event.destinationChainId),
+        } as DepositWithBlock;
+      });
       if (depositEvents.length > 0) {
         this.log(
           "debug",
@@ -555,7 +580,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
       }
     };
 
-    for (const event of ["V3FundsDeposited", "FundsDeposited"]) {
+    for (const event of ["FundsDeposited"]) {
       if (eventsToQuery.includes(event)) {
         await queryDepositEvents(event);
       }
@@ -563,11 +588,21 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
 
     // Performs indexing of a "speed up deposit"-like event.
     const querySpeedUpDepositEvents = (eventName: string) => {
-      const speedUpEvents = (queryResults[eventsToQuery.indexOf(eventName)] ?? []) as SpeedUpWithBlock[];
+      const speedUpEvents = (queryResults[eventsToQuery.indexOf(eventName)] ?? []).map((_event) => {
+        const event = _event as SpeedUpWithBlock & { depositor: string; updatedRecipient: string };
+        return {
+          ...event,
+          depositor: toAddressType(event.depositor, this.chainId),
+          updatedRecipient: toAddressType(event.updatedRecipient),
+        } as SpeedUpWithBlock;
+      });
 
       for (const event of speedUpEvents) {
-        const speedUp = { ...event, originChainId: this.chainId };
-        assign(this.speedUps, [speedUp.depositor, speedUp.depositId.toString()], [speedUp]);
+        const speedUp = {
+          ...event,
+          originChainId: this.chainId,
+        };
+        assign(this.speedUps, [speedUp.depositor.toAddress(), 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.
@@ -583,7 +618,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     };
 
     // Update deposits with speed up requests from depositor.
-    ["RequestedSpeedUpV3Deposit", "RequestedSpeedUpDeposit"].forEach((event) => {
+    ["RequestedSpeedUpDeposit"].forEach((event) => {
       if (eventsToQuery.includes(event)) {
         querySpeedUpDepositEvents(event);
       }
@@ -591,17 +626,29 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
 
     // Performs indexing of "requested slow fill"-like events.
     const queryRequestedSlowFillEvents = (eventName: string) => {
-      const slowFillRequests = (queryResults[eventsToQuery.indexOf(eventName)] ?? []) as SlowFillRequestWithBlock[];
+      const slowFillRequests = (queryResults[eventsToQuery.indexOf(eventName)] ?? []).map((_event) => {
+        const event = _event as SlowFillRequestWithBlock & {
+          depositor: string;
+          recipient: string;
+          inputToken: string;
+          outputToken: string;
+          exclusiveRelayer: string;
+        };
+        return {
+          ...event,
+          depositor: toAddressType(event.depositor, event.originChainId),
+          recipient: toAddressType(event.recipient, this.chainId),
+          inputToken: toAddressType(event.inputToken, event.originChainId),
+          outputToken: toAddressType(event.outputToken, this.chainId),
+          exclusiveRelayer: toAddressType(event.exclusiveRelayer, this.chainId),
+        } as SlowFillRequestWithBlock;
+      });
       for (const event of slowFillRequests) {
         const slowFillRequest = {
           ...event,
           destinationChainId: this.chainId,
         };
 
-        if (eventName === "RequestedV3SlowFill") {
-          slowFillRequest.messageHash = getMessageHash(slowFillRequest.message);
-        }
-
         const depositHash = getRelayEventKey({ ...slowFillRequest, destinationChainId: this.chainId });
 
         // Sanity check that this event is not a duplicate.
@@ -614,7 +661,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
       }
     };
 
-    ["RequestedV3SlowFill", "RequestedSlowFill"].forEach((event) => {
+    ["RequestedSlowFill"].forEach((event) => {
       if (eventsToQuery.includes(event)) {
         queryRequestedSlowFillEvents(event);
       }
@@ -622,7 +669,30 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
 
     // Performs indexing of filled relay-like events.
     const queryFilledRelayEvents = (eventName: string) => {
-      const fillEvents = (queryResults[eventsToQuery.indexOf(eventName)] ?? []) as FillWithBlock[];
+      const fillEvents = (queryResults[eventsToQuery.indexOf(eventName)] ?? []).map((_event) => {
+        const event = _event as FillWithBlock & {
+          depositor: string;
+          recipient: string;
+          inputToken: string;
+          outputToken: string;
+          exclusiveRelayer: string;
+          relayer: string;
+          relayExecutionInfo: RelayExecutionEventInfo & { updatedRecipient: string };
+        };
+        return {
+          ...event,
+          depositor: toAddressType(event.depositor, event.originChainId),
+          recipient: toAddressType(event.recipient, this.chainId),
+          inputToken: toAddressType(event.inputToken, event.originChainId),
+          outputToken: toAddressType(event.outputToken, this.chainId),
+          exclusiveRelayer: toAddressType(event.exclusiveRelayer, this.chainId),
+          relayer: toAddressType(event.relayer, this.chainId),
+          relayExecutionInfo: {
+            ...event.relayExecutionInfo,
+            updatedRecipient: toAddressType(event.relayExecutionInfo.updatedRecipient, this.chainId),
+          },
+        } as FillWithBlock;
+      });
 
       if (fillEvents.length > 0) {
         this.log("debug", `Using ${fillEvents.length} newly queried ${eventName} events for chain ${this.chainId}`, {
@@ -638,11 +708,6 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
           destinationChainId: this.chainId,
         };
 
-        if (eventName === "FilledV3Relay") {
-          fill.messageHash = getMessageHash((event as unknown as { message: string }).message);
-          fill.relayExecutionInfo.updatedMessageHash = getMessageHash(event.relayExecutionInfo.updatedMessage!);
-        }
-
         // Sanity check that this event is not a duplicate.
         const duplicateFill = this.fills[fill.originChainId]?.find((f) => duplicateEvent(fill, f));
         if (duplicateFill) {
@@ -656,15 +721,16 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     };
 
     // Update observed fills with ingested event data.
-    ["FilledV3Relay", "FilledRelay"].forEach((event) => {
+    ["FilledRelay"].forEach((event) => {
       if (eventsToQuery.includes(event)) {
         queryFilledRelayEvents(event);
       }
     });
 
     if (eventsToQuery.includes("EnabledDepositRoute")) {
-      const enableDepositsEvents = (queryResults[eventsToQuery.indexOf("EnabledDepositRoute")] ??
-        []) as EnabledDepositRouteWithBlock[];
+      const enableDepositsEvents = queryResults[
+        eventsToQuery.indexOf("EnabledDepositRoute")
+      ] as EnabledDepositRouteWithBlock[];
 
       for (const event of enableDepositsEvents) {
         assign(this.depositRoutes, [event.originToken, event.destinationChainId], event.enabled);
@@ -672,16 +738,18 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     }
 
     if (eventsToQuery.includes("RelayedRootBundle")) {
-      const relayedRootBundleEvents = (queryResults[eventsToQuery.indexOf("RelayedRootBundle")] ??
-        []) as RootBundleRelayWithBlock[];
+      const relayedRootBundleEvents = queryResults[
+        eventsToQuery.indexOf("RelayedRootBundle")
+      ] as RootBundleRelayWithBlock[];
       for (const event of relayedRootBundleEvents) {
         this.rootBundleRelays.push(event);
       }
     }
 
     if (eventsToQuery.includes("ExecutedRelayerRefundRoot")) {
-      const refundEvents = (queryResults[eventsToQuery.indexOf("ExecutedRelayerRefundRoot")] ??
-        []) as RelayerRefundExecutionWithBlock[];
+      const refundEvents = queryResults[
+        eventsToQuery.indexOf("ExecutedRelayerRefundRoot")
+      ] as RelayerRefundExecutionWithBlock[];
       for (const event of refundEvents) {
         this.relayerRefundExecutions.push(event);
       }
@@ -731,9 +799,9 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
    * @param deposit The deposit to retrieve the destination token for.
    * @returns The destination token.
    */
-  protected getDestinationTokenForDeposit(deposit: DepositWithBlock): string {
+  protected getDestinationTokenForDeposit(deposit: DepositWithBlock): Address {
     if (!this.canResolveZeroAddressOutputToken(deposit)) {
-      return ZERO_ADDRESS;
+      return toAddressType(ZERO_ADDRESS);
     }
     // L1 token should be resolved if we get here:
     const l1Token = this.hubPoolClient!.getL1TokenForL2TokenAtBlock(
@@ -741,10 +809,12 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
       deposit.originChainId,
       deposit.quoteBlockNumber
     )!;
-    return (
-      this.hubPoolClient!.getL2TokenForL1TokenAtBlock(l1Token, deposit.destinationChainId, deposit.quoteBlockNumber) ??
-      ZERO_ADDRESS
+    const counterpartToken = this.hubPoolClient!.getL2TokenForL1TokenAtBlock(
+      l1Token,
+      deposit.destinationChainId,
+      deposit.quoteBlockNumber
     );
+    return counterpartToken ?? toAddressType(ZERO_ADDRESS);
   }
 
   /**

package/src/clients/mocks/MockHubPoolClient.ts

@@ -1,16 +1,17 @@
 import winston from "winston";
 import { Contract } from "ethers";
-import { BigNumber, randomAddress, assign, bnZero } from "../../utils";
-import { L1Token, Log, PendingRootBundle, RealizedLpFee } from "../../interfaces";
+import { BigNumber, randomAddress, assign, bnZero, toAddressType, EvmAddress, Address, isDefined } from "../../utils";
+import { TokenInfo, Log, PendingRootBundle, RealizedLpFee, L1TokenInfo } from "../../interfaces";
 import { AcrossConfigStoreClient as ConfigStoreClient } from "../AcrossConfigStoreClient";
 import { HubPoolClient, HubPoolUpdate, LpFeeRequest } from "../HubPoolClient";
 import { EventManager, EventOverrides, getEventManager } from "./MockEvents";
+import { ZERO_ADDRESS } from "../../constants";
 
 const emptyRootBundle: PendingRootBundle = {
   poolRebalanceRoot: "",
   relayerRefundRoot: "",
   slowRelayRoot: "",
-  proposer: "",
+  proposer: EvmAddress.from(ZERO_ADDRESS),
   unclaimedPoolRebalanceLeafCount: 0,
   challengePeriodEndTimestamp: 0,
   bundleEvaluationBlockNumbers: [],
@@ -22,9 +23,9 @@ export class MockHubPoolClient extends HubPoolClient {
   private realizedLpFeePct: BigNumber = bnZero;
   private realizedLpFeePctOverride = false;
 
-  private l1TokensMock: L1Token[] = []; // L1Tokens and their associated info.
+  private l1TokensMock: L1TokenInfo[] = []; // L1Tokens and their associated info.
 
-  private spokePoolTokens: { [l1Token: string]: { [chainId: number]: string } } = {};
+  private spokePoolTokens: { [l1Token: string]: { [chainId: number]: Address } } = {};
 
   private eventManager: EventManager;
 
@@ -69,7 +70,7 @@ export class MockHubPoolClient extends HubPoolClient {
       [chainId],
       [
         {
-          spokePool: contract,
+          spokePool: toAddressType(contract),
           blockNumber: blockNumber,
           transactionIndex: 0,
           logIndex: 0,
@@ -82,7 +83,7 @@ export class MockHubPoolClient extends HubPoolClient {
     this.latestHeightSearched = blockNumber;
   }
 
-  addL1Token(l1Token: L1Token) {
+  addL1Token(l1Token: TokenInfo) {
     this.l1TokensMock.push(l1Token);
   }
 
@@ -92,19 +93,19 @@ export class MockHubPoolClient extends HubPoolClient {
 
   setTokenMapping(l1Token: string, chainId: number, l2Token: string) {
     this.spokePoolTokens[l1Token] ??= {};
-    this.spokePoolTokens[l1Token][chainId] = l2Token;
+    this.spokePoolTokens[l1Token][chainId] = toAddressType(l2Token);
   }
 
-  l2TokenEnabledForL1TokenAtBlock(l1Token: string, destinationChainId: number, hubBlockNumber: number): boolean {
-    if (this.spokePoolTokens[l1Token]?.[destinationChainId]) {
+  l2TokenEnabledForL1TokenAtBlock(l1Token: EvmAddress, destinationChainId: number, hubBlockNumber: number): boolean {
+    if (this.spokePoolTokens[l1Token.toEvmAddress()]?.[destinationChainId]) {
       return true;
     } else {
       return super.l2TokenEnabledForL1TokenAtBlock(l1Token, destinationChainId, hubBlockNumber);
     }
   }
-  l2TokenHasPoolRebalanceRoute(l2Token: string, chainId: number, hubPoolBlock: number): boolean {
+  l2TokenHasPoolRebalanceRoute(l2Token: Address, chainId: number, hubPoolBlock: number): boolean {
     const l1Token = Object.keys(this.spokePoolTokens).find(
-      (l1Token) => this.spokePoolTokens[l1Token]?.[chainId] === l2Token
+      (l1Token) => this.spokePoolTokens[l1Token]?.[chainId]?.eq(l2Token)
     );
     if (!l1Token) {
       return super.l2TokenHasPoolRebalanceRoute(l2Token, chainId, hubPoolBlock);
@@ -115,20 +116,24 @@ export class MockHubPoolClient extends HubPoolClient {
     delete this.spokePoolTokens[l1Token]?.[chainId];
   }
 
-  getL1TokenForL2TokenAtBlock(l2Token: string, chainId: number, blockNumber: number): string {
+  getL1TokenForL2TokenAtBlock(l2Token: Address, chainId: number, blockNumber: number): EvmAddress {
     const l1Token = Object.keys(this.spokePoolTokens).find(
-      (l1Token) => this.spokePoolTokens[l1Token]?.[chainId] === l2Token
+      (l1Token) => this.spokePoolTokens[l1Token]?.[chainId].eq(l2Token)
     );
-    return l1Token ?? super.getL1TokenForL2TokenAtBlock(l2Token, chainId, blockNumber);
+    if (isDefined(l1Token)) {
+      return EvmAddress.from(l1Token);
+    } else {
+      return super.getL1TokenForL2TokenAtBlock(l2Token, chainId, blockNumber);
+    }
   }
 
-  getL2TokenForL1TokenAtBlock(l1Token: string, chainId: number, blockNumber: number): string {
-    const l2Token = this.spokePoolTokens[l1Token]?.[chainId];
+  getL2TokenForL1TokenAtBlock(l1Token: EvmAddress, chainId: number, blockNumber: number): Address {
+    const l2Token = this.spokePoolTokens[l1Token.toEvmAddress()]?.[chainId];
     return l2Token ?? super.getL2TokenForL1TokenAtBlock(l1Token, chainId, blockNumber);
   }
 
-  getTokenInfoForL1Token(l1Token: string): L1Token | undefined {
-    return this.l1TokensMock.find((token) => token.address === l1Token);
+  getTokenInfoForL1Token(l1Token: EvmAddress): TokenInfo | undefined {
+    return this.l1TokensMock.find((token) => token.address.eq(l1Token));
   }
 
   _update(eventNames: string[]): Promise<HubPoolUpdate> {