useChangeMilestoneStatus

Responsable de modificar la propiedad "status" de un hito específico en el escrow.

Uso

Este hook personalizado expone una función para cambiar un estado personalizado del hito.

import { useChangeMilestoneStatus } from "@trustless-work/escrow/hooks";
import { ChangeMilestoneStatusPayload } from "@trustless-work/escrow/types";

/*
 *  useChangeMilestoneStatus 
*/
const { changeMilestoneStatus } = useChangeMilestoneStatus();

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

Función de Mutación

changeMilestoneStatus

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.

ChangeMilestoneStatusPayload: Un objeto con los campos necesarios para cambiar el estado del hito. Es aplicable tanto para tipos de escrow de liberación única como de múltiples liberaciones.

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 cambiar el estado del hito.

Cambiar estado del 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/useChangeMilestoneApprovedFlagForm.ts

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

export const useChangeMilestoneStatusForm = () => {

 /*
  *  useChangeMilestoneApprovedFlag
 */
 const { changeMilestoneApprovedFlag } = useChangeMilestoneStatus();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

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

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

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

      /**
       * @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"
       * - Hito actualizado con éxito
       * - Mostrar un toast de éxito
       *
       * data.status == "ERROR"
       * - Mostrar un toast de error
       */
      if (data.status === "SUCCESS") {
         toast.success(
          `Índice de hito - ${payload.milestoneIndex} actualizado a ${payload.newStatus}`
        );
      }
    } catch (error: unknown) {
      // lógica para capturar errores
    }
  };
}