JSON RPC Error codes standardization: open-rpc extension specs [A Sample implementation] #650
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
Error groups - Extended open-rpc spec sample implementation
simsonraj
changed the title
simsonraj
changed the title
simsonraj
changed the title
zcstarr
reviewed
May 13, 2025
Co-authored-by: Zane Starr <[email protected]>
|
STOP THIS A.I. SLOP NOW!!!!!!!!!!!! |
|
@sambacha this is not AI, but the culmination of many months and pretty close to a year of work, to put together a PR that can help move the ecosystem forward. If you have a criticism of the PR or something about it's content please feel free to comment with something constructive or instructive. If you don't have anything constructive to add to this conversation, please refrain from spamming the PR with comments |
meta data extension
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Goal
A standard for JSON-RPC error codes and messages across EVM-compatible chains and execution clients to improve interoperability, facilitate consistent error handling, and provide a better developer experience.
Motivation
Different Ethereum clients and EVM-compatible chains often use overlapping error codes or generic messages in their JSON-RPC API responses. This inconsistency confuses end users and developers, complicates cross-client tooling, and hampers interoperability.
Solution Abstract
This is made possible by extending the Open-RPC spec to support Extension specs, particularly by utilizing the x-error-group extension spec
This solution aims to address the inconsistent error codes by categorising common error scenarios
Each category could have a reserved range (200 in this case) error codes allotted between (-31999 to -30000), excluding the ranges specified in the JSON-RPC 2.0 specification.
Example: Below is an example categorisation to imagine how the standardization could look like & can be amended as per feedback with different stakeholders
Expected Error codes response validation implementation can be found here