Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document developing extensions to interact with MetaMask #4577

Closed
danfinlay opened this issue Jun 14, 2018 · 27 comments
Closed

Document developing extensions to interact with MetaMask #4577

danfinlay opened this issue Jun 14, 2018 · 27 comments
Assignees
@danfinlay
Labels
area-documentation Issues relating to documentation, in the codebase and off. has bounty type-enhancement

Comments

@danfinlay
Copy link
Contributor

danfinlay commented Jun 14, 2018 •
edited
Loading

We added the ability to create other webextensions that request transactions from MetaMask in #3997, but we haven't yet documented this great new feature!

Since this will involve creating a port to the other extension, it's likely this will benefit from creating modules for our port-stream.js and inpage-provider.js modules, so consumers can just import those, but I'm not 100% sure they will fit perfectly.

Bounty criteria, in case an external contributor wants to accelerate progress:

  • Create a Medium-ready blog post (submit your medium ID so we can add you to the MetaMask publication, where you can submit the article under your own name).
  • Document how to create a web3 provider from another extension.
  • Minimize the code required for setup: Probably requires creating a new module! Maybe metamask-extension-provider. const provider = new MetaMaskExtensionProvider()?
  • Transfer ownership of this new module to the MetaMask team, who will publish it to npm.
@danfinlay danfinlay added type-enhancement area-documentation Issues relating to documentation, in the codebase and off. labels Jun 14, 2018
This was referenced Jun 18, 2018
Closed
Closed
@zgallagher08
Copy link

@danfinlay Referring to your comment above on June 14, will there be any documentation released on how to request transactions from MetaMask in other web extensions?

@danfinlay
Copy link
Contributor Author

Yes, that's what this documentation would involve. Right now this issue is a little bit too low a priority for the core team to be working on it, but we're eager to document it soon. An intrepid developer could take the tips above and construct a new provider based on our port-stream and stream-provider. Will post a bounty in case someone wants to do this sooner.

@gitcoinbot
Copy link

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

This issue now has a funding of 0.4 ETH (181.11 USD @ $452.78/ETH) attached to it.

@gitcoinbot
Copy link

gitcoinbot commented Jul 23, 2018 •
edited
Loading

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 month, 2 weeks ago.
Please review their action plans below:

1) writeprovidence has been approved to start work.

This project will definately give the platform to unleash my potential. I just hope and pray that i should be approved for this project thanks.

Learn more on the Gitcoin Issue Details page.

@gitcoinbot
Copy link

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

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

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

@writeprovidence
Copy link

writeprovidence commented Jul 27, 2018 via email

@writeprovidence
Copy link

@danfinla Medium ID: https://medium.com/@writeprovidence

@writeprovidence
Copy link

@danfinla pls notify me when am added you to the MetaMask publication. thanks waiting for response

@bdresser
Copy link
Contributor

@writeprovidence thanks! could you drop a link to the draft so we can review?

@writeprovidence
Copy link

ok

@writeprovidence
Copy link

hi @bdresser @danfinlay this is a link to the draft. pls review. thanks
https://medium.com/@writeprovidence/how-to-create-a-web3-provider-from-another-extension-6b5ea59ed4c9

@bdresser
Copy link
Contributor

bdresser commented Aug 2, 2018

thanks @writeprovidence, we'll get back to you early next week

@writeprovidence
Copy link

@bdresser thanks for your response.

@bdresser bdresser added this to the Sprint 08 [8.6 - 8.17] milestone Aug 6, 2018
@gitcoinbot
Copy link

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

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

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

@bdresser
Copy link
Contributor

bdresser commented Aug 8, 2018

ignore! ^ we'll get back shortly, sorry for the wait.

@writeprovidence
Copy link

ok

@writeprovidence
Copy link

still waiting.

@danfinlay
Copy link
Contributor Author

Hi @writeprovidence, sorry for the wait, I was out last week and only saw this now! Your article is great, does what it claims, thank you so much.

Next up:

  • I'm going to invite you to the MetaMask publication
  • I'm going to add some changes to the article to punch it up.

I'm happy paying out though, because we can just copy and paste this article already, you've done the hard part of figuring out what needs to be done.

Thanks so much! I'll be able to pay out this evening.

@writeprovidence
Copy link

writeprovidence commented Aug 8, 2018 via email

@danfinlay
Copy link
Contributor Author

@writeprovidence you'll need to submit your work on Gitcoin:
https://github.com/MetaMask/metamask-extension/issues/%7Babsolute_url%7D

Do you mind if we re-publish under our own names, so we can more freely edit the content? I think I'll wrap up some of it in a new module.

@gitcoinbot
Copy link

gitcoinbot commented Aug 9, 2018 •
edited
Loading

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

Work for 0.4 ETH (145.48 USD @ $363.7/ETH) has been submitted by:

  1. @writeprovidence
  2. @writeprovidence

@danfinlay please take a look at the submitted work:

@writeprovidence
Copy link

@Do you mind if we re-publish under our own names, so we can more freely edit the content? I think I'll wrap up some of it in a new module.

ofcourse you can re-publish it under your own names.

@writeprovidence
Copy link

hello@danfinlay i have submitted on gitcoin.

@writeprovidence
Copy link

hello@danfinlay, i have submitted the task on gitcoin as you instructed more than 7 days ago but have not heard from you since. is everything ok? pls reply thanks.

@danfinlay
Copy link
Contributor Author

Hi, sorry, I got behind on github notifications, I know this is really not ok, especially for a bounty. I'll be making bounty review one of my very regular daily activities now.

The bounty criteria had included minimizing code required, but it's ok, your example is good enough to allow me to begin development of that module.

Paying out now.

@gitcoinbot
Copy link

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

The funding of 0.4 ETH (114.77 USD @ $286.92/ETH) attached to this issue has been approved & issued to @writeprovidence.

@writeprovidence
Copy link

thanks@danfinlay

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danfinlay danfinlay

Labels
area-documentation Issues relating to documentation, in the codebase and off. has bounty type-enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@danfinlay @bdresser @zgallagher08 @gitcoinbot @writeprovidence and others