Add syncing to RSKj eth_subscribe RPC Method

bguiz commented 3 years ago

Add syncing to RSKj eth_subscribe RPC Method

Prize Bounty

0.01610 RBTC

(approximately 1000 USD at time of posting)

Challenge Description

RSKj current implements the eth_subscribe and eth_unsubscribe RPC methods with the following subscription names:

newHeads - fires a notification each time a new header is appended to the chain, including chain reorganizations
logs - returns logs that are included in new imported blocks and match the given filter criteria

However, RSKj currently does not implement the following subscription names:

newPendingTransactions - returns the hash for all transactions that are added to the pending state and are signed with a key that is available in the node
syncing - indicates when the node starts or stops synchronizing

All 4 subscription names are detailed in this documentation: Real-time Events

Implement eth_subscribe and eth_unsubscribe RPC methods in RSKj for syncing.

If you attempt this bounty about “syncing”, we suggest that you also attempt the other bounty about “newPendingTransactions”, because if you complete one of these bounties, the other related bounty is likely to be much easier to complete, due to the similarity of the 2 tasks.

Submission Requirements

The submission is expected to be:

A Github pull request on the RSKj repository
Note that if you are attempting both related bounties (“newPendingSubscriptions” and “syncing”), you have the choice between:
- attempting them separately, and submit as separate Github PRs on separate git branches, OR
- attempting them together, and submit as a single Github PR on a single git branch
Add tests that provide coverage for the new features added
Implement the features as described in the “challenge description” section
Add tests that provide coverage for the new features added

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.0161 RBTC (999.75 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,140,005.62 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 1 week, 6 days from now. Please review their action plans below:

1) qkyrie has started work.

Add Syncing To RSKj Eth_subscribe RPC Method 2) jamesrowe08 has started work.

Implementing RPC Subscribe methods 3) elmol has started work.

Add Syncing To RSKj Eth_subscribe RPC Method Implementation

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.0161 RBTC (914.17 USD @ $56915.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,136,270.13 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 for 0.0161 RBTC (863.88 USD @ $55249.0/RBTC) has been submitted by:

@elmol

@bguiz please take a look at the submitted work:

PR by @elmol

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,407,558.88 more funded OSS Work available on the Gitcoin Issue Explorer

jamesrowe08 commented 3 years ago

Not to bug, but any idea on when this will be resolved?

rsksmart / rsk-gitcoin-hackathon-2021