useChangeMilestoneStatus

Responsável por modificar a propriedade "status" de um marco específico na caução.

Uso

Este hook personalizado expõe uma função para alterar um status personalizado do marco.

import { useChangeMilestoneStatus } from "@trustless-work/escrow/hooks";
import { ChangeMilestoneStatusPayload } from "@trustless-work/escrow/types";

/*
 *  useChangeMilestoneStatus 
*/
const { changeMilestoneStatus } = useChangeMilestoneStatus();

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

Função de Mutação

changeMilestoneStatus

Retornando uma transação não assinada baseada 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.

ChangeMilestoneStatusPayload: Um objeto com campos necessários para alterar o status do marco. É aplicável tanto para tipos de escrow de liberação única quanto de liberações múltiplas.

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: Contém os dados necessários para alterar o status do marco.

Alterar Status do Marco

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

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

export const useChangeMilestoneStatusForm = () => {

 /*
  *  useChangeMilestoneApprovedFlag
 */
 const { changeMilestoneApprovedFlag } = useChangeMilestoneStatus();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

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

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

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

      /**
       * @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"
       * - Marco atualizado com sucesso
       * - Mostrar um toast de sucesso
       *
       * data.status == "ERROR"
       * - Mostrar um toast de erro
       */
      if (data.status === "SUCCESS") {
         toast.success(
          `Índice do marco - ${payload.milestoneIndex} atualizado para ${payload.newStatus}`
        );
      }
    } catch (error: unknown) {
      // lógica de captura de erro
    }
  };
}