Skip to content

Commit

Permalink
EIP 1901 - Add OpenRPC Tooling Implementations (ethereum#2299)
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejonas authored and tkstanczak committed Nov 7, 2020
1 parent b47d84b commit 54496c4
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions EIPS/eip-1901.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,31 @@ Use cases for machine-readable [JSON-RPC 2.0](https://www.jsonrpc.org/specificat

- [Multi-Geth OpenRPC Discovery](https://github.com/multi-geth/multi-geth#openrpc-discovery)

### Tooling

#### Interactive Documentation Playground

You can view the interactive documentation [here](https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/etclabscore/ethereum-json-rpc-specification/master/openrpc.json).

**OR**

Using `rpc.discover` via multi-geth, the playground can discover and display the documentation for the Ethereum JSON-RPC API:

![eth-playground-openrpc](../assets/eip-1901/eth-playground-openrpc.gif)


#### Generated Client

The [clients](https://github.com/etclabscore/ethereum-json-rpc-specification#clients) are generated from the OpenRPC Document openrpc.json outlined in this EIP, and can be used as an alternative to web3.js or ethers.js but for various languages:

![eth-generated-client-openrpc](../assets/eip-1901/eth-generated-client-openrpc.gif)

#### Mock Server

The [OpenRPC mock server](https://github.com/open-rpc/mock-server) provides a mock server for any given OpenRPC Document which allows testing without booting up a real network.

![inspector-mock-server-openrpc](../assets/eip-1901/inspector-mock-server-openrpc.png)

## Resources

- [Multi-Geth OpenRPC Discovery](https://github.com/multi-geth/multi-geth#openrpc-discovery)
Expand Down
Binary file added assets/eip-1901/eth-generated-client-openrpc.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/eip-1901/eth-playground-openrpc.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/eip-1901/inspector-mock-server-openrpc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 54496c4

Please sign in to comment.