Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: Feat/openrpc describe #66

Closed
wants to merge 117 commits into from
Closed

WIP: Feat/openrpc describe #66

wants to merge 117 commits into from

Conversation

meowsbits
Copy link
Member

@meowsbits meowsbits commented Mar 12, 2020 •
edited

Rel #63

This is a spike to explore runtime generation of an OpenRPC rpc_discover document that completely describes geth's available RPC services. Working initially to pattern this closely against geth, and then abstract to a pluggable package that can be integrated with go-ethereum/rpc, and maybe also expose other OpenRPC library services.

Provided temporarily (for development only) in this PR are a script and logs, as well as a copy of the openrpc.json document itself. These together are intended to make changes to the openrpc.json document transparent and to give context for their implementation. The jj the script requires is https://github.com/tidwall/jj.

Included as submodules and forked for development are cornerstone libraries github.com/alecthomas/jsonschema and github.com/gregdhill/go-openrpc.

An example of what adding a method looks like: 7cbfe11

Yields

📄 rpc.discover document: https://gist.github.com/meowsbits/4da4c08765679dac1899543002d1f545. Note that geth uses a temporary rpc_describe method in lieu of the eventual rpc_discover name. This is in order to avoid the collision with the exising method, which returns the static ethereum-json-rpc-specification document.

👁️ Check it out on the OpenRPC Playground: https://playground.open-rpc.org/?url=https://gist.githubusercontent.com/meowsbits/4da4c08765679dac1899543002d1f545/raw/spec.json

Develop

> ./.develop/test.sh

https://github.com/etclabscore/core-geth/blob/feat/openrpc-describe/.develop/test.sh

@meowsbits
rpc: a way to describe openrpc doc vs. actual api methods
c0b3e99 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
rpc: return more information abound under methods
e1e296f 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
rpc: change method to dedupe, and instead read from file
2f27d7d 
It's annoying to managing passing the contents of a file
as an item in an array from the command line.
And the document has strange escape and special characters.
So this make that a little less hackrequire.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
openrpc.json: include current ethereum-json-rpc-specification documen…
c4cdb5d 
…t in root

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
: include script for developing openrpc document
70606a3 
This is just a quick little developer tool.
It'll produce some logs which we can include in the
development branch as well. I hope this'll help with
transparency of workflow and easier review.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
: initial results for openrpc development feedback tools
b717463 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
: use pretty printing and sorted Over lists
3d135fb 
This should make it a lot easier to actually read.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
: revise further with hopefully improved/simplified alphabetization s…
f71a118 
…cheme

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
openrpc: remove eth_submitHashrate
affbfe9 
It was in the Under list, ergo not available from the
actual server. Was listed as deprecated. Has met its fate.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
openrpc: add admin_addPeer
7cbfe11 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
openrpc: add admin_addTrustedPeer
7fe19af 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
openrpc: add admin_datadir
12fcc73 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
WIP: rpc api describing with runtime, ast
5174a59 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
rpc: getting closer to openrpc schema for under list
480c0ff 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
🔨
9c1fd41
@meowsbits
🔨
3655474
@meowsbits
WIP: tests and refactoring Describe
25ffa84 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
install alecthomas.jsonschema for cd schemas
f8badf7 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
💾
62e3a8e
@meowsbits
💾
ae7f91f
@meowsbits
WIP: was wrestling with nil-as-oneof but i'm buggy
6b1733d 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
wip: rpc_describe returns doc
2d532e0 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
Copy link
Member Author

https://playground.open-rpc.org/?schemaUrl=https://gist.githubusercontent.com/meowsbits/4da4c08765679dac1899543002d1f545/raw/49b7176be028626e4d0d1c54a9d7e6da6646c9de/ethereum-json-rpc.json

@meowsbits
go.mod: update to use fork
ccdf168 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
go.sum,openrpc,rpc: begin reorg
47f4b5a 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
rpc: checkout foundation/master -- rpc
b61bfa1 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
main,go.mod,go.sum,graphql,node,openrpc,rpc: chechout node, graphql, …
c1f79d7 
…rpc foundation/master

There was a refactoring of node/rpc handler.
This updates to that, and isolates openrpc logic
to openrpc, where it's waiting to be implemented

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.gitmodules,jsonschema: remove extraced submodule jsonschema
9a1451c 
Now using as a fork

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
go.mod,go.sum: update jsonschema fork imports
3c2b9ac 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
openrpc,rpc: init openrpc discover impl
1dd15d1 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.develop/spec.json,.develop/test.sh,go.mod,rpc: init working impl
9127410 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
: remove disused openrpc static files
fb5b231 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
main: update to new rpc/node pattern
9568648 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
rpc: (lint:deadcode) remote newGzipHandler
692713b 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
ethapi: lint:goimports
e4c4725 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.golangci.yml,rpc: lint:deadcode add rpc case to ignored issues
23bdc9c 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
go.mod,go.sum: bump openrpc dependency versions
600c206 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
Merge branch 'master' into feat/openrpc-describe
49c45f3 
Conflicts:
	cmd/geth/retesteth.go
	go.mod
	go.sum
	rpc/http.go
@meowsbits
.develop/spec.json,go.mod,go.sum: update go-openrpc-reflect, improvin…
5d263c2 
…g contentdescriptor naming

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.develop/spec.json,rpc: provide type to schema map for more hexutil t…
5319e62 
…ypes

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.develop/spec.json,go.mod,go.sum: bump go-openrpc-reflect dependency …
43180ab 
…v0.0.19

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.develop/spec.json,.develop/test.sh,rpc: register rpc.discover method…
8843b93 
… under rpc module namespace

It was under 'openrpc' for development to avoid
side effects of collision with the existing methods under
that module.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.develop/spec.json,node,rpc: refactor openrpc registry to node/ (out …
dfce94c 
…of rpc/)

The openrpc service shouldn't be installed in the
rpc library itself, since the library should only provide
the actual rpc service. Service registration, as it were,
should be handled by the layer using the rpc service,
in this case node/.
L

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
main,node: move openrpc descriptor service to each handler
a4188bf 
This allows discrete ipc/http/ws module sets, each
with their own rpc.discover document based on what
is actually being handled.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
.develop/spec.json,go.mod,node: remove redundant zeroed instances in …
6aad7c6 
…jsonschema typemapper

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
node,params: lint:goimports
fb5a231 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
go.mod,go.sum: bump go-openrpc-reflect v0.0.20
7b72230 
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
node: fix node stack name -> Core-Geth
4af7b8b 
This was overwritten when I checked out the
node and rpc packages from foundation/master.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits
bind: feature to keep the bind test 'replace' dependencies 1:1 with r…
492dae1 
…oot go.mod

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits meowsbits mentioned this pull request Apr 10, 2020
Closed
2 tasks
@meowsbits
Copy link
Member Author

Closing in favor of #90

@meowsbits meowsbits closed this Apr 15, 2020
@meowsbits meowsbits deleted the feat/openrpc-describe branch December 29, 2020 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BelfordZ BelfordZ BelfordZ left review comments

@zcstarr zcstarr Awaiting requested review from zcstarr

@shanejonas shanejonas Awaiting requested review from shanejonas

Assignees
No one assigned
Labels
M3-docs 📑 M6-API:RPC 📣 P5-sometimesoon 🌲
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@meowsbits @BelfordZ