# useReleaseFunds

## Uso

Este hook personalizado expõe uma função para liberar os fundos de um escrow.

{% code overflow="wrap" %}

```typescript
import { useReleaseFunds } from "@trustless-work/escrow/hooks";
import { SingleReleaseReleaseFundsPayload, MultiReleaseReleaseFundsPayload } from "@trustless-work/escrow/types";

/*
 *  useReleaseFunds
*/
const { releaseFunds } = useReleaseFunds();

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

```

{% endcode %}

### Função de Mutação

`releaseFunds`

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últiplas liberações de fundos.
* **single-release**: Os fundos são liberados em uma única transação.

**SingleReleaseReleaseFundsPayload:** Um objeto com os campos necessários para liberar um **single-release** escrow.

**MultiReleaseReleaseFundsPayload:** Um objeto com os campos necessários para liberar um **multi-release** escrow por um marco específico.

**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 liberar um escrow ou marco.

{% content-ref url="../developer-resources/tipos/payloads/liberar-fundos" %}
[liberar-fundos](https://docs.trustlesswork.com/trustless-work/pt/developer-resources/tipos/payloads/liberar-fundos)
{% endcontent-ref %}

*Valor de Retorno:*

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

***

## Exemplo de Uso

{% code title="src/hooks/useReleaseFundsForm.ts" overflow="wrap" %}

```typescript
import {
  useReleaseFunds,
  useSendTransaction,
} from "@trustless-work/escrow/hooks";
import {
  SingleReleaseReleaseFundsPayload, MultiReleaseReleaseFundsPayload
} from "@trustless-work/escrow/types";

export const useReleaseFundsForm = () => {

 /*
  *  useReleaseFunds
 */
 const { releaseFunds } = useReleaseFunds();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

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

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

      if (!unsignedTransaction) {
        throw new Error(
          "A transação não assinada está ausente no useReleaseFunds."
        );
      }

      /**
       * @Observação:
       * - 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("A transação assinada está ausente.");
      }

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

      /**
       * @Respostas:
       * data.status === "SUCCESS"
       * - Escrow liberado com sucesso
       * - Exibir um toast de sucesso
       *
       * data.status == "ERROR"
       * - Exibir um toast de erro
       */
      if (data.status === "SUCCESS") {
         toast.success("O escrow foi liberado");
      }
    } catch (error: unknown) {
      // lógica de captura de erro
    }
  };
}

```

{% endcode %}
