@across-protocol/sdk 4.0.0-beta.9 → 4.0.1

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

@@ -14,7 +14,6 @@ import {
 import {
   bnZero,
   AnyObject,
-  groupObjectCountsByTwoProps,
   fixedPointAdjustment,
   count2DDictionaryValues,
   count3DDictionaryValues,
@@ -26,7 +25,6 @@ import {
   updateRunningBalance,
   updateRunningBalanceForDeposit,
 } from "./PoolRebalanceUtils";
-import { V3FillWithBlock } from "./shims";
 import { AcrossConfigStoreClient } from "../../AcrossConfigStoreClient";
 import { HubPoolClient } from "../../HubPoolClient";
 import { buildPoolRebalanceLeafTree } from "./MerkleTreeUtils";
@@ -83,7 +81,6 @@ export function getRefundsFromBundle(
 export function prettyPrintV3SpokePoolEvents(
   bundleDepositsV3: BundleDepositsV3,
   bundleFillsV3: BundleFillsV3,
-  bundleInvalidFillsV3: V3FillWithBlock[],
   bundleSlowFillsV3: BundleSlowFills,
   expiredDepositsToRefundV3: ExpiredDepositsToRefundV3,
   unexecutableSlowFills: BundleExcessSlowFills
@@ -94,11 +91,6 @@ export function prettyPrintV3SpokePoolEvents(
     bundleSlowFillsV3: count2DDictionaryValues(bundleSlowFillsV3),
     expiredDepositsToRefundV3: count2DDictionaryValues(expiredDepositsToRefundV3),
     unexecutableSlowFills: count2DDictionaryValues(unexecutableSlowFills),
-    allInvalidFillsInRangeByDestinationChainAndRelayer: groupObjectCountsByTwoProps(
-      bundleInvalidFillsV3,
-      "destinationChainId",
-      (fill) => `${fill.relayer}`
-    ),
   };
 }
 

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

@@ -1,5 +1,7 @@
-import { Fill } from "../../../interfaces";
-import { getBlockRangeForChain, isSlowFill } from "../../../utils";
+import _ from "lodash";
+import { providers } from "ethers";
+import { Deposit, DepositWithBlock, Fill, FillWithBlock } from "../../../interfaces";
+import { getBlockRangeForChain, isSlowFill, chainIsEvm, isValidEvmAddress, isDefined } from "../../../utils";
 import { HubPoolClient } from "../../HubPoolClient";
 
 export function getRefundInformationFromFill(
@@ -44,3 +46,65 @@ export function getRefundInformationFromFill(
     repaymentToken,
   };
 }
+
+export function getRepaymentChainId(fill: Fill, matchedDeposit: Deposit): number {
+  // Lite chain deposits force repayment on origin chain.
+  return matchedDeposit.fromLiteChain ? fill.originChainId : fill.repaymentChainId;
+}
+
+export function isEvmRepaymentValid(
+  fill: Fill,
+  repaymentChainId: number,
+  possibleRepaymentChainIds: number[] = []
+): boolean {
+  // Slow fills don't result in repayments so they're always valid.
+  if (isSlowFill(fill)) {
+    return true;
+  }
+  // Return undefined if the requested repayment chain ID is not in a passed in set of eligible chains. This can
+  // be used by the caller to narrow the chains to those that are not disabled in the config store.
+  if (possibleRepaymentChainIds.length > 0 && !possibleRepaymentChainIds.includes(repaymentChainId)) {
+    return false;
+  }
+  return chainIsEvm(repaymentChainId) && isValidEvmAddress(fill.relayer);
+}
+
+// Verify that a fill sent to an EVM chain has a 20 byte address. If the fill does not, then attempt
+// to repay the `msg.sender` of the relay transaction. Otherwise, return undefined.
+export async function verifyFillRepayment(
+  _fill: FillWithBlock,
+  destinationChainProvider: providers.Provider,
+  matchedDeposit: DepositWithBlock,
+  possibleRepaymentChainIds: number[] = []
+): Promise<FillWithBlock | undefined> {
+  const fill = _.cloneDeep(_fill);
+
+  const repaymentChainId = getRepaymentChainId(fill, matchedDeposit);
+  const validEvmRepayment = isEvmRepaymentValid(fill, repaymentChainId, possibleRepaymentChainIds);
+
+  // Case 1: Repayment chain is EVM and repayment address is valid EVM address.
+  if (validEvmRepayment) {
+    return fill;
+  }
+  // Case 2: Repayment chain is EVM but repayment address is not a valid EVM address. Attempt to switch repayment
+  // address to msg.sender of relay transaction.
+  else if (chainIsEvm(repaymentChainId) && !isValidEvmAddress(fill.relayer)) {
+    // 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.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)) {
+      return undefined;
+    }
+    // Otherwise, assume the relayer to be repaid is the msg.sender. We don't need to modify the repayment chain since
+    // the getTransaction() call would only succeed if the fill was sent on an EVM chain and therefore the msg.sender
+    // is a valid EVM address and the repayment chain is an EVM chain.
+    fill.relayer = destinationRelayer;
+    return fill;
+  }
+  // Case 3: Repayment chain is not an EVM chain, must be invalid.
+  else {
+    return undefined;
+  }
+}

package/src/clients/SpokePoolClient.ts

@@ -135,6 +135,18 @@ export class SpokePoolClient extends BaseAbstractClient {
     return Object.values(this.depositHashes).filter((deposit) => deposit.destinationChainId === destinationChainId);
   }
 
+  /**
+   * Retrieves a list of duplicate deposits matching the given deposit's deposit hash.
+   * @notice A duplicate is considered any deposit sent after the original deposit with the same deposit hash.
+   * @param deposit The deposit to find duplicates for.
+   * @returns A list of duplicate deposits. Does NOT include the original deposit
+   * unless the original deposit is a duplicate.
+   */
+  private _getDuplicateDeposits(deposit: DepositWithBlock): DepositWithBlock[] {
+    const depositHash = this.getDepositHash(deposit);
+    return this.duplicateDepositHashes[depositHash] ?? [];
+  }
+
   /**
    * Returns a list of all deposits including any duplicate ones. Designed only to be used in use cases where
    * all deposits are required, regardless of duplicates. For example, the Dataworker can use this to refund
@@ -144,9 +156,10 @@ export class SpokePoolClient extends BaseAbstractClient {
    */
   public getDepositsForDestinationChainWithDuplicates(destinationChainId: number): DepositWithBlock[] {
     const deposits = this.getDepositsForDestinationChain(destinationChainId);
-    const duplicateDeposits = Object.values(this.duplicateDepositHashes).filter(
-      (deposits) => deposits.length > 0 && deposits[0].destinationChainId === destinationChainId
-    );
+    const duplicateDeposits = deposits.reduce((acc, deposit) => {
+      const duplicates = this._getDuplicateDeposits(deposit);
+      return acc.concat(duplicates);
+    }, [] as DepositWithBlock[]);
     return sortEventsAscendingInPlace(deposits.concat(duplicateDeposits.flat()));
   }
 

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -13,6 +13,7 @@ import {
   FillWithBlock,
   SlowFillLeaf,
   SpeedUp,
+  TokensBridged,
 } from "../../interfaces";
 import { toBN, toBNWei, getCurrentTime, randomAddress, BigNumber, bnZero, bnOne, bnMax } from "../../utils";
 import { SpokePoolClient, SpokePoolUpdate } from "../SpokePoolClient";
@@ -224,6 +225,19 @@ export class MockSpokePoolClient extends SpokePoolClient {
     });
   }
 
