This repository has been archived by the owner on Jan 13, 2025. It is now read-only.
[docs] new JSON RPC API docs format #28197
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nickfrosty
changed the title
github-actions
bot
added
the
stale
nickfrosty
changed the title
jacobcreech
removed
the
stale
* test_store_overhead works with write cache * test_storage_remove_account_double_remove works with write cache * test_set_storage_count_and_alive_bytes works with write cache * test_reuse_append_vec_id works with write cache
* make specific tests use write cache * fix a few more tests
cli: Use QUIC if the default TPU behavior uses QUIC
* ledger-tool create-snapshot uses write cache * ledger tool create snapshot works with write cache
…stalebot (solana-labs#29157) I got this wrong in solana-labs#29134. The original config set this at 365 days, not 7.
* test_shrink_candidate_slots uses write cache (solana-labs#29145) * add tests for collect_from_existing_account
…na-labs#29456) * retry get_latest_blockhash * more retries for get_latest_blockhash * retry for get_fee too * clippy * fmt * sleep * Update accounts-cluster-bench/src/main.rs Co-authored-by: Tyera <[email protected]> * Update accounts-cluster-bench/src/main.rs Co-authored-by: Tyera <[email protected]> * rename Co-authored-by: Tyera <[email protected]>
…abs#29421) dedups gossip addresses, keeping only the one with the highest weight In order to avoid traffic congestion or sending duplicate packets, when sampling gossip nodes if several nodes have the same gossip address (because they are behind a relayer or whatever), they need to be deduplicated into one.
* cleanup get_snapshot_storages * pr feedback
A subsequent change to `SamplePerformanceService` introduces non-vote transaction counts, which `bank`s need to store. Part of work on solana-labs#29159
* frozen-abi/macro * program-runtime * sdk/macro * sdk/program * storage-bigtable/build-proto * fix sorting
…olana-labs#29445) {verify,sign}_shreds_gpu need to point to offsets within the packets for the signed data. For merkle shreds this signed data is the merkle root of the erasure batch and this would necessitate embedding the merkle roots in the shreds payload. However this is wasteful and reduces shreds capacity to store data because the merkle root can already be recovered from the encoded merkle proof. Instead of pointing to offsets within the shreds payload, this commit recovers merkle roots from the merkle proofs and stores them in an allocated buffer. {verify,sign}_shreds_gpu would then point to offsets within this new buffer for the respective signed data. This would unblock us from removing merkle roots from shreds payload which would save capacity to send more data with each shred.
embeded -> embedded
when initializing, if a specific release is requested, we only need to confirm it exists this can be done with the download url itself, rather than pulling the list of releases
github-actions
bot
added
explorer
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The JSON RPC API docs are difficult to navigate and consume. It should be easier to see the actual method docs and examples of how to use the method.
Changes
v2.2.0to use some of new features/apilanding page (see picture below)src/api)httpandwebsocketmethods have been moved to different pages/apipages to show only the methods related to the current viewed page (e.g. http or websocket methods)spacevalue returned for accounts to the API docsNOTE:
This updated display method will also pave the way to enable the core docs to have each of the client API docs on the same page, with a client "language" selector the user can use to view all the respective API docs for each client (e.g. JSON RPC via cURL, JavaScript, Rust)
Workflow for adding/updating RPC method doc pages
Making updates to the individual docs for each method will be inside of their respective "partial" MDX file, located in the respective
src/apifolder. See this example of thegetAccountInfomethod doc for referenceEach of these markdown "partials" will be linked withing the corresponding api doc page (similar to importing a component in React, per the Docusaurus docs). Here is an example for the
getAccountInfomethodScreenshot of the proposed new format:
API home page (located at url
/api)Example of the "side-by-side" view (this example is located at
/api/http#getaccountinfo)Read more "details" component expanded: