@across-protocol/sdk 4.2.2-alpha.0 → 4.2.3

package/src/clients/SpokePoolClient/index.ts

@@ -1,10 +1,10 @@
 import { EVMSpokePoolClient } from "./EVMSpokePoolClient";
-import { SvmSpokePoolClient } from "./SVMSpokePoolClient";
+import { SVMSpokePoolClient } from "./SVMSpokePoolClient";
 import { SpokePoolClient } from "./SpokePoolClient";
 
 export { EVMSpokePoolClient } from "./EVMSpokePoolClient";
 export { SpokePoolClient, SpokePoolUpdate } from "./SpokePoolClient";
-export { SvmSpokePoolClient } from "./SVMSpokePoolClient";
+export { SVMSpokePoolClient } from "./SVMSpokePoolClient";
 
 /**
  * Checks if a SpokePoolClient is an EVMSpokePoolClient.
@@ -20,6 +20,6 @@ export function isEVMSpokePoolClient(spokePoolClient: SpokePoolClient): spokePoo
  * @param spokePoolClient The SpokePoolClient to check.
  * @returns True if the SpokePoolClient is an SVMSpokePoolClient, false otherwise.
  */
-export function isSvmSpokePoolClient(spokePoolClient: SpokePoolClient): spokePoolClient is SvmSpokePoolClient {
-  return spokePoolClient instanceof SvmSpokePoolClient;
+export function isSVMSpokePoolClient(spokePoolClient: SpokePoolClient): spokePoolClient is SVMSpokePoolClient {
+  return spokePoolClient instanceof SVMSpokePoolClient;
 }

package/src/clients/index.ts

@@ -6,6 +6,13 @@ export {
 } from "./AcrossConfigStoreClient";
 export { UpdateFailureReason } from "./BaseAbstractClient";
 export { HubPoolClient, LpFeeRequest } from "./HubPoolClient";
-export { SpokePoolClient, SpokePoolUpdate, EVMSpokePoolClient, SvmSpokePoolClient } from "./SpokePoolClient";
+export {
+  SpokePoolClient,
+  SpokePoolUpdate,
+  EVMSpokePoolClient,
+  SVMSpokePoolClient,
+  isEVMSpokePoolClient,
+  isSVMSpokePoolClient,
+} from "./SpokePoolClient";
 export * as BundleDataClient from "./BundleDataClient";
 export * as mocks from "./mocks";

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -25,6 +25,7 @@ import {
   BigNumber,
   bnZero,
   bnOne,
+  toAddress,
   toBytes32,
   spreadEventWithBlockNumber,
 } from "../../utils";
@@ -84,7 +85,6 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       lastDepositId = _depositIds[i];
     }
   }
-
   _getDepositIdAtBlock(blockTag: number): Promise<BigNumber> {
     return Promise.resolve(this.depositIdAtBlock[blockTag]);
   }
@@ -129,6 +129,10 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     return this._deposit("FundsDeposited", deposit);
   }
 
+  depositV3(deposit: Omit<Deposit, "messageHash"> & Partial<SortableEvent>): Log {
+    return this._deposit("V3FundsDeposited", deposit);
+  }
+
   protected _deposit(event: string, deposit: Omit<Deposit, "messageHash"> & Partial<SortableEvent>): Log {
     const { blockNumber, txnIndex } = deposit;
     let { depositId, destinationChainId, inputAmount, outputAmount } = deposit;
@@ -136,11 +140,12 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     this.numberOfDeposits = depositId.add(bnOne);
 
     destinationChainId ??= random(1, 42161, false);
-    const depositor = toBytes32(deposit.depositor ?? randomAddress());
-    const recipient = toBytes32(deposit.recipient ?? depositor);
-    const inputToken = toBytes32(deposit.inputToken ?? randomAddress());
-    const outputToken = toBytes32(deposit.outputToken ?? inputToken);
-    const exclusiveRelayer = toBytes32(deposit.exclusiveRelayer ?? ZERO_ADDRESS);
+    const addressModifier = event === "FundsDeposited" ? toBytes32 : toAddress;
+    const depositor = addressModifier(deposit.depositor ?? randomAddress());
+    const recipient = addressModifier(deposit.recipient ?? depositor);
+    const inputToken = addressModifier(deposit.inputToken ?? randomAddress());
+    const outputToken = addressModifier(deposit.outputToken ?? inputToken);
+    const exclusiveRelayer = addressModifier(deposit.exclusiveRelayer ?? ZERO_ADDRESS);
 
     inputAmount ??= toBNWei(random(1, 1000, false));
     outputAmount ??= inputAmount.mul(toBN("0.95"));
@@ -175,13 +180,17 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     });
   }
 
