RSKj JSON-RPC documentation generation

bguiz commented 3 years ago

RSKj JSON-RPC documentation generation

Prize Bounty

0.02570 RBTC

(approximately 1600 USD at time of posting)

Challenge Description

Programmatically generate documentation for JSON-RPC interface of RSKj.

This should take the form of:

Adding information about each RPC to RSKj’s source code
- For example, this could be annotations within the Java source code, and paired with additional info in other new files that contain extended information.
Adding a build tool or script (in a separate project/repo, not within RSKj) that programmatically extracts the information about each RPC, and uses this to generate documentation as a HTML page
The generated documentation page should have all RPCs on a single page, with each RPC able to expand/ collapse in the UI to allow ease of navigation
Optional: In addition to the HTML output, also create a JSON output as an intermediate step, which contains all of the information required to generate the HTML page.

Each RPC should:

Define the request parameters and response parameters
Include validation rules for request parameters and response parameters
Provide example(s) of request and response pair(s)
Provide a form for the user to input the RPC request params, and display the RPC response returned. This is needed for read RPC requests, i.e. does not involve transactions or signatures, for example eth_getBlockByNumber
Optional: The same as above, but also support write RPC requests, i.e. does involve transactions and signatures via an injected web3 provider such as MetaMask or Nifty, for example eth_call

Selected RPCs:

Not all RPCs need to be documented for the purposes of this bounty. Only the following need to be, as demonstration of sufficient breadth of different RPCs:

web3_sha3
net_peerCount
eth_getBalance
eth_getBlockByNumber
eth_getLogs
debug_traceTransaction
eth_sendTransaction
eth_sendRawTransaction
eth_call

Submission Requirements

Either
1. A Github pull request on the RSKj repository; and
2. A new project as a public repo on Github, which uses the same software licence as RSKj (GPL-3.0)
Implement the features as described in the “challenge description” section
You may not modify RSKj’s source code in a manner that affects any executing code in this task
- Note that if you assess that modifications to the executing code are needed, please get in touch with us to discuss beforehand.
Publish the generated page on a static file server (e.g. Github pages), and include the link
Add tests that provide coverage for the new features added
No “from scratch” requirement - you are free to implement this using any existing tools or frameworks of your choice, and build upon any prior work

Judging Criteria

Only one submission allowed per participant. Where a participant wishes to resubmit, update the original submission instead of submitting a separate entry.
If the submission involves a graphical user interface of any variety, please include a video recording of it in action.
If the submission involves a command line interface of any variety, please include a text file of it in action (including outputs).
Test coverage for any implementation is viewed favourably: More test coverage is better.
In cases where the bounty requires a Github PR on an existing repo, and that repo has continuous integration (CI) set up, the PR should not fail on the CI steps.
Documentation is viewed favourably: Include specific instructions on how to set up and use your submission. Optionally, include any explanations of architectural/ design choices that went into the submission.
The easier it is for the reviewer to run and understand the submission, the better, so be sure to consider this in your submissions!

Winner Announcement Date

This bounty is part of a hackathon, and there are three significant dates:
- Start date: 15/04/2021
- End date: 14/05/2021
- Results date: 15/06/2021
Submissions are welcome between the start date and the end date.
Reviews will be conducted between the end date and the results date.
All submissions must be submitted prior to the end date in order to be eligible for a bounty award.
Submissions submitted or resubmitted after the end date may not be awarded any bounty.
All submissions must be reviewed and accepted (successfully pass the review) prior to the results date in order to be eligible for a bounty award.
The bounty will be awarded on the Gitcoin platform to the best submission among all eligible submissions for this bounty.

More information

For questions related to this bounty, and other bounties in this hackathon, please join the RSK Slack, and check out the #gitcoin2021 channel.
To learn more about RSK and RIF technologies, check out our Developer Portal.

gitcoinbot commented 3 years ago

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

This issue now has a funding of 0.0257 RBTC (1595.87 USD @ $62096.0/RBTC) attached to it.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
- Want to chip in? Add your own contribution here.
- Questions? Checkout Gitcoin Help or the Gitcoin's Discord
- $2,132,076.30 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 3 years ago

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 days, 20 hours ago. Please review their action plans below:

1) mjosephd has started work.

Started working on this submission 2) skarchon has started work.

Start Work

Learn more on the Gitcoin Issue Details page.

gitcoinbot commented 3 years ago

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

Work for 0.0257 RBTC (1427.99 USD @ $49671.0/RBTC) has been submitted by:

Learn more on the Gitcoin Issue Details page
Want to chip in? Add your own contribution here.
Questions? Checkout Gitcoin Help or the Gitcoin's Discord
$2,524,132.63 more funded OSS Work available on the Gitcoin Issue Explorer

rsksmart / rsk-gitcoin-hackathon-2021