add accountsChange notification to inpage provider

move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)

.circleci/config.yml

@@ -54,8 +54,8 @@ workflows:
             - test-unit
             - test-unit-global
             - test-mozilla-lint
-            # - test-e2e-chrome
-            # - test-e2e-firefox
+            - test-e2e-chrome
+            - test-e2e-firefox
             - test-integration-flat-chrome
             - test-integration-flat-firefox
       - job-publish-prerelease:
@@ -72,9 +72,9 @@ workflows:
             - prep-build
       #       - prep-docs
             - all-tests-pass
-      # - coveralls-upload:
-      #     requires:
-      #       - test-unit
+      - coveralls-upload:
+          requires:
+            - test-unit
 
 jobs:
   create_release_pull_request:

app/scripts/contentscript.js

@@ -20,7 +20,7 @@ const inpageBundle = inpageContent + inpageSuffix
 // If we create a FireFox-only code path using that API,
 // MetaMask will be much faster loading and performant on Firefox.
 
-if (shouldInjectWeb3()) {
+if (shouldInjectProvider()) {
   injectScript(inpageBundle)
   start()
 }
@@ -39,7 +39,7 @@ function injectScript (content) {
     container.insertBefore(scriptTag, container.children[0])
     container.removeChild(scriptTag)
   } catch (e) {
-    console.error('MetaMask script injection failed', e)
+    console.error('MetaMask provider injection failed.', e)
   }
 }
 
@@ -159,11 +159,11 @@ function logStreamDisconnectWarning (remoteLabel, err) {
 }
 
 /**
- * Determines if Web3 should be injected
+ * Determines if the provider should be injected
  *
- * @returns {boolean} {@code true} if Web3 should be injected
+ * @returns {boolean} {@code true} if the provider should be injected
  */
