Document JSON-RPC interface in an EIP #1442

Arachnid · 2018-09-23T12:31:30Z

At present, the JSON-RPC interface all clients expose is loosely documented at https://github.com/ethereum/wiki/wiki/JSON-RPC, but this doesn't truly represent the current state of all clients. It's also incomplete, leaving out crucial details such as the format for hex-encoded numbers and strings, and doesn't provide an obvious mechanism for proposing and implementing new RPCs in a cross-client manner.

We should fix this by writing an EIP that serves as a complete reference for client maintainers and users of the standard RPCs.

Arachnid · 2018-09-23T12:31:54Z

CC @gitcoinco for potential bounty

moodysalem · 2018-09-24T18:22:29Z

Is this related?
#217

If not I think the schema should be programmatically readable, and would suggest it uses JSON schema and OpenAPI (aka Swagger) standards

Arachnid · 2018-09-25T19:08:56Z

@moodysalem Yes and no. A human-readable spec that describes what each API should do is different from a set of automated tests that verify the API behaves as expected.

cdetrio · 2018-09-25T19:37:19Z

With the JSON schema specs of #217 I was hoping to use the description fields to generate the wiki documentation. Then the schema test cases are used to verify that client methods are implemented according to the documentation. The test runner was recently dusted off and run again against multiple clients, reviving the proof-of-concept (only a handful of RPC methods have schemas): ethereum/hive#119

ChrisCates · 2018-09-30T19:01:48Z

Here are my questions in regards to an improved documentation spec:

What sort of documentation tools would you prefer? Or would a custom one work? What sort of formatting should it be in?
Will a checklist be provided of all the missing features from the existing documentation? Will a checklist be provided for existing documented features that need improvement?
Will a convention or guideline be provided for creating new documentation... Or, can I propose a guideline and convention?
(Optional) Maybe have a way to test and experiment with RPC calls via localhost or testnets.

gitcoinbot · 2018-09-30T19:02:30Z

Issue Status: 1. Open 2. Cancelled

Workers have applied to start work.

These users each claimed they can complete the work by 4 months from now.
Please review their action plans below:

1) sriharikapu has applied to start work (Funders only: approve worker | reject worker).

I will work on documenting about JSON RPC.

Learn more on the Gitcoin Issue Details page.

2) maexx393 has applied to start work (Funders only: approve worker | reject worker).

I would research about similar RPC documentation to understand the general format of the EIP content and then compare various well documented with the client's current documentation. The changes will be made to achieve a great flow of information for the users to easily understand.

Learn more on the Gitcoin Issue Details page.

3) jjdevbiz has applied to start work (Funders only: approve worker | reject worker).

Howdy!
I have been studying the ethereum json-rpc for the past few months and I feel comfortable that I could document it to the standards you mention (EIP) in short order.
I'd love to chat a little bit about your expectations further if that's ok. Thanks for the opportunity to do some good work!
Cheers,
JJ

Learn more on the Gitcoin Issue Details page.

4) raininja has applied to start work (Funders only: approve worker | reject worker).

I've done some work in this arena, prepping for work on an elixir based JSON-RPC client, so I'm very familiar with this subject.

Learn more on the Gitcoin Issue Details page.

5) skeptycal has applied to start work (Funders only: approve worker | reject worker).

I have experience designing and coding full stack solutions.
I am a retired teacher so I can write great technical documentation

This should take 3 - 6 days to complete.

Learn more on the Gitcoin Issue Details page.

ChrisCates · 2018-09-30T19:14:44Z

@cdetrio, perhaps before implementing a documentation and sandbox platform.
We should solidify a Swagger spec (or other convention), which, can then be fed into a web app.

bitpshr · 2018-10-02T17:30:17Z

Hi @Arachnid, thanks for filing this. I'm already working on an EIP draft that formalizes the current RPC specification. It should be ready to PR in a few days (no need for a bounty though).

PixelantDesign · 2018-10-12T03:44:21Z

@Arachnid you have one worker application pending!

ChrisCates · 2018-10-12T20:10:35Z

@PixelantDesign, see @bitpshr's comment. He is going to create a RPC specification.

bitpshr · 2018-10-12T20:55:58Z

An initial draft can be found at #1474. I'm addressing remaining PR / Ethereum Magicians feedback and tightening up verbiage in a few spots, and should have those updates pushed shortly.

vs77bb · 2018-10-13T20:59:18Z

Hi @bitpshr are you sure on the bounty? All it would take is a 'Start Work' action on Gitcoin here. If not, happy to cancel the bounty.

Regardless, thanks for this great contribution to the ecosystem! 🎉

frankchen07 · 2018-10-23T21:26:12Z

hey @bitpshr, just a reminder to start work on the bounty if you'd like. It'll ensure a smooth process for getting paid out at the end!

ChrisCates · 2018-11-27T00:12:15Z

Hey!~
I was approved for this bounty.
But I thought someone from their internal team already accepted it.

There are lots of other things I'd like to add revolved around this (see initial comment). An interactive webpage to query/test endpoints is what I sort of envision. Happy to discuss more!~

gitcoinbot · 2018-11-30T17:16:21Z

@ChrisCates Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

reminder (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot · 2018-12-06T17:16:14Z

@ChrisCates Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

reminder (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

xiaods · 2019-01-09T01:30:51Z

i suggest provide a interactive rest api page . it my proposal. just like : https://xiaods.github.io/Ethereum-api-docs/#introduction

xiaods · 2019-01-18T00:33:39Z

@vs77bb for api documentation, the best represent way is API site, could you please confirm what you want? the EIP is not suite for json-rpc api design.

xiaods · 2019-01-28T12:07:09Z

update api docs: https://xiaods.github.io/Ethereum-api-docs/#introduction

xiaods · 2019-02-05T06:13:18Z

any update for this issue.

xiaods · 2019-02-19T16:13:22Z

@Arachnid do you have some time to review this issue. do we need moving on road.

gitcoinbot · 2019-05-20T17:56:31Z

Issue Status: 1. Open 2. Cancelled

The funding of 325.0 DAI (325.0 USD @ $1.0/DAI) attached to this issue has been cancelled by the bounty submitter

Questions? Checkout Gitcoin Help or the Gitcoin Slack
$86,314.71 more funded OSS Work available on the Gitcoin Issue Explorer

axic · 2020-01-23T10:57:37Z

To clarify, this was done in #1474 and is visible at https://eips.ethereum.org/EIPS/eip-1474

bitpshr mentioned this issue Oct 5, 2018

EIP: Remote procedure call specification #1474

Merged

bmann mentioned this issue Nov 8, 2018

Community Call - Nov 27th 8am PST - JSON-RPC Spec and Testing for Ethereum Clients spadebuilders/community#15

Closed

colltoaction mentioned this issue Dec 10, 2018

Return JSON-RPC error on eth_call revert rsksmart/rskj#724

Merged

wtf mentioned this issue Mar 5, 2019

Add capabilities to generate and run test fixtures using JSON-RPC ethereum/trinity#369

Closed

nicksavers closed this as completed in #1474 Mar 7, 2019

shanejonas mentioned this issue Apr 2, 2019

Discussion: EIP 1901 Add OpenRPC Service Discovery To JSON-RPC Services #1902

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document JSON-RPC interface in an EIP #1442

Document JSON-RPC interface in an EIP #1442

Arachnid commented Sep 23, 2018

Arachnid commented Sep 23, 2018

moodysalem commented Sep 24, 2018

Arachnid commented Sep 25, 2018

cdetrio commented Sep 25, 2018

ChrisCates commented Sep 30, 2018

gitcoinbot commented Sep 30, 2018 •

edited

Loading

ChrisCates commented Sep 30, 2018

bitpshr commented Oct 2, 2018 •

edited

Loading

PixelantDesign commented Oct 12, 2018

ChrisCates commented Oct 12, 2018

bitpshr commented Oct 12, 2018

vs77bb commented Oct 13, 2018

frankchen07 commented Oct 23, 2018

ChrisCates commented Nov 27, 2018 •

edited

Loading

gitcoinbot commented Nov 30, 2018

gitcoinbot commented Dec 6, 2018

xiaods commented Jan 9, 2019 •

edited

Loading

xiaods commented Jan 18, 2019

xiaods commented Jan 28, 2019

xiaods commented Feb 5, 2019

xiaods commented Feb 19, 2019

gitcoinbot commented May 20, 2019

axic commented Jan 23, 2020

Document JSON-RPC interface in an EIP #1442

Document JSON-RPC interface in an EIP #1442

Comments

Arachnid commented Sep 23, 2018

Arachnid commented Sep 23, 2018

moodysalem commented Sep 24, 2018

Arachnid commented Sep 25, 2018

cdetrio commented Sep 25, 2018

ChrisCates commented Sep 30, 2018

gitcoinbot commented Sep 30, 2018 • edited Loading

ChrisCates commented Sep 30, 2018

bitpshr commented Oct 2, 2018 • edited Loading

PixelantDesign commented Oct 12, 2018

ChrisCates commented Oct 12, 2018

bitpshr commented Oct 12, 2018

vs77bb commented Oct 13, 2018

frankchen07 commented Oct 23, 2018

ChrisCates commented Nov 27, 2018 • edited Loading

gitcoinbot commented Nov 30, 2018

gitcoinbot commented Dec 6, 2018

xiaods commented Jan 9, 2019 • edited Loading

xiaods commented Jan 18, 2019

xiaods commented Jan 28, 2019

xiaods commented Feb 5, 2019

xiaods commented Feb 19, 2019

gitcoinbot commented May 20, 2019

axic commented Jan 23, 2020

gitcoinbot commented Sep 30, 2018 •

edited

Loading

bitpshr commented Oct 2, 2018 •

edited

Loading

ChrisCates commented Nov 27, 2018 •

edited

Loading

xiaods commented Jan 9, 2019 •

edited

Loading