@across-protocol/sdk 4.1.45-beta.0 → 4.1.45

package/src/clients/BundleDataClient/BundleDataClient.ts

@@ -32,7 +32,6 @@ import {
   forEachAsync,
   getBlockRangeForChain,
   getImpliedBundleBlockRanges,
-  getMessageHash,
   getRelayEventKey,
   isSlowFill,
   mapAsync,
@@ -46,7 +45,6 @@ import {
 } from "../../utils";
 import winston from "winston";
 import {
-  BundleData,
   BundleDataSS,
   getEndBlockBuffers,
   getRefundInformationFromFill,
@@ -58,7 +56,6 @@ import {
   V3FillWithBlock,
   verifyFillRepayment,
 } from "./utils";
-import { UNDEFINED_MESSAGE_HASH } from "../../constants";
 import { isEVMSpokePoolClient } from "../SpokePoolClient";
 
 // max(uint256) - 1
@@ -210,37 +207,6 @@ export class BundleDataClient {
     return `bundles-${BundleDataClient.getArweaveClientKey(blockRangesForChains)}`;
   }
 
-  // Post-populate any missing message hashes.
-  // @todo This can be removed once the legacy types hurdle is cleared (earliest 7 days post migration).
-  backfillMessageHashes(data: Pick<BundleData, "bundleDepositsV3" | "bundleFillsV3">): void {
-    Object.values(data.bundleDepositsV3).forEach((x) =>
-      Object.values(x).forEach((deposits) =>
-        deposits.forEach((deposit) => {
-          if (deposit.messageHash === UNDEFINED_MESSAGE_HASH) {
-            deposit.messageHash = getMessageHash(deposit.message);
-          }
-        })
-      )
-    );
-
-    Object.values(data.bundleFillsV3).forEach((x) =>
-      Object.values(x).forEach(({ fills }) =>
-        fills.forEach((fill) => {
-          if (fill.messageHash === UNDEFINED_MESSAGE_HASH && isDefined(fill.message)) {
-            // If messageHash is undefined, fill should be of type FilledV3Relay and should have a message.
-            fill.messageHash = getMessageHash(fill.message);
-          }
-          if (
-            fill.relayExecutionInfo.updatedMessageHash === UNDEFINED_MESSAGE_HASH &&
-            isDefined(fill.relayExecutionInfo.updatedMessage)
-          ) {
-            fill.relayExecutionInfo.updatedMessageHash = getMessageHash(fill.relayExecutionInfo.updatedMessage);
-          }
-        })
-      )
-    );
-  }
-
   private async loadPersistedDataFromArweave(
     blockRangesForChains: number[][]
   ): Promise<LoadDataReturnValue | undefined> {
@@ -272,9 +238,6 @@ export class BundleDataClient {
       );
 
     const data = persistedData[0].data;
-
-    this.backfillMessageHashes(data);
-
     const bundleData = {
       bundleFillsV3: convertTypedStringRecordIntoNumericRecord(data.bundleFillsV3),
       expiredDepositsToRefundV3: convertTypedStringRecordIntoNumericRecord(data.expiredDepositsToRefundV3),
@@ -359,6 +322,7 @@ export class BundleDataClient {
   // @dev This helper function should probably be moved to the InventoryClient
   async getApproximateRefundsForBlockRange(chainIds: number[], blockRanges: number[][]): Promise<CombinedRefunds> {
     const refundsForChain: CombinedRefunds = {};
+    const bundleEndBlockForMainnet = blockRanges[0][1];
     for (const chainId of chainIds) {
       if (this.spokePoolClients[chainId] === undefined) {
         continue;
@@ -401,7 +365,8 @@ export class BundleDataClient {
           _fill,
           spokeClient.spokePool.provider,
           matchingDeposit,
-          this.clients.hubPoolClient
+          this.clients.hubPoolClient,
+          bundleEndBlockForMainnet
         );
         if (!isDefined(fill)) {
           return;
@@ -410,9 +375,9 @@ export class BundleDataClient {
           {
             ...fill,
             fromLiteChain: matchingDeposit.fromLiteChain,
-            quoteBlockNumber: matchingDeposit.quoteBlockNumber,
           },
-          this.clients.hubPoolClient
+          this.clients.hubPoolClient,
+          bundleEndBlockForMainnet
         );
         // Assume that lp fees are 0 for the sake of speed. In the future we could batch compute
         // these or make hardcoded assumptions based on the origin-repayment chain direction. This might result
@@ -675,6 +640,7 @@ export class BundleDataClient {
     }
 
     const chainIds = this.clients.configStoreClient.getChainIdIndicesForBlock(blockRangesForChains[0][0]);
+    const bundleEndBlockForMainnet = blockRangesForChains[0][1];
 
     if (blockRangesForChains.length > chainIds.length) {
       throw new Error(
@@ -711,7 +677,7 @@ export class BundleDataClient {
           deposit.originChainId,
           deposit.outputToken,
           deposit.destinationChainId,
-          deposit.quoteBlockNumber
+          bundleEndBlockForMainnet
         ) &&
         // Cannot slow fill from or to a lite chain.
         !deposit.fromLiteChain &&
@@ -910,7 +876,8 @@ export class BundleDataClient {
                     fill,
                     destinationClient.spokePool.provider,
                     deposits[0],
-                    this.clients.hubPoolClient
+                    this.clients.hubPoolClient,
+                    bundleEndBlockForMainnet
                   );
                   if (!isDefined(fillToRefund)) {
                     bundleUnrepayableFillsV3.push(fill);
@@ -1014,7 +981,8 @@ export class BundleDataClient {
                   fill,
                   destinationClient.spokePool.provider,
                   matchedDeposit,
-                  this.clients.hubPoolClient
+                  this.clients.hubPoolClient,
+                  bundleEndBlockForMainnet
                 );
                 if (!isDefined(fillToRefund)) {
                   bundleUnrepayableFillsV3.push(fill);
@@ -1194,7 +1162,8 @@ export class BundleDataClient {
                 fill,
                 destinationClient.spokePool.provider,
                 deposits[0],
-                this.clients.hubPoolClient
+                this.clients.hubPoolClient,
+                bundleEndBlockForMainnet
               );
               if (!isDefined(fillToRefund)) {
                 bundleUnrepayableFillsV3.push(fill);
@@ -1250,7 +1219,8 @@ export class BundleDataClient {
               prefill,
               destinationClient.spokePool.provider,
               deposit,
-              this.clients.hubPoolClient
+              this.clients.hubPoolClient,
+              bundleEndBlockForMainnet
             );
             if (!isDefined(verifiedFill)) {
               bundleUnrepayableFillsV3.push(prefill);
@@ -1387,9 +1357,9 @@ export class BundleDataClient {
                 {
                   ...fill,
                   fromLiteChain: matchedDeposit.fromLiteChain,
-                  quoteBlockNumber: matchedDeposit.quoteBlockNumber,
                 },
-                this.clients.hubPoolClient
+                this.clients.hubPoolClient,
+                bundleEndBlockForMainnet
               );
               return {
                 ...fill,
@@ -1434,9 +1404,9 @@ export class BundleDataClient {
         {
           ...fill,
           fromLiteChain: associatedDeposit.fromLiteChain,
-          quoteBlockNumber: associatedDeposit.quoteBlockNumber,
         },
-        this.clients.hubPoolClient
+        this.clients.hubPoolClient,
+        bundleEndBlockForMainnet
       );
       updateBundleFillsV3(bundleFillsV3, fill, realizedLpFeePct, chainToSendRefundTo, repaymentToken, fill.relayer);
     });

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

@@ -233,7 +233,13 @@ export function _buildPoolRebalanceRoot(
         ) {
           return;
         }
-        updateRunningBalanceForDeposit(runningBalances, clients.hubPoolClient, deposit, deposit.inputAmount.mul(-1));
+        updateRunningBalanceForDeposit(
+          runningBalances,
+          clients.hubPoolClient,
+          deposit,
+          deposit.inputAmount.mul(-1),
+          mainnetBundleEndBlock
+        );
       });
     });
   });

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

@@ -9,7 +9,7 @@ import { HubPoolClient } from "../../HubPoolClient";
  * @notice FillRepaymentInformation is a fill with additional properties required to determine where it can
  * be repaid.
  */
-type FillRepaymentInformation = Fill & { quoteBlockNumber: number; fromLiteChain: boolean };
+type FillRepaymentInformation = Fill & { fromLiteChain: boolean };
 
 /**
  * @notice Return repayment chain and repayment token for a fill, but does not verify if the returned
@@ -20,12 +20,13 @@ type FillRepaymentInformation = Fill & { quoteBlockNumber: number; fromLiteChain
  */
 export function getRefundInformationFromFill(
   relayData: FillRepaymentInformation,
-  hubPoolClient: HubPoolClient
+  hubPoolClient: HubPoolClient,
+  bundleEndBlockForMainnet: number
 ): {
   chainToSendRefundTo: number;
   repaymentToken: string;
 } {
-  const chainToSendRefundTo = _getRepaymentChainId(relayData, hubPoolClient);
+  const chainToSendRefundTo = _getRepaymentChainId(relayData, hubPoolClient, bundleEndBlockForMainnet);
   if (chainToSendRefundTo === relayData.originChainId) {
     return {
       chainToSendRefundTo,
@@ -39,13 +40,13 @@ export function getRefundInformationFromFill(
   const l1TokenCounterpart = hubPoolClient.getL1TokenForL2TokenAtBlock(
     relayData.inputToken,
     relayData.originChainId,
-    relayData.quoteBlockNumber
+    bundleEndBlockForMainnet
   );
 
   const repaymentToken = hubPoolClient.getL2TokenForL1TokenAtBlock(
     l1TokenCounterpart,
     chainToSendRefundTo,
-    relayData.quoteBlockNumber
+    bundleEndBlockForMainnet
   );
   return {
     chainToSendRefundTo,
@@ -66,12 +67,12 @@ export async function verifyFillRepayment(
   _fill: FillWithBlock,
   destinationChainProvider: providers.Provider,
   matchedDeposit: DepositWithBlock,
-  hubPoolClient: HubPoolClient
+  hubPoolClient: HubPoolClient,
+  bundleEndBlockForMainnet: number
 ): Promise<FillWithBlock | undefined> {
   const fill = {
     ..._.cloneDeep(_fill),
     fromLiteChain: matchedDeposit.fromLiteChain,
-    quoteBlockNumber: matchedDeposit.quoteBlockNumber,
   };
 
   // Slow fills don't result in repayments so they're always valid.
@@ -79,7 +80,7 @@ export async function verifyFillRepayment(
     return fill;
   }
 
-  let repaymentChainId = _getRepaymentChainId(fill, hubPoolClient);
+  let repaymentChainId = _getRepaymentChainId(fill, hubPoolClient, bundleEndBlockForMainnet);
 
   // Repayments will always go to the fill.relayer address so check if its a valid EVM address. If its not, attempt
   // to change it to the msg.sender of the FilledRelay.
@@ -122,7 +123,11 @@ export async function verifyFillRepayment(
   return fill;
 }
 
-function _getRepaymentChainId(relayData: FillRepaymentInformation, hubPoolClient: HubPoolClient): number {
+function _getRepaymentChainId(
+  relayData: FillRepaymentInformation,
+  hubPoolClient: HubPoolClient,
+  bundleEndBlockForMainnet: number
+): number {
   if (relayData.fromLiteChain) {
     assert(!isSlowFill(relayData), "getRepaymentChainId: fromLiteChain and slow fill are mutually exclusive");
     return relayData.originChainId;
@@ -135,7 +140,7 @@ function _getRepaymentChainId(relayData: FillRepaymentInformation, hubPoolClient
   }
 
   // Repayment chain is valid if the input token and repayment chain are mapped to the same PoolRebalanceRoute.
-  const repaymentTokenIsValid = _repaymentChainTokenIsValid(relayData, hubPoolClient);
+  const repaymentTokenIsValid = _repaymentChainTokenIsValid(relayData, hubPoolClient, bundleEndBlockForMainnet);
   if (repaymentTokenIsValid) {
     return relayData.repaymentChainId;
   }
@@ -144,26 +149,26 @@ function _getRepaymentChainId(relayData: FillRepaymentInformation, hubPoolClient
   return relayData.originChainId;
 }
 
-function _repaymentChainTokenIsValid(relayData: FillRepaymentInformation, hubPoolClient: HubPoolClient): boolean {
+function _repaymentChainTokenIsValid(
+  relayData: FillRepaymentInformation,
+  hubPoolClient: HubPoolClient,
+  bundleEndBlockForMainnet: number
+): boolean {
   if (
-    !hubPoolClient.l2TokenHasPoolRebalanceRoute(
-      relayData.inputToken,
-      relayData.originChainId,
-      relayData.quoteBlockNumber
-    )
+    !hubPoolClient.l2TokenHasPoolRebalanceRoute(relayData.inputToken, relayData.originChainId, bundleEndBlockForMainnet)
   ) {
     return false;
   }
   const l1TokenCounterpart = hubPoolClient.getL1TokenForL2TokenAtBlock(
     relayData.inputToken,
     relayData.originChainId,
-    relayData.quoteBlockNumber
+    bundleEndBlockForMainnet
   );
   if (
     !hubPoolClient.l2TokenEnabledForL1TokenAtBlock(
       l1TokenCounterpart,
       relayData.repaymentChainId,
-      relayData.quoteBlockNumber
+      bundleEndBlockForMainnet
     )
   ) {
     return false;

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

@@ -163,12 +163,13 @@ export function updateRunningBalanceForDeposit(
   runningBalances: RunningBalances,
   hubPoolClient: HubPoolClient,
   deposit: V3DepositWithBlock,
-  updateAmount: BigNumber
+  updateAmount: BigNumber,
+  mainnetBundleEndBlock: number
 ): void {
   const l1TokenCounterpart = hubPoolClient.getL1TokenForL2TokenAtBlock(
     deposit.inputToken,
     deposit.originChainId,
-    deposit.quoteBlockNumber
+    mainnetBundleEndBlock
   );
   updateRunningBalance(runningBalances, deposit.originChainId, l1TokenCounterpart, updateAmount);
 }

package/src/clients/HubPoolClient.ts

@@ -231,36 +231,15 @@ export class HubPoolClient extends BaseAbstractClient {
     return sortEventsDescending(l2Tokens)[0].l1Token;
   }
 
-  /**
-   * Returns the L1 token that should be used for an L2 Bridge event. This function is
-   * designed to be used by the caller to associate the L2 token with its mapped L1 token
-   * at the HubPool equivalent block number of the L2 event.
-   * @param deposit Deposit event
-   * @param returns string L1 token counterpart for Deposit
-   */
-  getL1TokenForDeposit(deposit: Pick<DepositWithBlock, "originChainId" | "inputToken" | "quoteBlockNumber">): string {
+  protected getL1TokenForDeposit(
+    deposit: Pick<DepositWithBlock, "originChainId" | "inputToken" | "quoteBlockNumber">
+  ): string {
     // L1-->L2 token mappings are set via PoolRebalanceRoutes which occur on mainnet,
     // so we use the latest token mapping. This way if a very old deposit is filled, the relayer can use the
     // latest L2 token mapping to find the L1 token counterpart.
     return this.getL1TokenForL2TokenAtBlock(deposit.inputToken, deposit.originChainId, deposit.quoteBlockNumber);
   }
 
-  /**
-   * Returns the L2 token that should be used as a counterpart to a deposit event. For example, the caller
-   * might want to know what the refund token will be on l2ChainId for the deposit event.
-   * @param l2ChainId Chain where caller wants to get L2 token counterpart for
-   * @param event Deposit event
-   * @returns string L2 token counterpart on l2ChainId
-   */
-  getL2TokenForDeposit(
-    deposit: Pick<DepositWithBlock, "originChainId" | "destinationChainId" | "inputToken" | "quoteBlockNumber">,
-    l2ChainId = deposit.destinationChainId
-  ): string {
-    const l1Token = this.getL1TokenForDeposit(deposit);
-    // Use the latest hub block number to find the L2 token counterpart.
-    return this.getL2TokenForL1TokenAtBlock(l1Token, l2ChainId, deposit.quoteBlockNumber);
-  }
-
   l2TokenEnabledForL1Token(l1Token: string, destinationChainId: number): boolean {
     return this.l1TokensToDestinationTokens?.[l1Token]?.[destinationChainId] != undefined;
   }

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -369,11 +369,11 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
           const fillRepaymentData = {
             ...fill,
             fromLiteChain: deposit.fromLiteChain,
-            quoteBlockNumber: this.hubPoolClient!.latestBlockSearched,
           };
           const { chainToSendRefundTo: repaymentChainId } = getRefundInformationFromFill(
             fillRepaymentData,
-            this.hubPoolClient!
+            this.hubPoolClient!,
+            this.hubPoolClient!.latestBlockSearched
           );
           // In order to keep this function sync, we can't call verifyFillRepayment so we'll log any fills where
           // the filler-specified repayment chain and repayment address is not a valid repayment upon
@@ -464,7 +464,11 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     ) {
       return false;
     } else {
-      const l1Token = this.hubPoolClient?.getL1TokenForDeposit(deposit);
+      const l1Token = this.hubPoolClient?.getL1TokenForL2TokenAtBlock(
+        deposit.inputToken,
+        deposit.originChainId,
+        deposit.quoteBlockNumber
+      );
       return this.hubPoolClient.l2TokenEnabledForL1TokenAtBlock(
         l1Token,
         deposit.destinationChainId,
@@ -735,8 +739,16 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     if (!this.canResolveZeroAddressOutputToken(deposit)) {
       return ZERO_ADDRESS;
     }
-    // If there is no rate model client return address(0).
-    return this.hubPoolClient?.getL2TokenForDeposit(deposit) ?? ZERO_ADDRESS;
+    // L1 token should be resolved if we get here:
+    const l1Token = this.hubPoolClient!.getL1TokenForL2TokenAtBlock(
+      deposit.inputToken,
+      deposit.originChainId,
+      deposit.quoteBlockNumber
+    )!;
+    return (
+      this.hubPoolClient!.getL2TokenForL1TokenAtBlock(l1Token, deposit.destinationChainId, deposit.quoteBlockNumber) ??
+      ZERO_ADDRESS
+    );
   }
 
   /**