celo-monorepo icon indicating copy to clipboard operation
celo-monorepo copied to clipboard

[Bounty] Write a tutorial for interacting with on-chain phone number mappings

Open aslawson opened this issue 5 years ago • 33 comments

[Bounty] Write a tutorial for interacting with on-chain phone number mappings

Description

Decentralized identity is a big part of Celo and being able to understand phone mapping and how the Oblivious Decentralized Identifier Service (ODIS) works is critical for onboarding new developers and builders into our ecosystem. We are looking for a tutorial to be written on how to create a mapping using the protocol and read phone number mappings. The guide should include description and demonstrations of the following:

  • How to interact with ODIS in your dapp.
  • How to read phone number mappings and assert how many attestations the mapping has onchain.
  • Explanation of the heuristic used in SDK/Valora for what is considered "verified" (# of completed attestations, etc)
  • How to create new phone number mappings.
  • Explanation of how phone mapping can protect against SIM swaps.

Time expectation

Expect this bounty to take a developer 10-16 hours depending on the level of the initial understanding of Celo's identity protocol.

Knowledge Base

Bounty hunter will want to have a high-level understanding of the following areas (note resources below):

  • Valora
  • ODIS
  • Attestation Service

Resources

The high-level steps in creating the mapping are:

  1. Query ODIS to get an on-chain ID (see above)
  2. SetAccount
  3. RequestAttestations
  4. SelectIssuers
  5. Wait for randomness
  6. Request attestations
  7. Validate code received
  8. Complete an attestation

Example doc

The usage guide should look similar to our existing ODIS usage guide.

https://docs.celo.org/developer-guide/contractkit/odis

Submission Requirements

Ensure that the submission falls within the criteria outlined.

  • A clear tutorial that walks through the various steps outlined in the description.
  • A working demonstration of reading and writing phone number mappings. Please submit your open-source Github repo with your working code.
  • Present a short video on your project and have a README description.
  • Code will be reviewed by Celo engineers so please don't add anything malicious.
  • Due to the size of the payout, the submitter will be required to go through a KYC process before receiving payment.

Note that payments can take 2 weeks or more to process. The payout amount will be $500 equivalent of CELO at the time of submission.

What's next?

aslawson avatar Mar 11 '21 20:03 aslawson

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


This issue now has a funding of 135.0 CELO (504.9 USD @ $3.74/CELO) attached to it.

gitcoinbot avatar Mar 16 '21 14:03 gitcoinbot

@l-kh after reviewing your previous work I approved your request. Let me know if you have any questions about this, you can reach me on the Celo discord at https://chat.celo.org, joshc#2264. As mentioned in the bounty description, because of the payout amount, you will have to go through a KYC process. It is probably best to go through that process before you start work. Please reach out to me on discord or via email (josh at clabs.co) for those details.

critesjosh avatar Mar 16 '21 17:03 critesjosh

@l-kh I still haven't heard from you. If I don't hear from you I am going to stop work and allow someone else to start work.

critesjosh avatar Mar 18 '21 14:03 critesjosh

@L-KH I still haven't heard from you. If I don't hear from you I am going to stop work and allow someone else to start work.

Oh sorry about that, I check the docs, and seems I need a lot of time to complete it. if you the task soon please allow others to start work. I will check this bounty next 2week if no one complete it I will back working on it. THank you :)

L-KH avatar Mar 18 '21 18:03 L-KH

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


Work has been started.

These users each claimed they can complete the work by 265 years, 7 months from now. Please review their action plans below:

1) pensebien has been approved to start work.

I would love to look more deeply and write tutorials for on-chain phone number mappings. I write technical blog posts and explanation materials for deFIs and related projects. 2) ekorizki has applied to start work (Funders only: approve worker | reject worker).

How do you compete with other digital currencies?

Learn more on the Gitcoin Issue Details page.

gitcoinbot avatar Mar 27 '21 22:03 gitcoinbot

@pensebien and @ekorizki, can you please share a sample of technical writing you have done in the past? after reviewing I will approve one of you to start work.

critesjosh avatar Mar 29 '21 14:03 critesjosh

Approved @floar based on the provided writing sample. This tutorial should start from 0, but can link to other tutorials to help explain and demonstrate concepts necessary to understand this one.

critesjosh avatar Mar 29 '21 15:03 critesjosh

Hello Celo, I wrote a couple but one I have online is this https://docs.google.com/document/d/17QAovB7WxkVTgqkgeUJQ1H6WlEyyWDgtoNfLUOkgU4E/edit https://disrupt-africa.com/2018/06/22/how-ghanas-investxd-speeds-the-investment-process/ On Mon, Mar 29, 2021 at 10:20 AM Josh @.***> wrote:

@pensebien https://github.com/pensebien and @EkoRizki https://github.com/EkoRizki, can you please share a sample of technical writing you have done in the past? after reviewing I will approve one of you to start work.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-809418695, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKET7AJVCEOGYHQWZ33DTGCEEBANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar Mar 29 '21 19:03 pensebien

Hello Josh, I am familiarizing myself with celo by writing an article for the platform to help me integrate the system in the near future in my startup which would be a revamp of what we ran back in 2017.

On Mon, Mar 29, 2021 at 10:20 AM Josh @.***> wrote:

@pensebien https://github.com/pensebien and @EkoRizki https://github.com/EkoRizki, can you please share a sample of technical writing you have done in the past? after reviewing I will approve one of you to start work.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-809418695, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKET7AJVCEOGYHQWZ33DTGCEEBANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar Mar 29 '21 19:03 pensebien

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar Apr 01 '21 16:04 gitcoinbot

