Engine API: Revamp request/response description and explictly list all errors #85
Conversation
This file contains hidden or 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
|
cc @mkalinin |
djrtwo
reviewed
Oct 15, 2021
Co-authored-by: Danny Ryan <dannyjryan@gmail.com>
djrtwo
approved these changes
Oct 18, 2021
djrtwo
changed the title
|
This change looks good to me! 👍 A tiny cleanup is here #90 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I used Microsoft's Language Server Protocol spec as some inspiration for this update: https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#codeLensClientCapabilities
I find this format clearer and more consistent.
Regarding the errors, I have updated the
Unknown Payloaderror to-32001, because the JSON-RPC 2.0 spec explicitly allocated-32000to-32099for "implementation specific" errors. It would be great to enumerate the possible errors a client could return during execution of the API, but I think this is an uphill battle. For this reason, I've set aside-32000as a catch all for exceptions that may occur in an execution client while serving a request. This appears to be the behavior that geth's RPC currently provides.