EIP-1102: Opt-in provider access #4703

bitpshr · 2018-07-02T03:09:48Z

This pull request includes a fully-updated EIP-1102 implementation:

Provider is exposed at window.ethereum
Provider is populated with no accounts by default
Provider exposes Promise-returning enable method
Calling enable shows user approval UI
User approval resolves Promise and populates provider with accounts
User reject rejects Promise with error message
Users have the option to disable privacy mode

Note: This pull request depends on MetaMask/eth-json-rpc-middleware#5.

Required next steps

Decide on rollout date (11/02)
Publish blog post (https://goo.gl/PCvxuY)
Update web3 deprecation message (EIP-1102: Add deprecation message #5353)
Release transitionary API (EIP-1102: Transitionary API #5256)
Add privacy mode user setting (eed9d39)
Release new FAQ documentation
Release changes

Example detection code

https://gist.github.com/bitpshr/076b164843f0414077164fe7fe3278d9

Blog post

https://medium.com/metamask/https-medium-com-metamask-breaking-change-injecting-web3-7722797916a8

Example

Cached domain approval

Resolves #3930
Refs #714

danfinlay · 2018-07-03T18:52:18Z

For sites that currently rely on web3:

Should we provide a method for users to force-inject web3?
Should we issue a blog post about this breaking change? (almost definitely, needs author)
Should we give developers a period of time to read the blog post, and add this line of code to their sites?

danfinlay

This looks great. I added a few comments, none very blocking (although restoring e2e tests is important).

The biggest thing for me that we need to do is decisively agree on when to cut over to this. I suspect we need some of the strongest dapp-dev communication we've ever employed for this, because it will instantly break every dapp out there until they add at least one line of JS to their code.

The good news is this one line is so easy. We should tweet it out. We should get people adding it to their dapps ASAP.

danfinlay · 2018-07-03T19:04:54Z

app/_locales/en/messages.json

+    "message": "Please review this web3 API request."
+  },
+  "web3RequestInfo": {
+    "message": "The domain listed below is attempting to request access to the web3 API so it can interact with the Ethereum blockchain. Always double check that you're on the correct site before approving web3 access."


I bet we could punch this up a bit, we might want to workshop it.

I'm fine with the current draft for now. Might be worth discussing in the design meeting. @cjeria?

One pass:

The domain listed below is requesting access to the web3 API so it can interact with the Ethereum blockchain and view your current account. Always double check that you're on the correct site before approving web3 access.

danfinlay · 2018-07-03T19:06:06Z

app/scripts/metamask-controller.js

+   */
+  handleWeb3Request (requestedOrigin) {
+    const { openPopup } = this.opts
+    this.memStore.updateState({ pendingWeb3Requests: [requestedOrigin] })


Probably worth moving into its own controller long-term. Non-blocking, this works for MVP.

danfinlay · 2018-07-03T19:08:41Z

test/e2e/metamask.spec.js

-      assert.equal(await tokenBalance.getText(), '100 TST')
-    })
-  })
+  // describe('Token Factory', function () {


Would prefer to include the injection request as part of the e2e tests. Maybe @tmashuang could take a pass at this?

danfinlay · 2018-07-03T19:14:37Z

For consistency:

I notice EIP 1102 names its message 'ETHEREUM_PROVIDER_REQUEST', and here we have 'WEB3_API_REQUEST'.

I think we should maintain consistency between the two.

danfinlay · 2018-07-03T21:57:30Z

It might also make sense to add our usual titlebar to this window, with the logo and the name "MetaMask", just to help clarify to the user who is asking.

bitpshr · 2018-07-04T23:31:43Z

@danfinlay thanks for the review. I took care of all feedback except for adding the titlebar to the approval popup window. Since the popup isn't network-specific, the main function of the titlebar would only be to hold a logo. I agree that a logo would help inform users, but I feel that we should stay consistent with how we also brand transaction approval popups (at least for this PR.)

Updates to this PR:

Conforms to the latest updates to EIP-1102
Approval logic extracted into standalone controller
Approval verbiage updated accordingly

What this PR means to dapps:

