@across-protocol/sdk 4.3.150 → 4.3.152

package/src/clients/SpokePoolClient/SVMSpokePoolClient.ts

@@ -155,11 +155,11 @@ export class SVMSpokePoolClient extends SpokePoolClient {
         );
         return events.map(
           (event): SortableEvent => ({
+            ...unwrapEventData(event.data),
             txnRef: event.signature,
             blockNumber: Number(event.slot),
             txnIndex: 0,
             logIndex: 0,
-            ...(unwrapEventData(event.data) as Record<string, unknown>),
           })
         );
       }),

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -501,7 +501,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
    * @see _update
    */
   public async update(eventsToQuery = this._queryableEventNames()): Promise<void> {
-    const duplicateEvents: SortableEvent[] = [];
+    const duplicateEvents: { incoming: SortableEvent; existing: SortableEvent }[] = [];
     if (this.hubPoolClient !== null && !this.hubPoolClient.isUpdated) {
       throw new Error("HubPoolClient not updated");
     }
@@ -552,8 +552,9 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
         if (this.depositHashes[getRelayEventKey(deposit)] !== undefined) {
           // Sanity check that this event is not a duplicate, even though the relay data hash is a duplicate.
           const allDeposits = this._getDuplicateDeposits(deposit).concat(this.depositHashes[getRelayEventKey(deposit)]);
-          if (allDeposits.some((e) => duplicateEvent(deposit, e))) {
-            duplicateEvents.push(event);
+          const existing = allDeposits.find((e) => duplicateEvent(deposit, e));
+          if (existing !== undefined) {
+            duplicateEvents.push({ incoming: deposit, existing });
             continue;
           }
           assign(this.duplicateDepositHashes, [getRelayEventKey(deposit)], [deposit]);
@@ -650,8 +651,9 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
         const depositHash = getRelayEventKey(slowFillRequest);
 
         // Sanity check that this event is not a duplicate.
-        if (this.slowFillRequests[depositHash] !== undefined) {
-          duplicateEvents.push(slowFillRequest);
+        const existing = this.slowFillRequests[depositHash];
+        if (existing !== undefined) {
+          duplicateEvents.push({ incoming: slowFillRequest, existing });
           continue;
         }
 
@@ -680,9 +682,9 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
       // test that the types are complete. A broader change in strategy for safely unpacking events will be introduced.
       for (const fill of fillEvents) {
         // Sanity check that this event is not a duplicate.
-        const duplicateFill = this.fills[fill.originChainId]?.find((f) => duplicateEvent(fill, f));
-        if (duplicateFill) {
-          duplicateEvents.push(fill);
+        const existing = this.fills[fill.originChainId]?.find((f) => duplicateEvent(fill, f));
+        if (existing !== undefined) {
+          duplicateEvents.push({ incoming: fill, existing });
           continue;
         }
 

package/src/clients/mocks/MockConfigStoreClient.ts

@@ -2,21 +2,15 @@ import assert from "assert";
 import winston from "winston";
 import { Contract, ethers } from "ethers";
 import { Log } from "../../interfaces";
-import {
-  getCurrentTime,
-  EventSearchConfig,
-  MakeOptional,
-  isDefined,
-  utf8ToHex,
-  spreadEventWithBlockNumber,
-} from "../../utils";
+import { getCurrentTime, EventSearchConfig, MakeOptional, utf8ToHex, spreadEventWithBlockNumber } from "../../utils";
 import {
   AcrossConfigStoreClient,
   ConfigStoreUpdate,
   DEFAULT_CONFIG_STORE_VERSION,
   GLOBAL_CONFIG_STORE_KEYS,
 } from "../AcrossConfigStoreClient";
-import { EventManager, EventOverrides, getEventManager } from "./MockEvents";
+import { CHAIN_IDs } from "../../constants";
+import { EventManager, EventOverrides } from "./MockEvents";
 
 export class MockConfigStoreClient extends AcrossConfigStoreClient {
   public configStoreVersion = DEFAULT_CONFIG_STORE_VERSION;
@@ -35,17 +29,21 @@ export class MockConfigStoreClient extends AcrossConfigStoreClient {
     configStore: Contract,
     eventSearchConfig: MakeOptional<EventSearchConfig, "to"> = { from: 0, maxLookBack: 0 },
     configStoreVersion: number,
-    chainId = 1,
+    chainId = CHAIN_IDs.MAINNET,
     mockUpdate = false,
-    availableChainIdsOverride?: number[]
+    availableChainIdsOverride?: number[],
+    opts: { eventManager?: EventManager } = {}
   ) {
     super(logger, configStore, eventSearchConfig, configStoreVersion);
     this.chainId = chainId;
-    this.eventManager = mockUpdate ? getEventManager(chainId, this.eventSignatures) : null;
-    if (isDefined(this.eventManager) && this.eventManager) {
+    if (mockUpdate) {
+      this.eventManager = opts.eventManager ?? new EventManager();
+      this.eventManager.addEventSignatures(this.eventSignatures);
       this.updateGlobalConfig(GLOBAL_CONFIG_STORE_KEYS.CHAIN_ID_INDICES, JSON.stringify(availableChainIdsOverride), {
         blockNumber: this.eventManager.blockNumber,
       });
+    } else {
+      this.eventManager = null;
     }
   }
 

package/src/clients/mocks/MockEvents.ts

@@ -20,8 +20,6 @@ type EthersEventTemplate = {
   transactionIndex?: number;
 };
 
-const eventManagers: { [chainId: number]: EventManager } = {};
-
 export class EventManager {
   private logIndexes: Record<string, number> = {};
   public events: Log[] = [];
@@ -49,6 +47,14 @@ export class EventManager {
     return events;
   }
 
+  // Reset internal state. Useful when a long-lived EventManager instance is
+  // reused across test contexts that begin at different block numbers.
+  reset(blockNumber = 0): void {
+    this.blockNumber = blockNumber;
+    this.logIndexes = {};
+    this.events = [];
+  }
+
   generateEvent(inputs: EthersEventTemplate): Log {
     const { address, event, topics, data, args } = inputs;
     let { blockNumber, transactionIndex } = inputs;
@@ -82,25 +88,3 @@ export class EventManager {
     return generatedEvent;
   }
 }
-
-/**
- * @description Retrieve an instance of the EventManager for a specific chain, or instantiate a new one.
- * @param chainId Chain ID to retrieve EventManager for.
- * @param eventSignatures Event Signatures to append to EventManager instance.
- * @param Initial blockNumber to use if a new EventManager is instantiated.
- * @returns EventManager instance for chain ID.
- */
-export function getEventManager(
-  chainId: number,
-  eventSignatures?: Record<string, string>,
-  blockNumber?: number
-): EventManager {
-  if (!isDefined(eventManagers[chainId])) {
-    eventManagers[chainId] = new EventManager(blockNumber);
-  }
-  const eventManager = eventManagers[chainId];
-  if (isDefined(eventSignatures)) {
-    eventManager.addEventSignatures(eventSignatures);
-  }
-  return eventManager;
-}

package/src/clients/mocks/MockHubPoolClient.ts

@@ -4,8 +4,8 @@ import { BigNumber, randomAddress, assign, bnZero, toAddressType, EvmAddress, Ad
 import { 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";
+import { EventManager, EventOverrides } from "./MockEvents";
+import { CHAIN_IDs, ZERO_ADDRESS } from "../../constants";
 
 const emptyRootBundle: PendingRootBundle = {
   poolRebalanceRoot: "",
@@ -34,10 +34,12 @@ export class MockHubPoolClient extends HubPoolClient {
     hubPool: Contract,
     configStoreClient: ConfigStoreClient,
     deploymentBlock = 0,
-    chainId = 1
+    chainId = CHAIN_IDs.MAINNET,
+    opts: { eventManager?: EventManager } = {}
   ) {
     super(logger, hubPool, configStoreClient, deploymentBlock, chainId);
-    this.eventManager = getEventManager(chainId, this.eventSignatures, deploymentBlock);
+    this.eventManager = opts.eventManager ?? new EventManager(deploymentBlock);
+    this.eventManager.addEventSignatures(this.eventSignatures);
   }
 
   setDefaultRealizedLpFeePct(fee: BigNumber): void {

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -33,7 +33,7 @@ import {
 } from "../../utils";
 import { EVMSpokePoolClient, SpokePoolUpdate } from "../SpokePoolClient";
 import { HubPoolClient } from "../HubPoolClient";
-import { EventManager, EventOverrides, getEventManager } from "./MockEvents";
+import { EventManager, EventOverrides } from "./MockEvents";
 import { AcrossConfigStoreClient } from "../AcrossConfigStoreClient";
 
 // This class replaces internal SpokePoolClient functionality, enabling
@@ -50,11 +50,12 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     spokePool: Contract,
     chainId: number,
     deploymentBlock: number,
-    opts: { hubPoolClient: HubPoolClient | null } = { hubPoolClient: null }
+    opts: { hubPoolClient?: HubPoolClient | null; eventManager?: EventManager } = {}
   ) {
-    super(logger, spokePool, opts.hubPoolClient, chainId, deploymentBlock);
+    super(logger, spokePool, opts.hubPoolClient ?? null, chainId, deploymentBlock);
     this.latestHeightSearched = deploymentBlock;
-    this.eventManager = getEventManager(chainId, this.eventSignatures, deploymentBlock);
+    this.eventManager = opts.eventManager ?? new EventManager(deploymentBlock);
+    this.eventManager.addEventSignatures(this.eventSignatures);
   }
 
   setConfigStoreClient(configStore?: AcrossConfigStoreClient): void {

package/src/clients/mocks/MockSvmSpokePoolClient.ts

@@ -75,11 +75,11 @@ export class MockSvmSpokePoolClient extends SVMSpokePoolClient {
     const eventsWithBlockNumber = events.map((eventList) =>
       eventList.map((event) => {
         return {
+          ...unwrapEventData(event.data),
           txnRef: event.signature,
           blockNumber: Number(event.slot),
           txnIndex: 0,
           logIndex: 0,
-          ...(unwrapEventData(event.data) as Record<string, unknown>),
         };
       })
     );

package/src/clients/mocks/index.ts

@@ -1,4 +1,5 @@
 export * from "./MockConfigStoreClient";
+export * from "./MockEvents";
 export * from "./MockHubPoolClient";
 export * from "./MockSpokePoolClient";
 export * from "./MockSvmCpiEventsClient";

package/src/utils/SpokeUtils.ts

@@ -113,6 +113,27 @@ export function unpackFillEvent(rawEvent: SortableEvent, destinationChainId: num
   } satisfies FillWithBlock;
 }
 
+const RELAYDATA_ABI = [
+  {
+    type: "tuple",
+    components: [
+      { type: "bytes32", name: "depositor" },
+      { type: "bytes32", name: "recipient" },
+      { type: "bytes32", name: "exclusiveRelayer" },
+      { type: "bytes32", name: "inputToken" },
+      { type: "bytes32", name: "outputToken" },
+      { type: "uint256", name: "inputAmount" },
+      { type: "uint256", name: "outputAmount" },
+      { type: "uint256", name: "originChainId" },
+      { type: "uint256", name: "depositId" },
+      { type: "uint32", name: "fillDeadline" },
+      { type: "uint32", name: "exclusivityDeadline" },
+      { type: "bytes", name: "message" },
+    ],
+  },
+  { type: "uint256", name: "destinationChainId" },
+];
+
 /**
  * Compute the RelayData hash for a fill. This can be used to determine the fill status.
  * @param relayData RelayData information that is used to complete a fill.
@@ -120,26 +141,10 @@ export function unpackFillEvent(rawEvent: SortableEvent, destinationChainId: num
  * @returns The corresponding RelayData hash.
  */
 export function getRelayDataHash(relayData: RelayData, destinationChainId: number): string {
-  const abi = [
-    {
-      type: "tuple",
-      components: [
-        { type: "bytes32", name: "depositor" },
-        { type: "bytes32", name: "recipient" },
-        { type: "bytes32", name: "exclusiveRelayer" },
-        { type: "bytes32", name: "inputToken" },
-        { type: "bytes32", name: "outputToken" },
-        { type: "uint256", name: "inputAmount" },
-        { type: "uint256", name: "outputAmount" },
-        { type: "uint256", name: "originChainId" },
-        { type: "uint256", name: "depositId" },
-        { type: "uint32", name: "fillDeadline" },
-        { type: "uint32", name: "exclusivityDeadline" },
-        { type: "bytes", name: "message" },
-      ],
-    },
-    { type: "uint256", name: "destinationChainId" },
-  ];
+  if (chainIsSvm(destinationChainId)) {
+    const messageHash = getMessageHash(relayData.message);
+    return svm.getRelayDataHash({ ...relayData, messageHash }, destinationChainId);
+  }
 
   const _relayData = {
     ...relayData,
@@ -149,11 +154,7 @@ export function getRelayDataHash(relayData: RelayData, destinationChainId: numbe
     outputToken: relayData.outputToken.toBytes32(),
     exclusiveRelayer: relayData.exclusiveRelayer.toBytes32(),
   };
-  if (chainIsSvm(destinationChainId)) {
-    const messageHash = getMessageHash(relayData.message);
-    return svm.getRelayDataHash({ ...relayData, messageHash }, destinationChainId);
-  }
-  return keccak256(encodeAbiParameters(abi, [_relayData, destinationChainId]));
+  return keccak256(encodeAbiParameters(RELAYDATA_ABI, [_relayData, destinationChainId]));
 }
 
 export function getRelayHashFromEvent(e: RelayData & { destinationChainId: number }): string {