transactionSubscribe

エンドポイント

強化されたWebSocketはmainnetとdevnetで利用可能です。

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

WebSocketには10分の非アクティブタイマーがあります。WebSocket接続を維持するために、ヘルスチェックを実装し、毎分pingを送信することを強くお勧めします。

認可

api-key

string

必須

あなたのHelius APIキー。無料でダッシュボードから取得できます。

ボディ

params

array

必須

非表示 TransactionSubscribeFilter

vote

boolean

投票関連のトランザクションを含めるか除外するか。

failed

boolean

失敗したトランザクションを含めるか除外するか。

signature

string

トランザクションの署名で特定のトランザクションの更新をフィルタリングします。

accountInclude

string[]

トランザクション更新を受け取るアカウントのリスト。トランザクションにはこれらのアカウントの少なくとも1つが含まれている必要があります。最大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指定されたアカウントの公開鍵のラマポートやデータが変更されたときに通知を受け取るためにアカウントを購読します。

⌘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

購読解除