useFundEscrow

Permite a los usuarios depositar fondos en un contrato de escrow existente, asegurándolos hasta que se cumplan las condiciones acordadas.

Uso

Este hook personalizado expone una función para financiar y escrow.

import { useFundEscrow } from "@trustless-work/escrow/hooks";
import { FundEscrowPayload } from "@trustless-work/escrow/types";

/*
 *  useFundEscrow
*/
const { fundEscrow } = useFundEscrow();

/* 
 * Devuelve una transacción no firmada
 * el payload debe ser de tipo `fundEscrow`
*/
const { unsignedTransaction } = await fundEscrow(payload);

Función de Mutación

fundEscrow

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.

FundEscrowPayload: Un objeto con los campos necesarios para financiar un escrow. Es aplicable tanto para los tipos de escrow single-release como multi-release.

Parámetros:

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

• payload: Contiene los datos requeridos para financiar el escrow.

Liberar fondos

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/useFundEscrowForm.ts

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

export const useFundEscrowForm = () => {

 /*
  *  useFundEscrow
 */
 const { fundEscrow } = useFundEscrow();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

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

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

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

      /**
       * @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"
       * - Escrow financiado con éxito
       * - Mostrar un toast de éxito
       *
       * data.status == "ERROR"
       * - Mostrar un toast de error
       */
      if (data.status === "SUCCESS") {
        toast.success("Escrow financiado");
      }
    } catch (error: unknown) {
      // lógica para capturar errores
    }
  };
}