Skip to content

Commit

Permalink
Delete public config stream and store
Browse files Browse the repository at this point in the history 
* Delete public config store
* Replace public config stream with notifications
* Remove lock/unlock events; isUnlocked default false
* Fix annotations, rename a function
  • Loading branch information
@rekmarks
rekmarks committed Nov 30, 2020
1 parent d603707 commit b5f30cb
Show file tree
Hide file tree
Showing 5 changed files with 128 additions and 110 deletions.
1 change: 0 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
"json-rpc-engine": "^6.1.0",
"json-rpc-middleware-stream": "^2.1.1",
"obj-multiplex": "^1.0.0",
"obs-store": "^4.0.3",
"pump": "^3.0.0",
"safe-event-emitter": "^1.0.1"
},
Expand Down
209 changes: 126 additions & 83 deletions src/MetaMaskInpageProvider.js
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
const pump = require('pump')
const { JsonRpcEngine, createIdRemapMiddleware } = require('json-rpc-engine')
const createJsonRpcStream = require('json-rpc-middleware-stream')
const ObservableStore = require('obs-store')
const asStream = require('obs-store/lib/asStream')
const ObjectMultiplex = require('obj-multiplex')
const SafeEventEmitter = require('safe-event-emitter')
const dequal = require('fast-deep-equal')
Expand Down Expand Up @@ -50,7 +48,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
shouldSendMetadata = true,
} = {},
) {

validateLoggerObject(logger)
log = logger

Expand Down Expand Up @@ -87,13 +84,10 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
networkChanged: false,
notification: false,
},
// misc
// TODO:deprecation:remove
publicConfigStore: false,
},
isConnected: undefined,
accounts: undefined,
isUnlocked: undefined,
accounts: null,
isConnected: false,
isUnlocked: false,
}

this._metamask = this._getExperimentalApi()
Expand All @@ -105,6 +99,8 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {

// bind functions (to prevent consumers from making unbound calls)
this._handleAccountsChanged = this._handleAccountsChanged.bind(this)
this._handleChainChanged = this._handleChainChanged.bind(this)
this._handleUnlockStateChanged = this._handleUnlockStateChanged.bind(this)
this._handleDisconnect = this._handleDisconnect.bind(this)
this._sendSync = this._sendSync.bind(this)
this._rpcRequest = this._rpcRequest.bind(this)
Expand All @@ -123,49 +119,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
this._handleDisconnect.bind(this, 'MetaMask'),
)

// subscribe to metamask public config (one-way)
this._publicConfigStore = new ObservableStore({ storageKey: 'MetaMask-Config' })

// handle isUnlocked changes, and chainChanged and networkChanged events
this._publicConfigStore.subscribe((state) => {

if ('isUnlocked' in state && state.isUnlocked !== this._state.isUnlocked) {
this._state.isUnlocked = state.isUnlocked
if (this._state.isUnlocked) {
// this will get the exposed accounts, if any
try {
this._rpcRequest(
{ method: 'eth_accounts', params: [] },
NOOP,
true, // indicating that eth_accounts _should_ update accounts
)
} catch (_) { /* no-op */ }
} else {
// accounts are never exposed when the extension is locked
this._handleAccountsChanged([])
}
}

// Emit chainChanged event on chain change
if ('chainId' in state && state.chainId !== this.chainId) {
this.chainId = state.chainId || null
this.emit('chainChanged', this.chainId)
}

// Emit networkChanged event on network change
if ('networkVersion' in state && state.networkVersion !== this.networkVersion) {
this.networkVersion = state.networkVersion || null
this.emit('networkChanged', this.networkVersion)
}
})

pump(
mux.createStream('publicConfig'),
asStream(this._publicConfigStore),
// RPC requests should still work if only this stream fails
logStreamDisconnectWarning.bind(this, log, 'MetaMask PublicConfigStore'),
)

// ignore phishing warning message (handled elsewhere)
mux.ignoreStream('phishing')

Expand Down Expand Up @@ -193,19 +146,21 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
rpcEngine.push(jsonRpcConnection.middleware)
this._rpcEngine = rpcEngine

