-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
EIP-????: Add OpenRPC Service Discovery To JSON-RPC Services
- Loading branch information
1 parent
29f9e18
commit 2f38a9a
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Add OpenRPC Service Discovery To JSON-RPC Services | ||
|
|
||
| EIP: ?? | ||
| Title: Add OpenRPC Service Discovery To JSON-RPC Services | ||
| Author: Shane Jonas, Zachary Belford | ||
| Status: Draft | ||
| Type: Interface | ||
| Created: 2019-02-25 | ||
|
|
||
| # Abstract | ||
| ### What is this? | ||
|
|
||
| This is a proposal to add [OpenRPC](https://github.com/open-rpc/spec) support to existing and future JSON-RPC services by adding the method [`rpc.discover`](https://github.com/open-rpc/spec#service-discovery-method) to the projects [JSON-RPC](https://www.jsonrpc.org/specification) APIs, enabling automation and tooling. | ||
|
|
||
| # Motivation | ||
| This was first proposed [here as an ECIP](https://github.com/etclabscore/ECIPs/blob/master/ECIPs/ECIP-1053.md), but the benefits of this kind of tooling is apparent across Bitcoin, Ethereum Classic, Ethereum and other JSON-RPC accessible blockchains. | ||
|
|
||
| ### What is the problem? | ||
|
|
||
| - Maintenence time and accuracy on: | ||
| - documentation | ||
| - APIs | ||
| - clients | ||
| - Not all JSON-RPC servers return the same methods or return the same version of the API. | ||
| - There is nothing that provides both human *and* machine-readable interfaces to be able to interact with JSON-RPC. | ||
| - Communication between services in different programming languages is not easy. | ||
| - Implementation usually comes at the cost of user experience consuming the API. | ||
|
|
||
| # Implementation | ||
| ### How do I Solve the problem? | ||
| JSON-RPC APIs can support the OpenRPC specification by implementing a service discovery method that will return the [OpenRPC document](https://github.com/open-rpc/spec#openrpc-document) for the JSON-RPC API. The method MUST be named `rpc.discover`. The `rpc.` prefix is a reserved method prefix for [JSON-RPC 2.0 Specification](https://www.jsonrpc.org/specification) system extensions. | ||
|
|
||
| ### Use Case | ||
| This is the vision for the use case of OpenRPC and how it would relate to multi-geth: | ||
|
|
||
|  | ||
|
|
||
| # Specification | ||
|
|
||
| ### What is OpenRPC? | ||
| The [OpenRPC](https://github.com/open-rpc/spec) Specification defines a standard, programming language-agnostic interface description for [JSON-RPC 2.0](https://www.jsonrpc.org/specification) APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenRPC, a consumer can understand and interact with the remote service with a minimal amount of implementation logic, and share these logic patterns across use cases. Similar to what interface descriptions have done for lower-level programming, the OpenRPC Specification removes guesswork in calling a service. | ||
|
|
||
| ##### Structure | ||
| This is the structure of an OpenRPC Document: | ||
|
|
||
|  | ||
|
|
||
| And an initial example of what one would look like for `multi-geth` or `geth` can be found [here](https://github.com/etclabscore/multi-geth/blob/0718d25e92e568f486be17123e9384ce15d8b48c/openrpc.json). | ||
|
|
||
|
|
||
| # Rationale | ||
| ### Why would we do this? | ||
| Services need to figure out how to talk to each other. If we really want to build the next generation of automation, then having up to date libraries, documented APIs, and modern tools are going to provide easy discovery, on-boarding, and enable end user and developer interaction. | ||
|
|
||
| Use cases for machine-readable [JSON-RPC 2.0](https://www.jsonrpc.org/specification) API definition documents include, but are not limited to: | ||
|
|
||
| - A common vocabulary and document will keep developers, testers, architects, and technical writers all in sync. | ||
| - Server stubs/skeletons generated in many languages | ||
| - Clients generated in many languages | ||
| - Mock Server generated in many languages | ||
| - Tests generated in many languages | ||
| - Documentation Generation | ||
|
|
||
|
|
||
| # Alternative | ||
| [OpenRPC](https://github.com/open-rpc/spec) documents just describe [JSON-RPC](https://www.jsonrpc.org/specification) APIs services, and are represented in JSON format. These documents may be produced and served statically OR generated dynamically from an application and returned via the [`rpc.discover`](https://github.com/open-rpc/spec#service-discovery-method) method. This gives projects and communities the flexibility to adopt tools before the [`rpc.discover`](https://github.com/open-rpc/spec#service-discovery-method) method is implemented. |