useApproveMilestone

Responsible for modifying the "flag" property of a specific milestone in the escrow to approve that milestone.

Usage

This custom hook exposes a mutation function along with status flags to manage the approval of a milestone.

import { useApproveMilestone } from "@trustless-work/escrow/hooks";
import { ApproveMilestonePayload } from "@trustless-work/escrow/types";

/*
 *  useApproveMilestone
*/
const { approveMilestone, isPending, isError, isSuccess } = useApproveMilestone();

/* 
 * It returns an unsigned transaction
 * payload should be of type `ApproveMilestonePayload`
*/
const { unsignedTransaction } = await approveMilestone(payload);

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

approveMilestone

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.

ApproveMilestonePayload: An object with fields necessary to approve a milestone. It is applicable for both single-release and multi-release escrow types.

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 for milestone approval.

Types

Return Value:

unsignedTransaction: An object representing the constructed transaction, ready to be signed by your wallet and broadcast.

---

Usage Example

src/hooks/useApproveMilestoneForm.ts

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

export const useApproveMilestoneForm = () => {

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

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

    try {
      /**
       * API call by using the trustless work hooks
       * @Note:
       * - We need to pass the payload to the approveMilestone function
       * - The result will be an unsigned transaction
       */
      const { unsignedTransaction } = await approveMilestone({
        payload,
        type: "multi-release"
        // or ...
        type: "single-release"
      });

      if (!unsignedTransaction) {
        throw new Error(
          "Unsigned transaction is missing from approveMilestone response."
        );
      }

      /**
       * @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);

      /**
       * @Responses:
       * data.status === "SUCCESS"
       * - Milestones approved successfully
       * - Show a success toast
       *
       * data.status == "ERROR"
       * - Show an error toast
       */
      if (data.status === "SUCCESS") {
        toast.success(
          `Milestone index - ${payload.milestoneIndex} has been approved`
        );
      }
    } catch (error: unknown) {
      // catch error logic
    }
  };
}