// json rpc notification listener
jsonRpcConnection.events.on('notification', (payload) => {
this._initializeState()

// handle JSON RPC notifications
jsonRpcConnection.events.on('notification', (payload) => {
const { method, params, result } = payload

if (method === 'wallet_accountsChanged') {
this._handleAccountsChanged(result)
return
}

if (EMITTED_NOTIFICATIONS.includes(method)) {
this.emit('data', payload) // deprecated

} else if (method === 'wallet_unlockStateChanged') {
this._handleUnlockStateChanged(result)
} else if (method === 'wallet_chainChanged') {
this._handleChainChanged(result)
} else if (EMITTED_NOTIFICATIONS.includes(method)) {
this.emit('notification', payload) // deprecated
this.emit('message', {
type: method,
data: params,
Expand All @@ -231,14 +186,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
setTimeout(() => this.emit('connect', { chainId: this.chainId }))
}

get publicConfigStore () {
if (!this._state.sentWarnings.publicConfigStore) {
log.warn(messages.warnings.publicConfigStore)
this._state.sentWarnings.publicConfigStore = true
}
return this._publicConfigStore
}

//====================
// Public Methods
//====================
Expand All @@ -261,7 +208,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* or rejects if an error is encountered.
*/
async request (args) {

if (!args || typeof args !== 'object' || Array.isArray(args)) {
throw ethErrors.rpc.invalidRequest({
message: messages.errors.invalidRequestArgs(),
Expand Down Expand Up @@ -356,16 +302,50 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
// Private Methods
//====================

/**
* Constructor helper.
* Populates initial state by calling 'wallet_getProviderState' and
* 'eth_accounts', and emits necessary events.
*
* @private
*/
_initializeState () {
Promise.all([
this.request({ method: 'wallet_getProviderState' }),
this.request({ method: 'eth_accounts' }),
])
.then(([state, accounts]) => {
const {
chainId,
networkVersion,
isUnlocked,
} = state

// indicate that we've connected, for EIP-1193 compliance
this.emit('connect', { chainId })

this._handleChainChanged({ chainId, networkVersion })
this._handleUnlockStateChanged(isUnlocked)
this._handleAccountsChanged(accounts)
})
.catch((error) => {
log.error(
'MetaMask: Failed to get initial state. Please report this bug.',
error,
)
})
}

/**
* Internal RPC method. Forwards requests to background via the RPC engine.
* Also remap ids inbound and outbound.
*
* @private
* @param {Object} payload - The RPC request object.
* @param {Function} callback - The consumer's callback.
* @param {boolean} [isInternal=false] - Whether the request is internal.
*/
_rpcRequest (payload, callback, isInternal = false) {

let cb = callback

if (!Array.isArray(payload)) {
Expand Down Expand Up @@ -395,9 +375,11 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {

/**
* Called when connection is lost to critical streams.
*
* @private
* @emits MetamaskInpageProvider#disconnect
*/
_handleDisconnect (streamName, err) {

logStreamDisconnectWarning.bind(this)(log, streamName, err)

const disconnectError = {
Expand All @@ -417,19 +399,19 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* the current one, updates all state as necessary, and emits the
* accountsChanged event.
*
* @private
* @param {string[]} accounts - The new accounts value.
* @param {boolean} isEthAccounts - Whether the accounts value was returned by
* a call to eth_accounts.
* @param {boolean} isInternal - Whether the accounts value was returned by an
* internally initiated request.
*/
_handleAccountsChanged (accounts, isEthAccounts = false, isInternal = false) {

let _accounts = accounts

if (!Array.isArray(accounts)) {
log.error(
'MetaMask: Received non-array accounts parameter. Please report this bug.',
'MetaMask: Received invalid accounts parameter. Please report this bug.',
accounts,
)
_accounts = []
Expand All @@ -440,7 +422,7 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {

// we should always have the correct accounts even before eth_accounts
// returns, except in cases where isInternal is true
if (isEthAccounts && this._state.accounts !== undefined && !isInternal) {
if (isEthAccounts && this._state.accounts !== null && !isInternal) {
log.error(
`MetaMask: 'eth_accounts' unexpectedly updated accounts. Please report this bug.`,
_accounts,
Expand All @@ -459,8 +441,77 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
}
}

/**
* Upon receipt of a new chainId and networkVersion, emits corresponding
* events and sets relevant public state.
* Does nothing if neither the chainId nor the networkVersion are different
* from existing values.
*
* @private
* @emits MetamaskInpageProvider#chainChanged
* @param {Object} networkInfo - An object with network info.
* @param {string} networkInfo.chainId - The latest chain ID.
* @param {string} networkInfo.networkVersion - The latest network ID.
*/
_handleChainChanged ({ chainId, networkVersion } = {}) {
if (
typeof chainId !== 'string' || !chainId.startsWith('0x') ||
typeof networkVersion !== 'string'
) {
log.error(
'MetaMask: Received invalid network parameters. Please report this bug.',
{ chainId, networkVersion },
)
return
}

if (chainId !== this.chainId || networkVersion !== this.networkVersion) {
this.chainId = chainId
this.emit('chainChanged', this.chainId)

this.networkVersion = networkVersion
this.emit('networkChanged', this.networkVersion)
}
}

/**
* Upon receipt of a new isUnlocked state, emits the corresponding event
* and sets relevant public state.
* Does nothing if the received value is equal to the existing value.
*
* @private
* @param {boolean} isUnlocked - The latest isUnlocked value.
*/
_handleUnlockStateChanged (isUnlocked) {
if (typeof isUnlocked !== 'boolean') {
log.error('MetaMask: Received invalid isUnlocked parameter. Please report this bug.')
return
}

if (isUnlocked !== this._state.isUnlocked) {
this._state.isUnlocked = isUnlocked

if (isUnlocked) {

// this will get the exposed accounts, if any
try {
this._rpcRequest(
{ method: 'eth_accounts', params: [] },
NOOP,
true, // indicating that eth_accounts _should_ update accounts
)
} catch (_) { /* no-op */ }
} else {
// accounts are never exposed when the extension is locked
this._handleAccountsChanged([])
}
}
}

/**
* Warns of deprecation for the given event, if applicable.
*
* @private
*/
_warnOfDeprecation (eventName) {
if (this._state.sentWarnings.events[eventName] === false) {
Expand All @@ -473,9 +524,10 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* Constructor helper.
* Gets experimental _metamask API as Proxy, so that we can warn consumers
* about its experiment nature.
*
* @private
*/
_getExperimentalApi () {

return new Proxy(
{

Expand All @@ -485,19 +537,13 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* @returns {Promise<boolean>} - Promise resolving to true if MetaMask is currently unlocked
*/
isUnlocked: async () => {
if (this._state.isUnlocked === undefined) {
await new Promise(
(resolve) => this._publicConfigStore.once('update', () => resolve()),
)
}
return this._state.isUnlocked
},

/**
* Make a batch RPC request.
*/
requestBatch: async (requests) => {

if (!Array.isArray(requests)) {
throw ethErrors.rpc.invalidRequest({
message: 'Batch requests must be made with an array of request objects.',
Expand Down Expand Up @@ -537,7 +583,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* @returns {Promise<Array<string>>} - A promise that resolves to an array of addresses.
*/
enable () {

if (!this._state.sentWarnings.enable) {
log.warn(messages.warnings.enableDeprecation)
this._state.sentWarnings.enable = true
Expand Down Expand Up @@ -565,7 +610,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* @returns {unknown} - The method result, or a JSON RPC response object.
*/
send (methodOrPayload, callbackOrArgs) {

if (!this._state.sentWarnings.send) {
log.warn(messages.warnings.sendDeprecation)
this._state.sentWarnings.send = true
Expand Down Expand Up @@ -600,7 +644,6 @@ module.exports = class MetaMaskInpageProvider extends SafeEventEmitter {
* @deprecated
*/
_sendSync (payload) {

let result
switch (payload.method) {

Expand Down
1 change: 0 additions & 1 deletion src/messages.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,5 @@ module.exports = {
},
// misc
experimentalMethods: `MetaMask: 'ethereum._metamask' exposes non-standard, experimental methods. They may be removed or changed without warning.`,
publicConfigStore: `MetaMask: The property 'publicConfigStore' is deprecated and WILL be removed in the future.`,
},
}
2 changes: 1 addition & 1 deletion test/MetaMaskInpageProvider.misc.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ describe('MetaMaskInpageProvider: Miscellanea', () => {

expect(
provider.isConnected(),
).toBeUndefined()
).toBe(false)

provider._state.isConnected = true

Expand Down
Loading

0 comments on commit b5f30cb

Please sign in to comment.