# 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="/pages/b1f464587b12c3f9134d0dbd9aa86d1d0e5873bf" %}
[Liberar fundos](/trustless-work/v1-pt/introducao/developer-resources/tipos/payloads/liberar-fundos.md)
{% 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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.trustlesswork.com/trustless-work/v1-pt/sdk-react-de-escrow/escrows/usereleasefunds.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.