@across-protocol/sdk 4.0.0-beta.2 → 4.0.0-beta.20

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 { DepositWithBlock, Fill, FillWithBlock } from "../../../interfaces";
+import { getBlockRangeForChain, isSlowFill, chainIsEvm, isValidEvmAddress, isDefined } from "../../../utils";
 import { HubPoolClient } from "../../HubPoolClient";
 
 export function getRefundInformationFromFill(
@@ -44,3 +46,46 @@ export function getRefundInformationFromFill(
     repaymentToken,
   };
 }
+
+// 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> {
+  // Slow fills don't result in repayments so they're always valid.
+  if (isSlowFill(fill)) {
+    return fill;
+  }
+  // Lite chain deposits force repayment on origin chain.
+  const repaymentChainId = matchedDeposit.fromLiteChain ? fill.originChainId : fill.repaymentChainId;
+  // Return undefined if the requested repayment chain ID is not recognized by the hub pool.
+  if (!possibleRepaymentChainIds.includes(repaymentChainId)) {
+    return undefined;
+  }
+  const updatedFill = _.cloneDeep(fill);
+
+  // If the fill requests repayment on a chain where the repayment address is not valid, attempt to find a valid
+  // repayment address, otherwise return undefined.
+
+  // Case 1: repayment chain is an EVM chain but repayment address is not a valid EVM address.
+  if (chainIsEvm(repaymentChainId) && !isValidEvmAddress(updatedFill.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(updatedFill.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.
+    updatedFill.relayer = destinationRelayer;
+  }
+
+  // Case 2: TODO repayment chain is an SVM chain and repayment address is not a valid SVM address.
+  return updatedFill;
+}

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.
+   */
+  public 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()));
   }
 
