fix: return executeQuote result to client (#227)

* Return execute quote result

* Add changeset

Author: ashwinrava

.changeset/three-papayas-tie.md

@@ -0,0 +1,5 @@
+---
+"@across-protocol/app-sdk": minor
+---
+
+The executeQuote client function should return a deposit id and deposit/fill transaction receipts.

packages/sdk/src/actions/executeQuote.ts

@@ -163,16 +163,38 @@ export type ExecuteQuoteParams = {
   logger?: LoggerT;
 };
 
+/**
+ * Response parameters for {@link executeQuote}.
+ */
+export type ExecuteQuoteResponseParams = {
+  /**
+   * The ID of the deposit transaction.
+   */
+  depositId?: DepositStatus["depositId"];
+  /**
+   * The receipt of the deposit transaction.
+   */
+  depositTxReceipt?: TransactionReceipt;
+  /**
+   * The receipt of the fill transaction.
+   */
+  fillTxReceipt?: TransactionReceipt;
+  /**
+   * Error object if an error occurred and throwOnError was false.
+   */
+  error?: Error;
+};
+
 /**
  * Executes a quote by:
  * 1. Approving the SpokePool contract if necessary
  * 2. Depositing the input token on the origin chain
  * 3. Waiting for the deposit to be filled on the destination chain
  * @param params - See {@link ExecuteQuoteParams}.
- * @returns The deposit ID and receipts for the deposit and fill transactions.
+ * @returns The deposit ID and receipts for the deposit and fill transactions. See {@link ExecuteQuoteResponseParams}.
  * @public
  */
-export async function executeQuote(params: ExecuteQuoteParams) {
+export async function executeQuote(params: ExecuteQuoteParams): Promise<ExecuteQuoteResponseParams> {
   const {
     integratorId,
     deposit,
@@ -409,7 +431,7 @@ export async function executeQuote(params: ExecuteQuoteParams) {
     });
 
     if (!throwOnError) {
-      return { error };
+      return { error: error as Error };
     }
 
     throw error;

packages/sdk/src/client.ts

@@ -33,6 +33,7 @@ import {
   SimulateUpdateDepositTxParams,
   signUpdateDepositTypedData,
   SignUpdateDepositTypedDataParams,
+  ExecuteQuoteResponseParams,
 } from "./actions/index.js";
 import {
   MAINNET_API_URL,
@@ -286,7 +287,7 @@ export class AcrossClient {
       ExecuteQuoteParams,
       "logger" | "originClient" | "destinationClient" | "integratorId"
     >,
-  ) {
+  ): Promise<ExecuteQuoteResponseParams> {
     const logger = params?.logger ?? this.logger;
     const originClient =
       params?.originClient ??
@@ -304,7 +305,7 @@ export class AcrossClient {
     }
 
     try {
-      await executeQuote({
+      return await executeQuote({
         ...params,
         integratorId,
         logger,

packages/sdk/test/e2e/executeQuote.test.ts

@@ -9,6 +9,7 @@ import {
 } from "vitest";
 import { mainnetTestClient as testClient } from "../common/sdk.js";
 import {
+  ExecuteQuoteResponseParams,
   parseDepositLogs,
   parseFillLogs,
   type Quote,
@@ -58,6 +59,7 @@ let depositTxSuccess = false;
 let fillTxSuccess = false;
 let depositLog: ReturnType<typeof parseDepositLogs> | undefined;
 let fillLog: ReturnType<typeof parseFillLogs> | undefined;
+let executeQuoteResult: ExecuteQuoteResponseParams;
 
 describe("executeQuote", async () => {
   test("Gets available routes for intent", async () => {
@@ -196,6 +198,8 @@ describe("executeQuote", async () => {
               rej(false);
             }
           },
+        }).then((result: ExecuteQuoteResponseParams) => {
+          executeQuoteResult = result;
         });
       });
     });
@@ -253,5 +257,12 @@ describe("executeQuote", async () => {
         );
       });
     });
+
+    test("ExecuteQuote returns expected result", () => {
+      expect(executeQuoteResult.depositId).toBeDefined();
+      expect(executeQuoteResult.depositTxReceipt).toBeDefined();
+      expect(executeQuoteResult.fillTxReceipt).toBeDefined();
+      expect(executeQuoteResult.error).toBeUndefined();
+    });
   });
 });