useFundEscrow

Permite que usuários depositem fundos em um contrato de caução existente, garantindo-os até que as condições acordadas sejam atendidas.

Uso

Esse hook customizado expõe uma função para financiar e custodiar (escrow).

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

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

/* 
 * Retorna uma transação não assinada
 * payload deve ser do tipo `fundEscrow`
*/
const { unsignedTransaction } = await fundEscrow(payload);

Função de Mutação

fundEscrow

Retornando uma transação não assinada baseada no payload fornecido.

EscrowType: Especifica o tipo de escrow. Aceita os seguintes valores:

• multi-release: Permite múltiplas liberações de fundos.

• single-release: Os fundos são liberados em uma única transação.

FundEscrowPayload: Um objeto com os campos necessários para financiar um escrow. Aplicável tanto para escrow de single-release quanto multi-release.

Parâmetros:

• type: Descreve o tipo de escrow a ser usado. As opções são "multi-release" ou "single-release".

• payload: Contém os dados necessários para financiar o escrow.

Liberar Fundos

Valor de Retorno:

unsignedTransaction: Um objeto representando a transação construída, pronto para ser assinado pela sua carteira e transmitido.

---

Exemplo 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();

/*
 * função onSubmit, isso pode ser chamado por um botão de formulário
*/
 const onSubmit = async (payload: FundEscrowPayload) => {

    try {
      /**
       * Chamada de API usando os hooks do trustless work
       * @Note:
       * - Precisamos passar o payload para a função fundEscrow
       * - O resultado será uma transação não assinada
       */
      const { unsignedTransaction } = await fundEscrow(
        payload,
        "multi-release"
        // ou ...
        // "single-release"
      );

      if (!unsignedTransaction) {
        throw new Error(
          "Transação não assinada está ausente na resposta do fundEscrow."
        );
      }

      /**
       * @Note:
       * - Precisamos assinar a transação usando sua [chave privada], como a carteira
       * - O resultado será uma transação assinada
       */
      const signedXdr = await signTransaction({ /* Este método deve ser fornecido pela carteira */
        unsignedTransaction,
        address: walletAddress || "",
      });

      if (!signedXdr) {
        throw new Error("Transação assinada está ausente.");
      }

      /**
       * @Note:
       * - Precisamos enviar a transação assinada para a API
       * - Os dados serão um SendTransactionResponse
       */
      const data = await sendTransaction(signedXdr);

      /**
       * @Responses:
       * data.status === "SUCCESS"
       * - Escrow financiado com sucesso
       * - Mostrar um toast de sucesso
       *
       * data.status == "ERROR"
       * - Mostrar um toast de erro
       */
      if (data.status === "SUCCESS") {
        toast.success("Escrow Financiado");
      }
    } catch (error: unknown) {
      // lógica para capturar erro
    }
  };
}