useInitializeEscrow

Despliega el contrato de escrow y define las propiedades del escrow.

Uso

Este hook personalizado expone una función para desplegar un escrow.

import { useInitializeEscrow } from "@trustless-work/escrow/hooks";
import { InitializeSingleReleaseEscrowPayload, InitializeMultiReleaseEscrowPayload } from "@trustless-work/escrow/types";

/*
 *  useInitializeEscrow 
*/
const { deployEscrow } = useInitializeEscrow();

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

Función

deployEscrow Responsable de construir y devolver una transacción sin firmar 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 única transacción.

InitializeSingleReleaseEscrowPayload: Un objeto con los campos necesarios para inicializar un single-release escrow.

InitializeMultiReleaseEscrowPayload: Un objeto con los campos necesarios para inicializar un multi-release escrow.

Parámetros:

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

• tipo: 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.

Desplegar

Valor de retorno:

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

---

Ejemplo de uso

src/hooks/useInitializeEscrowForm.ts

import {
  useInitializeEscrow,
  useSendTransaction,
} from "@trustless-work/escrow/hooks";
import {
  InitializeMultiReleaseEscrowPayload,
  InitializeSingleReleaseEscrowPayload
} from "@trustless-work/escrow/types";

export const useInitializeEscrowForm = () => {

 /*
  *  useInitializeEscrow
 */
 const { deployEscrow } = useInitializeEscrow();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

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

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

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

      /**
       * @Nota:
       * - Necesitamos firmar la transacción usando tu [clave privada] como la billetera
       * - El resultado será una transacción firmada
       */
      const signedXdr = await signTransaction({ /* Este método debe ser proporcionado por la billetera */
        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 inicializado con éxito
       * - Mostrar una notificación de éxito
       *
       * data.status == "ERROR"
       * - Mostrar una notificación de error
       */
      if (data.status === "SUCCESS") {
        toast.success("Escrow creado");
      }
    } catch (error: unknown) {
      // lógica para capturar el error
    }
  };
}