-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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.
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
Document JSON-RPC interface in an EIP #1442
Comments
CC @gitcoinco for potential bounty |
Is this related? If not I think the schema should be programmatically readable, and would suggest it uses JSON schema and OpenAPI (aka Swagger) standards |
@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. |
With the JSON schema specs of #217 I was hoping to use the |
Here are my questions in regards to an improved documentation spec:
|
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. 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! 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. This should take 3 - 6 days to complete. Learn more on the Gitcoin Issue Details page. |
@cdetrio, perhaps before implementing a documentation and sandbox platform. |
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). |
@Arachnid you have one worker application pending! |
@PixelantDesign, see @bitpshr's comment. He is going to create a RPC specification. |
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. |
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! |
Hey!~ 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!~ |
@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!
Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days |
1 similar comment
@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!
Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days |
i suggest provide a interactive rest api page . it my proposal. just like : https://xiaods.github.io/Ethereum-api-docs/#introduction |
@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. |
update api docs: https://xiaods.github.io/Ethereum-api-docs/#introduction |
any update for this issue. |
@Arachnid do you have some time to review this issue. do we need moving on road. |
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
|
To clarify, this was done in #1474 and is visible at https://eips.ethereum.org/EIPS/eip-1474 |
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.
The text was updated successfully, but these errors were encountered: