@across-protocol/sdk 4.2.16 → 4.3.1

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

@@ -1,5 +1,5 @@
 // Create a combined `refunds` object containing refunds for V2 + V3 fills
-
+import assert from "assert";
 import {
   BundleDepositsV3,
   BundleExcessSlowFills,
@@ -17,6 +17,7 @@ import {
   fixedPointAdjustment,
   count2DDictionaryValues,
   count3DDictionaryValues,
+  toAddressType,
 } from "../../../utils";
 import {
   addLastRunningBalance,
@@ -65,10 +66,10 @@ export function getRefundsFromBundle(
     Object.entries(depositsForChain).forEach(([l2TokenAddress, deposits]) => {
       deposits.forEach((deposit) => {
         if (combinedRefunds[originChainId][l2TokenAddress] === undefined) {
-          combinedRefunds[originChainId][l2TokenAddress] = { [deposit.depositor]: deposit.inputAmount };
+          combinedRefunds[originChainId][l2TokenAddress] = { [deposit.depositor.toBytes32()]: deposit.inputAmount };
         } else {
-          const existingRefundAmount = combinedRefunds[originChainId][l2TokenAddress][deposit.depositor];
-          combinedRefunds[originChainId][l2TokenAddress][deposit.depositor] = deposit.inputAmount.add(
+          const existingRefundAmount = combinedRefunds[originChainId][l2TokenAddress][deposit.depositor.toBytes32()];
+          combinedRefunds[originChainId][l2TokenAddress][deposit.depositor.toBytes32()] = deposit.inputAmount.add(
             existingRefundAmount ?? bnZero
           );
         }
@@ -153,19 +154,25 @@ export function _buildPoolRebalanceRoot(
         // If the repayment token and repayment chain ID do not map to a PoolRebalanceRoute graph, then
         // there are no relevant L1 running balances.
         if (
-          !clients.hubPoolClient.l2TokenHasPoolRebalanceRoute(l2TokenAddress, repaymentChainId, mainnetBundleEndBlock)
+          !clients.hubPoolClient.l2TokenHasPoolRebalanceRoute(
+            toAddressType(l2TokenAddress, repaymentChainId),
+            repaymentChainId,
+            mainnetBundleEndBlock
+          )
         ) {
           chainWithRefundsOnly.add(repaymentChainId);
           return;
         }
-        const l1TokenCounterpart = clients.hubPoolClient.getL1TokenForL2TokenAtBlock(
-          l2TokenAddress,
+        const l1Token = clients.hubPoolClient.getL1TokenForL2TokenAtBlock(
+          toAddressType(l2TokenAddress, repaymentChainId),
           repaymentChainId,
           mainnetBundleEndBlock
         );
+        const l1TokenAddr = l1Token.toNative();
+        assert(l1Token.isEVM(), `Expected an EVM address: ${l1TokenAddr}`);
 
-        updateRunningBalance(runningBalances, repaymentChainId, l1TokenCounterpart, totalRefundAmount);
-        updateRunningBalance(realizedLpFees, repaymentChainId, l1TokenCounterpart, totalRealizedLpFee);
+        updateRunningBalance(runningBalances, repaymentChainId, l1TokenAddr, totalRefundAmount);
+        updateRunningBalance(realizedLpFees, repaymentChainId, l1TokenAddr, totalRealizedLpFee);
       }
     );
   });
@@ -182,12 +189,17 @@ export function _buildPoolRebalanceRoot(
     Object.entries(depositsForChain).forEach(([outputToken, deposits]) => {
       deposits.forEach((deposit) => {
         const l1TokenCounterpart = clients.hubPoolClient.getL1TokenForL2TokenAtBlock(
-          outputToken,
+          toAddressType(outputToken, destinationChainId),
           destinationChainId,
           mainnetBundleEndBlock
         );
         const lpFee = deposit.lpFeePct.mul(deposit.inputAmount).div(fixedPointAdjustment);
-        updateRunningBalance(runningBalances, destinationChainId, l1TokenCounterpart, deposit.inputAmount.sub(lpFee));
+        updateRunningBalance(
+          runningBalances,
+          destinationChainId,
+          l1TokenCounterpart.toEvmAddress(),
+          deposit.inputAmount.sub(lpFee)
+        );
         // Slow fill LP fees are accounted for when the slow fill executes and a V3FilledRelay is emitted. i.e. when
         // the slow fill execution is included in bundleFillsV3.
       });
@@ -206,12 +218,17 @@ export function _buildPoolRebalanceRoot(
     Object.entries(slowFilledDepositsForChain).forEach(([outputToken, slowFilledDeposits]) => {
       slowFilledDeposits.forEach((deposit) => {
         const l1TokenCounterpart = clients.hubPoolClient.getL1TokenForL2TokenAtBlock(
-          outputToken,
+          toAddressType(outputToken, destinationChainId),
           destinationChainId,
           mainnetBundleEndBlock
         );
         const lpFee = deposit.lpFeePct.mul(deposit.inputAmount).div(fixedPointAdjustment);
-        updateRunningBalance(runningBalances, destinationChainId, l1TokenCounterpart, lpFee.sub(deposit.inputAmount));
+        updateRunningBalance(
+          runningBalances,
+          destinationChainId,
+          l1TokenCounterpart.toEvmAddress(),
+          lpFee.sub(deposit.inputAmount)
+        );
         // Slow fills don't add to lpFees, only when the slow fill is executed and a V3FilledRelay is emitted, so
         // we don't need to subtract it here. Moreover, the HubPoole expects bundleLpFees to be > 0.
       });
@@ -271,11 +288,11 @@ export function _buildPoolRebalanceRoot(
           return;
         }
         const l1TokenCounterpart = clients.hubPoolClient.getL1TokenForL2TokenAtBlock(
-          inputToken,
+          toAddressType(inputToken, originChainId),
           originChainId,
           mainnetBundleEndBlock
         );
-        updateRunningBalance(runningBalances, originChainId, l1TokenCounterpart, deposit.inputAmount);
+        updateRunningBalance(runningBalances, originChainId, l1TokenCounterpart.toEvmAddress(), deposit.inputAmount);
       });
     });
   });

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

@@ -2,7 +2,7 @@ import _ from "lodash";
 import assert from "assert";
 import { providers } from "ethers";
 import { DepositWithBlock, Fill, FillWithBlock } from "../../../interfaces";
-import { isSlowFill, isValidEvmAddress, isDefined, chainIsEvm } from "../../../utils";
+import { isSlowFill, isValidEvmAddress, isDefined, chainIsEvm, Address, toAddressType } from "../../../utils";
 import { HubPoolClient } from "../../HubPoolClient";
 import { SVMProvider } from "../../../arch/svm";
 
@@ -25,7 +25,7 @@ export function getRefundInformationFromFill(
   bundleEndBlockForMainnet: number
 ): {
   chainToSendRefundTo: number;
-  repaymentToken: string;
+  repaymentToken: Address;
 } {
   const chainToSendRefundTo = _getRepaymentChainId(relayData, hubPoolClient, bundleEndBlockForMainnet);
   if (chainToSendRefundTo === relayData.originChainId) {
@@ -49,6 +49,7 @@ export function getRefundInformationFromFill(
     chainToSendRefundTo,
     bundleEndBlockForMainnet
   );
+
   return {
     chainToSendRefundTo,
     repaymentToken,
@@ -125,7 +126,11 @@ export async function verifyFillRepayment(
           return undefined;
         }
       }
-      fill.relayer = destinationRelayer;
+      fill.relayer = toAddressType(destinationRelayer, fill.destinationChainId);
+      assert(
+        fill.relayer.isValidOn(fill.destinationChainId),
+        `Cannot re-assign fill to msg.sender: ${destinationRelayer}`
+      );
     } else {
       return undefined;
     }
@@ -196,9 +201,8 @@ function _repaymentAddressNeedsToBeOverwritten(fill: Fill): boolean {
     return false;
   }
 
-  // @todo add Solana logic here:
-  // - i.e. If chainIsSvm && !isValidSvmAddress(fill.relayer) then return false
-  //        If chainIsEvm && !isValidEvmAddress(fill.relayer) then return false
-  //        If chainIsEvm && isValidEvmAddress(fill.relayer) then return true
-  return !isValidEvmAddress(fill.relayer);
+  // @dev If the repayment chain is EVM, the repayment address is valid if the address is 20 bytes.
+  // If the repayment chain is SVM, the repayment address is valid if the address is strictly greater than
+  // 20 bytes.
+  return !fill.relayer.isValidOn(fill.repaymentChainId);
 }

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

@@ -21,6 +21,12 @@ export function buildPoolRebalanceLeafTree(poolRebalanceLeaves: PoolRebalanceLea
   }
 
   const paramType = getParamType("MerkleLibTest", "verifyPoolRebalance", "rebalance");
-  const hashFn = (input: PoolRebalanceLeaf) => utils.keccak256(utils.defaultAbiCoder.encode([paramType], [input]));
+  const hashFn = (input: PoolRebalanceLeaf) => {
+    const ethersLeaf = {
+      ...input,
+      l1Tokens: input.l1Tokens.map((l1Token) => l1Token.toEvmAddress()),
+    };
+    return utils.keccak256(utils.defaultAbiCoder.encode([paramType], [ethersLeaf]));
+  };
   return new MerkleTree<PoolRebalanceLeaf>(poolRebalanceLeaves, hashFn);
 }

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

@@ -1,7 +1,7 @@
 import { MerkleTree } from "@across-protocol/contracts/dist/utils/MerkleTree";
 import { RunningBalances, PoolRebalanceLeaf, Clients, SpokePoolTargetBalance } from "../../../interfaces";
 import { SpokePoolClient } from "../../SpokePoolClient";
-import { BigNumber, bnZero, compareAddresses } from "../../../utils";
+import { BigNumber, bnZero, compareAddresses, EvmAddress } from "../../../utils";
 import { HubPoolClient } from "../../HubPoolClient";
 import { V3DepositWithBlock } from "./shims";
 import { AcrossConfigStoreClient } from "../../AcrossConfigStoreClient";
@@ -151,7 +151,7 @@ export function addLastRunningBalance(
       const { runningBalance } = hubPoolClient.getRunningBalanceBeforeBlockForChain(
         latestMainnetBlock,
         Number(repaymentChainId),
-        l1TokenAddress
+        EvmAddress.from(l1TokenAddress)
       );
       if (!runningBalance.eq(bnZero)) {
         updateRunningBalance(runningBalances, Number(repaymentChainId), l1TokenAddress, runningBalance);
@@ -172,7 +172,7 @@ export function updateRunningBalanceForDeposit(
     deposit.originChainId,
     mainnetBundleEndBlock
   );
-  updateRunningBalance(runningBalances, deposit.originChainId, l1TokenCounterpart, updateAmount);
+  updateRunningBalance(runningBalances, deposit.originChainId, l1TokenCounterpart.toEvmAddress(), updateAmount);
 }
 
 export function constructPoolRebalanceLeaves(
@@ -253,7 +253,7 @@ export function constructPoolRebalanceLeaves(
           runningBalances: leafRunningBalances,
           groupIndex: groupIndexForChainId++,
           leafId: leaves.length,
-          l1Tokens: l1TokensToIncludeInThisLeaf,
+          l1Tokens: l1TokensToIncludeInThisLeaf.map((l1TokenAddr: string) => EvmAddress.from(l1TokenAddr)),
         });
       }
     });

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

@@ -14,8 +14,8 @@ import {
   union,
   type,
 } from "superstruct";
-import { UNDEFINED_MESSAGE_HASH } from "../../../constants";
-import { BigNumber } from "../../../utils";
+import { CHAIN_IDs, UNDEFINED_MESSAGE_HASH } from "../../../constants";
+import { BigNumber, EvmAddress, RawAddress, SvmAddress, toAddressType } from "../../../utils";
 
 const PositiveIntegerStringSS = pattern(string(), /\d+/);
 const Web3AddressSS = pattern(string(), /^0x[a-fA-F0-9]{40}$/);
@@ -31,19 +31,31 @@ const BigNumberType = coerce(instance(BigNumber), union([string(), number()]), (
   }
 });
 
+// Accept any concrete implementation of `Address` (Evm, Svm, or Raw) but avoid using the
+// abstract `Address` class directly to keep TypeScript happy.
+const AddressInstanceSS = union([instance(EvmAddress), instance(SvmAddress), instance(RawAddress)]);
+
+const AddressType = coerce(AddressInstanceSS, string(), (value) => {
+  // Addresses are posted to arweave in their native format (base16 for EVM, base58 for SVM). The chainId for
+  // for the event data is not directly available, so infer it based on the shape of the address. RawAddress
+  // will be instantiated if the address format does not match the expected family.
+  const chainId = value.startsWith("0x") ? CHAIN_IDs.MAINNET : CHAIN_IDs.SOLANA;
+  return toAddressType(value, chainId);
+});
+
 const FillTypeSS = number();
 
 const V3RelayDataSS = {
-  inputToken: string(),
+  inputToken: AddressType,
   inputAmount: BigNumberType,
-  outputToken: string(),
+  outputToken: AddressType,
   outputAmount: BigNumberType,
   fillDeadline: number(),
-  exclusiveRelayer: string(),
+  exclusiveRelayer: AddressType,
   exclusivityDeadline: number(),
   originChainId: number(),
-  depositor: string(),
-  recipient: string(),
+  depositor: AddressType,
+  recipient: AddressType,
   depositId: BigNumberType,
   message: string(),
 };
@@ -67,7 +79,7 @@ const V3DepositSS = {
   quoteTimestamp: number(),
   relayerFeePct: optional(BigNumberType),
   speedUpSignature: optional(string()),
-  updatedRecipient: optional(string()),
+  updatedRecipient: optional(AddressType),
   updatedOutputAmount: optional(BigNumberType),
   updatedMessage: optional(string()),
 };
@@ -88,7 +100,7 @@ const V3DepositWithBlockLpFeeSS = object({
 const V3RelayExecutionEventInfoSS = object({
   updatedOutputAmount: BigNumberType,
   fillType: FillTypeSS,
-  updatedRecipient: string(),
+  updatedRecipient: AddressType,
   updatedMessage: optional(string()),
   updatedMessageHash: defaulted(string(), UNDEFINED_MESSAGE_HASH),
 });
@@ -98,7 +110,7 @@ const V3FillSS = {
   message: optional(string()),
   messageHash: defaulted(string(), UNDEFINED_MESSAGE_HASH),
   destinationChainId: number(),
-  relayer: string(),
+  relayer: AddressType,
   repaymentChainId: number(),
   relayExecutionInfo: V3RelayExecutionEventInfoSS,
   quoteTimestamp: number(),