+  setTokensBridged(tokensBridged: TokensBridged): Log {
+    const event = "TokensBridged";
+    const topics = [tokensBridged.chainId, tokensBridged.leafId, tokensBridged.l2TokenAddress];
+    const args = { ...tokensBridged };
+
+    return this.eventManager.generateEvent({
+      event,
+      address: this.spokePool.address,
+      topics: topics.map((topic) => topic.toString()),
+      args,
+    });
+  }
+
   requestV3SlowFill(request: SlowFillRequestWithBlock): Log {
     const event = "RequestedV3SlowFill";
 

package/src/constants.ts

@@ -57,8 +57,6 @@ export const DEFAULT_ARWEAVE_STORAGE_ADDRESS = "Z6hjBM8FHu90lYWB8o5jR1dfX92FlV2W
 
 export const EMPTY_MESSAGE = "0x";
 
-export const EMPTY_MESSAGE_HASH = ethersConstants.HashZero;
-
 export const BRIDGED_USDC_SYMBOLS = [
   TOKEN_SYMBOLS_MAP["USDC.e"].symbol,
   TOKEN_SYMBOLS_MAP.USDbC.symbol,

package/src/providers/index.ts

@@ -5,3 +5,4 @@ export * from "./speedProvider";
 export * from "./constants";
 export * from "./types";
 export * from "./utils";
+export * as mocks from "./mockProvider";

package/src/providers/mockProvider.ts

@@ -0,0 +1,77 @@
+import { BigNumber, providers } from "ethers";
+import { Block, BlockTag, FeeData, TransactionResponse } from "@ethersproject/abstract-provider";
+import { bnZero } from "../utils/BigNumberUtils";
+
+/**
+ * @notice Class used to test GasPriceOracle which makes ethers provider calls to the following implemented
+ * methods.
+ */
+export class MockedProvider extends providers.StaticJsonRpcProvider {
+  private transactions: { [hash: string]: TransactionResponse } = {};
+
+  constructor(
+    readonly stdLastBaseFeePerGas: BigNumber,
+    readonly stdMaxPriorityFeePerGas: BigNumber,
+    readonly defaultChainId = 1
+  ) {
+    super(undefined, defaultChainId);
+  }
+
+  getBlock(_blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<Block> {
+    const mockBlock: Block = {
+      transactions: [],
+      hash: "0x",
+      parentHash: "0x",
+      number: 0,
+      nonce: "0",
+      difficulty: 0,
+      _difficulty: bnZero,
+      timestamp: 0,
+      gasLimit: bnZero,
+      gasUsed: bnZero,
+      baseFeePerGas: this.stdLastBaseFeePerGas,
+      miner: "0x",
+      extraData: "0x",
+    };
+    return Promise.resolve(mockBlock);
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  send(method: string, _params: Array<any>): Promise<any> {
+    switch (method) {
+      case "eth_maxPriorityFeePerGas":
+        return Promise.resolve(this.stdMaxPriorityFeePerGas);
+      default:
+        throw new Error(`MockedProvider#Unimplemented method: ${method}`);
+    }
+  }
+
+  getFeeData(): Promise<FeeData> {
+    return Promise.resolve({
+      lastBaseFeePerGas: this.stdLastBaseFeePerGas,
+      maxPriorityFeePerGas: this.stdMaxPriorityFeePerGas,
+      // Following fields unused in GasPrice oracle
+      maxFeePerGas: null,
+      gasPrice: null,
+    });
+  }
+
+  getTransaction(hash: string): Promise<TransactionResponse> {
+    return Promise.resolve(this.transactions[hash]);
+  }
+
+  getGasPrice(): Promise<BigNumber> {
+    return Promise.resolve(this.stdLastBaseFeePerGas.add(this.stdMaxPriorityFeePerGas));
+  }
+
+  getNetwork(): Promise<{ chainId: number; name: string }> {
+    return Promise.resolve({
+      name: "mocknetwork",
+      chainId: this.defaultChainId,
+    });
+  }
+
+  _setTransaction(hash: string, transaction: TransactionResponse) {
+    this.transactions[hash] = transaction;
+  }
+}

package/src/utils/AddressUtils.ts

@@ -39,6 +39,16 @@ export function compareAddressesSimple(addressA?: string, addressB?: string): bo
   return addressA.toLowerCase() === addressB.toLowerCase();
 }
 
+// Converts an input (assumed to be) bytes32 string into a bytes20 string.
+// If the input is not a bytes32 but is less than type(uint160).max, then this function
+// will still succeed.
+// Throws an error if the string as an unsigned integer is greater than type(uint160).max.
+export function toAddress(hexString: string): string {
+  // rawAddress is the address which is not properly checksummed.
+  const rawAddress = utils.hexZeroPad(utils.hexStripZeros(hexString), 20);
+  return utils.getAddress(rawAddress);
+}
+
 export function isValidEvmAddress(address: string): boolean {
   if (utils.isAddress(address)) {
     return true;

package/src/utils/BlockUtils.ts

@@ -34,6 +34,7 @@ const defaultHighBlockOffset = 10;
 const cacheTTL = 60 * 15;
 const now = getCurrentTime(); // Seed the cache with initial values.
 const blockTimes: { [chainId: number]: BlockTimeAverage } = {
+  [CHAIN_IDs.DOCTOR_WHO]: { average: 1, timestamp: now, blockRange: 1 },
   [CHAIN_IDs.INK]: { average: 1, timestamp: now, blockRange: 1 },
   [CHAIN_IDs.LINEA]: { average: 3, timestamp: now, blockRange: 1 },
   [CHAIN_IDs.MAINNET]: { average: 12.5, timestamp: now, blockRange: 1 },

package/src/utils/DepositUtils.ts

@@ -1,6 +1,6 @@
 import assert from "assert";
 import { SpokePoolClient } from "../clients";
-import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE, EMPTY_MESSAGE_HASH } from "../constants";
+import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE, ZERO_BYTES } from "../constants";
 import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillRequest } from "../interfaces";
 import { getNetworkName } from "./NetworkUtils";
 import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
@@ -160,7 +160,7 @@ export function isMessageEmpty(message = EMPTY_MESSAGE): boolean {
 }
 
 export function isFillOrSlowFillRequestMessageEmpty(message: string): boolean {
-  return isMessageEmpty(message) || message === EMPTY_MESSAGE_HASH;
+  return isMessageEmpty(message) || message === ZERO_BYTES;
 }
 
 /**

package/src/utils/EventUtils.ts

@@ -3,11 +3,27 @@ import { Result } from "@ethersproject/abi";
 import { Contract, Event, EventFilter } from "ethers";
 import { Log, SortableEvent } from "../interfaces";
 import { delay } from "./common";
-import { isDefined, toBN, BigNumberish } from "./";
+import { isDefined, toBN, BigNumberish, toAddress } from "./";
 
 const maxRetries = 3;
 const retrySleepTime = 10;
 
+// Event fields which changed from an `address` to `bytes32` after the SVM contract upgrade.
+const knownExtendedAddressFields = [
+  // TokensBridged
+  "l2TokenAddress",
+  // FundsDeposited/FilledRelay/RequestedSlowFill
+  "inputToken",
+  "outputToken",
+  "depositor",
+  "recipient",
+  "exclusiveRelayer",
+  // FilledRelay
+  "relayer",
+  // RequestedSpeedUpDeposit
+  "updatedRecipient",
+];
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function spreadEvent(args: Result | Record<string, unknown>): { [key: string]: any } {
   const keys = Object.keys(args).filter((key: string) => isNaN(+key)); // Extract non-numeric keys.
@@ -67,6 +83,18 @@ export function spreadEvent(args: Result | Record<string, unknown>): { [key: str
     returnedObject.depositId = toBN(returnedObject.depositId as BigNumberish);
   }
 
+  // Truncate all fields which may be bytes32 into a bytes20 string.
+  for (const field of knownExtendedAddressFields) {
+    if (isDefined(returnedObject[field])) {
+      let address = String(returnedObject[field]);
+      try {
+        address = toAddress(address);
+        // eslint-disable-next-line no-empty
+      } catch (_) {}
+      returnedObject[field] = address;
+    }
+  }
+
   return returnedObject;
 }
 

package/src/utils/NetworkUtils.ts

@@ -142,9 +142,10 @@ export function chainIsEvm(chainId: number): boolean {
 export function chainIsCCTPEnabled(chainId: number): boolean {
   return [
     // Mainnets
+    CHAIN_IDs.ARBITRUM,
     CHAIN_IDs.BASE,
+    CHAIN_IDs.DOCTOR_WHO,
     CHAIN_IDs.OPTIMISM,
-    CHAIN_IDs.ARBITRUM,
     CHAIN_IDs.POLYGON,
     // Testnets
     CHAIN_IDs.BASE_SEPOLIA,

package/src/utils/SpokeUtils.ts

@@ -5,6 +5,8 @@ import { Deposit, Fill, FillStatus, FillWithBlock, RelayData, SlowFillRequest }
 import { SpokePoolClient } from "../clients";
 import { chunk } from "./ArrayUtils";
 import { BigNumber, toBN, bnOne, bnZero } from "./BigNumberUtils";
+import { keccak256 } from "./common";
+import { isMessageEmpty } from "./DepositUtils";
 import { isDefined } from "./TypeGuards";
 import { getNetworkName } from "./NetworkUtils";
 import { paginatedEventQuery, spreadEventWithBlockNumber } from "./EventUtils";
@@ -223,26 +225,34 @@ export async function getDepositIdAtBlock(contract: Contract, blockTag: number):
  * @returns The corresponding RelayData hash.
  */
 export function getRelayDataHash(relayData: RelayData, destinationChainId: number): string {
+  const _relayData = {
+    ...relayData,
+    depositor: ethersUtils.hexZeroPad(relayData.depositor, 32),
+    recipient: ethersUtils.hexZeroPad(relayData.recipient, 32),
+    inputToken: ethersUtils.hexZeroPad(relayData.inputToken, 32),
+    outputToken: ethersUtils.hexZeroPad(relayData.outputToken, 32),
+    exclusiveRelayer: ethersUtils.hexZeroPad(relayData.exclusiveRelayer, 32),
+  };
   return ethersUtils.keccak256(
     ethersUtils.defaultAbiCoder.encode(
       [
         "tuple(" +
-          "address depositor," +
-          "address recipient," +
-          "address exclusiveRelayer," +
-          "address inputToken," +
-          "address outputToken," +
+          "bytes32 depositor," +
+          "bytes32 recipient," +
+          "bytes32 exclusiveRelayer," +
+          "bytes32 inputToken," +
+          "bytes32 outputToken," +
           "uint256 inputAmount," +
           "uint256 outputAmount," +
           "uint256 originChainId," +
-          "uint32 depositId," +
+          "uint256 depositId," +
           "uint32 fillDeadline," +
           "uint32 exclusivityDeadline," +
           "bytes message" +
           ")",
         "uint256 destinationChainId",
       ],
-      [relayData, destinationChainId]
+      [_relayData, destinationChainId]
     )
   );
 }
@@ -412,7 +422,6 @@ export async function findFillEvent(
   // In production the chainId returned from the provider matches 1:1 with the actual chainId. Querying the provider
   // object saves an RPC query becasue the chainId is cached by StaticJsonRpcProvider instances. In hre, the SpokePool
   // may be configured with a different chainId than what is returned by the provider.
-  // @todo Sub out actual chain IDs w/ CHAIN_IDs constants
   const destinationChainId = Object.values(CHAIN_IDs).includes(relayData.originChainId)
     ? (await spokePool.provider.getNetwork()).chainId
     : Number(await spokePool.chainId());
@@ -427,3 +436,7 @@ export async function findFillEvent(
 export function isZeroAddress(address: string): boolean {
   return address === ZERO_ADDRESS || address === ZERO_BYTES;
 }
+
+export function getMessageHash(message: string): string {
+  return isMessageEmpty(message) ? ZERO_BYTES : keccak256(message);
+}

package/src/utils/common.ts

@@ -7,6 +7,8 @@ export type Decimalish = string | number | Decimal;
 export const AddressZero = ethers.constants.AddressZero;
 export const MAX_BIG_INT = BigNumber.from(Number.MAX_SAFE_INTEGER.toString());
 
+export const { keccak256 } = ethers.utils;
+
 /**
  * toBNWei.
  *