Hey just checking in: I have done quite a bit of preparation already, but as by Josh's email from 30.03 are currently awaiting the final result for KYC procedure.

floAr avatar Apr 01 '21 16:04 floAr

@floAr just confirming here as well that you are good to continue working on this

critesjosh avatar Apr 05 '21 21:04 critesjosh

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar Apr 10 '21 16:04 gitcoinbot

Sorry but I have to retract my commitment for the time being. Personal life got in the way and I don't want to block this for you for the next two weeks at least. So happy to hand this over to someone else. Sorry for the inconvenience!

floAr avatar Apr 10 '21 17:04 floAr

Hello Florian, I would love to take over the work if you are disponible.

On Sat, Apr 10, 2021 at 1:24 PM Florian Uhde @.***> wrote:

Sorry but I have to retract my commitment for the time being. Personal life got in the way and I don't want to block this for you for the next two weeks at least. So happy to hand this over to someone else. Sorry for the inconvenience!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-817174500, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKEWF5YOGPKCP5ZBW52LTICCVBANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar Apr 11 '21 13:04 pensebien

@floAr thanks for letting me know.

@pensebien do you have any technical writing samples that you can share? @L-KH checking if you are interested in this bounty.

critesjosh avatar Apr 13 '21 17:04 critesjosh

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar Apr 30 '21 16:04 gitcoinbot

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar Apr 30 '21 16:04 gitcoinbot

I am still working on this issue.

On Fri, Apr 30, 2021 at 12:15 PM Gitcoin.co Bot @.***> wrote:

@pensebien https://github.com/pensebien 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!

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

Funders only: Snooze warnings for 1 day https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=1 | 3 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=3 | 5 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=5 | 10 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=10 | 100 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=100

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-830204462, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKES6MJV6ARNYTNHV753TLLJTZANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar Apr 30 '21 16:04 pensebien

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar May 09 '21 16:05 gitcoinbot

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar May 09 '21 16:05 gitcoinbot

I would love to submit a PR the first draft I have.

pensebien avatar May 09 '21 17:05 pensebien

I would love to submit a PR the first draft I have.

Please do!

critesjosh avatar May 13 '21 23:05 critesjosh

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

  • [x] reminder (3 days)
  • [ ] escalation to mods (6 days)

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

gitcoinbot avatar May 18 '21 16:05 gitcoinbot

@pensebien do you have a draft to share?

critesjosh avatar May 19 '21 16:05 critesjosh

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


@pensebien due to inactivity, we have escalated this issue to Gitcoin's moderation team. Let us know if you believe this has been done in error!

  • [x] reminder (3 days)
  • [x] escalation to mods (6 days)

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

gitcoinbot avatar May 21 '21 16:05 gitcoinbot

Hello Here is a draft

On Fri, May 21, 2021 at 12:15 PM Gitcoin.co Bot @.***> wrote:

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

@pensebien https://github.com/pensebien due to inactivity, we have escalated this issue https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162 to Gitcoin's moderation team. Let us know if you believe this has been done in error!

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

Funders only: Snooze warnings for 1 day https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=1 | 3 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=3 | 5 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=5 | 10 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=10 | 100 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=100

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-846074535, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKEWOERXEY5WHYRPIXX3TO2BLNANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar May 21 '21 22:05 pensebien

https://docs.google.com/document/d/1bujGoVOuh1g_MA9cyxzr2sqyFsWUi6lRIsbtjj29abE/edit?usp=sharing

On Fri, May 21, 2021 at 6:12 PM Awokoya Emma @.***> wrote:

Hello Here is a draft

On Fri, May 21, 2021 at 12:15 PM Gitcoin.co Bot @.***> wrote:

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

@pensebien https://github.com/pensebien due to inactivity, we have escalated this issue https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162 to Gitcoin's moderation team. Let us know if you believe this has been done in error!

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

Funders only: Snooze warnings for 1 day https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=1 | 3 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=3 | 5 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=5 | 10 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=10 | 100 days https://gitcoin.co/issue/celo-org/celo-monorepo/7419/100025162?snooze=100

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-846074535, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKEWOERXEY5WHYRPIXX3TO2BLNANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar May 21 '21 22:05 pensebien

@pensebien I requested comment access to the doc.

critesjosh avatar May 26 '21 14:05 critesjosh

What email should I use for your Josh?

On Wed, May 26, 2021 at 10:54 AM Josh @.***> wrote:

@pensebien https://github.com/pensebien I requested comment access to the doc.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/celo-org/celo-monorepo/issues/7419#issuecomment-848838454, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4AKEWQTWC6MNKFURQWHFLTPUDTHANCNFSM4ZA7SADQ .

--

Kind Regards,

Akin-Awokoya Emmanuel

Data/Telecommunication Network Engineer and Web/Content Developer

Member IEEE, NSE, ISOC, CTO, DSA, ICANN

Interested in volunteerism, project research

Startups, opendatamining, open data research

TVWhitespace technology

I can be on the next boat, next ship, next plane, next bus as long as where I am going I could

help someone have a better access and create local contents on the Internet.

@.*** https://twitter.com/penseBien*

Facebook: emma.awokoya

Linkedin: EmmaAwokoya https://ng.linkedin.com/in/emmaawokoya

Skype: pensebientoi

pensebien avatar May 26 '21 14:05 pensebien