A provider is injected globally as ETHEREUM_PROVIDER.
Dapp reload on network change is no longer implemented.
We no longer set defaultAddress, only accounts.

Release comments:

Agreed, we should author a blog post including relevant code.
Agreed, a (1 month?) grace period seems sufficient and necessary.
I think we should also be very proactive with other browser teams.

This is going to be a jarring change for dapp developers. MetaMask and other Ethereum-enabled DOM environments are unique in that it's difficult to version changes: extensions (and desktop applications) are usually evergreen, meaning that once a feature is released, downstream users can't selectively pick up that feature as they could if this were, say, an NPM module that could be versioned as downstream projects see fit. Still, it's an extremely necessary change for security purposes. I feel that a sufficient explanation, hand-holding via example code, a lengthy grace period, and buy-in from other dapp browsers will go a long way with our active developer base. I'm happy to author the relevant blog post(s) and to spread awareness throughout the community.

Edit: Ah, forgot e2e tests. Need to trigger postMessage calls using webdriver so we can re-enable all disabled tests. We need to use executeScript but I need to check the correct syntax and API. Will update shortly.

TrejGun · 2018-07-05T08:55:11Z

app/_locales/ru/messages.json

+    "message": "Одобрить"
+  },
+  "reject": {
+    "message": "отклонять"


Отклонить

TrejGun · 2018-07-05T08:55:51Z

app/_locales/ru/messages.json

+    "message": "Просмотрите этот запрос API web3."
+  },
+  "providerRequestInfo": {
+    "message": "Домен, указанный ниже, пытается запросить доступ к API-интерфейсу web3, чтобы он мог взаимодействовать с блок-цепочкой Ethereum. Всегда проверяйте, что вы находитесь на правильном сайте, прежде чем одобрять доступ к веб-сайту."


Домен, указанный ниже, пытается запросить доступ к API-интерфейсу web3, чтобы он мог взаимодействовать с блокчейном Ethereum. Всегда проверяйте, что вы находитесь на правильном сайте, прежде чем одобрять доступ к веб-сайту.

bdresser · 2018-07-09T16:40:10Z

Should we provide a method for users to force-inject web3?

Seems like a good idea - do we need design for this?

cjeria · 2018-07-09T17:40:09Z

@bdresser @bitpshr I definitely think this needs design. It shouldn't block progress, but this will ultimately need design.

bdresser · 2018-07-09T19:59:40Z

@cjeria opened #4759 to discuss ^

wbt · 2018-11-05T19:11:44Z

@Grsmto It would also be nice to see the blog post linked to from the console warning updated. The current released version doesn't even have the privacy mode option to ease testing, and the public statements still remain that instead of a phased roll-out it'll be an all-of-a-sudden change applying to everyone by default, to take effect on a now-passed date.

I've already heard some devs say that their dapp is continuing to function fine well after that announced change date, so they must be done and not have anything more to worry about (moving on to the next order of business now...) when the dapp is definitely NOT ready. Updating the blog post with a revised timeline or note that it's on indefinite hold, and noting that once the privacy mode setting is released it'll be off by default for a while to permit dapp changes and testing (hoping that's true!) would be very helpful. Also, devs who did integrate the needed changes early are getting burned by last-minute breaking changes in the breaking change, underscoring the incentive to wait until MetaMask has decided and implemented how this new behavior will work.

derrickpelletier · 2018-11-05T19:33:23Z

Bug in latest build:

Metamask state: Locked, Privacy mode OFF

run window.ethereum.enable().
MM shows locked popup
enter password
MM shows "connect" screen.

My understanding is that this screen should not be seen if the user has not opted in.
If MM is unlocked, and I run .enable() it does not show the connect screen.

metamaskbot · 2018-11-05T19:37:46Z

Builds ready [1bc8ec7]: mascara, chrome, firefox, edge, opera

bdresser · 2018-11-05T19:40:23Z

@Grsmto @wbt this feature will be released in 4.18 today or tomorrow morning. Ironing out some last kinks, thanks for your patience!

@derrickpelletier see #5679

metamaskbot · 2018-11-05T19:40:33Z

Builds ready [a3ad59f]: mascara, chrome, firefox, edge, opera

danfinlay · 2018-11-05T19:46:35Z

Thanks for the report, @derrickpelletier, I actually just found this too, discussing/fixing here: #5679

wbt · 2018-11-05T19:58:21Z

@bdresser When Privacy Mode is added as an option, is it going to be on by default (per description in the public blog post) or off by default (per responses to @hayesgm above) to allow developers to adapt their dapps based on what the actual implementation is, as the adaptation actually needed has apparently been changing quickly within the past few days?

I would highly recommend updating the blog post about what's happening, without waiting for the PR to be merged!

Thanks for supporting better privacy.

bdresser · 2018-11-05T20:08:44Z

@wbt the blog post states

On November 2nd, 2018, MetaMask plans to release these changes with “privacy mode” disabled by default. This option will eventually be enabled by default in a future release.

The wording in the subtitle could have been misinterpreted; I've updated it to clarify 😄

filips123 · 2018-11-05T20:24:18Z

Could you make a new blog post when this will be final?

wbt · 2018-11-05T20:36:32Z

@bdresser As far as what I'm seeing, the subtitle says, emphasis added:

On November 2nd, MetaMask and other dapp browsers will stop universally exposing user accounts. Instead, dapps must request access using a new provider method: provider.enable().

How about:

On or after November 6th, MetaMask will be updated with an off-by-default "privacy mode" that requires an extra step to ask user permissions before accounts are exposed to dapps. Dapp developers should update their code to support this privacy-protecting feature, which will be enabled by default in the future.

filips123 · 2018-11-23T19:26:48Z

@bitpshr What is website doesn't request or user rejects request? Will website have access to network (for example watching blocks, getting other addresses, interacting with contracts) but without user accounts?

bitpshr · 2018-11-25T17:42:31Z

Hi @filips123. Yes, your understanding is correct: dapps can only initiate RPC calls that don't require user accounts until account access is approved.

whymarrh · 2019-11-26T13:35:30Z

Please open up new issues for related topics and questions

bitpshr requested review from kumavis, danfinlay, danjm and whymarrh July 2, 2018 14:03

bitpshr force-pushed the eip-1102 branch 2 times, most recently from a05b070 to ef27fe9 Compare July 3, 2018 18:07

danfinlay reviewed Jul 3, 2018

View reviewed changes

bitpshr force-pushed the eip-1102 branch from ef27fe9 to b3cfdb3 Compare July 3, 2018 19:33

TrejGun suggested changes Jul 5, 2018

View reviewed changes

bdresser mentioned this pull request Jul 9, 2018

Allow user to force-inject web3 #4759

Closed

bdresser mentioned this pull request Jul 9, 2018

Design for web3 opt-in dialog #4761

Closed

bitpshr force-pushed the eip-1102 branch 9 times, most recently from 43e8583 to fa1192d Compare July 11, 2018 16:25

danfinlay mentioned this pull request Jul 12, 2018

Stop reload on network change #4558

Merged

bitpshr force-pushed the eip-1102 branch from e6d267a to 2812956 Compare July 13, 2018 18:45

bitpshr changed the title ~~Initial opt-in web3 access (EIP-1102)~~ EIP-1102: Opt-in provider access Jul 15, 2018

joelamouche mentioned this pull request Nov 5, 2018

New MetaMask 'enable' doesn't trigger any effect on Chrome #5676

Closed

whymarrh added 2 commits November 5, 2018 14:20

