useGetEscrow

Returns all the information of an escrow requested through the contractId.

Usage

This custom hook exposes a mutation function to get the escrow that you are looking obtain.

import { useGetEscrow } from "@trustless-work/escrow/hooks";
import { GetEscrowParams } from "@trustless-work/escrow/types";

/*
 *  useGetEscrow
*/
const { getEscrow, escrow, isPending, isError, isSuccess } = useGetEscrow();

/* 
 * It returns an Escrow
 * payload should be of type `GetEscrowParams`
*/
await getEscrow(payload);

Description of Return Values

• escrow The escrow you are looking to obtain.

• 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

getEscrow

This is the main mutation function. Internally, it wraps mutate or mutateAsync and handles building and returning an unsigned transaction based on the provided payload.

EscrowType: Specifies the type of escrow. It accepts the following values:

• multi-release: Allows for multiple releases of funds.

• single-release: Funds are released in a single transaction.

GetEscrowParams: An object containing the required fields to get the escrow.

Parameters:

Ensure they match: if you choose a "multi-release" type, you must also use a "multi-release" payload.

• type: Describes the escrow type to be used. Options are "multi-release" or "single-release".

• payload: Contains the data required to get an escrow.

Types

Return Value:

escrow: The escrow that you are looking for. It could be a single-release or multi-release escrow.

---

Usage Example

src/hooks/useGetEscrowForm.ts

import {
  useGetEscrow,
} from "@trustless-work/escrow/hooks";
import {
  GetEscrowParams, 
  SingleReleaseEscrow,
  MultiReleaseEscrow
} from "@trustless-work/escrow/types";

export const useGetEscrowForm = () => {

 /*
  *  useGetEscrow
 */
 const { getEscrow, escrow, isPending, isError, isSuccess } = useGetEscrow();

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

    try {
      /**
       * API call by using the trustless work hooks
       * @Note:
       * - We need to pass the payload to the getEscrow function
       * - The result will be an Escrow
      */
      await getEscrow({
        payload,
        type: "multi-release"
        // or ...
        type: "single-release"
      });
      
      if (!escrow) {
        throw new Error("Escrow not found");
      }

      /**
       * @Responses:
       * escrow !== null
       * - Escrow received successfully
       * - Save the escrow
       * - Show a success toast
       *
       * escrow === null
       * - Show an error toast
       */
      if (escrow: SingleReleaseEscrow | MultiReleaseEscrow) {
        toast.success("Escrow Received");
      }
    } catch (error: unknown) {
      // catch error logic
    }
  };
}