transactionSubscribe

Endpoints

WebSockets aprimorados estão disponíveis na mainnet e na devnet:

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

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

Autorizações

string

obrigatório

Sua chave de API Helius. Você pode obter uma gratuitamente no dashboard.

Corpo

array

obrigatório

Ocultar TransactionSubscribeFilter

boolean

Incluir ou excluir transações relacionadas a votos.

boolean

Incluir ou excluir transações que falharam.

string

Filtrar atualizações para uma transação específica pela sua assinatura.

string[]

Lista de contas para receber atualizações de transação. Uma transação deve incluir pelo menos uma dessas contas. Suporta até 50.000 endereços.

string[]

Lista de contas a serem excluídas das atualizações de transação. Suporta até 50.000 endereços.

string[]

Lista de contas que todas devem ser incluídas em uma transação para que ela corresponda. Suporta até 50.000 endereços.

string

Inscreva-se para expandir a conta de token associada (ATA) para que uma carteira accountInclude também corresponda a transações onde possui um saldo de token SPL — por exemplo, transferências de token recebidas que tocam na conta de token da carteira em vez de sua chave pública. Aceita:

"balanceChanged" — corresponde quando a carteira possui um saldo de token cujo valor mudou (ou cuja conta de token foi fechada) na transação.
"all" — corresponde a qualquer transação que faça referência a um saldo de token que a carteira possui, mesmo que não tenha mudado. Maior volume.
"none" — igual a omitir o campo (sem expansão). Este é o padrão.

Um valor inválido retorna o erro JSON-RPC -32602: Invalid tokenAccounts value '<x>', expected one of: none, balanceChanged, all.

Mostrar TransactionSubscribeOptions

string

Nível de compromisso para buscar dados. Pode ser processed, confirmed ou finalized.

string

Formato de codificação para os dados retornados. Pode ser base58, base64 ou jsonParsed.

string

Nível de detalhe para os dados da transação retornados. Pode ser full, signatures, accounts ou none.

boolean

Determina se os dados de recompensa devem ser incluídos nas atualizações.

integer

A versão mais alta de transação para receber atualizações. Defina para 0 para obter transações tanto legadas quanto com versão.

Necessário quando transactionDetails está definido para "accounts" ou "full".

Resposta

integer

ID da assinatura (necessário para cancelar inscrição)

{
  "jsonrpc": "2.0",
  "id": 420,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"]
    },
    {
      "commitment": "processed",
      "encoding": "jsonParsed",
      "transactionDetails": "full",
      "showRewards": true,
      "maxSupportedTransactionVersion": 0
    }
  ]
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["<WALLET_PUBKEY>"],
      "tokenAccounts": "balanceChanged"
    },
    { "commitment": "confirmed", "encoding": "jsonParsed" }
  ]
}

const WebSocket = require("ws");

const ws = new WebSocket("wss://mainnet.helius-rpc.com/?api-key=<API_KEY>");

ws.on("open", () => {
  ws.send(JSON.stringify({
    jsonrpc: "2.0",
    id: 420,
    method: "transactionSubscribe",
    params: [
      { accountInclude: ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"] },
      {
        commitment: "processed",
        encoding: "jsonParsed",
        transactionDetails: "full",
        maxSupportedTransactionVersion: 0,
      },
    ],
  }));

  // Keep connection alive
  setInterval(() => ws.ping(), 30_000);
});

ws.on("message", (data) => {
  console.log(JSON.parse(data.toString()));
});

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "jsonrpc": "2.0",
  "method": "transactionNotification",
  "params": {
    "subscription": 4743323479349712,
    "result": {
      "transaction": {
        "transaction": [
          "Ae6zfSExLsJ/E1+q0jI+3ueAtSoW+6HnuDohmuFwagUo2BU4OpkSdUKYNI1dJfMOonWvjaumf4Vv1ghn9f3Avg0BAAEDGycH0OcYRpfnPNuu0DBQxTYPWpmwHdXPjb8y2P200JgK3hGiC2JyC9qjTd2lrug7O4cvSRUVWgwohbbefNgKQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0HcpwKokfYDDAJTaF/TWRFWm0Gz5/me17PRnnywHurMBAgIAAQwCAAAAoIYBAAAAAAA=",
          "base64"
        ],
        "meta": {
          "err": null,
          "status": {
            "Ok": null
          },
          "fee": 5000,
          "preBalances": [
            28279852264,
            158122684,
            1
          ],
          "postBalances": [
            28279747264,
            158222684,
            1
          ],
          "innerInstructions": [],
          "logMessages": [
            "Program 11111111111111111111111111111111 invoke [1]",
            "Program 11111111111111111111111111111111 success"
          ],
          "preTokenBalances": [],
          "postTokenBalances": [],
          "rewards": null,
          "loadedAddresses": {
            "writable": [],
            "readonly": []
          },
          "computeUnitsConsumed": 0
        }
      },
      "signature": "5moMXe6VW7L7aQZskcAkKGQ1y19qqUT1teQKBNAAmipzdxdqVLAdG47WrsByFYNJSAGa9TByv15oygnqYvP6Hn2p",
      "slot": 224341380,
      "transactionIndex": 42
    }
  }
}

