useStartDispute

Responsável por definir a caução em estado de disputa. Altera o valor da propriedade de flag "disputed" da caução para true.

Uso

Este hook customizado expõe uma função para iniciar uma disputa em um escrow.

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

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

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

Função de Mutação

startDispute

Esta é a função principal de mutação. Internamente, ela envolve mutate ou mutateAsync e é responsável por construir e retornar uma transação não assinada com base no payload fornecido.

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

• multi-release: Permite múltiplos desembolsos de fundos.

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

SingleReleaseStartDisputePayload: Um objeto com os campos necessários para contestar um single-release escrow.

MultiReleaseStartDisputePayload: Um objeto com os campos necessários para contestar um multi-release escrow por marco.

Parâmetros:

Garanta que correspondam: se você escolher o tipo "multi-release", também deve usar um payload "multi-release".

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

• payload: Um objeto contendo os campos necessários para inicializar um escrow.

Iniciar Disputa

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

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

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

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

      /**
       * @Nota:
       * - Precisamos assinar a transação usando sua [chave privada], como uma 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.");
      }

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

      /**
       * @Respostas:
       * data.status === "SUCCESS"
       * - Disputa iniciada com sucesso
       * - Mostrar um toast de sucesso
       *
       * data.status == "ERROR"
       * - Mostrar um toast de erro
       */
      if (data.status === "SUCCESS") {
         toast.success("Disputa Iniciada");
      }
    } catch (error: unknown) {
      // lógica de captura de erro
    }
  };
}