-function shouldInjectWeb3 () {
+function shouldInjectProvider () {
   return doctypeCheck() && suffixCheck() &&
     documentElementCheck() && !blacklistedDomainCheck()
 }
@@ -186,8 +186,8 @@ function doctypeCheck () {
  * Returns whether or not the extension (suffix) of the current document is prohibited
  *
  * This checks {@code window.location.pathname} against a set of file extensions
- * that should not have web3 injected into them. This check is indifferent of query parameters
- * in the location.
+ * that we should not inject the provider into. This check is indifferent of
+ * query parameters in the location.
  *
  * @returns {boolean} whether or not the extension of the current document is prohibited
  */

app/scripts/controllers/permissions/index.js

@@ -19,12 +19,13 @@ const WALLET_METHOD_PREFIX = 'wallet_'
 const CAVEAT_NAMES = {
   exposedAccounts: 'exposedAccounts',
 }
+const ACCOUNTS_CHANGED_NOTIFICATION = 'wallet_accountsChanged'
 
 class PermissionsController {
 
   constructor (
     {
-      openPopup, closePopup, notifyDomain, notifyAllDomains, keyringController
+      openPopup, closePopup, notifyDomain, notifyAllDomains, keyringController,
     } = {},
     restoredPermissions = {},
     restoredState = {}) {
@@ -141,7 +142,10 @@ class PermissionsController {
       origin, 'eth_accounts', CAVEAT_NAMES.exposedAccounts, accounts
     )
 
-    this.notifyDomain(origin, 'accountsChanged', accounts)
+    this.notifyDomain(origin, {
+      method: ACCOUNTS_CHANGED_NOTIFICATION,
+      result: accounts,
+    })
   }
 
   /**
@@ -212,7 +216,10 @@ class PermissionsController {
         perms.map(methodName => {
 
           if (methodName === 'eth_accounts') {
-            this.notifyDomain(origin, 'accountsChanged', [])
+            this.notifyDomain(
+              origin,
+              { method: ACCOUNTS_CHANGED_NOTIFICATION, result: [] }
+            )
           }
 
           return { parentCapability: methodName }
@@ -249,7 +256,10 @@ class PermissionsController {
    */
   clearPermissions () {
     this.permissions.clearDomains()
-    this.notifyAllDomains('accountsChanged', [])
+    this.notifyAllDomains({
+      method: ACCOUNTS_CHANGED_NOTIFICATION,
+      result: [],
+    })
   }
 
   /**

app/scripts/controllers/permissions/permissions-safe-methods.json

@@ -5,6 +5,7 @@
   "net_version",
   "eth_blockNumber",
   "eth_call",
+  "eth_chainId",
   "eth_coinbase",
   "eth_estimateGas",
   "eth_gasPrice",

app/scripts/controllers/transactions/index.js

@@ -191,11 +191,11 @@ class TransactionController extends EventEmitter {
     // validate
     const normalizedTxParams = txUtils.normalizeTxParams(txParams)
 
-    // TODO:lps once, I saw origin with a value of 'chrome-extension://...' for a
-    // transaction initiated from the UI.
+    // TODO:lps once, I saw 'origin' with a value of 'chrome-extension://...'
+    // for a transaction initiated from the UI.
     // When would this happen? It's a problem if it does. I don't think we want to
     // hard-code 'chrome-extension://' here
-    if (origin === 'MetaMask') {
+    if (origin === 'metamask') {
       // Assert the from address is the selected address
       if (normalizedTxParams.from !== this.getSelectedAddress()) {
         throw ethErrors.rpc.internal(`Internally initiated transaction is using invalid account.`)

app/scripts/inpage.js

@@ -31,16 +31,14 @@ const restoreContextAfterImports = () => {
 }
 
 cleanContextForImports()
-require('web3/dist/web3.min.js')
+
 const log = require('loglevel')
 const LocalMessageDuplexStream = require('post-message-stream')
-const setupDappAutoReload = require('./lib/auto-reload.js')
 const MetamaskInpageProvider = require('metamask-inpage-provider')
-const ObjectMultiplex = require('obj-multiplex')
-const pump = require('pump')
-const promisify = require('pify')
 
-let warned = false
+// TODO:deprecate:2019-12-16
+require('web3/dist/web3.min.js')
+const setupDappAutoReload = require('./lib/auto-reload.js')
 
 restoreContextAfterImports()
 
@@ -62,71 +60,9 @@ const inpageProvider = new MetamaskInpageProvider(metamaskStream)
 // set a high max listener count to avoid unnecesary warnings
 inpageProvider.setMaxListeners(100)
 
-const pageMux = new ObjectMultiplex()
-const onboardingStream = pageMux.createStream('onboarding')
-pump(
-  pageMux,
-  metamaskStream,
-  error => log.error('MetaMask muxed in-page traffic failed', error)
-)
-
-
-// give the dapps control of a refresh they can toggle this off on the window.ethereum
-// this will be default true so it does not break any old apps.
-inpageProvider.autoRefreshOnNetworkChange = true
-
-// publicConfig isn't populated until we get a message from background.
-// Using this getter will ensure the state is available
-const getPublicConfigWhenReady = async () => {
-  const store = inpageProvider.publicConfigStore
-  let state = store.getState()
-  // if state is missing, wait for first update
-  if (!state.hasOwnProperty('isUnlocked')) {
-    state = await new Promise(resolve => store.once('update', resolve))
-  }
-  return state
-}
-
-// add metamask-specific convenience methods
-inpageProvider._metamask = new Proxy({
-
-  /**
-   * Determines if MetaMask is unlocked by the user
-   *
-   * @returns {Promise<boolean>} - Promise resolving to true if MetaMask is currently unlocked
-   */
-  isUnlocked: async function () {
-    const { isUnlocked } = await getPublicConfigWhenReady()
-    return Boolean(isUnlocked)
-  },
-
-  /**
-   * WILL BE DEPRECATED.
-   * Asynchronously determines if this domain is currently enabled.
-   *
-   * @returns {Promise<boolean>} - Promise resolving to true if this domain is currently enabled
-   */
-  isApproved: async function () {
-    return Boolean(inpageProvider.selectedAddress)
-  },
-
-  /**
-   * Registers a page as having initated onboarding. This facilitates MetaMask focusing the initiating tab after onboarding.
-   *
-   * @returns {Promise} - Promise resolving to undefined
-   */
-  registerOnboarding: async () => {
-    await promisify(onboardingStream.write({ type: 'registerOnboarding' }))
-  },
-}, {
-  get: function (obj, prop) {
-    !warned && console.warn('Heads up! ethereum._metamask exposes methods that have ' +
-    'not been standardized yet. This means that these methods may not be implemented ' +
-    'in other dapp browsers and may be removed from MetaMask in the future.')
-    warned = true
-    return obj[prop]
-  },
-})
+//
+// TODO:deprecate:2019-12-16
+//
 
 // Work around for web3@1.0 deleting the bound `sendAsync` but not the unbound
 // `sendAsync` method on the prototype, causing `this` reference issues
@@ -136,11 +72,7 @@ const proxiedInpageProvider = new Proxy(inpageProvider, {
   deleteProperty: () => true,
 })
 
-window.ethereum = proxiedInpageProvider
-
-//
 // setup web3
-//
 
 if (typeof window.web3 !== 'undefined') {
   throw new Error(`MetaMask detected another web3.
@@ -157,3 +89,9 @@ web3.setProvider = function () {
 log.debug('MetaMask - injected web3')
 
 setupDappAutoReload(web3, inpageProvider.publicConfigStore)
+
+//
+// end deprecate:2019-12-16
+//
+
+window.ethereum = proxiedInpageProvider

app/scripts/lib/auto-reload.js

@@ -1,3 +1,6 @@
+
+// TODO:deprecate:2019-12-16
+
 module.exports = setupDappAutoReload
 
 function setupDappAutoReload (web3, observable) {

app/scripts/metamask-controller.js

@@ -295,7 +295,6 @@ module.exports = class MetamaskController extends EventEmitter {
       CachedBalancesController: this.cachedBalancesController.store,
       OnboardingController: this.onboardingController.store,
       IncomingTransactionsController: this.incomingTransactionsController.store,
-      ThreeBoxController: this.threeBoxController.store,
       ABTestController: this.abTestController.store,
       PermissionsController: this.permissionsController.permissions,
       PermissionsMetadata: this.permissionsController.store,
@@ -1425,6 +1424,7 @@ module.exports = class MetamaskController extends EventEmitter {
    * @param {object} publicApi - The public API
    */
   setupProviderConnection (outStream, senderUrl, extensionId) {
+    const origin = senderUrl.hostname
     const engine = this.setupProviderEngine(senderUrl, extensionId)
 
     // setup connection
@@ -1552,7 +1552,7 @@ module.exports = class MetamaskController extends EventEmitter {
   }
 
   /**
-   * Adds a reference to a connection by origin. Ignores the 'MetaMask' origin.
+   * Adds a reference to a connection by origin. Ignores the 'metamask' origin.
    * Caller must ensure that the returned id is stored such that the reference
    * can be deleted later.
    *
@@ -1563,7 +1563,7 @@ module.exports = class MetamaskController extends EventEmitter {
    */
   addConnection (origin, { engine }) {
 
-    if (origin === 'MetaMask') {
+    if (origin === 'metamask') {
       return null
     }
 
@@ -1588,54 +1588,53 @@ module.exports = class MetamaskController extends EventEmitter {
    */
   removeConnection (origin, id) {
 
-    if (!this.connections[origin]) {
+    const connections = this.connections[origin]
+    if (!connections) {
       return
     }
 
-    delete this.connections[origin][id]
+    delete connections[id]
 
-    if (Object.keys(this.connections[origin].length === 0)) {
+    if (Object.keys(connections.length === 0)) {
       delete this.connections[origin]
     }
   }
 
   /**
    * Causes the RPC engines associated with the connections to the given origin
-   * to emit an event with the given name and payload.
+   * to emit a notification event with the given payload.
    * Ignores unknown origins.
    *
    * @param {string} origin - The connection's origin string.
-   * @param {string} eventName - The name of the event to emit.
    * @param {any} payload - The event payload.
    */
-  notifyConnections (origin, eventName, payload) {
+  notifyConnections (origin, payload) {
 
-    if (!this.connections[origin]) {
+    const connections = this.connections[origin]
+    if (!connections) {
       return
     }
 
-    Object.values(this.connections[origin]).forEach(conn => {
-      conn.engine && conn.engine.emit(eventName, payload)
+    Object.values(connections).forEach(conn => {
+      conn.engine && conn.engine.emit('notification', payload)
     })
   }
 
   /**
-   * Causes the RPC engines associated with all connections to emit an event
-   * with the given name and payload.
+   * Causes the RPC engines associated with all connections to emit a
+   * notification event with the given payload.
    *
-   * @param {string} eventName - The name of the event to emit.
    * @param {any} payload - The event payload.
    */
-  notifyAllConnections (eventName, payload) {
+  notifyAllConnections (payload) {
 
     Object.values(this.connections).forEach(origin => {
       Object.values(origin).forEach(conn => {
-        conn.engine && conn.engine.emit(eventName, payload)
+        conn.engine && conn.engine.emit('notification', payload)
       })
     })
   }
 
-
   // handlers
 
   /**

package.json

@@ -128,7 +128,7 @@
     "lodash.shuffle": "^4.2.0",
     "loglevel": "^1.4.1",
     "luxon": "^1.8.2",
-    "metamask-inpage-provider": "rekmarks/metamask-inpage-provider#permissions",
+    "metamask-inpage-provider": "MetaMask/metamask-inpage-provider#LoginPerSite",
     "metamask-logo": "^2.1.4",
     "mkdirp": "^0.5.1",
     "multihashes": "^0.4.12",
@@ -174,7 +174,7 @@
     "redux-thunk": "^2.2.0",
     "request-promise": "^4.2.1",
     "reselect": "^3.0.1",
-    "rpc-cap": "^0.18.0",
+    "rpc-cap": "^1.0.0",
     "safe-event-emitter": "^1.0.1",
     "safe-json-stringify": "^1.2.0",
     "single-call-balance-checker-abi": "^1.0.0",