Infura JSON RPC Documentation

[mikeonghub]

This is a Gitcoin bounty to write documentation for the Infura JSON RPC.

This documentation will provide a detailed description of each JSON RPC method supported by Infura, format for calling the method, and format of the method response. The description should include common use cases for each method.

An example of API documentation that we really like is Stripe's API documentation here, https://stripe.com/docs/api#intro

In addition to the detailed description, the documentation needs to include example use cases of each method in Javascript. If time allows, additional examples in other languages such as Python are welcome.

Workflow
Prospective bounty claimer will provide examples of previously written documentation and present familiarity with Infura and its API.

Once approved for the bounty, the person will have a scheduled meeting with one of the maintainers of the JSON RPC API system. The maintainer will provide a detailed breakdown of the required documentation and answer any questions around the API and its use cases.

The person will then write the documentation per the details in this ticket and the provided information from the maintainer.

The person will submit the documentation within the agreed time frame and will address 2 rounds of feedback in the event that it is needed.

Once the feedback rounds are complete, the bounty reward will be distributed if the acceptance criteria are met.

Acceptance criteria
The documentation has clear information for the following:
API call format for each method
API response examples for each method
Example use cases for all API methods including written description of the example
Any other criteria outlined by the maintainer during the scheduled meeting will be recorded here.

Timeline
The expected time to complete the bounty is 9 hours. The timeline will start after the scheduled meeting with the maintainer. We will discuss an agreed upon timeline during the meeting with the maintainer.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 1.0 ETH (479.63 USD @ $479.63/ETH) attached to it.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $25,986.61 more funded OSS Work available on the Gitcoin Issue Explorer

[mikeonghub]

@vikaskyadav, can you please provide API documentation examples and examples of your familiarity with Infura's JSON RPC API?

[Qqwy]

It might make sense to tackle #124 before this one.

[vikaskyadav]

I haven't used Infura's JSON RPC API but yeah I have done api documentation of other projects. I think it won't be very different.

[mikeonghub]

@vikaskyadav Can you provide examples of your documentation?

[vikaskyadav]

yeah sure, Have a look at api.boostr.ai . This is documentation of one of the product I worked on.

[mikeonghub]

@vikaskyadav Do you have any where you provided code examples?

[vikaskyadav]

I can't share that code man. anything else we can agree on?

[mikeonghub]

To clarify, I meant documentation where you provide coding examples on how to use the API, per the requirements identified in the bounty.

[owocki]

just rejected the applications above per mike's request

[vikaskyadav]

fine. no worries.

…

On Sat, 21 Jul 2018, 20:35 Kevin Owocki, ***@***.***> wrote: just rejected the applications above per mike's request — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#127 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AMBh11sXLj_MBu_kXG-nOXe8JuEGDTFeks5uI0MfgaJpZM4VTjYT> .

[owocki]

@vikaskyadav i think he wants to see examples of documentation you've done in the past as you apply

[rahulrumalla]

hey @mbgodsey

To clarify, I'm guessing you want to capture all the API endpoints ( assuming all of them are indeed supported ), potentially in a .yaml file (like swagger) and to be ported into something like apiary?

I did run into the incomplete apiary docs.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work has been started.

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

1) rahulrumalla has been approved to start work.

Happy to pick this up. I presume the endpoints here (https://github.com/ethereum/wiki/wiki/JSON-RPC) need to be documented.

Project I contributed to in the past (in apiary)
https://github.com/omi/api-specs
https://omi01.docs.apiary.io

Although I have been working with infura on private projects, I spun up a quick repo in golang to demonstrate my familiarity.
https://github.com/rahulrumalla/go-infura-json-rpc/blob/master/infura/api.go

Learn more on the Gitcoin Issue Details page.

[vikaskyadav]

@owocki @mbgodsey have sent api swagger link that I created yesterday.

[mikeonghub]

@rahulrumalla I have approved you to start, will email you with starting meeting suggestions.

[gitcoinbot]

@rahulrumalla 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!

• warning (3 days)
• escalation to mods (6 days)

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

[mikeonghub]

@rahulrumalla I have snoozed the warnings since we have discussed a timeline offline

[rahulrumalla]

Perfect. Thanks.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work for 1.0 ETH (467.3 USD @ $467.3/ETH) has been submitted by:

1. @rahulrumalla

@mbgodsey please take a look at the submitted work:

• PR by @rahulrumalla

---

• Learn more on the Gitcoin Issue Details page
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $30,558.72 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

The funding of 1.0 ETH (448.09 USD @ $448.09/ETH) attached to this issue has been approved & issued to @rahulrumalla.

• Learn more on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $28,456.72 more funded OSS Work available on the Gitcoin Issue Explorer

[mikeonghub]

@rahulrumalla great work on this issue!

[vs77bb]

🎉 🎉 🎉

[chaftacode]

I think it is important to keep Infura's documentation (and implementation) up-to-date with ethereum/EIPs#1474 when it lands. I think Infura's documentation is fine for now since they both relied on the same eth JSON-RPC wiki.

[ryanschneider]

Thanks for the heads up on the EIP @chaftacode and for your work in reviewing it, it'll be great to see formalization of the RPC format land as an EIP.

One item that might be interesting to discuss as an addendum to the EIP is additional custom error codes. For example we specifically block certain methods for various reasons, it'd be ideal if we could return an standard JSONRPC error response w/ a specific code like -32004 method unsupported on this platform so that client libraries can respond accordingly. Basically this would be an error that can tells the client "yes the node recognized your request as a valid Ethereum RPC, but we are rejecting it for the reason stated in the error message".

Not sure if you are looking for additions to the current EIP so leaving this comment here, but if you are open to adding a code like that to the EIP before it's merged I'm happy to continue the discussion over there.

[ryanschneider]

Looks like the case for an "unsupported" error code was also made here:

ethereum/EIPs#136 (comment)

I'll go ahead and move this discussion over the the EIP.