useStartDispute

Responsable de establecer el escrow en estado de disputa. Cambia el valor de la propiedad de bandera "disputed" del escrow a true.

Uso

Este hook personalizado expone una función para iniciar una disputa en un escrow.

import { useStartDispute } from "@trustless-work/escrow/hooks";
import { SingleReleaseStartDisputePayload, MultiReleaseStartDisputePayload } from "@trustless-work/escrow/types";

/*
 *  useStartDispute
*/
const { startDispute } = useStartDispute();

/* 
 * Devuelve una transacción sin firmar
 * el payload debe ser de tipo `MultiReleaseStartDisputePayload` o `SingleReleaseStartDisputePayload`
*/
const { unsignedTransaction } = await startDispute(payload);

Función de Mutación

startDispute

Esta es la función principal de mutación. Internamente, envuelve mutate o mutateAsync y es responsable de construir y devolver 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.

SingleReleaseStartDisputePayload: Un objeto con los campos necesarios para disputar un single-release escrow.

MultiReleaseStartDisputePayload: Un objeto con los campos necesarios para disputar un multi-release escrow por hito.

Parámetros:

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

• type: Describe el tipo de escrow a utilizar. Las opciones son "multi-release" o "single-release".

• payload: Un objeto que contiene los campos requeridos para inicializar un escrow.

Tipos

Valor de retorno:

unsignedTransaction: Un objeto que representa la transacción construida, listo para ser firmado por tu wallet y transmitido.

---

Ejemplo de uso

src/hooks/useStartDisputeForm.ts

import {
  useStartDispute,
  useSendTransaction,
} from "@trustless-work/escrow/hooks";
import {
  SingleReleaseStartDisputePayload, MultiReleaseStartDisputePayload
} from "@trustless-work/escrow/types";

export const useStartDisputeForm = () => {

 /*
  *  useStartDispute
 */
 const { startDispute } = useStartDispute();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

/*
 * función onSubmit, esto podría ser llamada por un botón de formulario
*/
 const onSubmit = async (payload: SingleReleaseStartDisputePayload | MultiReleaseStartDisputePayload) => {

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

      if (!unsignedTransaction) {
        throw new Error(
          "La transacción no firmada falta en startDispute."
        );
      }

      /**
       * @Note:
       * - 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.");
      }

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

      /**
       * @Responses:
       * data.status === "SUCCESS"
       * - Disputa iniciada con éxito
       * - Mostrar un toast de éxito
       *
       * data.status == "ERROR"
       * - Mostrar un toast de error
       */
      if (data.status === "SUCCESS") {
         toast.success("Disputa iniciada");
      }
    } catch (error: unknown) {
      // lógica para capturar errores
    }
  };
}