-  fillRelay(fill: Omit<Fill, "messageHash"> & { message?: string } & Partial<SortableEvent>): Log {
+  fillV3Relay(fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>): Log {
+    return this._fillRelay("FilledV3Relay", fill);
+  }
+
+  fillRelay(fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>): Log {
     return this._fillRelay("FilledRelay", fill);
   }
 
   protected _fillRelay(
     event: string,
-    fill: Omit<Fill, "messageHash"> & { message?: string } & Partial<SortableEvent>
+    fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>
   ): Log {
     const { blockNumber, txnIndex } = fill;
     let { originChainId, depositId, inputAmount, outputAmount, fillDeadline } = fill;
@@ -191,14 +200,15 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     outputAmount ??= inputAmount;
     fillDeadline ??= getCurrentTime() + 60;
 
-    const depositor = toBytes32(fill.depositor ?? randomAddress());
-    const recipient = toBytes32(fill.recipient ?? depositor);
-    const inputToken = toBytes32(fill.inputToken ?? randomAddress());
-    const outputToken = toBytes32(fill.outputToken ?? ZERO_ADDRESS);
-    const exclusiveRelayer = toBytes32(fill.exclusiveRelayer ?? ZERO_ADDRESS);
-    const relayer = toBytes32(fill.relayer ?? randomAddress());
+    const addressModifier = event === "FilledRelay" ? toBytes32 : toAddress;
+    const depositor = addressModifier(fill.depositor ?? randomAddress());
+    const recipient = addressModifier(fill.recipient ?? depositor);
+    const inputToken = addressModifier(fill.inputToken ?? randomAddress());
+    const outputToken = addressModifier(fill.outputToken ?? ZERO_ADDRESS);
+    const exclusiveRelayer = addressModifier(fill.exclusiveRelayer ?? ZERO_ADDRESS);
+    const relayer = addressModifier(fill.relayer ?? randomAddress());
 
-    const topics = [originChainId, depositId, relayer];
+    const topics = [originChainId, depositId, relayer]; // @todo verify
     const message = fill.message ?? EMPTY_MESSAGE;
     const updatedMessage = fill.relayExecutionInfo?.updatedMessage ?? message;
 
@@ -229,14 +239,25 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       },
     };
 
-    const args = {
-      ..._args,
-      messageHash: getMessageHash(message),
-      relayExecutionInfo: {
-        ...relayExecutionInfo,
-        updatedMessageHash: getMessageHash(updatedMessage),
-      },
-    };
+    const args =
+      event === "FilledRelay"
+        ? {
+            ..._args,
+            messageHash: getMessageHash(message),
+            relayExecutionInfo: {
+              ...relayExecutionInfo,
+              updatedMessageHash: getMessageHash(updatedMessage),
+            },
+          }
+        : {
+            // FilledV3Relay
+            ..._args,
+            message,
+            relayExecutionInfo: {
+              ...relayExecutionInfo,
+              updatedMessage,
+            },
+          };
 
     return this.eventManager.generateEvent({
       event,
@@ -248,12 +269,17 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     });
   }
 
