@across-protocol/sdk 4.1.46-beta.1 → 4.1.46-beta.3

package/src/clients/AcrossConfigStoreClient/AcrossConfigStoreClient.ts

@@ -24,6 +24,7 @@ import {
   DisabledChainsUpdate,
   GlobalConfigUpdate,
   LiteChainsIdListUpdate,
+  Log,
   ParsedTokenConfig,
   RateModelUpdate,
   RouteRateModelUpdate,
@@ -42,8 +43,8 @@ type ConfigStoreUpdateSuccess = {
   chainId: number;
   searchEndBlock: number;
   events: {
-    updatedTokenConfigEvents: SortableEvent[];
-    updatedGlobalConfigEvents: SortableEvent[];
+    updatedTokenConfigEvents: Log[];
+    updatedGlobalConfigEvents: Log[];
     globalConfigUpdateTimes: number[];
   };
 };
@@ -340,13 +341,8 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
       paginatedEventQuery(this.configStore, this.configStore.filters.UpdatedGlobalConfig(), searchConfig),
     ]);
 
-    const updatedTokenConfigSortableEvents = updatedTokenConfigEvents.map(spreadEventWithBlockNumber);
-    const updatedGlobalConfigSortableEvents = updatedGlobalConfigEvents.map(spreadEventWithBlockNumber);
-
     // Events *should* normally be received in ascending order, but explicitly enforce the ordering.
-    [updatedTokenConfigSortableEvents, updatedGlobalConfigSortableEvents].forEach((events) =>
-      sortEventsAscendingInPlace(events)
-    );
+    [updatedTokenConfigEvents, updatedGlobalConfigEvents].forEach((events) => sortEventsAscendingInPlace(events));
 
     const globalConfigUpdateTimes = (
       await Promise.all(updatedGlobalConfigEvents.map((event) => this.configStore.provider.getBlock(event.blockNumber)))
@@ -357,8 +353,8 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
       chainId,
       searchEndBlock: searchConfig.toBlock,
       events: {
-        updatedTokenConfigEvents: updatedTokenConfigSortableEvents,
-        updatedGlobalConfigEvents: updatedGlobalConfigSortableEvents,
+        updatedTokenConfigEvents,
+        updatedGlobalConfigEvents,
         globalConfigUpdateTimes,
       },
     };
@@ -384,11 +380,13 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
     // Save new TokenConfig updates.
     for (const event of updatedTokenConfigEvents) {
       // If transaction hash is known to be invalid, skip it immediately to avoid creating extra logs.
-      if (KNOWN_INVALID_TOKEN_CONFIG_UPDATE_HASHES.includes(event.txnRef.toLowerCase())) {
+      if (KNOWN_INVALID_TOKEN_CONFIG_UPDATE_HASHES.includes(event.transactionHash.toLowerCase())) {
         continue;
       }
 
-      const args = event as TokenConfig;
+      const args = {
+        ...(spreadEventWithBlockNumber(event) as TokenConfig),
+      };
 
       try {
         const { rateModel, routeRateModel, spokeTargetBalances } = this.validateTokenConfigUpdate(args);
@@ -420,7 +418,7 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
           this.logger.debug({
             at: "ConfigStoreClient::update",
             message: `Skipping invalid historical update at block ${event.blockNumber}`,
-            txnRef: event.txnRef,
+            transactionHash: event.transactionHash,
           });
         }
         continue;
@@ -429,7 +427,7 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
 
     // Save new Global config updates.
     for (let i = 0; i < updatedGlobalConfigEvents.length; i++) {
-      const args = updatedGlobalConfigEvents[i] as SortableEvent & {
+      const args = spreadEventWithBlockNumber(updatedGlobalConfigEvents[i]) as SortableEvent & {
         key: string;
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         value: any;
@@ -564,7 +562,7 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
     rateModel: string | undefined;
     routeRateModel: RouteRateModelUpdate["routeRateModel"];
   } {
-    const { value, key, txnRef } = args;
+    const { value, key, transactionHash } = args;
     const parsedValue = parseJSONWithNumericString(value) as ParsedTokenConfig;
     const l1Token = key;
 
@@ -580,7 +578,7 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
       const rateModel = parsedValue.rateModel;
       assert(
         this.isValidRateModel(rateModel),
-        `Invalid rateModel UBar for ${l1Token} at transaction ${txnRef}, ${JSON.stringify(rateModel)}`
+        `Invalid rateModel UBar for ${l1Token} at transaction ${transactionHash}, ${JSON.stringify(rateModel)}`
       );
       rateModelForToken = JSON.stringify(rateModel);
 
@@ -603,7 +601,7 @@ export class AcrossConfigStoreClient extends BaseAbstractClient {
           Object.entries(parsedValue.routeRateModel).map(([path, routeRateModel]) => {
             assert(
               this.isValidRateModel(routeRateModel) &&
-                `Invalid routeRateModel UBar for ${path} for ${l1Token} at transaction ${txnRef}, ${JSON.stringify(
+                `Invalid routeRateModel UBar for ${path} for ${l1Token} at transaction ${transactionHash}, ${JSON.stringify(
                   routeRateModel
                 )}`
             );

package/src/clients/BundleDataClient/BundleDataClient.ts

@@ -237,115 +237,13 @@ export class BundleDataClient {
         {} as Record<number, Record<string, UnderlyingType>>
       );
 
-    const convertSortableEventFieldsIntoRequiredFields = <
-      T extends {
-        txnIndex?: number;
-        transactionIndex?: number;
-        txnRef?: string;
-        transactionHash?: string;
-      },
-    >(
-      data: T[]
-    ): Array<
-      Omit<T, "txnIndex" | "transactionIndex" | "txnRef" | "transactionHash"> & {
-        txnIndex: number;
-        txnRef: string;
-      }
-    > => {
-      return data.map((item) => {
-        // For txnIndex/transactionIndex: throw if both are defined or both are missing.
-        if (
-          (item.txnIndex !== undefined && item.transactionIndex !== undefined) ||
-          (item.txnIndex === undefined && item.transactionIndex === undefined)
-        ) {
-          throw new Error("Either txnIndex or transactionIndex must be defined, but not both.");
-        }
-
-        // For txnRef/transactionHash: throw if both are defined or both are missing.
-        if (
-          (item.txnRef !== undefined && item.transactionHash !== undefined) ||
-          (item.txnRef === undefined && item.transactionHash === undefined)
-        ) {
-          throw new Error("Either txnRef or transactionHash must be defined, but not both.");
-        }
-
-        // Destructure the fields we don't need anymore
-        const { txnIndex, transactionIndex, txnRef, transactionHash, ...rest } = item;
-
-        // Return a new object with normalized fields.
-        // The non-null assertion (!) is safe here because our conditions ensure that one of each pair is defined.
-        return {
-          ...rest,
-          txnIndex: txnIndex ?? transactionIndex!,
-          txnRef: txnRef ?? transactionHash!,
-        };
-      });
-    };
-
-    const convertEmbeddedSortableEventFieldsIntoRequiredFields = <
-      T extends {
-        txnIndex?: number;
-        transactionIndex?: number;
-        txnRef?: string;
-        transactionHash?: string;
-      },
-    >(
-      data: Record<string, Record<string, T[]>>
-    ) => {
-      return Object.fromEntries(
-        Object.entries(data).map(([chainId, tokenData]) => [
-          chainId,
-          Object.fromEntries(
-            Object.entries(tokenData).map(([token, data]) => [
-              token,
-              convertSortableEventFieldsIntoRequiredFields(data),
-            ])
-          ),
-        ])
-      );
-    };
-
     const data = persistedData[0].data;
-
-    // This section processes and transforms bundle data loaded from Arweave storage into the correct format:
-    // 1. Each field (bundleFillsV3, expiredDepositsToRefundV3, etc.) contains nested records keyed by chainId and token
-    // 2. The chainId keys are converted from strings to numbers using convertTypedStringRecordIntoNumericRecord
-    // 3. For arrays of events (fills, deposits, etc.), the transaction fields are normalized:
-    //    - txnIndex/transactionIndex -> txnIndex
-    //    - txnRef/transactionHash -> txnRef
-    //    This ensures consistent field names across all event objects
-    // 4. The data structure maintains all other fields like refunds, totalRefundAmount, and realizedLpFees
     const bundleData = {
-      bundleFillsV3: convertTypedStringRecordIntoNumericRecord(
-        Object.fromEntries(
-          Object.entries(data.bundleFillsV3).map(([chainId, tokenData]) => [
-            chainId,
-            Object.fromEntries(
-              Object.entries(tokenData).map(([token, data]) => [
-                token,
-                {
-                  refunds: data.refunds,
-                  totalRefundAmount: data.totalRefundAmount,
-                  realizedLpFees: data.realizedLpFees,
-                  fills: convertSortableEventFieldsIntoRequiredFields(data.fills),
-                },
-              ])
-            ),
-          ])
-        )
-      ),
-      expiredDepositsToRefundV3: convertTypedStringRecordIntoNumericRecord(
-        convertEmbeddedSortableEventFieldsIntoRequiredFields(data.expiredDepositsToRefundV3)
-      ),
-      bundleDepositsV3: convertTypedStringRecordIntoNumericRecord(
-        convertEmbeddedSortableEventFieldsIntoRequiredFields(data.bundleDepositsV3)
-      ),
-      unexecutableSlowFills: convertTypedStringRecordIntoNumericRecord(
-        convertEmbeddedSortableEventFieldsIntoRequiredFields(data.unexecutableSlowFills)
-      ),
-      bundleSlowFillsV3: convertTypedStringRecordIntoNumericRecord(
-        convertEmbeddedSortableEventFieldsIntoRequiredFields(data.bundleSlowFillsV3)
-      ),
+      bundleFillsV3: convertTypedStringRecordIntoNumericRecord(data.bundleFillsV3),
+      expiredDepositsToRefundV3: convertTypedStringRecordIntoNumericRecord(data.expiredDepositsToRefundV3),
+      bundleDepositsV3: convertTypedStringRecordIntoNumericRecord(data.bundleDepositsV3),
+      unexecutableSlowFills: convertTypedStringRecordIntoNumericRecord(data.unexecutableSlowFills),
+      bundleSlowFillsV3: convertTypedStringRecordIntoNumericRecord(data.bundleSlowFillsV3),
     };
     this.logger.debug({
       at: "BundleDataClient#loadPersistedDataFromArweave",

package/src/clients/BundleDataClient/utils/FillUtils.ts

@@ -87,7 +87,9 @@ export async function verifyFillRepayment(
   if (_repaymentAddressNeedsToBeOverwritten(fill)) {
     // TODO: Handle case where fill was sent on non-EVM chain, in which case the following call would fail
     // or return something unexpected. We'd want to return undefined here.
-    const fillTransaction = await destinationChainProvider.getTransaction(fill.txnRef);
+
+    // @todo: If chainIsEvm:
+    const fillTransaction = await destinationChainProvider.getTransaction(fill.transactionHash);
     const destinationRelayer = fillTransaction?.from;
     // Repayment chain is still an EVM chain, but the msg.sender is a bytes32 address, so the fill is invalid.
     if (!isDefined(destinationRelayer) || !isValidEvmAddress(destinationRelayer)) {

package/src/clients/BundleDataClient/utils/SuperstructUtils.ts

@@ -48,15 +48,11 @@ const V3RelayDataSS = {
   message: string(),
 };
 
-export const SortableEventSS = {
+const SortableEventSS = {
   blockNumber: number(),
+  transactionIndex: number(),
   logIndex: number(),
-
-  txnRef: optional(string()),
-  txnIndex: optional(number()),
-
-  transactionHash: optional(string()),
-  transactionIndex: optional(number()),
+  transactionHash: string(),
 };
 
 const V3DepositSS = {

package/src/clients/HubPoolClient.ts

@@ -884,13 +884,11 @@ export class HubPoolClient extends BaseAbstractClient {
     if (eventsToQuery.includes("CrossChainContractsSet")) {
       for (const event of events["CrossChainContractsSet"]) {
         const args = spreadEventWithBlockNumber(event) as CrossChainContractsSet;
-        const dataToAdd: CrossChainContractsSet = {
+        const dataToAdd = {
           spokePool: args.spokePool,
           blockNumber: args.blockNumber,
-          txnRef: args.txnRef,
+          transactionIndex: args.transactionIndex,
           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
@@ -948,9 +946,9 @@ export class HubPoolClient extends BaseAbstractClient {
                 l1Token: args.l1Token,
                 l2Token: destinationToken,
                 blockNumber: args.blockNumber,
-                txnIndex: args.txnIndex,
+                transactionIndex: args.transactionIndex,
                 logIndex: args.logIndex,
-                txnRef: args.txnRef,
+                transactionHash: args.transactionHash,
               },
             ]
           );
@@ -996,7 +994,12 @@ export class HubPoolClient extends BaseAbstractClient {
       this.proposedRootBundles.push(
         ...events["ProposeRootBundle"]
           .filter((event) => !this.configOverride.ignoredHubProposedBundles.includes(event.blockNumber))
-          .map((event) => spreadEventWithBlockNumber(event) as ProposedRootBundle)
+          .map((event) => {
+            return {
+              ...spreadEventWithBlockNumber(event),
+              transactionHash: event.transactionHash,
+            } as ProposedRootBundle;
+          })
       );
     }
 

package/src/clients/SpokePoolClient/EVMSpokePoolClient.ts

@@ -19,7 +19,6 @@ import {
 } from "../../utils";
 import {
   EventSearchConfig,
-  logToSortableEvent,
   paginatedEventQuery,
   sortEventsAscendingInPlace,
   spreadEventWithBlockNumber,
@@ -128,7 +127,7 @@ export class EVMSpokePoolClient extends SpokePoolClient {
     }
 
     // Sort all events to ensure they are stored in a consistent order.
-    events.forEach((events) => sortEventsAscendingInPlace(events.map(logToSortableEvent)));
+    events.forEach((events) => sortEventsAscendingInPlace(events));
 
     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.txnRef}:${x.logIndex}`;
+      const txnUid = `${x.transactionHash}:${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,14 +2,7 @@ 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, isDefined, utf8ToHex } from "../../utils";
 import {
   AcrossConfigStoreClient,
   ConfigStoreUpdate,
@@ -99,9 +92,9 @@ export class MockConfigStoreClient extends AcrossConfigStoreClient {
       chainId: this.chainId as number,
       searchEndBlock: this.eventSearchConfig.toBlock || latestBlockSearched,
       events: {
-        updatedGlobalConfigEvents: events["UpdatedGlobalConfig"].map(spreadEventWithBlockNumber),
+        updatedGlobalConfigEvents: events["UpdatedGlobalConfig"],
         globalConfigUpdateTimes,
-        updatedTokenConfigEvents: events["UpdatedTokenConfig"].map(spreadEventWithBlockNumber),
+        updatedTokenConfigEvents: events["UpdatedTokenConfig"],
       },
     });
   }

package/src/clients/mocks/MockHubPoolClient.ts

@@ -23,8 +23,7 @@ export class MockHubPoolClient extends HubPoolClient {
   private realizedLpFeePctOverride = false;
 
   private l1TokensMock: L1Token[] = []; // L1Tokens and their associated info.
-  private tokenInfoToReturn: L1Token = { address: "", decimals: 0, symbol: "" };
-  
+
   private spokePoolTokens: { [l1Token: string]: { [chainId: number]: string } } = {};
 
   private eventManager: EventManager;
@@ -91,10 +90,6 @@ export class MockHubPoolClient extends HubPoolClient {
     return this.l1TokensMock;
   }
 
-  getTokenInfoForAddress() {
-    return this.tokenInfoToReturn;
-  }
-
   setTokenMapping(l1Token: string, chainId: number, l2Token: string) {
     this.spokePoolTokens[l1Token] ??= {};
     this.spokePoolTokens[l1Token][chainId] = l2Token;
@@ -136,10 +131,6 @@ export class MockHubPoolClient extends HubPoolClient {
     return this.l1TokensMock.find((token) => token.address === l1Token);
   }
 
-  setTokenInfoToReturn(tokenInfo: L1Token) {
-    this.tokenInfoToReturn = tokenInfo;
-  }
-
   _update(eventNames: string[]): Promise<HubPoolUpdate> {
     // Generate new "on chain" responses.
     const latestBlockSearched = this.eventManager.blockNumber;

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, txnIndex } = deposit;
+    const { blockNumber, transactionIndex } = 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: txnIndex,
+      transactionIndex,
     });
   }
 
@@ -187,7 +187,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     event: string,
     fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>
   ): Log {
-    const { blockNumber, txnIndex } = fill;
+    const { blockNumber, transactionIndex } = 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: txnIndex,
+      transactionIndex,
     });
   }
 
@@ -335,7 +335,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
         exclusiveRelayer: addressModifier(args.exclusiveRelayer ?? ZERO_ADDRESS),
       },
       blockNumber: request.blockNumber,
-      transactionIndex: request.txnIndex,
+      transactionIndex: request.transactionIndex,
     });
   }
 

package/src/interfaces/Common.ts

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

package/src/utils/EventUtils.ts

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