@across-protocol/sdk 4.2.5 → 4.2.6-alpha.1

package/src/arch/svm/SpokeUtils.ts

@@ -26,16 +26,16 @@ import { CHAIN_IDs } from "../../constants";
 import { Deposit, DepositWithBlock, FillStatus, FillWithBlock, RelayData } from "../../interfaces";
 import {
   BigNumber,
-  isUnsafeDepositId,
   SvmAddress,
+  chainIsSvm,
+  chunk,
   getTokenInfo,
   isDefined,
-  toAddressType,
+  isUnsafeDepositId,
   keccak256,
-  chainIsSvm,
-  chunk,
+  toAddressType,
 } from "../../utils";
-import { getStatePda, SvmCpiEventsClient, getFillStatusPda, unwrapEventData, getEventAuthority } from "./";
+import { SvmCpiEventsClient, getEventAuthority, getFillStatusPda, getStatePda, unwrapEventData } from "./";
 import { SVMEventNames, SVMProvider } from "./types";
 
 /**
@@ -373,9 +373,17 @@ export async function fillRelayInstruction(
   const shortenedBuffer = new Uint8Array(Buffer.from(deposit.depositId.toHexString().slice(2), "hex"));
   depositIdBuffer.set(shortenedBuffer, 32 - shortenedBuffer.length);
 
+  const delegatePda = await getFillRelayDelegatePda(
+    relayDataHash,
+    BigInt(repaymentChainId),
+    relayerAddress.toV2Address(),
+    spokePool.toV2Address()
+  );
+
   return SvmSpokeClient.getFillRelayInstruction({
     signer: relayer,
     state: statePda,
+    delegate: SvmAddress.from(delegatePda.toString()).toV2Address(),
     mint: outputToken.toV2Address(),
     relayerTokenAccount: relayerTokenAccount,
     recipientTokenAccount: recipientTokenAccount,
@@ -579,3 +587,129 @@ async function fetchBatchFillStatusFromPdaAccounts(
 
   return fillStatuses;
 }
+
+/**
+ * Returns the delegate PDA for deposit.
+ */
+export async function getDepositDelegatePda(
+  depositData: {
+    depositor: Address<string>;
+    recipient: Address<string>;
+    inputToken: Address<string>;
+    outputToken: Address<string>;
+    inputAmount: bigint;
+    outputAmount: bigint;
+    destinationChainId: bigint;
+    exclusiveRelayer: Address<string>;
+    quoteTimestamp: bigint;
+    fillDeadline: bigint;
+    exclusivityParameter: bigint;
+    message: Uint8Array;
+  },
+  programId: Address<string>
+): Promise<Address<string>> {
+  const addrEnc = getAddressEncoder();
+  const u64 = getU64Encoder();
+  const u32 = getU32Encoder();
+
+  const parts: Uint8Array[] = [
+    Uint8Array.from(addrEnc.encode(depositData.depositor)),
+    Uint8Array.from(addrEnc.encode(depositData.recipient)),
+    Uint8Array.from(addrEnc.encode(depositData.inputToken)),
+    Uint8Array.from(addrEnc.encode(depositData.outputToken)),
+    Uint8Array.from(u64.encode(depositData.inputAmount)),
+    Uint8Array.from(u64.encode(depositData.outputAmount)),
+    Uint8Array.from(u64.encode(depositData.destinationChainId)),
+    Uint8Array.from(addrEnc.encode(depositData.exclusiveRelayer)),
+    Uint8Array.from(u32.encode(depositData.quoteTimestamp)),
+    Uint8Array.from(u32.encode(depositData.fillDeadline)),
+    Uint8Array.from(u32.encode(depositData.exclusivityParameter)),
+    Uint8Array.from(u32.encode(BigInt(depositData.message.length))),
+    depositData.message,
+  ];
+
+  const seedHash = Buffer.from(keccak256(Buffer.concat(parts)).slice(2), "hex");
+
+  const [pda] = await getProgramDerivedAddress({
+    programAddress: programId,
+    seeds: [Buffer.from("delegate"), seedHash],
+  });
+
+  return pda;
+}
+
+/**
+ * Returns the delegate PDA for depositNow.
+ */
+export async function getDepositNowDelegatePda(
+  depositData: {
+    depositor: Address<string>;
+    recipient: Address<string>;
+    inputToken: Address<string>;
+    outputToken: Address<string>;
+    inputAmount: bigint;
+    outputAmount: bigint;
+    destinationChainId: bigint;
+    exclusiveRelayer: Address<string>;
+    fillDeadlineOffset: bigint;
+    exclusivityPeriod: bigint;
+    message: Uint8Array;
+  },
+  programId: Address<string>
+): Promise<Address<string>> {
+  const addrEnc = getAddressEncoder();
+  const u64 = getU64Encoder();
+  const u32 = getU32Encoder();
+
+  const parts: Uint8Array[] = [
+    Uint8Array.from(addrEnc.encode(depositData.depositor)),
+    Uint8Array.from(addrEnc.encode(depositData.recipient)),
+    Uint8Array.from(addrEnc.encode(depositData.inputToken)),
+    Uint8Array.from(addrEnc.encode(depositData.outputToken)),
+    Uint8Array.from(u64.encode(depositData.inputAmount)),
+    Uint8Array.from(u64.encode(depositData.outputAmount)),
+    Uint8Array.from(u64.encode(depositData.destinationChainId)),
+    Uint8Array.from(addrEnc.encode(depositData.exclusiveRelayer)),
+    Uint8Array.from(u32.encode(depositData.fillDeadlineOffset)),
+    Uint8Array.from(u32.encode(depositData.exclusivityPeriod)),
+    Uint8Array.from(u32.encode(BigInt(depositData.message.length))),
+    depositData.message,
+  ];
+
+  const seedHash = Buffer.from(keccak256(Buffer.concat(parts)).slice(2), "hex");
+
+  const [pda] = await getProgramDerivedAddress({
+    programAddress: programId,
+    seeds: [Buffer.from("delegate"), seedHash],
+  });
+
+  return pda;
+}
+
+/**
+ * Returns the fill-delegate PDA for fillRelay.
+ */
+export async function getFillRelayDelegatePda(
+  relayHash: Uint8Array,
+  repaymentChainId: bigint,
+  repaymentAddress: Address<string>,
+  programId: Address<string>
+): Promise<Address<string>> {
+  const addrEnc = getAddressEncoder();
+  const u64 = getU64Encoder();
+
+  const parts: Uint8Array[] = [
+    relayHash,
+    Uint8Array.from(u64.encode(repaymentChainId)),
+    Uint8Array.from(addrEnc.encode(repaymentAddress)),
+  ];
+
+  const seedHash = Buffer.from(keccak256(Buffer.concat(parts)).slice(2), "hex");
+
+  const [pda] = await getProgramDerivedAddress({
+    programAddress: programId,
+    seeds: [Buffer.from("delegate"), seedHash],
+  });
+
+  return pda;
+}

package/src/arch/svm/eventsClient.ts

@@ -177,7 +177,7 @@ export class SvmCpiEventsClient {
    * @param commitment - Commitment level.
    * @returns A promise that resolves to an array of events.
    */
-  private async readEventsFromSignature(txSignature: Signature, commitment: Commitment = "confirmed") {
+  async readEventsFromSignature(txSignature: Signature, commitment: Commitment = "confirmed") {
     const txResult = await this.rpc
       .getTransaction(txSignature, { commitment, maxSupportedTransactionVersion: 0 })
       .send();

package/src/arch/svm/types.ts

@@ -19,7 +19,6 @@ export type EventData =
   | SvmSpokeClient.PausedDeposits
   | SvmSpokeClient.PausedFills
   | SvmSpokeClient.SetXDomainAdmin
-  | SvmSpokeClient.EnabledDepositRoute
   | SvmSpokeClient.FilledRelay
   | SvmSpokeClient.FundsDeposited
   | SvmSpokeClient.EmergencyDeletedRootBundle
@@ -30,7 +29,6 @@ export type EventData =
 export enum SVMEventNames {
   FilledRelay = "FilledRelay",
   FundsDeposited = "FundsDeposited",
-  EnabledDepositRoute = "EnabledDepositRoute",
   RelayedRootBundle = "RelayedRootBundle",
   ExecutedRelayerRefundRoot = "ExecutedRelayerRefundRoot",
   BridgedToHubPool = "BridgedToHubPool",
@@ -56,9 +54,10 @@ export type EventWithData = {
   program: Address;
 };
 
+export type SVMProvider = Rpc<SolanaRpcApiFromTransport<RpcTransport>>;
+
 // Typed aggregate of JSON‑RPC and subscription clients.
 export type RpcClient = {
-  rpc: Rpc<SolanaRpcApiFromTransport<RpcTransport>>;
+  rpc: SVMProvider;
   rpcSubscriptions: RpcSubscriptions<SignatureNotificationsApi & SlotNotificationsApi>;
 };
-export type SVMProvider = Rpc<SolanaRpcApiFromTransport<RpcTransport>>;

package/src/clients/SpokePoolClient/SVMSpokePoolClient.ts

@@ -32,9 +32,9 @@ import { knownEventNames, SpokePoolClient, SpokePoolUpdate } from "./SpokePoolCl
  */
 export class SVMSpokePoolClient extends SpokePoolClient {
   /**
-   * Protected constructor. Use the async create() method to instantiate.
+   * Note: Strongly prefer to use the async create() method to instantiate.
    */
-  protected constructor(
+  constructor(
     logger: winston.Logger,
     hubPoolClient: HubPoolClient | null,
     chainId: number,
@@ -118,8 +118,6 @@ export class SVMSpokePoolClient extends SpokePoolClient {
       return { success: false, reason };
     }
 
-    const deploymentSlot = BigInt(this.deploymentBlock);
-
     const eventSearchConfigs = eventsToQuery.map((eventName) => {
       if (!this._queryableEventNames().includes(eventName)) {
         throw new Error(`SpokePoolClient: Cannot query unrecognised SpokePool event name: ${eventName}`);
@@ -127,13 +125,6 @@ export class SVMSpokePoolClient extends SpokePoolClient {
 
       const _searchConfig = { ...searchConfig }; // shallow copy
 
-      // By default, an event's query range is controlled by the `eventSearchConfig` passed in during instantiation.
-      // However, certain events have special overriding requirements to their search ranges:
-      // - EnabledDepositRoute: The full history is always required, so override the requested fromBlock.
-      if (eventName === "EnabledDepositRoute" && !this.isUpdated) {
-        _searchConfig.from = Number(deploymentSlot);
-      }
-
       return _searchConfig as EventSearchConfig;
     });
 

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -76,7 +76,6 @@ export const knownEventNames = [
  */
 export abstract class SpokePoolClient extends BaseAbstractClient {
   protected currentTime = 0;
-  protected depositHashes: { [depositHash: string]: DepositWithBlock } = {};
   protected duplicateDepositHashes: { [depositHash: string]: DepositWithBlock[] } = {};
   protected depositHashesToFills: { [depositHash: string]: FillWithBlock[] } = {};
   protected speedUps: { [depositorAddress: string]: { [depositId: string]: SpeedUpWithBlock[] } } = {};
@@ -87,6 +86,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
   protected relayerRefundExecutions: RelayerRefundExecutionWithBlock[] = [];
   protected configStoreClient: AcrossConfigStoreClient | undefined;
   protected invalidFills: Set<string> = new Set();
+  public readonly depositHashes: { [depositHash: string]: DepositWithBlock } = {};
   public spokePoolAddress: Address | undefined;
   public fills: { [OriginChainId: number]: FillWithBlock[] } = {};
 

package/src/gasPriceOracle/oracle.ts

@@ -11,6 +11,7 @@ import * as ethereum from "./adapters/ethereum";
 import * as polygon from "./adapters/polygon";
 import * as lineaViem from "./adapters/linea-viem";
 import * as solana from "./adapters/solana";
+import { EvmProvider } from "../arch/evm/types";
 
 export interface GasPriceEstimateOptions {
   // baseFeeMultiplier Multiplier applied to base fee for EIP1559 gas prices (or total fee for legacy).
@@ -36,7 +37,7 @@ const VIEM_CHAINS = [CHAIN_IDs.LINEA];
 
 // Overload For EVM providers
 export async function getGasPriceEstimate(
-  provider: providers.Provider,
+  provider: EvmProvider,
   opts?: Partial<GasPriceEstimateOptions>
 ): Promise<EvmGasPriceEstimate>;
 
@@ -53,7 +54,7 @@ export async function getGasPriceEstimate(
  * @returns An  object of type GasPriceEstimate.
  */
 export async function getGasPriceEstimate(
-  provider: providers.Provider | SolanaProvider,
+  provider: EvmProvider | SolanaProvider,
   opts: Partial<GasPriceEstimateOptions> = {}
 ): Promise<GasPriceEstimate> {
   const baseFeeMultiplier = opts.baseFeeMultiplier ?? toBNWei("1");

package/src/relayFeeCalculator/chain-queries/baseQuery.ts

@@ -20,8 +20,8 @@ import assert from "assert";
 import { Logger, QueryInterface, getDefaultSimulatedRelayerAddress } from "../relayFeeCalculator";
 import { Transport } from "viem";
 import { getGasPriceEstimate, EvmGasPriceEstimate } from "../../gasPriceOracle";
-type Provider = providers.Provider;
-type OptimismProvider = L2Provider<Provider>;
+import { EvmProvider } from "../../arch/evm/types";
+
 export type SymbolMappingType = Record<
   string,
   {
@@ -48,7 +48,7 @@ export class QueryBase implements QueryInterface {
    * @param coingeckoBaseCurrency The basis currency that CoinGecko will use to resolve pricing
    */
   constructor(
-    readonly provider: Provider | OptimismProvider,
+    readonly provider: EvmProvider,
     readonly symbolMapping: SymbolMappingType,
     readonly spokePoolAddress: string,
     readonly simulatedRelayerAddress: string,

package/src/utils/TypeGuards.ts

@@ -1,5 +1,5 @@
-import { providers } from "ethers";
 import { SVMProvider } from "../arch/svm/types";
+import { EvmProvider } from "../arch/evm/types";
 
 export function isPromiseFulfilled<T>(
   promiseSettledResult: PromiseSettledResult<T>
@@ -17,6 +17,7 @@ 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;
+export function isEvmProvider(provider: EvmProvider | SVMProvider): provider is EvmProvider {
+  // Check that the provider doesn't have SVM-specific methods
+  return typeof provider === "object" && provider !== null && !("getSlot" in provider);
 }