Update "Learn more" link on 1102 connect screen (#5677)

1bc8ec7

Update the colour of the default image used on Connect Request (#5678)

a3ad59f

whymarrh approved these changes Nov 5, 2018

View reviewed changes

derrickpelletier mentioned this pull request Nov 5, 2018

In EIP 1120 build, closing "connect" screen via window controls hangs .enable() promise #5680

Closed

bitpshr mentioned this pull request Nov 5, 2018

Small bug with .enable() with privacy mode off. #5679

Closed

JaceHensley mentioned this pull request Nov 5, 2018

Script tags added continuously added to <head> #5683

Closed

danfinlay merged commit f692123 into develop Nov 5, 2018

danfinlay deleted the eip-1102 branch November 5, 2018 23:08

ya7ya mentioned this pull request Nov 6, 2018

[READY] implementing metmask privacy mode handler livepeer/livepeer-monorepo#252

Merged

4 tasks

bitpshr mentioned this pull request Nov 8, 2018

ethereum.enable never returns when user closes login prompt. #5702

Closed

medied mentioned this pull request Nov 8, 2018

handle privacy mode metamask update DemocracyEarth/wallet#412

Merged

bdresser removed the DO-NOT-MERGE Pull requests that should not be merged label Nov 19, 2018

bdresser mentioned this pull request Nov 19, 2018

privacy: option to enable injection on per-site basis #2888

Closed

ghost mentioned this pull request Jan 3, 2019

Be signed out per domain until signing in #714

Closed

whymarrh mentioned this pull request Aug 14, 2019

Connections settings tab #7013

Merged

4 tasks

MetaMask locked as resolved and limited conversation to collaborators Nov 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EIP-1102: Opt-in provider access #4703

EIP-1102: Opt-in provider access #4703

bitpshr commented Jul 2, 2018 •

edited

Loading

danfinlay commented Jul 3, 2018

danfinlay left a comment

danfinlay Jul 3, 2018

danfinlay Jul 3, 2018

danfinlay Jul 3, 2018

danfinlay commented Jul 3, 2018

danfinlay commented Jul 3, 2018

bitpshr commented Jul 4, 2018 •

edited

Loading

TrejGun Jul 5, 2018

TrejGun Jul 5, 2018

bdresser commented Jul 9, 2018

cjeria commented Jul 9, 2018

bdresser commented Jul 9, 2018

wbt commented Nov 5, 2018 •

edited

Loading

derrickpelletier commented Nov 5, 2018

metamaskbot commented Nov 5, 2018

bdresser commented Nov 5, 2018

metamaskbot commented Nov 5, 2018

danfinlay commented Nov 5, 2018

wbt commented Nov 5, 2018 •

edited

Loading

bdresser commented Nov 5, 2018

filips123 commented Nov 5, 2018

wbt commented Nov 5, 2018

filips123 commented Nov 23, 2018

bitpshr commented Nov 25, 2018

whymarrh commented Nov 26, 2019

EIP-1102: Opt-in provider access #4703

EIP-1102: Opt-in provider access #4703

Conversation

bitpshr commented Jul 2, 2018 • edited Loading

Required next steps

Example detection code

Blog post

Example

Cached domain approval

danfinlay commented Jul 3, 2018

danfinlay left a comment

Choose a reason for hiding this comment

danfinlay Jul 3, 2018

Choose a reason for hiding this comment

danfinlay Jul 3, 2018

Choose a reason for hiding this comment

danfinlay Jul 3, 2018

Choose a reason for hiding this comment

danfinlay commented Jul 3, 2018

danfinlay commented Jul 3, 2018

bitpshr commented Jul 4, 2018 • edited Loading

TrejGun Jul 5, 2018

Choose a reason for hiding this comment

TrejGun Jul 5, 2018

Choose a reason for hiding this comment

bdresser commented Jul 9, 2018

cjeria commented Jul 9, 2018

bdresser commented Jul 9, 2018

wbt commented Nov 5, 2018 • edited Loading

derrickpelletier commented Nov 5, 2018

metamaskbot commented Nov 5, 2018

bdresser commented Nov 5, 2018

metamaskbot commented Nov 5, 2018

danfinlay commented Nov 5, 2018

wbt commented Nov 5, 2018 • edited Loading

bdresser commented Nov 5, 2018

filips123 commented Nov 5, 2018

wbt commented Nov 5, 2018

filips123 commented Nov 23, 2018

bitpshr commented Nov 25, 2018

whymarrh commented Nov 26, 2019

bitpshr commented Jul 2, 2018 •

edited

Loading

bitpshr commented Jul 4, 2018 •

edited

Loading

wbt commented Nov 5, 2018 •

edited

Loading

wbt commented Nov 5, 2018 •

edited

Loading