This repository has been archived by the owner on Jan 22, 2025. It is now read-only.
Fixed typo and json standards in the document #27557
Merged
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
CriesofCarrots
approved these changes
Sep 1, 2022
| @@ -413,7 +413,7 @@ Returns identity and transaction information about a confirmed block in the ledg | |||
| ["jsonParsed" encoding](jsonrpc-api.md#parsed-responses) attempts to use program-specific instruction parsers to return more human-readable and explicit data in the `transaction.message.instructions` list. If "jsonParsed" is requested but a parser cannot be found, the instruction falls back to regular JSON encoding (`accounts`, `data`, and `programIdIndex` fields). | |||
| - (optional) `transactionDetails: <string>` - level of transaction detail to return, either "full", "signatures", or "none". If parameter not provided, the default detail level is "full". | |||
| - (optional) `rewards: bool` - whether to populate the `rewards` array. If parameter not provided, the default includes rewards. | |||
| - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment); "processed" is not supported. If parameter not provided, the default is "finalized". | |||
| - (optional) `commitment: <string>` - [Commitment](jsonrpc-api.md#configuring-state-commitment); "processed" is not supported. If parameter not provided, the default is "finalized". | |||
There was a problem hiding this comment.
It looks like there are some other places we follow this pattern, but I'll fix them up.
mergify bot
pushed a commit
that referenced
this pull request
Sep 1, 2022
* fixed message.accountKeys typo * Fixed parameter argument according to json standards (cherry picked from commit b200217)
mergify bot
added a commit
that referenced
this pull request
Sep 1, 2022
Fixed typo and json standards in the document (#27557) * fixed message.accountKeys typo * Fixed parameter argument according to json standards (cherry picked from commit b200217) Co-authored-by: Piyush Jaiswal <[email protected]>
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.
Summary
JSON RPC APIhad object member name typo, basicallyaccount_keysandaccountKeyswere pointing towards same property of the objectaccountKeys. In thegetBlockmethod request parameter, thecommitmentparameter was defined without providing the argument name. Upon misinterpretation it will cause JSON parse error.Fixes #
account_keystoaccountKeyscommitmentafter testing the request parameters.