@across-protocol/sdk 4.3.6 → 4.3.7

package/src/arch/svm/SpokeUtils.ts

@@ -671,21 +671,95 @@ export const createDepositInstruction = async (
  * Creates a request slow fill instruction.
  * @param signer - The signer of the transaction.
  * @param solanaClient - The Solana client.
- * @param depositInput - The deposit input.
+ * @param requestSlowFillInput - The input arguments for the `requestSlowFill` instruction.
  * @returns The request slow fill instruction.
  */
 export const createRequestSlowFillInstruction = async (
   signer: TransactionSigner,
   solanaClient: SVMProvider,
-  depositInput: SvmSpokeClient.RequestSlowFillInput
+  requestSlowFillInput: SvmSpokeClient.RequestSlowFillInput
 ) => {
-  const requestSlowFillIx = SvmSpokeClient.getRequestSlowFillInstruction(depositInput);
+  const requestSlowFillIx = SvmSpokeClient.getRequestSlowFillInstruction(requestSlowFillInput);
 
   return pipe(await createDefaultTransaction(solanaClient, signer), (tx) =>
     appendTransactionMessageInstruction(requestSlowFillIx, tx)
   );
 };
 
+/**
+ * @notice Return the requestSlowFill transaction for a given deposit
+ * @param spokePoolAddr Address of the spoke pool we're trying to fill through
+ * @param solanaClient RPC client to interact with Solana chain
+ * @param relayData RelayData instance, supplemented with destinationChainId
+ * @param signer signer associated with the relayer creating a Fill.
+ * @returns requestSlowFill transaction
+ */
+export async function getSlowFillRequestTx(
+  spokePoolAddr: SvmAddress,
+  solanaClient: SVMProvider,
+  relayData: Omit<RelayData, "recipient" | "outputToken"> & {
+    destinationChainId: number;
+    recipient: SvmAddress;
+    outputToken: SvmAddress;
+  },
+  signer: TransactionSigner
+) {
+  const {
+    depositor,
+    recipient,
+    inputToken,
+    outputToken,
+    exclusiveRelayer,
+    destinationChainId,
+    originChainId,
+    depositId,
+    fillDeadline,
+    exclusivityDeadline,
+    message,
+  } = relayData;
+
+  const program = toAddress(spokePoolAddr);
+  const relayDataHash = getRelayDataHash(relayData, destinationChainId);
+
+  const [state, fillStatus, eventAuthority] = await Promise.all([
+    getStatePda(program),
+    getFillStatusPda(program, relayData, destinationChainId),
+    getEventAuthority(program),
+  ]);
+
+  const depositIdBuffer = new Uint8Array(32);
+  const shortenedBuffer = arrayify(depositId.toHexString());
+  depositIdBuffer.set(shortenedBuffer, 32 - shortenedBuffer.length);
+
+  const relayDataInput: SvmSpokeClient.RequestSlowFillInput["relayData"] = {
+    depositor: toAddress(depositor),
+    recipient: toAddress(recipient),
+    exclusiveRelayer: toAddress(exclusiveRelayer),
+    inputToken: toAddress(inputToken),
+    outputToken: toAddress(outputToken),
+    inputAmount: bigToU8a32(relayData.inputAmount.toBigInt()),
+    outputAmount: relayData.outputAmount.toBigInt(),
+    originChainId: BigInt(originChainId),
+    depositId: depositIdBuffer,
+    fillDeadline: fillDeadline,
+    exclusivityDeadline: exclusivityDeadline,
+    message: arrayify(message),
+  };
+
+  const requestSlowFillInput: SvmSpokeClient.RequestSlowFillInput = {
+    signer,
+    state,
+    fillStatus,
+    eventAuthority,
+    program,
+    relayHash: arrayify(relayDataHash),
+    relayData: relayDataInput,
+    systemProgram: SYSTEM_PROGRAM_ADDRESS,
+  };
+
+  return createRequestSlowFillInstruction(signer, solanaClient, requestSlowFillInput);
+}
+
 /**
  * Creates a close fill PDA instruction.
  * @param signer - The signer of the transaction.
@@ -707,6 +781,7 @@ export const createCloseFillPdaInstruction = async (
     appendTransactionMessageInstruction(closeFillPdaIx, tx)
   );
 };
+
 export async function getAssociatedTokenAddress(
   owner: SvmAddress,
   mint: SvmAddress,

package/src/clients/SpokePoolClient/EVMSpokePoolClient.ts

@@ -29,11 +29,13 @@ import { isUpdateFailureReason } from "../BaseAbstractClient";
 import { knownEventNames, SpokePoolClient, SpokePoolUpdate } from "./SpokePoolClient";
 import winston from "winston";
 import { HubPoolClient } from "../HubPoolClient";
+import { EVM_SPOKE_POOL_CLIENT_TYPE } from "./types";
 
 /**
  * An EVM-specific SpokePoolClient.
  */
 export class EVMSpokePoolClient extends SpokePoolClient {
+  readonly type = EVM_SPOKE_POOL_CLIENT_TYPE;
   constructor(
     logger: winston.Logger,
     public readonly spokePool: Contract,

package/src/clients/SpokePoolClient/SVMSpokePoolClient.ts

@@ -24,12 +24,14 @@ import {
 import { isUpdateFailureReason } from "../BaseAbstractClient";
 import { HubPoolClient } from "../HubPoolClient";
 import { knownEventNames, SpokePoolClient, SpokePoolUpdate } from "./SpokePoolClient";
+import { SVM_SPOKE_POOL_CLIENT_TYPE } from "./types";
 
 /**
  * SvmSpokePoolClient is a client for the SVM SpokePool program. It extends the base SpokePoolClient
  * and implements the abstract methods required for interacting with an SVM Spoke Pool.
  */
 export class SVMSpokePoolClient extends SpokePoolClient {
+  readonly type = SVM_SPOKE_POOL_CLIENT_TYPE;
   /**
    * Note: Strongly prefer to use the async create() method to instantiate.
    */

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -79,6 +79,7 @@ export const knownEventNames = [
  * for events and storing them in memory. It also provides some convenience methods for querying the stored events.
  */
 export abstract class SpokePoolClient extends BaseAbstractClient {
+  abstract readonly type: string;
   protected currentTime = 0;
   protected duplicateDepositHashes: { [depositHash: string]: DepositWithBlock[] } = {};
   protected depositHashesToFills: { [depositHash: string]: FillWithBlock[] } = {};

package/src/clients/SpokePoolClient/index.ts

@@ -1,6 +1,7 @@
 import { EVMSpokePoolClient } from "./EVMSpokePoolClient";
 import { SVMSpokePoolClient } from "./SVMSpokePoolClient";
 import { SpokePoolClient } from "./SpokePoolClient";
+import { EVM_SPOKE_POOL_CLIENT_TYPE, SVM_SPOKE_POOL_CLIENT_TYPE } from "./types";
 
 export { EVMSpokePoolClient } from "./EVMSpokePoolClient";
 export { SpokePoolClient, SpokePoolUpdate } from "./SpokePoolClient";
@@ -13,7 +14,8 @@ export { SpokePoolManager } from "./SpokePoolClientManager";
  * @returns True if the SpokePoolClient is an EVMSpokePoolClient, false otherwise.
  */
 export function isEVMSpokePoolClient(spokePoolClient: SpokePoolClient): spokePoolClient is EVMSpokePoolClient {
-  return spokePoolClient instanceof EVMSpokePoolClient;
+  // @TODO: Shoud we handle the case where spokePoolClient is undefined?
+  return spokePoolClient?.type === EVM_SPOKE_POOL_CLIENT_TYPE;
 }
 
 /**
@@ -22,5 +24,6 @@ export function isEVMSpokePoolClient(spokePoolClient: SpokePoolClient): spokePoo
  * @returns True if the SpokePoolClient is an SVMSpokePoolClient, false otherwise.
  */
 export function isSVMSpokePoolClient(spokePoolClient: SpokePoolClient): spokePoolClient is SVMSpokePoolClient {
-  return spokePoolClient instanceof SVMSpokePoolClient;
+  // @TODO: Shoud we handle the case where spokePoolClient is undefined?
+  return spokePoolClient?.type === SVM_SPOKE_POOL_CLIENT_TYPE;
 }

package/src/clients/SpokePoolClient/types.ts

@@ -0,0 +1,2 @@
+export const EVM_SPOKE_POOL_CLIENT_TYPE = "EVM";
+export const SVM_SPOKE_POOL_CLIENT_TYPE = "SVM";