+  speedUpV3Deposit(speedUp: SpeedUp): Log {
+    return this._speedUpDeposit("RequestedSpeedUpV3Deposit", speedUp);
+  }
+
   speedUpDeposit(speedUp: SpeedUp): Log {
     return this._speedUpDeposit("RequestedSpeedUpDeposit", speedUp);
   }
 
   protected _speedUpDeposit(event: string, speedUp: SpeedUp): Log {
-    const depositor = toBytes32(speedUp.depositor);
+    const addressModifier = event === "RequestedSpeedUpDeposit" ? toBytes32 : toAddress;
+    const depositor = addressModifier(speedUp.depositor);
     const topics = [speedUp.depositId, depositor];
     const args = { ...speedUp };
 
@@ -264,7 +290,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       args: {
         ...args,
         depositor,
-        updatedRecipient: toBytes32(speedUp.updatedRecipient),
+        updatedRecipient: addressModifier(speedUp.updatedRecipient),
       },
     });
   }
@@ -282,19 +308,24 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     });
   }
 
-  requestSlowFill(request: Omit<SlowFillRequest, "destinationChainId"> & Partial<SortableEvent>): Log {
+  requestV3SlowFill(request: Omit<SlowFillRequest, "messageHash"> & Partial<SortableEvent>): Log {
+    return this._requestSlowFill("RequestedV3SlowFill", request);
+  }
+
+  requestSlowFill(request: Omit<SlowFillRequest, "messageHash"> & Partial<SortableEvent>): Log {
     return this._requestSlowFill("RequestedSlowFill", request);
   }
 
   protected _requestSlowFill(
     event: string,
-    request: Omit<SlowFillRequest, "destinationChainId"> & Partial<SortableEvent>
+    request: Omit<SlowFillRequest, "messageHash"> & Partial<SortableEvent>
   ): Log {
     const { originChainId, depositId } = request;
     const topics = [originChainId, depositId];
     const args = { ...request };
 
-    const depositor = toBytes32(args.depositor ?? randomAddress());
+    const addressModifier = event === "RequestedSlowFill" ? toBytes32 : toAddress;
+    const depositor = addressModifier(args.depositor ?? randomAddress());
 
     return this.eventManager.generateEvent({
       event,
@@ -302,21 +333,20 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       topics: topics.map((topic) => topic.toString()),
       args: {
         ...args,
-        destinationChainId: this.chainId,
         depositor,
-        recipient: toBytes32(args.recipient ?? depositor),
-        inputToken: toBytes32(args.inputToken ?? randomAddress()),
-        outputToken: toBytes32(args.outputToken ?? ZERO_ADDRESS),
-        exclusiveRelayer: toBytes32(args.exclusiveRelayer ?? ZERO_ADDRESS),
+        recipient: addressModifier(args.recipient ?? depositor),
+        inputToken: addressModifier(args.inputToken ?? randomAddress()),
+        outputToken: addressModifier(args.outputToken ?? ZERO_ADDRESS),
+        exclusiveRelayer: addressModifier(args.exclusiveRelayer ?? ZERO_ADDRESS),
       },
       blockNumber: request.blockNumber,
       transactionIndex: request.txnIndex,
     });
   }
 
-  // This is a simple wrapper around fillRelay().
+  // This is a simple wrapper around fillV3Relay().
   // rootBundleId and proof are discarded here - we have no interest in verifying that.
-  executeSlowRelayLeaf(leaf: Omit<SlowFillLeaf, "messageHash">): Log {
+  executeV3SlowRelayLeaf(leaf: Omit<SlowFillLeaf, "messageHash">): Log {
     const fill = {
       ...leaf.relayData,
       destinationChainId: this.chainId,
@@ -331,7 +361,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       },
     };
 
-    return this.fillRelay(fill);
+    return this.fillV3Relay(fill);
   }
 
   executeRelayerRefundLeaf(refund: RelayerRefundExecution & Partial<SortableEvent>): Log {

package/src/clients/mocks/MockSvmSpokePoolClient.ts

@@ -3,7 +3,7 @@ import { SvmSpokeClient } from "@across-protocol/contracts";
 import { Address } from "@solana/kit";
 import { DepositWithBlock, RelayerRefundExecution, SortableEvent, SlowFillLeaf, Log } from "../../interfaces";
 import { getCurrentTime, bnZero, MakeOptional, EventSearchConfig } from "../../utils";
-import { SpokePoolUpdate, SvmSpokePoolClient } from "../SpokePoolClient";
+import { SpokePoolUpdate, SVMSpokePoolClient } from "../SpokePoolClient";
 import { HubPoolClient } from "../HubPoolClient";
 import { EventOverrides } from "./MockEvents";
 import { AcrossConfigStoreClient } from "../AcrossConfigStoreClient";
@@ -12,7 +12,7 @@ import { EventWithData, SvmCpiEventsClient, SVMEventNames, unwrapEventData } fro
 
 // This class replaces internal SpokePoolClient functionality, enabling
 // the user to bypass on-chain queries and inject events directly.
-export class MockSvmSpokePoolClient extends SvmSpokePoolClient {
+export class MockSvmSpokePoolClient extends SVMSpokePoolClient {
   public mockEventsClient: MockSvmCpiEventsClient;
   private destinationTokenForChainOverride: Record<number, string> = {};
 

package/src/constants.ts

@@ -2,10 +2,12 @@ import { constants as ethersConstants } from "ethers";
 import { CHAIN_IDs, TOKEN_SYMBOLS_MAP } from "@across-protocol/constants";
 
 export {
+  CCTP_NO_DOMAIN,
   ChainFamily,
   CHAIN_IDs,
   MAINNET_CHAIN_IDs,
   PUBLIC_NETWORKS,
+  PRODUCTION_NETWORKS,
   TESTNET_CHAIN_IDs,
   TOKEN_SYMBOLS_MAP,
   TOKEN_EQUIVALENCE_REMAPPING,

package/src/gasPriceOracle/adapters/solana.ts

@@ -1,6 +1,6 @@
 import { SVMProvider } from "../../arch/svm";
 import { toBN, dedupArray, parseUnits } from "../../utils";
-import { GasPriceEstimate } from "../types";
+import { SvmGasPriceEstimate } from "../types";
 import { GasPriceEstimateOptions } from "../oracle";
 import { CompilableTransactionMessage, TransactionMessageBytesBase64, compileTransaction } from "@solana/kit";
 
@@ -8,7 +8,7 @@ import { CompilableTransactionMessage, TransactionMessageBytesBase64, compileTra
  * @notice Returns result of getFeeForMessage and getRecentPrioritizationFees RPC calls.
  * @returns GasPriceEstimate
  */
-export async function messageFee(provider: SVMProvider, opts: GasPriceEstimateOptions): Promise<GasPriceEstimate> {
+export async function messageFee(provider: SVMProvider, opts: GasPriceEstimateOptions): Promise<SvmGasPriceEstimate> {
   const { unsignedTx: _unsignedTx } = opts;
 
   // Cast the opaque unsignedTx type to a solana-kit CompilableTransactionMessage.

package/src/gasPriceOracle/oracle.ts

@@ -2,9 +2,9 @@ import assert from "assert";
 import { Transport } from "viem";
 import { providers } from "ethers";
 import { CHAIN_IDs } from "../constants";
-import { BigNumber, chainIsOPStack, fixedPointAdjustment, toBNWei } from "../utils";
+import { BigNumber, chainIsOPStack, fixedPointAdjustment, isEvmProvider, toBNWei } from "../utils";
 import { SVMProvider as SolanaProvider } from "../arch/svm";
-import { GasPriceEstimate } from "./types";
+import { EvmGasPriceEstimate, GasPriceEstimate, SvmGasPriceEstimate } from "./types";
 import { getPublicClient } from "./util";
 import * as arbitrum from "./adapters/arbitrum";
 import * as ethereum from "./adapters/ethereum";
@@ -34,10 +34,22 @@ const GAS_PRICE_ESTIMATE_DEFAULTS = {
 // Chains that use the Viem gas price oracle.
 const VIEM_CHAINS = [CHAIN_IDs.LINEA];
 
+// Overload For EVM providers
+export async function getGasPriceEstimate(
+  provider: providers.Provider,
+  opts?: Partial<GasPriceEstimateOptions>
+): Promise<EvmGasPriceEstimate>;
+
+// Overload For SVM providers
+export async function getGasPriceEstimate(
+  provider: SolanaProvider,
+  opts?: Partial<GasPriceEstimateOptions>
+): Promise<SvmGasPriceEstimate>;
+
 /**
  * Provide an estimate for the current gas price for a particular chain.
  * @param provider A valid ethers provider.
- * @param {opts} GasPriceEstimateOptions optional parameters.
+ * @param {GasPriceEstimateOptions} opts optional parameters.
  * @returns An  object of type GasPriceEstimate.
  */
 export async function getGasPriceEstimate(
@@ -56,7 +68,7 @@ export async function getGasPriceEstimate(
   );
 
   // Exit here if we need to estimate on Solana.
-  if (!(provider instanceof providers.Provider)) {
+  if (!isEvmProvider(provider)) {
     const optsWithDefaults: GasPriceEstimateOptions = {
       ...GAS_PRICE_ESTIMATE_DEFAULTS,
       baseFeeMultiplier,
@@ -68,7 +80,6 @@ export async function getGasPriceEstimate(
   }
 
   // Cast the provider to an ethers provider, which should be given to the oracle when querying an EVM network.
-  provider = provider as providers.Provider;
   const chainId = opts.chainId ?? (await provider.getNetwork()).chainId;
   const optsWithDefaults: GasPriceEstimateOptions = {
     ...GAS_PRICE_ESTIMATE_DEFAULTS,

package/src/gasPriceOracle/types.ts

@@ -1,5 +1,5 @@
 import { type Chain, type Transport, PublicClient, FeeValuesEIP1559 } from "viem";
-import { BigNumber } from "../utils";
+import { BigNumber, isDefined } from "../utils";
 
 export type InternalGasPriceEstimate = FeeValuesEIP1559;
 export type GasPriceEstimate = EvmGasPriceEstimate | SvmGasPriceEstimate;
@@ -17,3 +17,13 @@ export type SvmGasPriceEstimate = {
 export interface GasPriceFeed {
   (provider: PublicClient<Transport, Chain>, chainId: number): Promise<InternalGasPriceEstimate>;
 }
+
+export function isEVMGasPrice(gasPrice: GasPriceEstimate): gasPrice is EvmGasPriceEstimate {
+  const { maxFeePerGas, maxPriorityFeePerGas } = gasPrice as EvmGasPriceEstimate;
+  return isDefined(maxFeePerGas) && isDefined(maxPriorityFeePerGas);
+}
+
+export function isSVMGasPrice(gasPrice: GasPriceEstimate): gasPrice is SvmGasPriceEstimate {
+  const { baseFee, microLamportsPerComputeUnit } = gasPrice as SvmGasPriceEstimate;
+  return isDefined(baseFee) && isDefined(microLamportsPerComputeUnit);
+}

package/src/interfaces/SpokePool.ts

@@ -1,8 +1,11 @@
 import { SortableEvent } from "./Common";
+import { FilledV3RelayEvent, V3FundsDepositedEvent } from "../typechain";
 import { SpokePoolClient } from "../clients";
 import { BigNumber } from "../utils";
 import { RelayerRefundLeaf } from "./HubPool";
 
+export type { FilledV3RelayEvent, V3FundsDepositedEvent };
+
 export interface RelayData {
   originChainId: number;
   depositor: string;
@@ -90,7 +93,7 @@ export interface SpeedUp {
 
 export interface SpeedUpWithBlock extends SpeedUp, SortableEvent {}
 
-export interface SlowFillRequest extends Omit<RelayData, "message"> {
+export interface SlowFillRequest extends RelayData {
   messageHash: string;
   destinationChainId: number;
 }

package/src/providers/infura.ts

@@ -6,6 +6,7 @@ const MAINNET_CHAIN_IDs = Object.values(_MAINNET_CHAIN_IDs);
 // Chain-specific overrides for when the endpoint name does not match the canonical chain name.
 const endpoints: { [chainId: string]: string } = {
   [CHAIN_IDs.ARBITRUM]: "arbitrum",
+  [CHAIN_IDs.BSC]: "bsc",
 };
 
 export function getURL(chainId: number, apiKey: string, transport: RPCTransport): string {

package/src/utils/BlockFinder.ts

@@ -11,7 +11,6 @@ export type BlockTimeAverage = {
 };
 
 export interface Block {
-  hash: string;
   number: number;
   timestamp: number;
 }

package/src/utils/NetworkUtils.ts

@@ -1,5 +1,12 @@
-import { CCTP_NO_DOMAIN } from "@across-protocol/constants";
-import { ChainFamily, CHAIN_IDs, MAINNET_CHAIN_IDs, PUBLIC_NETWORKS, TESTNET_CHAIN_IDs } from "../constants";
+import {
+  CCTP_NO_DOMAIN,
+  ChainFamily,
+  CHAIN_IDs,
+  MAINNET_CHAIN_IDs,
+  PRODUCTION_NETWORKS,
+  PUBLIC_NETWORKS,
+  TESTNET_CHAIN_IDs,
+} from "../constants";
 
 export const hreNetworks: Record<number, string> = {
   666: "Hardhat1",
@@ -89,24 +96,6 @@ export function chainIsArbitrum(chainId: number): boolean {
   return [CHAIN_IDs.ARBITRUM, CHAIN_IDs.ARBITRUM_SEPOLIA].includes(chainId);
 }
 
-/**
- * Determines whether a chain ID is an Aleph0 implementation
- * @param chainId Chain ID to evaluate
- * @returns True if chainId is an Aleph0 chain, otherwise false.
- */
-export function chainIsAlephZero(chainId: number): boolean {
-  return [CHAIN_IDs.ALEPH_ZERO].includes(chainId);
-}
-
-/**
- * Determines whether a chain ID is a Lens implementation
- * @param chainId Chain ID to evaluate
- * @returns True if chainId is a Lens chain, otherwise false.
- */
-export function chainIsLens(chainId: number): boolean {
-  return [CHAIN_IDs.LENS_SEPOLIA].includes(chainId);
-}
-
 /**
  * Determines whether a chain ID is a Linea implementation.
  * @param chainId Chain ID to evaluate.
@@ -159,7 +148,10 @@ export function chainIsSvm(chainId: number): boolean {
  * @returns True if chainId is a CCTP-bridging enabled chain, otherwise false.
  */
 export function chainIsCCTPEnabled(chainId: number): boolean {
-  return PUBLIC_NETWORKS?.[chainId]?.cctpDomain !== CCTP_NO_DOMAIN;
+  // Add chainIds to cctpExceptions to administratively disable CCTP on a chain.
+  // This is useful if constants has been updated to specify a CCTP domain in advance of it being activated.
+  const cctpExceptions: number[] = [];
+  return PRODUCTION_NETWORKS[chainId]?.cctpDomain !== CCTP_NO_DOMAIN && !cctpExceptions.includes(chainId);
 }
 
 /**

package/src/utils/TypeGuards.ts

@@ -1,3 +1,6 @@
+import { providers } from "ethers";
+import { SVMProvider } from "../arch/svm/types";
+
 export function isPromiseFulfilled<T>(
   promiseSettledResult: PromiseSettledResult<T>
 ): promiseSettledResult is PromiseFulfilledResult<T> {
@@ -13,3 +16,7 @@ export function isPromiseRejected<T>(
 export function isDefined<T>(input: T | null | undefined): input is T {
   return input !== null && input !== undefined;
 }
+
+export function isEvmProvider(provider: providers.Provider | SVMProvider): provider is providers.Provider {
+  return provider instanceof providers.Provider;
+}