Metamask-extension: Document developing extensions to interact with MetaMask

Created on 14 Jun 2018  Â·  27Comments  Â·  Source: MetaMask/metamask-extension

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.
L05-documentation T01-enhancement has bounty

All 27 comments

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

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.

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.__

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.

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

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

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

yes am still on it. work in progress

On Fri, Jul 27, 2018 at 4:15 PM, Gitcoin.co Bot notifications@github.com
wrote:

@writeprovidence https://github.com/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
https://gitcoin.co/issue/MetaMask/metamask-extension/4577/854?snooze=1
| 3 days
https://gitcoin.co/issue/MetaMask/metamask-extension/4577/854?snooze=3
| 5 days
https://gitcoin.co/issue/MetaMask/metamask-extension/4577/854?snooze=5
| 10 days
https://gitcoin.co/issue/MetaMask/metamask-extension/4577/854?snooze=10
| 100 days
https://gitcoin.co/issue/MetaMask/metamask-extension/4577/854?snooze=100

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/MetaMask/metamask-extension/issues/4577#issuecomment-408467295,
or mute the thread
https://github.com/notifications/unsubscribe-auth/Ad6C1RsU3oHuH9MbTQcPuFIJ2y0N3A_Hks5uKzyogaJpZM4UoWiR
.

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

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

ok

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

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

@bdresser thanks for your response.

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

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

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

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

ok

still waiting.

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.

thanks so much @ Dan Finlay. am glad i was able to do something.
am waiting for the next step

On Thu, Aug 9, 2018 at 12:10 AM, Dan Finlay notifications@github.com
wrote:

Hi @writeprovidence https://github.com/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.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/MetaMask/metamask-extension/issues/4577#issuecomment-411582656,
or mute the thread
https://github.com/notifications/unsubscribe-auth/Ad6C1SgdCcldH2bBTOR8d7OANqC2YPAWks5uO2_UgaJpZM4UoWiR
.

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

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:

  • PR by @writeprovidence
  • PR by @writeprovidence

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

hello@danfinlay i have submitted on gitcoin.

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.

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.

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.__

Was this page helpful?
0 / 5 - 0 ratings

Related issues

kumavis picture kumavis  Â·  3Comments

danfinlay picture danfinlay  Â·  3Comments

bdresser picture bdresser  Â·  3Comments

estebanmino picture estebanmino  Â·  3Comments

MarkOSullivan94 picture MarkOSullivan94  Â·  3Comments