From 7430896c79f08b69d22297c3228b4053412d643b Mon Sep 17 00:00:00 2001 From: Tyera Eulberg Date: Wed, 5 Aug 2020 17:31:49 -0600 Subject: [PATCH] Mark token-specific rpcs as unstable --- docs/src/apps/jsonrpc-api.md | 37 ++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/docs/src/apps/jsonrpc-api.md b/docs/src/apps/jsonrpc-api.md index 3dcb23d52..9e73bb46b 100644 --- a/docs/src/apps/jsonrpc-api.md +++ b/docs/src/apps/jsonrpc-api.md @@ -46,10 +46,6 @@ To interact with a Solana node inside a JavaScript application, use the [solana- - [getSlotLeader](jsonrpc-api.md#getslotleader) - [getStakeActivation](jsonrpc-api.md#getstakeactivation) - [getSupply](jsonrpc-api.md#getsupply) -- [getTokenAccountBalance](jsonrpc-api.md#gettokenaccountbalance) -- [getTokenAccountsByDelegate](jsonrpc-api.md#gettokenaccountsbydelegate) -- [getTokenAccountsByOwner](jsonrpc-api.md#gettokenaccountsbyowner) -- [getTokenSupply](jsonrpc-api.md#gettokensupply) - [getTransactionCount](jsonrpc-api.md#gettransactioncount) - [getVersion](jsonrpc-api.md#getversion) - [getVoteAccounts](jsonrpc-api.md#getvoteaccounts) @@ -69,6 +65,15 @@ To interact with a Solana node inside a JavaScript application, use the [solana- - [slotSubscribe](jsonrpc-api.md#slotsubscribe) - [slotUnsubscribe](jsonrpc-api.md#slotunsubscribe) +## Unstable Methods + +Unstable methods may see breaking changes in patch releases and may not be supported in perpetuity. + +- [getTokenAccountBalance](jsonrpc-api.md#gettokenaccountbalance) +- [getTokenAccountsByDelegate](jsonrpc-api.md#gettokenaccountsbydelegate) +- [getTokenAccountsByOwner](jsonrpc-api.md#gettokenaccountsbyowner) +- [getTokenSupply](jsonrpc-api.md#gettokensupply) + ## Request Formatting To make a JSON-RPC request, send an HTTP POST request with a `Content-Type: application/json` header. The JSON request data should contain 4 fields: @@ -152,7 +157,7 @@ Returns all information associated with the account of provided Pubkey - `` - (optional) Configuration object containing the following optional fields: - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) - (optional) `encoding: ` - encoding for Account data, either "binary" or jsonParsed". If parameter not provided, the default encoding is binary. - Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. + Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. **jsonParsed encoding is UNSTABLE** #### Results: @@ -300,7 +305,7 @@ Returns identity and transaction information about a confirmed block in the ledg #### Parameters: - `` - slot, as u64 integer -- `` - (optional) encoding for each returned Transaction, either "json", "jsonParsed", or "binary". If parameter not provided, the default encoding is JSON. +- `` - (optional) encoding for each returned Transaction, either "json", "jsonParsed", or "binary". If parameter not provided, the default encoding is JSON. **jsonParsed encoding is UNSTABLE** Parsed-JSON encoding attempts to use program-specific instruction parsers to return more human-readable and explicit data in the `transaction.message.instructions` list. If parsed-JSON is requested but a parser cannot be found, the instruction falls back to regular JSON encoding (`accounts`, `data`, and `programIdIndex` fields). #### Results: @@ -458,7 +463,7 @@ Returns transaction details for a confirmed transaction - `` - transaction signature as base-58 encoded string N encoding attempts to use program-specific instruction parsers to return more human-readable and explicit data in the `transaction.message.instructions` list. If parsed-JSON is requested but a parser cannot be found, the instruction falls back to regular JSON encoding (`accounts`, `data`, and `programIdIndex` fields). -- `` - (optional) encoding for the returned Transaction, either "json", "jsonParsed", or "binary". +- `` - (optional) encoding for the returned Transaction, either "json", "jsonParsed", or "binary". **jsonParsed encoding is UNSTABLE** #### Results: @@ -839,7 +844,7 @@ Returns all accounts owned by the provided program Pubkey - `` - (optional) Configuration object containing the following optional fields: - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) - (optional) `encoding: ` - encoding for Account data, either "binary" or jsonParsed". If parameter not provided, the default encoding is binary. - Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. + Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. **jsonParsed encoding is UNSTABLE** - (optional) `filters: ` - filter results using various [filter objects](jsonrpc-api.md#filters); account must meet all filter criteria to be included in results ##### Filters: @@ -1056,7 +1061,7 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, " ### getTokenAccountBalance -Returns the token balance of an SPL Token account. +Returns the token balance of an SPL Token account. **UNSTABLE** #### Parameters: @@ -1082,7 +1087,7 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, " ### getTokenAccountsByDelegate -Returns all SPL Token accounts by approved Delegate. +Returns all SPL Token accounts by approved Delegate. **UNSTABLE** #### Parameters: @@ -1093,7 +1098,7 @@ Returns all SPL Token accounts by approved Delegate. - `` - (optional) Configuration object containing the following optional fields: - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) - (optional) `encoding: ` - encoding for Account data, either "binary" or jsonParsed". If parameter not provided, the default encoding is binary. - Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. + Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. **jsonParsed encoding is UNSTABLE** #### Results: @@ -1118,7 +1123,7 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, " ### getTokenAccountsByOwner -Returns all SPL Token accounts by token owner. +Returns all SPL Token accounts by token owner. **UNSTABLE** #### Parameters: @@ -1129,7 +1134,7 @@ Returns all SPL Token accounts by token owner. - `` - (optional) Configuration object containing the following optional fields: - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) - (optional) `encoding: ` - encoding for Account data, either "binary" or jsonParsed". If parameter not provided, the default encoding is binary. - Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. + Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. **jsonParsed encoding is UNSTABLE** #### Results: @@ -1154,7 +1159,7 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, " ### getTokenSupply -Returns the total supply of an SPL Token type. +Returns the total supply of an SPL Token type. **UNSTABLE** #### Parameters: @@ -1421,7 +1426,7 @@ Subscribe to an account to receive notifications when the lamports or data for a - `` - (optional) Configuration object containing the following optional fields: - `` - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) - (optional) `encoding: ` - encoding for Account data, either "binary" or jsonParsed". If parameter not provided, the default encoding is binary. - Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. + Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. **jsonParsed encoding is UNSTABLE** #### Results: @@ -1529,7 +1534,7 @@ Subscribe to a program to receive notifications when the lamports or data for a - `` - (optional) Configuration object containing the following optional fields: - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) - (optional) `encoding: ` - encoding for Account data, either "binary" or jsonParsed". If parameter not provided, the default encoding is binary. - Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. + Parsed-JSON encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If parsed-JSON is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the `data` field is type ``. **jsonParsed encoding is UNSTABLE** - (optional) `filters: ` - filter results using various [filter objects](jsonrpc-api.md#filters); account must meet all filter criteria to be included in results #### Results: