-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
JSON RPC API docs updates #32747
JSON RPC API docs updates #32747
Conversation
7459f79
to
864312a
Compare
@buffalojoec - Based on the status of the linked PR's, I don't think you have finished what you had mentioned wanting to finish. That being said, I don't necessarily think you have to collect all of the and wait to push until you have completely gone through all methods. I don't imagine this PR would grow that big, but for example, if we started to hit 100's of lines changed, breaking up into smaller PR's would preferred if possible. Either is fine with me - you can sit on this until you've finished or you can push fixes in incrementally as you find them. Either way, when you'd like me to take a look, please move the PR out of |
Sounds good to me. We actually are on the last HTTP methods and - as you said - we can always pen a new PR with any additional findings. Why don't we go ahead and mark this ready and we can explore opening another new one if we spot anything else? |
864312a
to
6d67359
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
I can't merge! 😥 |
Problem
We've noticed a few things that are inaccurate in the JSON RPC docs while building out the new Web3 JS library.
Some methods have parameters marked as
optional
that are actuallyrequired
, and other similar minor errors.Summary of Changes
getBlocksWithLimit
: Makelimit
a required parametergetHighestSnapshotSlot
: Response fieldincremental
should be of type<u64|null>
not<u64|undefined>
getSignatureStatuses
: Makesignatures
a required parametergetVersion
:feature-set
solana-core: string
&feature-set: number
)Fixes #32696
I'm curious why the response for
RpcVersionInfo
is set to Kebab case, rather than Camel case. Surely there's a good reason for this, but it throws off client library management since the rest of the methods appear to adhere to Camel case. Just curious why this is done (Source)Note: This will remain a draft until we've finished implementing all remaining RPC HTTP methods (see solana-labs/solana-web3.js#1449) and Web Socket methods (see solana-labs/solana-web3.js#1505)