> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# signatureSubscribe

> Assine para receber uma notificação quando a transação com a assinatura fornecida atingir o nível de comprometimento especificado.

Esta é uma assinatura para uma única notificação. Ela é cancelada automaticamente pelo servidor assim que a notificação, `signatureNotification`, é enviada pelo RPC.

## Endpoints

Websockets estão disponíveis na mainnet e devnet com as seguintes URLs:

* **Mainnet** `wss://mainnet.helius-rpc.com/?api-key=<api-key>`
* **Devnet** `wss://devnet.helius-rpc.com/?api-key=<api-key>`

<Note>Os websockets têm um temporizador de inatividade de 10 minutos; implementar verificações de integridade e enviar pings a cada minuto é altamente recomendado para manter a conexão websocket ativa.</Note>

## Autorizações

<ParamField query="api-key" type="string" required>
  Sua chave de API Helius. Você pode obter uma gratuitamente no [painel](https://dashboard.helius.dev/api-keys).
</ParamField>

## Corpo

<ParamField body="params" type="array" required>
  <Expandable title="properties" defaultOpen>
    <ParamField body="signature" type="string" required>
      Assinatura da transação, como string codificada em base-58.

      A assinatura da transação deve ser a primeira assinatura da transação (veja o ID da transação para mais detalhes).
    </ParamField>

    <ParamField body="config" type="object">
      Objeto de configuração contendo os seguintes campos:

      <ParamField body="commitment" type="string">
        O nível de comprometimento para a assinatura. Pode ser `finalized`, `confirmed`, ou `processed`.
      </ParamField>

      <ParamField body="enableReceivedNotification" type="boolean">
        Se deve enviar uma notificação quando a assinatura da transação for recebida.
      </ParamField>
    </ParamField>
  </Expandable>
</ParamField>

## Resposta

<ResponseField name="result" type="integer">
  ID de assinatura (necessário para cancelar a assinatura)
</ResponseField>

## Formato de Notificação

A notificação será um objeto JSON RpcResponse com valor contendo um objeto com:

* `slot: <u64>` - O slot correspondente.
* `value: <object|string>` - um valor de notificação de RpcSignatureResult, resultando em:
  * quando `enableReceivedNotification` é `true` e a assinatura é recebida: a string literal `"receivedSignature"`, ou
  * quando a assinatura é processada: `err: <object|null>`:
    * `null` se a transação foi processada com sucesso no nível de comprometimento especificado, ou
    * um TransactionError, se a transação falhou

<RequestExample>
  ```json Request theme={"system"}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "signatureSubscribe",
    "params": [
      "2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b",
      {
        "commitment": "finalized",
        "enableReceivedNotification": false
      }
    ]
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={"system"}
  {
    "jsonrpc": "2.0",
    "result": 0,
    "id": 1
  }
  ```

  ```json Notification (Processed Transaction) theme={"system"}
  {
    "jsonrpc": "2.0",
    "method": "signatureNotification",
    "params": {
      "result": {
        "context": {
          "slot": 5207624
        },
        "value": {
          "err": null
        }
      },
      "subscription": 24006
    }
  }
  ```

  ```json Notification (Received Transaction) theme={"system"}
  {
    "jsonrpc": "2.0",
    "method": "signatureNotification",
    "params": {
      "result": {
        "context": {
          "slot": 5207624
        },
        "value": "receivedSignature"
      },
      "subscription": 24006
    }
  }
  ```
</ResponseExample>