useApproveMilestone

Responsable de modificar la propiedad "flag" de un hito específico en el escrow para aprobar ese hito.

Uso

Este hook personalizado expone una función junto con indicadores de estado para gestionar la aprobación de un hito.

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

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

/* 
 * Devuelve una transacción sin firmar
 * payload debe ser del tipo `ApproveMilestonePayload`
*/
const { unsignedTransaction } = await approveMilestone(payload);

Función de Mutación

approveMilestone

Devuelve una transacción no firmada basada en el payload proporcionado.

EscrowType: Especifica el tipo de escrow. Acepta los siguientes valores:

• multi-release: Permite múltiples liberaciones de fondos.

• single-release: Los fondos se liberan en una sola transacción.

ApproveMilestonePayload: Un objeto con los campos necesarios para aprobar un hito. Es aplicable tanto para tipos de escrow de una sola entrega como de múltiples entregas.

Parámetros:

Asegúrate de que coincidan: si eliges el tipo "multi-release", también debes usar un payload de "multi-release".

• tipo: Describe el tipo de escrow que se va a usar. Las opciones son "multi-release" o "single-release".

• payload: Contiene los datos requeridos para la aprobación del hito.

Aprobar hito

Valor de retorno:

unsignedTransaction: Un objeto que representa la transacción construida, lista para ser firmada por tu wallet y transmitida.

---

Ejemplo de uso

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 } = useApproveMilestone();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

/*
 * función onSubmit, esto podría ser llamado por el botón del formulario
*/
 const onSubmit = async (payload: ApproveMilestonePayload) => {

    try {
      /**
       * Llamada a la API usando los hooks de trustless work
       * @Nota:
       * - Necesitamos pasar el payload a la función approveMilestone
       * - El resultado será una transacción sin firmar
       */
      const { unsignedTransaction } = await approveMilestone(
        payload,
        "multi-release"
        // o ...
        // "single-release"
      );

      if (!unsignedTransaction) {
        throw new Error(
          "La transacción sin firmar falta en la respuesta de approveMilestone."
        );
      }

      /**
       * @Nota:
       * - Necesitamos firmar la transacción usando tu [clave privada] como la wallet
       * - El resultado será una transacción firmada
       */
      const signedXdr = await signTransaction({ /* Este método debe ser proporcionado por la wallet */
        unsignedTransaction,
        address: walletAddress || "",
      });

      if (!signedXdr) {
        throw new Error("La transacción firmada falta.");
      }

      /**
       * @Nota:
       * - Necesitamos enviar la transacción firmada a la API
       * - Los datos serán un SendTransactionResponse
       */
      const data = await sendTransaction(signedXdr);

      /**
       * @Respuestas:
       * data.status === "SUCCESS"
       * - Hitos aprobados con éxito
       * - Mostrar un toast de éxito
       *
       * data.status == "ERROR"
       * - Mostrar un toast de error
       */
      if (data.status === "SUCCESS") {
        toast.success(
          `Índice del hito - ${payload.milestoneIndex} ha sido aprobado`
        );
      }
    } catch (error: unknown) {
      // lógica para capturar errores
    }
  };
}