Audit type hints and expose types via PEP561

pipermerriam commented 5 years ago

What is wrong?

The library currently uses type hints, however they may be able to be tightened up.

In addition, PEP561 allows us to expose type hints from this library to other libraries which use it.

Definition of done?

Update mypy to the latest stable released version.
Update the mypy run in CI to the following.

mypy --follow-imports=silent --warn-unused-ignores --ignore-missing-imports --no-strict-optional --check-untyped-defs --disallow-incomplete-defs --disallow-untyped-defs --disallow-any-generics -p eth_keys`

Usage of type: ignore (silencing the type checker) is minimized and there's a reasonable explanation for its usage
Update the setup.py to expose this data to other libraries as was done here: https://github.com/ethereum/eth-typing/pull/10

Stretch goals

When this issue is done, stretch goals can be applied (and individually get funded) to tighten type support to qualify:

mypy --strict --follow-imports=silent --ignore-missing-imports --no-strict-optional -p eth_keys

Do what was done in https://github.com/ethereum/eth-typing/pull/10 to allow this data to be exposed when this library is installed as a package.

carver commented 5 years ago

blocked until #11 is complete

copypasta?

gitcoinbot commented 5 years ago

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

This issue now has a funding of 120.0 DAI (120.0 USD @ $1.0/DAI) 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 Slack
- $49,191.98 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 5 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 3 months, 3 weeks ago. Please review their action plans below:

1) dimitrivla has applied to start work _(Funders only: approve worker | reject worker)_.

I’ll view its contents, and review them. Look how it will progress.

Learn more on the Gitcoin Issue Details page.

2) bhargavasomu has been approved to start work.

I have already made a PR with completing the tasks mentioned, and waiting for a review.

Learn more on the Gitcoin Issue Details page.

pipermerriam commented 5 years ago

@6ug can be approved to work on this (but please get a pull request opened within the next day)

gitcoinbot commented 5 years ago

@6ug 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] warning (3 days)
[ ] escalation to mods (6 days)

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

gitcoinbot commented 5 years ago

@6ug 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] warning (3 days)
[ ] escalation to mods (6 days)

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

rmshea commented 5 years ago

Hey @pipermerriam, Ryan from Gitcoin checking in. Looks like @6ug sent over a PR for you to check out!

gitcoinbot commented 5 years ago

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

@6ug 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] warning (3 days)
[x] escalation to mods (6 days)

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

6ug commented 5 years ago

what does meaning of Escalated for Abandonment of Bounty, should I work for this issue?

pipermerriam commented 5 years ago

@6ug you're still clear to work on this, check your PR as I added a commit, rebased it and left a comment.

gitcoinbot commented 5 years ago

@6ug 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] warning (3 days)
[ ] escalation to mods (6 days)

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

gitcoinbot commented 5 years ago

@6ug 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] warning (3 days)
[ ] escalation to mods (6 days)

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

gitcoinbot commented 5 years ago

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

@6ug 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] warning (3 days)
[x] escalation to mods (6 days)

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

Bhargavasomu commented 5 years ago

As this issue has still been unresolved, I would like to work on this. @pipermerriam do I have the permission to go for it? @gitcoinbot could you please reopen this issue?

Bhargavasomu commented 5 years ago

@pipermerriam I have made the sufficient changes in #48. Please review the PR and we could close this issue and bounty.

gitcoinbot commented 5 years ago

@6ug 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] warning (3 days)
[ ] escalation to mods (6 days)

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

rmshea commented 5 years ago

Hey @pipermerriam and @Bhargavasomu, Ryan from Gitcoin here. Looks like 6ug has dropped out -- if you apply to the bounty @Bhargavasomu I'll approve you to work. From there, @pipermerriam can review #48 and close the bounty! Let me know if you have any questions :) 🌮

Bhargavasomu commented 5 years ago

@ryan-shea I have applied at gitcoin page, so please approve whenever you get the chance.

spm32 commented 5 years ago

@Bhargavasomu just approved you :)

gitcoinbot commented 5 years ago

@Bhargavasomu 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

Bhargavasomu commented 5 years ago

@gitcoinbot I have completed resolving the issue in PR #48, waiting for @pipermerriam to take a review on this.

pipermerriam commented 5 years ago

@gitcoinbot payment for this issue can be issued to @Bhargavasomu

@Bhargavasomu thanks for doing this.

spm32 commented 5 years ago

@pipermerriam Glad everything went well, @Bhargavasomu once you formally submit work I can pay you out :)

Bhargavasomu commented 5 years ago

@ceresstation @gitcoinbot I am not able to find an option to submit work in gitcoin page. Maybe this is because the status says Warned for Abandonment of Bounty. Could you please look into it and let me know what to do?

Bhargavasomu commented 5 years ago

Sorry for the multiple pings @ceresstation , but could you please check the gitcoin page status, as I am not able to submit my work. Thankyou

spm32 commented 5 years ago

No problem @Bhargavasomu, looking into this, will pay you out using advanced payout instead if the solution turns out to take a bit more time :)

owocki commented 5 years ago

@Bhargavasomu can u try now

Bhargavasomu commented 5 years ago

@owocki still I am not able to submit the work because the button is not highlighted. It is something like this. screenshot from 2018-11-14 14-35-38

spm32 commented 5 years ago

Hey @Bhargavasomu can you try again? Sorry!

owocki commented 5 years ago

just put in a fix for this @Bhargavasomu

gitcoinbot commented 5 years ago

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

Work for 120.0 DAI (120.0 USD @ $1.0/DAI) has been submitted by:

@bhargavasomu

@ceresstation please take a look at the submitted work:

PR by @Bhargavasomu

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
$45,535.70 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 5 years ago

⚡️ A *Fast Response* Kudos has been sent to @Bhargavasomu for this issue from @ceresstation. ⚡️ Nice work @Bhargavasomu! Your Kudos has automatically been sent in the ETH address we have on file.

gitcoinbot commented 5 years ago

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

The funding of 120.0 DAI (120.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @Bhargavasomu.

Learn more on the Gitcoin Issue Details page
- Questions? Checkout Gitcoin Help or the Gitcoin Slack
- $45,415.70 more funded OSS Work available on the Gitcoin Issue Explorer

spm32 commented 5 years ago

Hey @Bhargavasomu thanks for jumping on this so quickly after the other contributor dropped out, and thanks for bearing with us on the payout!

Bhargavasomu commented 5 years ago

@ceresstation thankyou.

ethereum / eth-keys