Gerenciando Assinaturas

IDs de Assinatura

Quando transactionSubscribe tem sucesso, o servidor retorna um ID de assinatura no campo result. Este é o mesmo número que aparece em params.subscription em cada notificação dessa assinatura:

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "jsonrpc": "2.0",
  "method": "transactionNotification",
  "params": {
    "subscription": 4743323479349712,
    "result": {}
  }
}

Armazene o ID da assinatura da resposta. Você precisará dele para cancelar a inscrição.

Cancelando Inscrição

Para parar de receber notificações, chame transactionUnsubscribe com o ID da assinatura. Cada chamada transactionSubscribe na mesma conexão cria uma assinatura separada com seu próprio ID, então certifique-se de cancelar a inscrição antes de se reinscrever para evitar receber notificações duplicadas.

{
  "jsonrpc": "2.0",
  "id": 421,
  "method": "transactionUnsubscribe",
  "params": [4743323479349712]
}

{
  "jsonrpc": "2.0",
  "result": true,
  "id": 421
}

Algumas mensagens em trânsito ainda podem chegar logo após chamar transactionUnsubscribe. Este é um comportamento esperado.

Métodos LaserStream WebSocket

accountSubscribe

⌘I

{
  "jsonrpc": "2.0",
  "id": 420,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"]
    },
    {
      "commitment": "processed",
      "encoding": "jsonParsed",
      "transactionDetails": "full",
      "showRewards": true,
      "maxSupportedTransactionVersion": 0
    }
  ]
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["<WALLET_PUBKEY>"],
      "tokenAccounts": "balanceChanged"
    },
    { "commitment": "confirmed", "encoding": "jsonParsed" }
  ]
}

const WebSocket = require("ws");

const ws = new WebSocket("wss://mainnet.helius-rpc.com/?api-key=<API_KEY>");

ws.on("open", () => {
  ws.send(JSON.stringify({
    jsonrpc: "2.0",
    id: 420,
    method: "transactionSubscribe",
    params: [
      { accountInclude: ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"] },
      {
        commitment: "processed",
        encoding: "jsonParsed",
        transactionDetails: "full",
        maxSupportedTransactionVersion: 0,
      },
    ],
  }));

  // Keep connection alive
  setInterval(() => ws.ping(), 30_000);
});

ws.on("message", (data) => {
  console.log(JSON.parse(data.toString()));
});

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "jsonrpc": "2.0",
  "method": "transactionNotification",
  "params": {
    "subscription": 4743323479349712,
    "result": {
      "transaction": {
        "transaction": [
          "Ae6zfSExLsJ/E1+q0jI+3ueAtSoW+6HnuDohmuFwagUo2BU4OpkSdUKYNI1dJfMOonWvjaumf4Vv1ghn9f3Avg0BAAEDGycH0OcYRpfnPNuu0DBQxTYPWpmwHdXPjb8y2P200JgK3hGiC2JyC9qjTd2lrug7O4cvSRUVWgwohbbefNgKQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0HcpwKokfYDDAJTaF/TWRFWm0Gz5/me17PRnnywHurMBAgIAAQwCAAAAoIYBAAAAAAA=",
          "base64"
        ],
        "meta": {
          "err": null,
          "status": {
            "Ok": null
          },
          "fee": 5000,
          "preBalances": [
            28279852264,
            158122684,
            1
          ],
          "postBalances": [
            28279747264,
            158222684,
            1
          ],
          "innerInstructions": [],
          "logMessages": [
            "Program 11111111111111111111111111111111 invoke [1]",
            "Program 11111111111111111111111111111111 success"
          ],
          "preTokenBalances": [],
          "postTokenBalances": [],
          "rewards": null,
          "loadedAddresses": {
            "writable": [],
            "readonly": []
          },
          "computeUnitsConsumed": 0
        }
      },
      "signature": "5moMXe6VW7L7aQZskcAkKGQ1y19qqUT1teQKBNAAmipzdxdqVLAdG47WrsByFYNJSAGa9TByv15oygnqYvP6Hn2p",
      "slot": 224341380,
      "transactionIndex": 42
    }
  }
}

Referência de API

Solana RPC APIs

Solana APIs

APIs de Transmissão de Dados

APIs de Escuta de Eventos

APIs de Gerenciamento de Contas

Endpoints

Autorizações

Corpo

Resposta

Gerenciando Assinaturas

IDs de Assinatura

Cancelando Inscrição

​Endpoints

​Autorizações

​Corpo

​Resposta

​Gerenciando Assinaturas

​IDs de Assinatura

​Cancelando Inscrição

Endpoints

Autorizações

Corpo

Resposta

Gerenciando Assinaturas

IDs de Assinatura

Cancelando Inscrição