RIF Identity Email verified credentials

bguiz commented 3 years ago

RIF Identity Email verified credentials

Prize Bounty

0.01280 RBTC

(approximately 800 at time of posting)

Challenge Description

Users can currently use RIF Identity to store verified credentials (VCs). These VCs may be issued by VC issuers. This task is to integrate Email verification and SMS verification as VC issuers within RIF Identity Manager.

This bounty is only about “Email verification”. If you attempt this bounty, we suggest that you also attempt the other bounty about “SMS verification”, 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.

Integrate Email verification VC Issuer into RIF Identity Manager.
This already exists as a separate application, see: RIF Identity Email VC Issuer repository
Optional: If you have attempted both related bounties (email and SMS verifiers):
- Refactor these two VC issuers to use a “plugin” or “module” system.
- Provide basic documentation (a short README.md file will suffice) on how to add more “$X verifications VC Issuer” plugins/ modules, where $X may be any other communication tool.

Submission Requirements

A Github pull request on the RIF Identity Manager repository
Implement the features as described in the “challenge description” section
You may reuse the existing code within the RIF Identity Email VC Issuer repository, including a verbatim copy - this part of the task is viewed as a refactor effort.
Note that if you are attempting both related bounties (“Email verified credentials” and “SMS verified credentials”), 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
- In particular, you must include end-to-end tests related to external services (such as email or SMS), and include the appropriate stubs or mocks as necessary.

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.0128 RBTC (794.83 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,134,671.97 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.0128 RBTC (718.05 USD @ $56098.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,414,067.09 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 day, 10 hours from now. Please review their action plans below:

1) vmandal has started work.

Work submitted

Learn more on the Gitcoin Issue Details page.

ilanolkies commented 3 years ago

Hi @vmandal! Thanks a lot for your submissions!

We are working on a full review for them (https://github.com/vmandal/rif-issuer-server and https://github.com/rsksmart/rif-identity-manager/pull/78) but we need to point out an important issue asap, so you have some time to fix it.

As mentioned in the bounties #12 and #13, the objective was to use our existing Email vc issuer. It was required to do the integration of the Email Issuer into the Id Manager. We also recommend it to be used as the base for the SMS VC Issuer.

So, this initial feedback would be:

About #12: Use Email vc issuer server and codebase for the Integration into Id Mgr. URL is https://email-verifier-backend.identity.rifos.org
About #13: if not using the Email VC issuer as codebase, keep it in a separate repo named /sms-vc-issuer, but keep the interface and architecture consistent. Or, if you want to use the same repo and extend it, implement a new API in the same repo, add SMS functionality for verifying phone numbers and publish a PR.

Another important thing we found is that most of the code in the ID Manager is commented and wrongly organised. This cannot be merged into our prod codebase.

miltonwg commented 3 years ago

First important feedback for this submission posted on this issue

jessgusclark commented 3 years ago

Additional feedback regarding the SMS messaging not working left in this repo: https://github.com/vmandal/rif-issuer-server/issues/2

rsksmart / rsk-gitcoin-hackathon-2021