@@ -331,7 +344,7 @@ export class SpokePoolClient extends BaseAbstractClient {
 
     this.logger.debug({
       at: "SpokePoolClient::getDepositForFill",
-      message: `Rejected fill for ${getNetworkName(fill.originChainId)} deposit ${fill.depositId}.`,
+      message: `Rejected fill for ${getNetworkName(fill.originChainId)} deposit ${fill.depositId.toString()}.`,
       reason: match.reason,
       deposit,
       fill,
@@ -415,7 +428,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    * @note This hash takes the form of: `${depositId}-${originChainId}`.
    */
   public getDepositHash(event: { depositId: BigNumber; originChainId: number }): string {
-    return `${event.depositId}-${event.originChainId}`;
+    return `${event.depositId.toString()}-${event.originChainId}`;
   }
 
   /**
@@ -833,7 +846,7 @@ export class SpokePoolClient extends BaseAbstractClient {
       const srcChain = getNetworkName(this.chainId);
       const dstChain = getNetworkName(destinationChainId);
       throw new Error(
-        `Could not find deposit ${depositId} for ${dstChain} fill` +
+        `Could not find deposit ${depositId.toString()} for ${dstChain} fill` +
           ` between ${srcChain} blocks [${searchBounds.low}, ${searchBounds.high}]`
       );
     }

package/src/constants.ts

@@ -26,9 +26,11 @@ export const SECONDS_PER_YEAR = 31557600; // 365.25 days per year.
  */
 export const HUBPOOL_CHAIN_ID = 1;
 
-// List of versions where certain UMIP features were deprecated
+// List of versions where certain UMIP features were deprecated or activated
 export const TRANSFER_THRESHOLD_MAX_CONFIG_STORE_VERSION = 1;
 
+export const PRE_FILL_MIN_CONFIG_STORE_VERSION = 5;
+
 // A hardcoded identifier used, by default, to tag all Arweave records.
 export const ARWEAVE_TAG_APP_NAME = "across-protocol";
 

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

@@ -38,3 +38,19 @@ export function compareAddressesSimple(addressA?: string, addressB?: string): bo
   }
   return addressA.toLowerCase() === addressB.toLowerCase();
 }
+
+export function isValidEvmAddress(address: string): boolean {
+  if (utils.isAddress(address)) {
+    return true;
+  }
+  // We may throw an error here if hexZeroPadFails. This will happen if the address to pad is greater than 20 bytes long, indicating
+  // that the address had less than 12 leading zero bytes.
+  // We may also throw at getAddress if the input cannot be converted into a checksummed EVM address for some reason.
+  // For both cases, this indicates that the address cannot be casted as a bytes20 EVM address, so we should return false.
+  try {
+    const evmAddress = utils.hexZeroPad(utils.hexStripZeros(address), 20);
+    return utils.isAddress(utils.getAddress(evmAddress));
+  } catch (_e) {
+    return false;
+  }
+}

package/src/utils/CachingUtils.ts

@@ -52,5 +52,5 @@ export async function setDepositInCache(
  */
 export function getDepositKey(bridgeEvent: Deposit | Fill | SlowFillRequest): string {
   const relayHash = getRelayHashFromEvent(bridgeEvent);
-  return `deposit_${bridgeEvent.originChainId}_${bridgeEvent.depositId}_${relayHash}`;
+  return `deposit_${bridgeEvent.originChainId}_${bridgeEvent.depositId.toString()}_${relayHash}`;
 }

package/src/utils/DepositUtils.ts

@@ -5,6 +5,7 @@ import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillReq
 import { getNetworkName } from "./NetworkUtils";
 import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
 import { validateFillForDeposit } from "./FlowUtils";
+import { isUnsafeDepositId } from "./SpokeUtils";
 import { getCurrentTime } from "./TimeUtils";
 import { isDefined } from "./TypeGuards";
 import { isDepositFormedCorrectly } from "./ValidatorUtils";
@@ -17,6 +18,7 @@ export enum InvalidFill {
   DepositIdInvalid = 0, // Deposit ID seems invalid for origin SpokePool
   DepositIdNotFound, // Deposit ID not found (bad RPC data?)
   FillMismatch, // Fill does not match deposit parameters for deposit ID.
+  DepositIdOutOfRange, // Fill is for a deterministic deposit.
 }
 
 export type DepositSearchResult =
@@ -40,6 +42,13 @@ export async function queryHistoricalDepositForFill(
   fill: Fill | SlowFillRequest,
   cache?: CachingMechanismInterface
 ): Promise<DepositSearchResult> {
+  if (isUnsafeDepositId(fill.depositId)) {
+    return {
+      found: false,
+      code: InvalidFill.DepositIdOutOfRange,
+      reason: `Cannot find historical deposit for fill with unsafe deposit ID ${fill.depositId}.`,
+    };
+  }
   if (fill.originChainId !== spokePoolClient.chainId) {
     throw new Error(`OriginChainId mismatch (${fill.originChainId} != ${spokePoolClient.chainId})`);
   }
@@ -56,7 +65,7 @@ export async function queryHistoricalDepositForFill(
     return {
       found: false,
       code: InvalidFill.DepositIdInvalid,
-      reason: `Deposit ID ${depositId} is outside of SpokePool bounds [${lowId},${highId}].`,
+      reason: `Deposit ID ${depositId.toString()} is outside of SpokePool bounds [${lowId},${highId}].`,
     };
   }
 
@@ -73,14 +82,14 @@ export async function queryHistoricalDepositForFill(
       return {
         found: false,
         code: InvalidFill.FillMismatch,
-        reason: `Fill for ${originChain} deposit ID ${depositId} is invalid (${match.reason}).`,
+        reason: `Fill for ${originChain} deposit ID ${depositId.toString()} is invalid (${match.reason}).`,
       };
     }
 
     return {
       found: false,
       code: InvalidFill.DepositIdNotFound,
-      reason: `${originChain} deposit ID ${depositId} not found in SpokePoolClient event buffer.`,
+      reason: `${originChain} deposit ID ${depositId.toString()} not found in SpokePoolClient event buffer.`,
     };
   }
 

package/src/utils/NetworkUtils.ts

@@ -123,6 +123,17 @@ export function chainIsL1(chainId: number): boolean {
   return [CHAIN_IDs.MAINNET, CHAIN_IDs.SEPOLIA].includes(chainId);
 }
 
+/**
+ * Determines whether a chain ID runs on an EVM-like execution layer.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chain corresponding to chainId has an EVM-like execution layer.
+ */
+export function chainIsEvm(chainId: number): boolean {
+  chainId;
+  // TODO: Fix when we support non-EVM chains.
+  return true;
+}
+
 /**
  * Determines whether a chain ID has the capacity for having its USDC bridged via CCTP.
  * @param chainId Chain ID to evaluate.

package/src/utils/SpokeUtils.ts

@@ -154,7 +154,7 @@ export async function getBlockRangeForDepositId(
     //                                     // targetId = 2 <- pass (does not trigger this error)
     //                                     // targetId = 3 <- pass (does not trigger this error)
     throw new Error(
-      `Target depositId is less than the initial low block (${targetDepositId} > ${lowestDepositIdInRange})`
+      `Target depositId is less than the initial low block (${targetDepositId.toString()} > ${lowestDepositIdInRange})`
     );
   }
 
@@ -209,7 +209,7 @@ export async function getBlockRangeForDepositId(
 export async function getDepositIdAtBlock(contract: Contract, blockTag: number): Promise<BigNumber> {
   const _depositIdAtBlock = await contract.numberOfDeposits({ blockTag });
   const depositIdAtBlock = toBN(_depositIdAtBlock);
-  // Sanity check to ensure that the deposit ID is an integer and is greater than or equal to zero.
+  // Sanity check to ensure that the deposit ID is greater than or equal to zero.
   if (depositIdAtBlock.lt(bnZero)) {
     throw new Error("Invalid deposit count");
   }
@@ -281,7 +281,9 @@ export async function relayFillStatus(
 
   if (![FillStatus.Unfilled, FillStatus.RequestedSlowFill, FillStatus.Filled].includes(fillStatus)) {
     const { originChainId, depositId } = relayData;
-    throw new Error(`relayFillStatus: Unexpected fillStatus for ${originChainId} deposit ${depositId} (${fillStatus})`);
+    throw new Error(
+      `relayFillStatus: Unexpected fillStatus for ${originChainId} deposit ${depositId.toString()} (${fillStatus})`
+    );
   }
 
   return fillStatus;
@@ -345,7 +347,6 @@ export async function findFillBlock(
   // 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 provider.getNetwork()).chainId
     : Number(await spokePool.chainId());
@@ -370,7 +371,7 @@ export async function findFillBlock(
   if (initialFillStatus === FillStatus.Filled) {
     const { depositId, originChainId } = relayData;
     const [srcChain, dstChain] = [getNetworkName(originChainId), getNetworkName(destinationChainId)];
-    throw new Error(`${srcChain} deposit ${depositId} filled on ${dstChain} before block ${lowBlockNumber}`);
+    throw new Error(`${srcChain} deposit ${depositId.toString()} filled on ${dstChain} before block ${lowBlockNumber}`);
   }
 
   // Find the leftmost block where filledAmount equals the deposit amount.