nifty-wallet/app/scripts/metamask-controller.js

1044 lines
33 KiB
JavaScript
Raw Normal View History

2018-03-15 15:27:10 -07:00
/**
* @file The central metamask controller. Aggregates other controllers and exports an api.
* @copyright Copyright (c) 2018 MetaMask
* @license MIT
*/
const EventEmitter = require('events')
const pump = require('pump')
const Dnode = require('dnode')
2017-01-24 19:47:00 -08:00
const ObservableStore = require('obs-store')
const ComposableObservableStore = require('./lib/ComposableObservableStore')
const asStream = require('obs-store/lib/asStream')
const AccountTracker = require('./lib/account-tracker')
const RpcEngine = require('json-rpc-engine')
const debounce = require('debounce')
const createEngineStream = require('json-rpc-middleware-stream/engineStream')
const createFilterMiddleware = require('eth-json-rpc-filters')
const createOriginMiddleware = require('./lib/createOriginMiddleware')
const createLoggerMiddleware = require('./lib/createLoggerMiddleware')
const createProviderMiddleware = require('./lib/createProviderMiddleware')
const setupMultiplex = require('./lib/stream-utils.js').setupMultiplex
2017-09-22 14:38:40 -07:00
const KeyringController = require('eth-keyring-controller')
const NetworkController = require('./controllers/network')
2017-02-27 10:39:48 -08:00
const PreferencesController = require('./controllers/preferences')
const CurrencyController = require('./controllers/currency')
const NoticeController = require('./notice-controller')
2017-02-27 10:39:48 -08:00
const ShapeShiftController = require('./controllers/shapeshift')
2017-03-09 13:58:42 -08:00
const AddressBookController = require('./controllers/address-book')
const InfuraController = require('./controllers/infura')
const BlacklistController = require('./controllers/blacklist')
const RecentBlocksController = require('./controllers/recent-blocks')
const MessageManager = require('./lib/message-manager')
const PersonalMessageManager = require('./lib/personal-message-manager')
2017-09-29 09:24:08 -07:00
const TypedMessageManager = require('./lib/typed-message-manager')
2017-05-16 10:27:41 -07:00
const TransactionController = require('./controllers/transactions')
const BalancesController = require('./controllers/computed-balances')
const TokenRatesController = require('./controllers/token-rates')
const ConfigManager = require('./lib/config-manager')
const nodeify = require('./lib/nodeify')
const accountImporter = require('./account-import-strategies')
const getBuyEthUrl = require('./lib/buy-eth-url')
2017-11-20 13:27:29 -08:00
const Mutex = require('await-semaphore').Mutex
const version = require('../manifest.json').version
const BN = require('ethereumjs-util').BN
const GWEI_BN = new BN('1000000000')
const percentile = require('percentile')
2018-03-02 15:32:57 -08:00
const seedPhraseVerifier = require('./lib/seed-phrase-verifier')
const log = require('loglevel')
module.exports = class MetamaskController extends EventEmitter {
2018-03-15 15:27:10 -07:00
/**
* @constructor
* @param {Object} opts
2018-03-15 15:27:10 -07:00
*/
constructor (opts) {
super()
2018-01-25 12:28:11 -08:00
this.defaultMaxListeners = 20
this.sendUpdate = debounce(this.privateSendUpdate.bind(this), 200)
2016-06-24 17:00:35 -07:00
this.opts = opts
2017-04-26 21:05:45 -07:00
const initState = opts.initState || {}
this.recordFirstTimeInfo(initState)
2017-01-11 19:04:19 -08:00
// platform-specific api
this.platform = opts.platform
2017-01-11 19:04:19 -08:00
// observable state store
this.store = new ComposableObservableStore(initState)
// lock to ensure only one vault created at once
this.createVaultMutex = new Mutex()
2017-02-02 20:59:47 -08:00
// network store
this.networkController = new NetworkController(initState.NetworkController)
2017-01-11 19:04:19 -08:00
// config manager
this.configManager = new ConfigManager({
store: this.store,
})
// preferences controller
this.preferencesController = new PreferencesController({
initState: initState.PreferencesController,
initLangCode: opts.initLangCode,
})
// currency controller
this.currencyController = new CurrencyController({
initState: initState.CurrencyController,
})
this.currencyController.updateConversionRate()
this.currencyController.scheduleConversionInterval()
// infura controller
this.infuraController = new InfuraController({
initState: initState.InfuraController,
})
this.infuraController.scheduleInfuraNetworkCheck()
this.blacklistController = new BlacklistController()
this.blacklistController.scheduleUpdates()
// rpc provider
this.provider = this.initializeProvider()
this.blockTracker = this.provider._blockTracker
// token exchange rate tracker
this.tokenRatesController = new TokenRatesController({
preferences: this.preferencesController.store,
})
this.recentBlocksController = new RecentBlocksController({
blockTracker: this.blockTracker,
provider: this.provider,
})
// account tracker watches balances, nonces, and any code at their address.
2017-09-22 14:16:19 -07:00
this.accountTracker = new AccountTracker({
provider: this.provider,
blockTracker: this.blockTracker,
})
2017-01-11 19:04:19 -08:00
// key mgmt
this.keyringController = new KeyringController({
2017-01-28 13:12:12 -08:00
initState: initState.KeyringController,
getNetwork: this.networkController.getNetworkState.bind(this.networkController),
encryptor: opts.encryptor || undefined,
2016-06-24 16:13:27 -07:00
})
// If only one account exists, make sure it is selected.
this.keyringController.memStore.subscribe((state) => {
const addresses = state.keyrings.reduce((res, keyring) => {
return res.concat(keyring.accounts)
}, [])
if (addresses.length === 1) {
const address = addresses[0]
this.preferencesController.setSelectedAddress(address)
}
this.accountTracker.syncWithAddresses(addresses)
})
// address book controller
this.addressBookController = new AddressBookController({
initState: initState.AddressBookController,
}, this.keyringController)
// tx mgmt
2017-05-16 10:27:41 -07:00
this.txController = new TransactionController({
initState: initState.TransactionController || initState.TransactionManager,
networkStore: this.networkController.networkStore,
2017-02-02 21:09:17 -08:00
preferencesStore: this.preferencesController.store,
2016-12-16 10:33:36 -08:00
txHistoryLimit: 40,
getNetwork: this.networkController.getNetworkState.bind(this),
signTransaction: this.keyringController.signTransaction.bind(this.keyringController),
2016-12-16 10:33:36 -08:00
provider: this.provider,
blockTracker: this.blockTracker,
getGasPrice: this.getGasPrice.bind(this),
2016-12-16 10:33:36 -08:00
})
this.txController.on('newUnapprovedTx', opts.showUnapprovedTx.bind(opts))
2017-09-12 15:06:19 -07:00
// computed balances (accounting for pending transactions)
this.balancesController = new BalancesController({
accountTracker: this.accountTracker,
2017-09-12 15:06:19 -07:00
txController: this.txController,
blockTracker: this.blockTracker,
2017-09-12 15:06:19 -07:00
})
this.networkController.on('networkDidChange', () => {
this.balancesController.updateAllBalances()
})
this.balancesController.updateAllBalances()
2017-09-12 15:06:19 -07:00
// notices
this.noticeController = new NoticeController({
initState: initState.NoticeController,
version,
firstVersion: initState.firstTimeInfo.version,
})
this.noticeController.updateNoticesList()
// to be uncommented when retrieving notices from a remote server.
// this.noticeController.startPolling()
this.shapeshiftController = new ShapeShiftController({
initState: initState.ShapeShiftController,
})
this.networkController.lookupNetwork()
this.messageManager = new MessageManager()
this.personalMessageManager = new PersonalMessageManager()
2017-09-29 09:24:08 -07:00
this.typedMessageManager = new TypedMessageManager()
this.publicConfigStore = this.initPublicConfigStore()
this.store.updateStructure({
TransactionController: this.txController.store,
KeyringController: this.keyringController.store,
PreferencesController: this.preferencesController.store,
AddressBookController: this.addressBookController.store,
CurrencyController: this.currencyController.store,
NoticeController: this.noticeController.store,
ShapeShiftController: this.shapeshiftController.store,
NetworkController: this.networkController.store,
InfuraController: this.infuraController.store,
})
2018-01-31 10:49:58 -08:00
this.memStore = new ComposableObservableStore(null, {
NetworkController: this.networkController.store,
AccountTracker: this.accountTracker.store,
TxController: this.txController.memStore,
BalancesController: this.balancesController.store,
TokenRatesController: this.tokenRatesController.store,
MessageManager: this.messageManager.memStore,
PersonalMessageManager: this.personalMessageManager.memStore,
TypesMessageManager: this.typedMessageManager.memStore,
KeyringController: this.keyringController.memStore,
PreferencesController: this.preferencesController.store,
RecentBlocksController: this.recentBlocksController.store,
AddressBookController: this.addressBookController.store,
CurrencyController: this.currencyController.store,
NoticeController: this.noticeController.memStore,
ShapeshiftController: this.shapeshiftController.store,
InfuraController: this.infuraController.store,
})
this.memStore.subscribe(this.sendUpdate.bind(this))
}
2018-03-15 15:27:10 -07:00
/**
* Constructor helper: initialize a provider.
*/
initializeProvider () {
const providerOpts = {
static: {
eth_syncing: false,
web3_clientVersion: `MetaMask/v${version}`,
eth_sendTransaction: (payload, next, end) => {
const origin = payload.origin
const txParams = payload.params[0]
nodeify(this.txController.newUnapprovedTransaction, this.txController)(txParams, { origin }, end)
},
},
// account mgmt
getAccounts: (cb) => {
const isUnlocked = this.keyringController.memStore.getState().isUnlocked
const result = []
const selectedAddress = this.preferencesController.getSelectedAddress()
// only show address if account is unlocked
if (isUnlocked && selectedAddress) {
result.push(selectedAddress)
}
cb(null, result)
},
// tx signing
// old style msg signing
processMessage: this.newUnsignedMessage.bind(this),
// personal_sign msg signing
processPersonalMessage: this.newUnsignedPersonalMessage.bind(this),
processTypedMessage: this.newUnsignedTypedMessage.bind(this),
}
const providerProxy = this.networkController.initializeProvider(providerOpts)
return providerProxy
}
2018-03-15 15:27:10 -07:00
/**
* Constructor helper: initialize a public config store.
2018-03-15 15:27:10 -07:00
*/
2017-01-26 21:19:09 -08:00
initPublicConfigStore () {
// get init state
const publicConfigStore = new ObservableStore()
// memStore -> transform -> publicConfigStore
this.on('update', (memState) => {
this.isClientOpenAndUnlocked = memState.isUnlocked && this._isClientOpen
const publicState = selectPublicState(memState)
publicConfigStore.putState(publicState)
})
function selectPublicState (memState) {
const result = {
selectedAddress: memState.isUnlocked ? memState.selectedAddress : undefined,
networkVersion: memState.network,
}
2017-01-26 21:19:09 -08:00
return result
}
return publicConfigStore
}
//=============================================================================
// EXPOSED TO THE UI SUBSYSTEM
//=============================================================================
2017-01-26 21:19:09 -08:00
2018-03-15 15:27:10 -07:00
/**
* The metamask-state of the various controllers, made available to the UI
*
* @returns {Object} status
2018-03-15 15:27:10 -07:00
*/
getState () {
const wallet = this.configManager.getWallet()
const vault = this.keyringController.store.getState().vault
const isInitialized = (!!wallet || !!vault)
2017-09-13 14:20:19 -07:00
return {
...{ isInitialized },
...this.memStore.getFlatState(),
...this.configManager.getConfig(),
...{
2017-01-31 20:02:38 -08:00
lostAccounts: this.configManager.getLostAccounts(),
2017-02-02 16:54:16 -08:00
seedWords: this.configManager.getSeedWords(),
forgottenPassword: this.configManager.getPasswordForgotten(),
},
}
}
2018-03-15 15:27:10 -07:00
/**
* Returns an api-object which is consumed by the UI
*
* @returns {Object}
2018-03-15 15:27:10 -07:00
*/
getApi () {
const keyringController = this.keyringController
const preferencesController = this.preferencesController
2017-05-16 10:27:41 -07:00
const txController = this.txController
const noticeController = this.noticeController
const addressBookController = this.addressBookController
2017-09-29 16:09:38 -07:00
const networkController = this.networkController
return {
// etc
2017-04-26 21:05:45 -07:00
getState: (cb) => cb(null, this.getState()),
setCurrentCurrency: this.setCurrentCurrency.bind(this),
setUseBlockie: this.setUseBlockie.bind(this),
2018-03-15 17:29:45 -07:00
setCurrentLocale: this.setCurrentLocale.bind(this),
2017-04-26 21:05:45 -07:00
markAccountsFound: this.markAccountsFound.bind(this),
markPasswordForgotten: this.markPasswordForgotten.bind(this),
unMarkPasswordForgotten: this.unMarkPasswordForgotten.bind(this),
2017-09-29 16:09:38 -07:00
// coinbase
buyEth: this.buyEth.bind(this),
2016-08-18 10:40:35 -07:00
// shapeshift
2016-08-18 15:20:26 -07:00
createShapeShiftTx: this.createShapeShiftTx.bind(this),
// primary HD keyring management
addNewAccount: nodeify(this.addNewAccount, this),
2017-04-26 21:05:45 -07:00
placeSeedWords: this.placeSeedWords.bind(this),
verifySeedPhrase: nodeify(this.verifySeedPhrase, this),
2017-04-26 21:05:45 -07:00
clearSeedWordCache: this.clearSeedWordCache.bind(this),
resetAccount: nodeify(this.resetAccount, this),
2017-04-26 21:05:45 -07:00
importAccountWithStrategy: this.importAccountWithStrategy.bind(this),
// vault management
submitPassword: nodeify(keyringController.submitPassword, keyringController),
2017-09-29 16:09:38 -07:00
// network management
setNetworkEndpoints: nodeify(networkController.setNetworkEndpoints, networkController),
2017-09-29 16:09:38 -07:00
setProviderType: nodeify(networkController.setProviderType, networkController),
setCustomRpc: nodeify(this.setCustomRpc, this),
// PreferencesController
2017-07-12 15:06:49 -07:00
setSelectedAddress: nodeify(preferencesController.setSelectedAddress, preferencesController),
addToken: nodeify(preferencesController.addToken, preferencesController),
removeToken: nodeify(preferencesController.removeToken, preferencesController),
2017-07-12 15:06:49 -07:00
setCurrentAccountTab: nodeify(preferencesController.setCurrentAccountTab, preferencesController),
2017-11-14 08:04:55 -08:00
setFeatureFlag: nodeify(preferencesController.setFeatureFlag, preferencesController),
// AddressController
2017-07-12 15:06:49 -07:00
setAddressBook: nodeify(addressBookController.setAddressBook, addressBookController),
// KeyringController
2017-07-12 15:06:49 -07:00
setLocked: nodeify(keyringController.setLocked, keyringController),
createNewVaultAndKeychain: nodeify(this.createNewVaultAndKeychain, this),
createNewVaultAndRestore: nodeify(this.createNewVaultAndRestore, this),
2017-07-12 15:06:49 -07:00
addNewKeyring: nodeify(keyringController.addNewKeyring, keyringController),
saveAccountLabel: nodeify(keyringController.saveAccountLabel, keyringController),
exportAccount: nodeify(keyringController.exportAccount, keyringController),
2017-05-16 10:27:41 -07:00
// txController
cancelTransaction: nodeify(txController.cancelTransaction, txController),
updateTransaction: nodeify(txController.updateTransaction, txController),
2017-07-12 15:06:49 -07:00
updateAndApproveTransaction: nodeify(txController.updateAndApproveTransaction, txController),
2017-12-06 20:20:15 -08:00
retryTransaction: nodeify(this.retryTransaction, this),
// messageManager
2017-07-12 15:06:49 -07:00
signMessage: nodeify(this.signMessage, this),
2017-04-26 21:05:45 -07:00
cancelMessage: this.cancelMessage.bind(this),
2017-02-22 16:23:13 -08:00
// personalMessageManager
2017-07-12 15:06:49 -07:00
signPersonalMessage: nodeify(this.signPersonalMessage, this),
2017-04-26 21:05:45 -07:00
cancelPersonalMessage: this.cancelPersonalMessage.bind(this),
2017-09-29 09:24:08 -07:00
// personalMessageManager
signTypedMessage: nodeify(this.signTypedMessage, this),
cancelTypedMessage: this.cancelTypedMessage.bind(this),
// notices
2017-04-26 21:05:45 -07:00
checkNotices: noticeController.updateNoticesList.bind(noticeController),
markNoticeRead: noticeController.markNoticeRead.bind(noticeController),
}
}
2018-01-08 15:41:57 -08:00
2018-03-15 15:27:10 -07:00
//=============================================================================
// VAULT / KEYRING RELATED METHODS
//=============================================================================
2018-03-15 15:27:10 -07:00
/**
* Creates a new Vault(?) and create a new keychain(?)
*
2018-03-15 15:27:10 -07:00
* A vault is ...
*
2018-03-15 15:27:10 -07:00
* A keychain is ...
*
2018-03-15 15:27:10 -07:00
*
* @param {} password
*
2018-03-15 15:27:10 -07:00
* @returns {} vault
*/
2017-11-20 13:27:29 -08:00
async createNewVaultAndKeychain (password) {
const release = await this.createVaultMutex.acquire()
let vault
try {
const accounts = await this.keyringController.getAccounts()
if (accounts.length > 0) {
vault = await this.keyringController.fullUpdate()
} else {
2017-11-28 15:35:20 -08:00
vault = await this.keyringController.createNewVaultAndKeychain(password)
this.selectFirstIdentity(vault)
}
release()
} catch (err) {
release()
throw err
2017-11-20 13:27:29 -08:00
}
return vault
2017-11-20 13:27:29 -08:00
}
2018-03-15 15:27:10 -07:00
/**
* Create a new Vault and restore an existent keychain
* @param {} password
* @param {} seed
*/
2017-11-20 13:27:29 -08:00
async createNewVaultAndRestore (password, seed) {
const release = await this.createVaultMutex.acquire()
try {
const vault = await this.keyringController.createNewVaultAndRestore(password, seed)
this.selectFirstIdentity(vault)
release()
return vault
} catch (err) {
release()
throw err
}
}
2018-03-15 15:27:10 -07:00
/**
* Retrieves the first Identiy from the passed Vault and selects the related address
*
2018-03-15 15:27:10 -07:00
* An Identity is ...
*
2018-03-15 15:27:10 -07:00
* @param {} vault
*/
selectFirstIdentity (vault) {
const { identities } = vault
const address = Object.keys(identities)[0]
this.preferencesController.setSelectedAddress(address)
}
2018-03-15 15:27:10 -07:00
// ?
// Opinionated Keyring Management
//
2018-03-15 15:27:10 -07:00
/**
* Adds a new account to ...
*
2018-03-15 15:27:10 -07:00
* @returns {} keyState
*/
async addNewAccount () {
const primaryKeyring = this.keyringController.getKeyringsByType('HD Key Tree')[0]
if (!primaryKeyring) {
throw new Error('MetamaskController - No HD Key Tree found')
}
const keyringController = this.keyringController
const oldAccounts = await keyringController.getAccounts()
const keyState = await keyringController.addNewAccount(primaryKeyring)
const newAccounts = await keyringController.getAccounts()
await this.verifySeedPhrase()
newAccounts.forEach((address) => {
if (!oldAccounts.includes(address)) {
this.preferencesController.setSelectedAddress(address)
}
})
return keyState
}
2018-03-15 15:27:10 -07:00
/**
* Adds the current vault's seed words to the UI's state tree.
*
2018-03-15 15:27:10 -07:00
* Used when creating a first vault, to allow confirmation.
* Also used when revealing the seed words in the confirmation view.
*/
placeSeedWords (cb) {
2018-03-03 13:08:10 -08:00
this.verifySeedPhrase()
.then((seedWords) => {
this.configManager.setSeedWords(seedWords)
return cb(null, seedWords)
})
.catch((err) => {
2018-03-03 13:08:10 -08:00
return cb(err)
})
2018-03-03 13:08:10 -08:00
}
2018-03-15 15:27:10 -07:00
/**
* Verifies the validity of the current vault's seed phrase.
*
* Validity: seed phrase restores the accounts belonging to the current vault.
2018-03-15 15:27:10 -07:00
*
* Called when the first account is created and on unlocking the vault.
*/
async verifySeedPhrase () {
2018-03-03 13:08:10 -08:00
const primaryKeyring = this.keyringController.getKeyringsByType('HD Key Tree')[0]
if (!primaryKeyring) {
throw new Error('MetamaskController - No HD Key Tree found')
}
const serialized = await primaryKeyring.serialize()
const seedWords = serialized.mnemonic
const accounts = await primaryKeyring.getAccounts()
if (accounts.length < 1) {
throw new Error('MetamaskController - No accounts found')
}
try {
await seedPhraseVerifier.verifyAccounts(accounts, seedWords)
return seedWords
} catch (err) {
log.error(err.message)
throw err
}
}
2018-03-15 15:27:10 -07:00
/**
* Remove the primary account seed phrase from the UI's state tree.
*
2018-03-15 15:27:10 -07:00
* The seed phrase remains available in the background process.
*
2018-03-15 15:27:10 -07:00
*/
clearSeedWordCache (cb) {
this.configManager.setSeedWords(null)
cb(null, this.preferencesController.getSelectedAddress())
}
2018-03-15 15:27:10 -07:00
/**
* ?
*/
async resetAccount (cb) {
const selectedAddress = this.preferencesController.getSelectedAddress()
this.txController.wipeTransactions(selectedAddress)
const networkController = this.networkController
2018-03-27 19:04:28 -07:00
const oldType = networkController.getProviderConfig().type
await networkController.setProviderType(oldType, true)
return selectedAddress
2018-01-31 00:33:15 -08:00
}
2018-03-15 15:27:10 -07:00
/**
* Imports an account ... ?
*
2018-03-15 15:27:10 -07:00
* @param {} strategy
* @param {} args
* @param {} cb
*/
importAccountWithStrategy (strategy, args, cb) {
accountImporter.importAccount(strategy, args)
.then((privateKey) => {
return this.keyringController.addNewKeyring('Simple Key Pair', [ privateKey ])
})
.then(keyring => keyring.getAccounts())
.then((accounts) => this.preferencesController.setSelectedAddress(accounts[0]))
.then(() => { cb(null, this.keyringController.fullUpdate()) })
.catch((reason) => { cb(reason) })
}
// ---------------------------------------------------------------------------
// Identity Management (sign)
2018-03-15 15:27:10 -07:00
/**
* @param {} msgParams
* @param {} cb
*/
signMessage (msgParams, cb) {
log.info('MetaMaskController - signMessage')
const msgId = msgParams.metamaskId
// sets the status op the message to 'approved'
// and removes the metamaskId for signing
return this.messageManager.approveMessage(msgParams)
.then((cleanMsgParams) => {
// signs the message
return this.keyringController.signMessage(cleanMsgParams)
})
.then((rawSig) => {
// tells the listener that the message has been signed
// and can be returned to the dapp
this.messageManager.setMsgStatusSigned(msgId, rawSig)
return this.getState()
})
}
// Prefixed Style Message Signing Methods:
2018-03-15 15:27:10 -07:00
/**
*
2018-03-15 15:27:10 -07:00
* @param {} msgParams
* @param {} cb
*/
approvePersonalMessage (msgParams, cb) {
2017-04-26 21:05:45 -07:00
const msgId = this.personalMessageManager.addUnapprovedMessage(msgParams)
this.sendUpdate()
this.opts.showUnconfirmedMessage()
this.personalMessageManager.once(`${msgId}:finished`, (data) => {
switch (data.status) {
case 'signed':
return cb(null, data.rawSig)
case 'rejected':
return cb(new Error('MetaMask Message Signature: User denied transaction signature.'))
default:
return cb(new Error(`MetaMask Message Signature: Unknown problem: ${JSON.stringify(msgParams)}`))
}
})
}
2018-03-15 15:27:10 -07:00
/**
* @param {} msgParams
*/
signPersonalMessage (msgParams) {
log.info('MetaMaskController - signPersonalMessage')
const msgId = msgParams.metamaskId
// sets the status op the message to 'approved'
// and removes the metamaskId for signing
return this.personalMessageManager.approveMessage(msgParams)
.then((cleanMsgParams) => {
// signs the message
return this.keyringController.signPersonalMessage(cleanMsgParams)
})
.then((rawSig) => {
// tells the listener that the message has been signed
// and can be returned to the dapp
this.personalMessageManager.setMsgStatusSigned(msgId, rawSig)
return this.getState()
})
}
2018-03-15 15:27:10 -07:00
/**
* @param {} msgParams
*/
2017-09-29 09:24:08 -07:00
signTypedMessage (msgParams) {
log.info('MetaMaskController - signTypedMessage')
const msgId = msgParams.metamaskId
// sets the status op the message to 'approved'
// and removes the metamaskId for signing
return this.typedMessageManager.approveMessage(msgParams)
.then((cleanMsgParams) => {
// signs the message
return this.keyringController.signTypedMessage(cleanMsgParams)
})
.then((rawSig) => {
// tells the listener that the message has been signed
// and can be returned to the dapp
this.typedMessageManager.setMsgStatusSigned(msgId, rawSig)
return this.getState()
})
}
// ---------------------------------------------------------------------------
// Account Restauration
2018-03-15 15:27:10 -07:00
/**
* ?
*
2018-03-15 15:27:10 -07:00
* @param {} migratorOutput
*/
2017-04-26 21:05:45 -07:00
restoreOldVaultAccounts (migratorOutput) {
2017-01-27 19:35:03 -08:00
const { serialized } = migratorOutput
return this.keyringController.restoreKeyring(serialized)
.then(() => migratorOutput)
}
2018-03-15 15:27:10 -07:00
/**
* ?
*
2018-03-15 15:27:10 -07:00
* @param {} migratorOutput
*/
2017-04-26 21:05:45 -07:00
restoreOldLostAccounts (migratorOutput) {
2017-01-27 19:35:03 -08:00
const { lostAccounts } = migratorOutput
if (lostAccounts) {
this.configManager.setLostAccounts(lostAccounts.map(acct => acct.address))
return this.importLostAccounts(migratorOutput)
}
2017-01-27 19:35:03 -08:00
return Promise.resolve(migratorOutput)
}
2018-03-15 15:27:10 -07:00
/**
* Import (lost) Accounts
*
2018-03-15 15:27:10 -07:00
* @param {Object} {lostAccounts} @Array accounts <{ address, privateKey }>
*
2018-03-15 15:27:10 -07:00
* Uses the array's private keys to create a new Simple Key Pair keychain
* and add it to the keyring controller.
*/
2017-01-27 19:35:03 -08:00
importLostAccounts ({ lostAccounts }) {
const privKeys = lostAccounts.map(acct => acct.privateKey)
return this.keyringController.restoreKeyring({
type: 'Simple Key Pair',
data: privKeys,
})
}
//=============================================================================
// END (VAULT / KEYRING RELATED METHODS)
//=============================================================================
//
//=============================================================================
// MESSAGES
//=============================================================================
2017-12-06 20:20:15 -08:00
async retryTransaction (txId, cb) {
await this.txController.retryTransaction(txId)
const state = await this.getState()
return state
}
newUnsignedMessage (msgParams, cb) {
2017-04-26 21:05:45 -07:00
const msgId = this.messageManager.addUnapprovedMessage(msgParams)
2017-02-01 11:54:01 -08:00
this.sendUpdate()
this.opts.showUnconfirmedMessage()
this.messageManager.once(`${msgId}:finished`, (data) => {
switch (data.status) {
case 'signed':
2017-02-01 11:54:01 -08:00
return cb(null, data.rawSig)
case 'rejected':
2017-02-23 16:00:43 -08:00
return cb(new Error('MetaMask Message Signature: User denied message signature.'))
2017-02-01 11:54:01 -08:00
default:
return cb(new Error(`MetaMask Message Signature: Unknown problem: ${JSON.stringify(msgParams)}`))
}
})
}
newUnsignedPersonalMessage (msgParams, cb) {
2017-02-23 16:00:43 -08:00
if (!msgParams.from) {
return cb(new Error('MetaMask Message Signature: from field is required.'))
}
2017-04-26 21:05:45 -07:00
const msgId = this.personalMessageManager.addUnapprovedMessage(msgParams)
this.sendUpdate()
this.opts.showUnconfirmedMessage()
this.personalMessageManager.once(`${msgId}:finished`, (data) => {
switch (data.status) {
case 'signed':
return cb(null, data.rawSig)
case 'rejected':
2017-02-23 16:00:43 -08:00
return cb(new Error('MetaMask Message Signature: User denied message signature.'))
default:
return cb(new Error(`MetaMask Message Signature: Unknown problem: ${JSON.stringify(msgParams)}`))
}
})
}
2017-09-29 09:24:08 -07:00
newUnsignedTypedMessage (msgParams, cb) {
2017-10-05 14:39:35 -07:00
let msgId
try {
msgId = this.typedMessageManager.addUnapprovedMessage(msgParams)
this.sendUpdate()
this.opts.showUnconfirmedMessage()
} catch (e) {
return cb(e)
}
2017-09-29 09:24:08 -07:00
this.typedMessageManager.once(`${msgId}:finished`, (data) => {
switch (data.status) {
case 'signed':
return cb(null, data.rawSig)
case 'rejected':
return cb(new Error('MetaMask Message Signature: User denied message signature.'))
default:
return cb(new Error(`MetaMask Message Signature: Unknown problem: ${JSON.stringify(msgParams)}`))
}
})
}
2017-04-26 21:05:45 -07:00
cancelMessage (msgId, cb) {
2017-02-23 16:00:43 -08:00
const messageManager = this.messageManager
messageManager.rejectMsg(msgId)
if (cb && typeof cb === 'function') {
cb(null, this.getState())
}
}
2017-09-29 09:24:08 -07:00
2017-04-26 21:05:45 -07:00
cancelPersonalMessage (msgId, cb) {
2017-02-23 16:00:43 -08:00
const messageManager = this.personalMessageManager
messageManager.rejectMsg(msgId)
if (cb && typeof cb === 'function') {
cb(null, this.getState())
}
}
2017-01-27 19:35:03 -08:00
2017-09-29 09:24:08 -07:00
cancelTypedMessage (msgId, cb) {
const messageManager = this.typedMessageManager
messageManager.rejectMsg(msgId)
if (cb && typeof cb === 'function') {
cb(null, this.getState())
}
}
2017-01-27 19:35:03 -08:00
markAccountsFound (cb) {
this.configManager.setLostAccounts([])
this.sendUpdate()
cb(null, this.getState())
}
markPasswordForgotten(cb) {
this.configManager.setPasswordForgotten(true)
this.sendUpdate()
cb()
}
unMarkPasswordForgotten(cb) {
this.configManager.setPasswordForgotten(false)
this.sendUpdate()
cb()
}
//=============================================================================
// SETUP
//=============================================================================
2017-01-27 19:35:03 -08:00
setupUntrustedCommunication (connectionStream, originDomain) {
// Check if new connection is blacklisted
if (this.blacklistController.checkForPhishing(originDomain)) {
log.debug('MetaMask - sending phishing warning for', originDomain)
this.sendPhishingWarning(connectionStream, originDomain)
return
}
// setup multiplexing
const mux = setupMultiplex(connectionStream)
// connect features
this.setupProviderConnection(mux.createStream('provider'), originDomain)
this.setupPublicConfig(mux.createStream('publicConfig'))
}
setupTrustedCommunication (connectionStream, originDomain) {
// setup multiplexing
const mux = setupMultiplex(connectionStream)
// connect features
this.setupControllerConnection(mux.createStream('controller'))
this.setupProviderConnection(mux.createStream('provider'), originDomain)
}
sendPhishingWarning (connectionStream, hostname) {
const mux = setupMultiplex(connectionStream)
const phishingStream = mux.createStream('phishing')
phishingStream.write({ hostname })
}
setupControllerConnection (outStream) {
const api = this.getApi()
const dnode = Dnode(api)
pump(
outStream,
dnode,
outStream,
(err) => {
if (err) log.error(err)
}
)
dnode.on('remote', (remote) => {
// push updates to popup
const sendUpdate = remote.sendUpdate.bind(remote)
this.on('update', sendUpdate)
2017-01-27 19:35:03 -08:00
})
}
setupProviderConnection (outStream, origin) {
// setup json rpc engine stack
const engine = new RpcEngine()
// create filter polyfill middleware
const filterMiddleware = createFilterMiddleware({
provider: this.provider,
blockTracker: this.provider._blockTracker,
})
engine.push(createOriginMiddleware({ origin }))
engine.push(createLoggerMiddleware({ origin }))
engine.push(filterMiddleware)
engine.push(createProviderMiddleware({ provider: this.provider }))
// setup connection
const providerStream = createEngineStream({ engine })
pump(
outStream,
providerStream,
outStream,
(err) => {
// cleanup filter polyfill middleware
filterMiddleware.destroy()
if (err) log.error(err)
}
)
}
setupPublicConfig (outStream) {
pump(
asStream(this.publicConfigStore),
outStream,
(err) => {
if (err) log.error(err)
}
)
}
privateSendUpdate () {
this.emit('update', this.getState())
}
getGasPrice () {
const { recentBlocksController } = this
const { recentBlocks } = recentBlocksController.store.getState()
// Return 1 gwei if no blocks have been observed:
if (recentBlocks.length === 0) {
return '0x' + GWEI_BN.toString(16)
}
const lowestPrices = recentBlocks.map((block) => {
if (!block.gasPrices || block.gasPrices.length < 1) {
return GWEI_BN
}
return block.gasPrices
.map(hexPrefix => hexPrefix.substr(2))
.map(hex => new BN(hex, 16))
.sort((a, b) => {
return a.gt(b) ? 1 : -1
})[0]
})
.map(number => number.div(GWEI_BN).toNumber())
const percentileNum = percentile(50, lowestPrices)
const percentileNumBn = new BN(percentileNum)
return '0x' + percentileNumBn.mul(GWEI_BN).toString(16)
}
2018-03-15 15:27:10 -07:00
//=============================================================================
// CONFIG
//=============================================================================
2017-01-27 19:35:03 -08:00
// Log blocks
setCurrentCurrency (currencyCode, cb) {
try {
this.currencyController.setCurrentCurrency(currencyCode)
this.currencyController.updateConversionRate()
const data = {
conversionRate: this.currencyController.getConversionRate(),
currentCurrency: this.currencyController.getCurrentCurrency(),
conversionDate: this.currencyController.getConversionDate(),
}
cb(null, data)
} catch (err) {
cb(err)
}
}
buyEth (address, amount) {
if (!amount) amount = '5'
const network = this.networkController.getNetworkState()
const url = getBuyEthUrl({ network, address, amount })
if (url) this.platform.openWindow({ url })
}
2016-08-18 15:20:26 -07:00
createShapeShiftTx (depositAddress, depositType) {
this.shapeshiftController.createShapeShiftTx(depositAddress, depositType)
2016-08-18 10:40:35 -07:00
}
2017-09-29 16:09:38 -07:00
// network
2017-09-29 16:09:38 -07:00
async setCustomRpc (rpcTarget, rpcList) {
this.networkController.setRpcTarget(rpcTarget)
2017-09-29 16:09:38 -07:00
await this.preferencesController.updateFrequentRpcList(rpcTarget)
return rpcTarget
}
2017-09-29 16:09:38 -07:00
2017-11-25 14:57:54 -08:00
setUseBlockie (val, cb) {
try {
this.preferencesController.setUseBlockie(val)
cb(null)
} catch (err) {
cb(err)
}
}
2018-03-15 17:29:45 -07:00
setCurrentLocale (key, cb) {
try {
this.preferencesController.setCurrentLocale(key)
cb(null)
} catch (err) {
cb(err)
}
}
recordFirstTimeInfo (initState) {
if (!('firstTimeInfo' in initState)) {
initState.firstTimeInfo = {
version,
date: Date.now(),
}
}
}
set isClientOpen (open) {
this._isClientOpen = open
this.isClientOpenAndUnlocked = this.getState().isUnlocked && open
}
set isClientOpenAndUnlocked (active) {
this.tokenRatesController.isActive = active
}
}