useWithdrawRemainingFunds

En un escrow de liberaciones múltiples, cuando algunos fondos están bloqueados, puedes usar este hook para liberar los fondos restantes

Uso

Este hook personalizado expone una función para retirar los fondos restantes en un escrow.

import { useResolveDispute } from "@trustless-work/escrow/hooks";
import { WithdrawRemainingFundsPayload } from "@trustless-work/escrow/types";

/*
 *  useWithdrawRemainingFunds
*/
const { withdrawRemainingFunds} = useWithdrawRemainingFunds();

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

Función de Mutación

withdrawRemainingFunds

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.

WithdrawRemainingFundsPayload: Un objeto con los campos necesarios para liberar los fondos bloqueados

Parámetros:

Solo permite escrows de liberación múltiple..

• payload: Un objeto que contiene los campos requeridos para resolver una disputa.

Retirar fondos restantes

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

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

export const useStartDisputeForm = () => {

 /*
  *  useWithdrawRemainingFunds
 */
 const { withdrawRemainingFunds } = useWithdrawRemainingFunds();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

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

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

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

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