@across-protocol/sdk 4.1.46 → 4.1.47-beta.0

package/src/clients/HubPoolClient.ts

@@ -907,11 +907,13 @@ export class HubPoolClient extends BaseAbstractClient {
     if (eventsToQuery.includes("CrossChainContractsSet")) {
       for (const event of events["CrossChainContractsSet"]) {
         const args = spreadEventWithBlockNumber(event) as CrossChainContractsSet;
-        const dataToAdd = {
+        const dataToAdd: CrossChainContractsSet = {
           spokePool: args.spokePool,
           blockNumber: args.blockNumber,
-          transactionIndex: args.transactionIndex,
+          txnRef: args.txnRef,
           logIndex: args.logIndex,
+          txnIndex: args.txnIndex,
+          l2ChainId: args.l2ChainId,
         };
         // If the chain is SVM then our `args.spokePool` will be set to the `solanaSpokePool.toAddressUnchecked()` in the
         // hubpool event because our hub deals with `address` types and not byte32. Therefore, we should confirm that the
@@ -969,9 +971,9 @@ export class HubPoolClient extends BaseAbstractClient {
                 l1Token: args.l1Token,
                 l2Token: destinationToken,
                 blockNumber: args.blockNumber,
-                transactionIndex: args.transactionIndex,
+                txnIndex: args.txnIndex,
                 logIndex: args.logIndex,
-                transactionHash: args.transactionHash,
+                txnRef: args.txnRef,
               },
             ]
           );
@@ -1017,12 +1019,7 @@ export class HubPoolClient extends BaseAbstractClient {
       this.proposedRootBundles.push(
         ...events["ProposeRootBundle"]
           .filter((event) => !this.configOverride.ignoredHubProposedBundles.includes(event.blockNumber))
-          .map((event) => {
-            return {
-              ...spreadEventWithBlockNumber(event),
-              transactionHash: event.transactionHash,
-            } as ProposedRootBundle;
-          })
+          .map((event) => spreadEventWithBlockNumber(event) as ProposedRootBundle)
       );
     }
 

package/src/clients/SpokePoolClient/EVMSpokePoolClient.ts

@@ -19,6 +19,7 @@ import {
 } from "../../utils";
 import {
   EventSearchConfig,
+  logToSortableEvent,
   paginatedEventQuery,
   sortEventsAscendingInPlace,
   spreadEventWithBlockNumber,
@@ -127,7 +128,7 @@ export class EVMSpokePoolClient extends SpokePoolClient {
     }
 
     // Sort all events to ensure they are stored in a consistent order.
-    events.forEach((events) => sortEventsAscendingInPlace(events));
+    events.forEach((events) => sortEventsAscendingInPlace(events.map(logToSortableEvent)));
 
     return {
       success: true,

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -401,7 +401,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
 
     // Log any invalid deposits with same deposit id but different params.
     const invalidFillsForDeposit = invalidFills.filter((x) => {
-      const txnUid = `${x.transactionHash}:${x.logIndex}`;
+      const txnUid = `${x.txnRef}:${x.logIndex}`;
       // if txnUid doesn't exist in the invalidFills set, add it now, but log the corresponding fill.
       const newInvalidFill = x.depositId.eq(deposit.depositId) && !this.invalidFills.has(txnUid);
       if (newInvalidFill) {

package/src/clients/mocks/MockConfigStoreClient.ts

@@ -2,7 +2,14 @@ import assert from "assert";
 import winston from "winston";
 import { Contract, ethers } from "ethers";
 import { Log } from "../../interfaces";
-import { getCurrentTime, EventSearchConfig, MakeOptional, isDefined, utf8ToHex } from "../../utils";
+import {
+  getCurrentTime,
+  EventSearchConfig,
+  MakeOptional,
+  isDefined,
+  utf8ToHex,
+  spreadEventWithBlockNumber,
+} from "../../utils";
 import {
   AcrossConfigStoreClient,
   ConfigStoreUpdate,
@@ -92,9 +99,9 @@ export class MockConfigStoreClient extends AcrossConfigStoreClient {
       chainId: this.chainId as number,
       searchEndBlock: this.eventSearchConfig.toBlock || latestBlockSearched,
       events: {
-        updatedGlobalConfigEvents: events["UpdatedGlobalConfig"],
+        updatedGlobalConfigEvents: events["UpdatedGlobalConfig"].map(spreadEventWithBlockNumber),
         globalConfigUpdateTimes,
-        updatedTokenConfigEvents: events["UpdatedTokenConfig"],
+        updatedTokenConfigEvents: events["UpdatedTokenConfig"].map(spreadEventWithBlockNumber),
       },
     });
   }

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -129,7 +129,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
   }
 
   protected _deposit(event: string, deposit: Omit<Deposit, "messageHash"> & Partial<SortableEvent>): Log {
-    const { blockNumber, transactionIndex } = deposit;
+    const { blockNumber, txnIndex } = deposit;
     let { depositId, destinationChainId, inputAmount, outputAmount } = deposit;
     depositId ??= this.numberOfDeposits;
     this.numberOfDeposits = depositId.add(bnOne);
@@ -171,7 +171,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       topics: topics.map((topic) => topic.toString()),
       args,
       blockNumber,
-      transactionIndex,
+      transactionIndex: txnIndex,
     });
   }
 
@@ -187,7 +187,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     event: string,
     fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>
   ): Log {
-    const { blockNumber, transactionIndex } = fill;
+    const { blockNumber, txnIndex } = fill;
     let { originChainId, depositId, inputAmount, outputAmount, fillDeadline } = fill;
     originChainId ??= random(1, 42161, false);
     depositId ??= BigNumber.from(random(1, 100_000, false));
@@ -260,7 +260,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       topics: topics.map((topic) => topic.toString()),
       args,
       blockNumber,
-      transactionIndex,
+      transactionIndex: txnIndex,
     });
   }
 
