useSendTransaction

Most Trustless Work endpoints return an unsigned transaction in XDR format. This endpoint is used to sign such unsigned transactions and send them to the Stellar network.

This endpoint must be used for all the endpoints after we execute it. Except getEscrow and getEscrowBalances.

Usage

This custom hook exposes a mutation function to send a signed transaction to the network.

import { useSendTransaction} from "@trustless-work/escrow/hooks";
import { SendTransactionPayload } from "@trustless-work/escrow/types";

/*
 *  useSendTransaction
*/
const { sendTransaction, isPending, isError, isSuccess } = useSendTransaction();

/* 
 * It returns a SendTransactionResponse
 * payload should be of type `SendTransactionPayload`
*/
const data = await sendTransaction({
  signedXdr,
  returnEscrowDataIsRequired: false, // Should be true only for these endpoints: Initialize Escrow and Update Escrow
});

Description of Return Values

• isPending A boolean status flag indicating whether the mutation is currently in progress. Useful for showing loaders or disabling UI elements during the process.

• isError A boolean status flag that becomes true if the mutation fails.

• isSuccess A boolean status flag that becomes true once the mutation completes successfully.

Mutation Function

• sendTransaction This is the main mutation function. Internally, it wraps mutate or mutateAsync and is responsible for building and returning data based on the provided payload.

Argument:

SendTransactionPayload: An object containing the required fields to send a transaction to the network.

Types

Return Value:

For: Fund Escrow, Resolve Dispute, Change Milestone Status, Change Milestone Approved Flag, Start Dispute, Release Funds:

• This object will be a type of sendTransactionResponse.

For: Initialize Escrow:

• This object will be a type of sendTransactionResponse. But you can set it as InitializeEscrowResponse.

For: Update Escrow:

• This object will be a type of sendTransactionResponse. But you can set it as UpdateEscrowResponse.

---

Usage Example

src/hooks/useSendTransactionForm.ts

import {
  useFundEscrow,
  useSendTransaction,
} from "@trustless-work/escrow/hooks";
import {
  useSomeEndpointPayload
} from "@trustless-work/escrow/types";

export const useSomeEndpointForm= () => {

 /*
  *  useSomeEndpoint
 */
 const { someFunction, isPending, isError, isSuccess } = useSomeEndpoint();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction, isPending, isError, isSuccess } = useSendTransaction();

/*
 * onSubmit function, this could be called by form button
*/
 const onSubmit = async (payload: useSomeEndpointPayload) => {

    try {
      // get unsignedTransaction from some endpoint ...

      /**
       * @Note:
       * - We need to sign the transaction using your [private key] such as wallet
       * - The result will be a signed transaction
       */
      const signedXdr = await signTransaction({ /* This method should be provided by the wallet */
        unsignedTransaction,
        address: walletAddress || "",
      });

      if (!signedXdr) {
        throw new Error("Signed transaction is missing.");
      }

      /**
       * @Note:
       * - We need to send the signed transaction to the API
       * - The data will be an SendTransactionResponse
       */
      const data = await sendTransaction({
        signedXdr,
        returnEscrowDataIsRequired: false, // Should be true only for these endpoints: Initialize Escrow and Update Escrow
      });

    } catch (error: unknown) {
      // catch error logic
    }
  };
}