From 26bec21d0565fe51c51e358a66ce8936d5561d28 Mon Sep 17 00:00:00 2001 From: Nick Frostbutter <75431177+nickfrosty@users.noreply.github.com> Date: Mon, 17 Apr 2023 14:22:11 -0400 Subject: [PATCH] [docs] clarify logsSubscribe `mentions` param (#31225) * fix: clarify logsSubscribe mentions param * Update docs/src/api/websocket/_logsSubscribe.mdx Co-authored-by: Tyera * Update docs/src/api/websocket/_logsSubscribe.mdx Co-authored-by: Tyera --------- Co-authored-by: Tyera --- docs/src/api/websocket/_logsSubscribe.mdx | 24 +++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/src/api/websocket/_logsSubscribe.mdx b/docs/src/api/websocket/_logsSubscribe.mdx index f715bb8b52..6955004489 100644 --- a/docs/src/api/websocket/_logsSubscribe.mdx +++ b/docs/src/api/websocket/_logsSubscribe.mdx @@ -27,7 +27,8 @@ Subscribe to transaction logging A string with one of the following values: - `all` - subscribe to all transactions except for simple vote transactions -- `allWithVotes` - subscribe to all transactions including simple vote transactions +- `allWithVotes` - subscribe to all transactions, including simple vote + transactions @@ -35,7 +36,17 @@ A string with one of the following values: An object with the following field: -- `mentions: [ ]` - array of Pubkeys (as base-58 encoded strings) to listen for being mentioned in any transaction +- `mentions: [ ]` - array containing a single Pubkey (as base-58 + encoded string); if present, subscribe to only transactions mentioning this address + +:::caution + +Currently, the `mentions` field +[only supports one](https://github.com/solana-labs/solana/blob/master/rpc/src/rpc_pubsub.rs#L481) +Pubkey string per method call. Listing additional addresses will result in an +error. + +::: @@ -100,8 +111,13 @@ Configuration object containing the following fields: The notification will be an RpcResponse JSON object with value equal to: - `signature: ` - The transaction signature base58 encoded. -- `err: ` - Error if transaction failed, null if transaction succeeded. [TransactionError definitions](https://github.com/solana-labs/solana/blob/c0c60386544ec9a9ec7119229f37386d9f070523/sdk/src/transaction/error.rs#L13) -- `logs: ` - Array of log messages the transaction instructions output during execution, null if simulation failed before the transaction was able to execute (for example due to an invalid blockhash or signature verification failure) +- `err: ` - Error if transaction failed, null if transaction + succeeded. + [TransactionError definitions](https://github.com/solana-labs/solana/blob/c0c60386544ec9a9ec7119229f37386d9f070523/sdk/src/transaction/error.rs#L13) +- `logs: ` - Array of log messages the transaction instructions + output during execution, null if simulation failed before the transaction was + able to execute (for example due to an invalid blockhash or signature + verification failure) Example: