transactionSubscribe

端点

增强的 WebSocket 在主网和开发网可用：

主网 wss://mainnet.helius-rpc.com/?api-key=<api-key>
开发网 wss://devnet.helius-rpc.com/?api-key=<api-key>

WebSocket 具有 10 分钟不活动计时器；强烈建议实施健康检查并每分钟发送 ping 以保持 WebSocket 连接。

授权

api-key

string

必填

您的 Helius API 密钥。您可以在仪表板中免费获取一个。

正文

params

array

必填

隐藏 TransactionSubscribeFilter

vote

boolean

包含或排除与投票相关的交易。

failed

boolean

包含或排除失败的交易。

signature

string

通过签名过滤特定交易的更新。

accountInclude

string[]

接收交易更新的账户列表。交易必须包括至少一个这些账户。最多支持 50,000 个地址。

accountExclude

string[]

排除交易更新的账户列表。最多支持 50,000 个地址。

accountRequired

string[]

必须全部包含在交易中的帐户列表，以便进行匹配。支持最多50,000个地址。

tokenAccounts

string

选择参与关联代币账户（ATA）扩展，因此一个accountInclude钱包也匹配其拥有一个SPL代币余额的交易，例如，涉及钱包代币账户的传入代币转账而不是其公钥的交易。接受：

"balanceChanged" — 当钱包拥有一个在交易中金额发生变化（或代币账户被关闭）的代币余额时进行匹配。
"all" — 匹配任何引用钱包所拥有代币余额的交易，即使没有变化。更高的流量。
"none" — 与省略该字段相同（无扩展）。这是默认值。

无效值将返回JSON-RPC错误-32602: Invalid tokenAccounts value '<x>', expected one of: none, balanceChanged, all。

显示 TransactionSubscribeOptions

commitment

string

用于获取数据的承诺级别。可以是processed, confirmed, 或finalized。

encoding

string

返回数据的编码格式。可以是base58, base64, 或jsonParsed。

transactionDetails

string

返回交易数据的详细级别。可以是full, signatures, accounts, 或none。

showRewards

boolean

是否在更新中包含奖励数据。

maxSupportedTransactionVersion

integer

接收更新的最高交易版本。设置为0以获取旧版和版本化交易。

当transactionDetails设置为"accounts" 或 "full"时是必需的。

响应

result

integer

订阅ID（需要取消订阅）

{
  "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
    }
  }
}

管理订阅

订阅ID

当transactionSubscribe成功时，服务器会在result字段返回一个订阅ID。这与每个通知中出现的params.subscription数字相同：

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

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

从响应中存储订阅ID。您需要它来取消订阅。

取消订阅

要停止接收通知，请使用订阅ID调用transactionUnsubscribe。在同一连接上，每次调用transactionSubscribe都会创建一个具有自己ID的单独订阅，因此请确保在重新订阅之前取消订阅，以避免接收重复通知。

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

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

在调用transactionUnsubscribe后，可能会有一些正在传输的消息短暂到达。这是预期的行为。

accountSubscribe订阅一个账户，以便在给定账户公钥的 lamports 或数据发生变化时接收通知。

⌘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
    }
  }
}

API 参考

Solana RPC API

Solana API

数据流 API

事件监听 API

账户管理 API

端点

授权

正文

响应

管理订阅

订阅ID

取消订阅

​端点

​授权

​正文

​响应

​管理订阅

​订阅ID

​取消订阅

端点

授权

正文

响应

管理订阅

订阅ID

取消订阅