@@ -335,7 +335,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
         exclusiveRelayer: addressModifier(args.exclusiveRelayer ?? ZERO_ADDRESS),
       },
       blockNumber: request.blockNumber,
-      transactionIndex: request.transactionIndex,
+      transactionIndex: request.txnIndex,
     });
   }
 

package/src/interfaces/Common.ts

@@ -9,9 +9,9 @@ export type Log = _Log & {
 
 export interface SortableEvent {
   blockNumber: number;
-  transactionIndex: number;
+  txnIndex: number;
   logIndex: number;
-  transactionHash: string;
+  txnRef: string;
 }
 
 export interface BigNumberForToken {

package/src/utils/EventUtils.ts

@@ -204,13 +204,19 @@ export function getPaginatedBlockRanges({
   return ranges;
 }
 
+export function logToSortableEvent(log: Log): SortableEvent {
+  return {
+    txnIndex: log.transactionIndex,
+    txnRef: log.transactionHash,
+    logIndex: log.logIndex,
+    blockNumber: log.blockNumber,
+  };
+}
+
 export function spreadEventWithBlockNumber(event: Log): SortableEvent {
   return {
     ...spreadEvent(event.args),
-    blockNumber: event.blockNumber,
-    transactionIndex: event.transactionIndex,
-    logIndex: event.logIndex,
-    transactionHash: event.transactionHash,
+    ...logToSortableEvent(event),
   };
 }
 
@@ -226,8 +232,8 @@ export function sortEventsAscendingInPlace<T extends SortableEvent>(events: T[])
     if (ex.blockNumber !== ey.blockNumber) {
       return ex.blockNumber - ey.blockNumber;
     }
-    if (ex.transactionIndex !== ey.transactionIndex) {
-      return ex.transactionIndex - ey.transactionIndex;
+    if (ex.txnIndex !== ey.txnIndex) {
+      return ex.txnIndex - ey.txnIndex;
     }
     return ex.logIndex - ey.logIndex;
   });
@@ -245,8 +251,8 @@ export function sortEventsDescendingInPlace<T extends SortableEvent>(events: T[]
     if (ex.blockNumber !== ey.blockNumber) {
       return ey.blockNumber - ex.blockNumber;
     }
-    if (ex.transactionIndex !== ey.transactionIndex) {
-      return ey.transactionIndex - ex.transactionIndex;
+    if (ex.txnIndex !== ey.txnIndex) {
+      return ey.txnIndex - ex.txnIndex;
     }
     return ey.logIndex - ex.logIndex;
   });
@@ -257,16 +263,16 @@ export function isEventOlder<T extends SortableEvent>(ex: T, ey: T): boolean {
   if (ex.blockNumber !== ey.blockNumber) {
     return ex.blockNumber < ey.blockNumber;
   }
-  if (ex.transactionIndex !== ey.transactionIndex) {
-    return ex.transactionIndex < ey.transactionIndex;
+  if (ex.txnIndex !== ey.txnIndex) {
+    return ex.txnIndex < ey.txnIndex;
   }
   return ex.logIndex < ey.logIndex;
 }
 
-export function getTransactionHashes(events: SortableEvent[]): string[] {
-  return [...Array.from(new Set(events.map((e) => e.transactionHash)))];
+export function getTransactionRefs(events: SortableEvent[]): string[] {
+  return [...Array.from(new Set(events.map((e) => e.txnRef)))];
 }
 
 export function duplicateEvent(a: SortableEvent, b: SortableEvent): boolean {
-  return a.transactionHash === b.transactionHash && a.logIndex === b.logIndex;
+  return a.txnRef === b.txnRef && a.logIndex === b.logIndex;
 }