TheDude
/
ciphermask
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1848 from MetaMask/transactionControllerRefractor

Browse Source 
Transaction controller refractor part 1: promises for everyone and more tests!
feature/default_network_editable
kumavis 7 years ago committed by GitHub
parent 2c37d43888 5ac4c2de6f
commit 8a9d0073b1
6 changed files with 331 additions and 272 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 2
      app/scripts/background.js
  2. 345
      app/scripts/controllers/transactions.js
  3. 61
      app/scripts/lib/tx-utils.js
  4. 30
      app/scripts/metamask-controller.js
  5. 1
      package.json
  6. 164
      test/unit/tx-controller-test.js

2
app/scripts/background.js
Unescape View File

@ -121,7 +121,7 @@ function setupController (initState) {
// plugin badge text // plugin badge text
function updateBadge () { function updateBadge () {
var label = '' var label = ''
var unapprovedTxCount = controller.txController.unapprovedTxCount var unapprovedTxCount = controller.txController.getUnapprovedTxCount()
var unapprovedMsgCount = controller.messageManager.unapprovedMsgCount var unapprovedMsgCount = controller.messageManager.unapprovedMsgCount
var unapprovedPersonalMsgs = controller.personalMessageManager.unapprovedPersonalMsgCount var unapprovedPersonalMsgs = controller.personalMessageManager.unapprovedPersonalMsgCount
var count = unapprovedTxCount + unapprovedMsgCount + unapprovedPersonalMsgs var count = unapprovedTxCount + unapprovedMsgCount + unapprovedPersonalMsgs

345
app/scripts/controllers/transactions.js
Unescape View File

@ -1,10 +1,9 @@
const EventEmitter = require('events') const EventEmitter = require('events')
const async = require('async')
const extend = require('xtend') const extend = require('xtend')
const clone = require('clone') const clone = require('clone')
const ObservableStore = require('obs-store') const ObservableStore = require('obs-store')
const ethUtil = require('ethereumjs-util') const ethUtil = require('ethereumjs-util')
const pify = require('pify') const EthQuery = require('ethjs-query')
const TxProviderUtil = require('../lib/tx-utils') const TxProviderUtil = require('../lib/tx-utils')
const getStack = require('../lib/util').getStack const getStack = require('../lib/util').getStack
const createId = require('../lib/random-id') const createId = require('../lib/random-id')
@ -32,7 +31,7 @@ module.exports = class TransactionController extends EventEmitter {
}) })
}, },
}) })
this.query = opts.ethQuery this.query = new EthQuery(this.provider)
this.txProviderUtils = new TxProviderUtil(this.query) this.txProviderUtils = new TxProviderUtil(this.query)
this.blockTracker.on('rawBlock', this.checkForTxInBlock.bind(this)) this.blockTracker.on('rawBlock', this.checkForTxInBlock.bind(this))
// this is a little messy but until ethstore has been either // this is a little messy but until ethstore has been either
@ -61,13 +60,6 @@ module.exports = class TransactionController extends EventEmitter {
return this.preferencesStore.getState().selectedAddress return this.preferencesStore.getState().selectedAddress
} }
// Returns the tx list
getTxList () {
const network = this.getNetwork()
const fullTxList = this.getFullTxList()
return fullTxList.filter(txMeta => txMeta.metamaskNetworkId === network)
}
// Returns the number of txs for the current network. // Returns the number of txs for the current network.
getTxCount () { getTxCount () {
return this.getTxList().length return this.getTxList().length
@ -78,6 +70,58 @@ module.exports = class TransactionController extends EventEmitter {
return this.store.getState().transactions return this.store.getState().transactions
} }
getUnapprovedTxCount () {
return Object.keys(this.getUnapprovedTxList()).length
}
getPendingTxCount () {
return this.getTxsByMetaData('status', 'signed').length
}
// Returns the tx list
getTxList () {
const network = this.getNetwork()
const fullTxList = this.getFullTxList()
return this.getTxsByMetaData('metamaskNetworkId', network, fullTxList)
}
// gets tx by Id and returns it
getTx (txId) {
const txList = this.getTxList()
const txMeta = txList.find(txData => txData.id === txId)
return txMeta
}
getUnapprovedTxList () {
const txList = this.getTxList()
return txList.filter((txMeta) => txMeta.status === 'unapproved')
.reduce((result, tx) => {
result[tx.id] = tx
return result
}, {})
}
updateTx (txMeta) {
// create txMeta snapshot for history
const txMetaForHistory = clone(txMeta)
// dont include previous history in this snapshot
delete txMetaForHistory.history
// add stack to help understand why tx was updated
txMetaForHistory.stack = getStack()
// add snapshot to tx history
if (!txMeta.history) txMeta.history = []
txMeta.history.push(txMetaForHistory)
const txId = txMeta.id
const txList = this.getFullTxList()
const index = txList.findIndex(txData => txData.id === txId)
if (!txMeta.history) txMeta.history = []
txMeta.history.push(txMetaForHistory)
txList[index] = txMeta
this._saveTxList(txList)
this.emit('update')
}
// Adds a tx to the txlist // Adds a tx to the txlist
addTx (txMeta) { addTx (txMeta) {
const txCount = this.getTxCount() const txCount = this.getTxCount()
@ -91,7 +135,7 @@ module.exports = class TransactionController extends EventEmitter {
// or rejected tx's. // or rejected tx's.
// not tx's that are pending or unapproved // not tx's that are pending or unapproved
if (txCount > txHistoryLimit - 1) { if (txCount > txHistoryLimit - 1) {
var index = fullTxList.findIndex((metaTx) => ((metaTx.status === 'confirmed' || metaTx.status === 'rejected') && network === txMeta.metamaskNetworkId)) const index = fullTxList.findIndex((metaTx) => ((metaTx.status === 'confirmed' || metaTx.status === 'rejected') && network === txMeta.metamaskNetworkId))
fullTxList.splice(index, 1) fullTxList.splice(index, 1)
} }
fullTxList.push(txMeta) fullTxList.push(txMeta)
@ -109,92 +153,59 @@ module.exports = class TransactionController extends EventEmitter {
this.emit(`${txMeta.id}:unapproved`, txMeta) this.emit(`${txMeta.id}:unapproved`, txMeta)
} }
// gets tx by Id and returns it async newUnapprovedTransaction (txParams) {
getTx (txId, cb) { log.debug(`MetaMaskController newUnapprovedTransaction ${JSON.stringify(txParams)}`)
var txList = this.getTxList() const txMeta = await this.addUnapprovedTransaction(txParams)
var txMeta = txList.find(txData => txData.id === txId) this.emit('newUnaprovedTx', txMeta)
return cb ? cb(txMeta) : txMeta // listen for tx completion (success, fail)
} return new Promise((resolve, reject) => {
this.once(`${txMeta.id}:finished`, (completedTx) => {
// switch (completedTx.status) {
updateTx (txMeta) { case 'submitted':
// create txMeta snapshot for history return resolve(completedTx.hash)
const txMetaForHistory = clone(txMeta) case 'rejected':
// dont include previous history in this snapshot return reject(new Error('MetaMask Tx Signature: User denied transaction signature.'))
delete txMetaForHistory.history default:
// add stack to help understand why tx was updated return reject(new Error(`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(completedTx.txParams)}`))
txMetaForHistory.stack = getStack() }
// add snapshot to tx history })
if (!txMeta.history) txMeta.history = [] })
txMeta.history.push(txMetaForHistory)
// update the tx
var txId = txMeta.id
var txList = this.getFullTxList()
var index = txList.findIndex(txData => txData.id === txId)
txList[index] = txMeta
this._saveTxList(txList)
this.emit('update')
}
get unapprovedTxCount () {
return Object.keys(this.getUnapprovedTxList()).length
}
get pendingTxCount () {
return this.getTxsByMetaData('status', 'signed').length
} }
addUnapprovedTransaction (txParams, done) { async addUnapprovedTransaction (txParams) {
let txMeta = {} // validate
async.waterfall([ await this.txProviderUtils.validateTxParams(txParams)
// validate // construct txMeta
(cb) => this.txProviderUtils.validateTxParams(txParams, cb), const txMeta = {
// construct txMeta id: createId(),
(cb) => { time: (new Date()).getTime(),
txMeta = { status: 'unapproved',
id: createId(), metamaskNetworkId: this.getNetwork(),
time: (new Date()).getTime(), txParams: txParams,
status: 'unapproved', history: [],
metamaskNetworkId: this.getNetwork(), }
txParams: txParams, // add default tx params
history: [], await this.addTxDefaults(txMeta)
} // save txMeta
cb() this.addTx(txMeta)
}, return txMeta
// add default tx params
(cb) => this.addTxDefaults(txMeta, cb),
// save txMeta
(cb) => {
this.addTx(txMeta)
cb(null, txMeta)
},
], done)
} }
addTxDefaults (txMeta, cb) { async addTxDefaults (txMeta) {
const txParams = txMeta.txParams const txParams = txMeta.txParams
// ensure value // ensure value
txParams.value = txParams.value || '0x0' txParams.value = txParams.value || '0x0'
if (!txParams.gasPrice) { if (!txParams.gasPrice) {
this.query.gasPrice((err, gasPrice) => { const gasPrice = await this.query.gasPrice()
txParams.gasPrice = gasPrice
if (err) return cb(err)
// set gasPrice
txParams.gasPrice = gasPrice
})
} }
// set gasLimit // set gasLimit
this.txProviderUtils.analyzeGasUsage(txMeta, cb) return await this.txProviderUtils.analyzeGasUsage(txMeta)
} }
getUnapprovedTxList () { async updateAndApproveTransaction (txMeta) {
var txList = this.getTxList() this.updateTx(txMeta)
return txList.filter((txMeta) => txMeta.status === 'unapproved') await this.approveTransaction(txMeta.id)
.reduce((result, tx) => {
result[tx.id] = tx
return result
}, {})
} }
async approveTransaction (txId) { async approveTransaction (txId) {
@ -230,26 +241,6 @@ module.exports = class TransactionController extends EventEmitter {
} }
} }
cancelTransaction (txId, cb = warn) {
this.setTxStatusRejected(txId)
cb()
}
async updateAndApproveTransaction (txMeta) {
this.updateTx(txMeta)
await this.approveTransaction(txMeta.id)
}
getChainId () {
const networkState = this.networkStore.getState()
const getChainId = parseInt(networkState)
if (Number.isNaN(getChainId)) {
return 0
} else {
return getChainId
}
}
async signTransaction (txId) { async signTransaction (txId) {
const txMeta = this.getTx(txId) const txMeta = this.getTx(txId)
const txParams = txMeta.txParams const txParams = txMeta.txParams
@ -257,10 +248,9 @@ module.exports = class TransactionController extends EventEmitter {
// add network/chain id // add network/chain id
txParams.chainId = this.getChainId() txParams.chainId = this.getChainId()
const ethTx = this.txProviderUtils.buildEthTxFromParams(txParams) const ethTx = this.txProviderUtils.buildEthTxFromParams(txParams)
const rawTx = await this.signEthTx(ethTx, fromAddress).then(() => { await this.signEthTx(ethTx, fromAddress)
this.setTxStatusSigned(txMeta.id) this.setTxStatusSigned(txMeta.id)
return ethUtil.bufferToHex(ethTx.serialize()) const rawTx = ethUtil.bufferToHex(ethTx.serialize())
})
return rawTx return rawTx
} }
@ -268,10 +258,24 @@ module.exports = class TransactionController extends EventEmitter {
const txMeta = this.getTx(txId) const txMeta = this.getTx(txId)
txMeta.rawTx = rawTx txMeta.rawTx = rawTx
this.updateTx(txMeta) this.updateTx(txMeta)
await this.txProviderUtils.publishTransaction(rawTx).then((txHash) => { const txHash = await this.txProviderUtils.publishTransaction(rawTx)
this.setTxHash(txId, txHash) this.setTxHash(txId, txHash)
this.setTxStatusSubmitted(txId) this.setTxStatusSubmitted(txId)
}) }
async cancelTransaction (txId) {
this.setTxStatusRejected(txId)
}
getChainId () {
const networkState = this.networkStore.getState()
const getChainId = parseInt(networkState)
if (Number.isNaN(getChainId)) {
return 0
} else {
return getChainId
}
} }
// receives a txHash records the tx as signed // receives a txHash records the tx as signed
@ -284,7 +288,7 @@ module.exports = class TransactionController extends EventEmitter {
/* /*
Takes an object of fields to search for eg: Takes an object of fields to search for eg:
var thingsToLookFor = { let thingsToLookFor = {
to: '0x0..', to: '0x0..',
from: '0x0..', from: '0x0..',
status: 'signed', status: 'signed',
@ -307,7 +311,7 @@ module.exports = class TransactionController extends EventEmitter {
and that have been 'confirmed' and that have been 'confirmed'
*/ */
getFilteredTxList (opts) { getFilteredTxList (opts) {
var filteredTxList let filteredTxList
Object.keys(opts).forEach((key) => { Object.keys(opts).forEach((key) => {
filteredTxList = this.getTxsByMetaData(key, opts[key], filteredTxList) filteredTxList = this.getTxsByMetaData(key, opts[key], filteredTxList)
}) })
@ -368,7 +372,7 @@ module.exports = class TransactionController extends EventEmitter {
// merges txParams obj onto txData.txParams // merges txParams obj onto txData.txParams
// use extend to ensure that all fields are filled // use extend to ensure that all fields are filled
updateTxParams (txId, txParams) { updateTxParams (txId, txParams) {
var txMeta = this.getTx(txId) const txMeta = this.getTx(txId)
txMeta.txParams = extend(txMeta.txParams, txParams) txMeta.txParams = extend(txMeta.txParams, txParams)
this.updateTx(txMeta) this.updateTx(txMeta)
} }
@ -376,20 +380,19 @@ module.exports = class TransactionController extends EventEmitter {
// checks if a signed tx is in a block and // checks if a signed tx is in a block and
// if included sets the tx status as 'confirmed' // if included sets the tx status as 'confirmed'
checkForTxInBlock (block) { checkForTxInBlock (block) {
var signedTxList = this.getFilteredTxList({status: 'submitted'}) const signedTxList = this.getFilteredTxList({status: 'submitted'})
if (!signedTxList.length) return if (!signedTxList.length) return
signedTxList.forEach((txMeta) => { signedTxList.forEach((txMeta) => {
var txHash = txMeta.hash const txHash = txMeta.hash
var txId = txMeta.id const txId = txMeta.id
if (!txHash) { if (!txHash) {
return this.setTxStatusFailed(txId, { const noTxHashErr = new Error('We had an error while submitting this transaction, please try again.')
stack: 'checkForTxInBlock: custom tx-controller error message', noTxHashErr.name = 'NoTxHashError'
errCode: 'No hash was provided', this.setTxStatusFailed(txId, noTxHashErr)
message: 'We had an error while submitting this transaction, please try again.',
})
} }
block.transactions.forEach((tx) => { block.transactions.forEach((tx) => {
if (tx.hash === txHash) this.setTxStatusConfirmed(txId) if (tx.hash === txHash) this.setTxStatusConfirmed(txId)
}) })
@ -407,7 +410,45 @@ module.exports = class TransactionController extends EventEmitter {
if (diff > 1) this._checkPendingTxs() if (diff > 1) this._checkPendingTxs()
} }
// PRIVATE METHODS resubmitPendingTxs () {
const pending = this.getTxsByMetaData('status', 'submitted')
// only try resubmitting if their are transactions to resubmit
if (!pending.length) return
pending.forEach((txMeta) => this._resubmitTx(txMeta).catch((err) => {
/*
Dont marked as failed if the error is a "known" transaction warning
"there is already a transaction with the same sender-nonce
but higher/same gas price"
*/
const errorMessage = err.message.toLowerCase()
const isKnownTx = (
// geth
errorMessage.includes('replacement transaction underpriced')
|| errorMessage.includes('known transaction')
// parity
|| errorMessage.includes('gas price too low to replace')
|| errorMessage.includes('transaction with the same hash was already imported')
// other
|| errorMessage.includes('gateway timeout')
|| errorMessage.includes('nonce too low')
)
// ignore resubmit warnings, return early
if (isKnownTx) return
// encountered real error - transition to error state
this.setTxStatusFailed(txMeta.id, {
stack: err.stack || err.message,
errCode: err.errCode || err,
message: err.message,
})
}))
}
/* _____________________________________
| |
| PRIVATE METHODS |
|______________________________________*/
// Should find the tx in the tx list and // Should find the tx in the tx list and
// update it. // update it.
@ -420,7 +461,7 @@ module.exports = class TransactionController extends EventEmitter {
// - `'confirmed'` the tx has been included in a block. // - `'confirmed'` the tx has been included in a block.
// - `'failed'` the tx failed for some reason, included on tx data. // - `'failed'` the tx failed for some reason, included on tx data.
_setTxStatus (txId, status) { _setTxStatus (txId, status) {
var txMeta = this.getTx(txId) const txMeta = this.getTx(txId)
txMeta.status = status txMeta.status = status
this.emit(`${txMeta.id}:${status}`, txId) this.emit(`${txMeta.id}:${status}`, txId)
if (status === 'submitted' || status === 'rejected') { if (status === 'submitted' || status === 'rejected') {
@ -445,39 +486,6 @@ module.exports = class TransactionController extends EventEmitter {
this.memStore.updateState({ unapprovedTxs, selectedAddressTxList }) this.memStore.updateState({ unapprovedTxs, selectedAddressTxList })
} }
resubmitPendingTxs () {
const pending = this.getTxsByMetaData('status', 'submitted')
// only try resubmitting if their are transactions to resubmit
if (!pending.length) return
pending.forEach((txMeta) => this._resubmitTx(txMeta).catch((err) => {
/*
Dont marked as failed if the error is a "known" transaction warning
"there is already a transaction with the same sender-nonce
but higher/same gas price"
*/
const errorMessage = err.message.toLowerCase()
const isKnownTx = (
// geth
errorMessage.includes('replacement transaction underpriced')
|| errorMessage.includes('known transaction')
// parity
|| errorMessage.includes('gas price too low to replace')
|| errorMessage.includes('transaction with the same hash was already imported')
// other
|| errorMessage.includes('gateway timeout')
|| errorMessage.includes('nonce too low')
)
// ignore resubmit warnings, return early
if (isKnownTx) return
// encountered real error - transition to error state
this.setTxStatusFailed(txMeta.id, {
stack: err.stack || err.message,
errCode: err.errCode || err,
message: err.message,
})
}))
}
async _resubmitTx (txMeta) { async _resubmitTx (txMeta) {
const address = txMeta.txParams.from const address = txMeta.txParams.from
const balance = this.ethStore.getState().accounts[address].balance const balance = this.ethStore.getState().accounts[address].balance
@ -524,17 +532,14 @@ module.exports = class TransactionController extends EventEmitter {
// extra check in case there was an uncaught error during the // extra check in case there was an uncaught error during the
// signature and submission process // signature and submission process
if (!txHash) { if (!txHash) {
this.setTxStatusFailed(txId, { const noTxHashErr = new Error('We had an error while submitting this transaction, please try again.')
stack: '_checkPendingTxs: custom tx-controller error message', noTxHashErr.name = 'NoTxHashError'
errCode: 'No hash was provided', this.setTxStatusFailed(txId, noTxHashErr)
message: 'We had an error while submitting this transaction, please try again.',
})
return
} }
// get latest transaction status // get latest transaction status
let txParams let txParams
try { try {
txParams = await pify((cb) => this.query.getTransactionByHash(txHash, cb))() txParams = await this.query.getTransactionByHash(txHash)
if (!txParams) return if (!txParams) return
if (txParams.blockNumber) { if (txParams.blockNumber) {
this.setTxStatusConfirmed(txId) this.setTxStatusConfirmed(txId)
@ -547,12 +552,8 @@ module.exports = class TransactionController extends EventEmitter {
message: 'There was a problem loading this transaction.', message: 'There was a problem loading this transaction.',
} }
this.updateTx(txMeta) this.updateTx(txMeta)
log.error(err) throw err
} }
} }
} }
}
}
const warn = () => log.warn('warn was used no cb provided')

61
app/scripts/lib/tx-utils.js
Unescape View File

@ -1,4 +1,3 @@
const async = require('async')
const ethUtil = require('ethereumjs-util') const ethUtil = require('ethereumjs-util')
const Transaction = require('ethereumjs-tx') const Transaction = require('ethereumjs-tx')
const normalize = require('eth-sig-util').normalize const normalize = require('eth-sig-util').normalize
@ -10,24 +9,19 @@ its passed ethquery
and used to do things like calculate gas of a tx. and used to do things like calculate gas of a tx.
*/ */
module.exports = class txProviderUtils { module.exports = class txProvideUtils {
constructor (ethQuery) { constructor (ethQuery) {
this.query = ethQuery this.query = ethQuery
} }
analyzeGasUsage (txMeta, cb) { async analyzeGasUsage (txMeta) {
var self = this const block = await this.query.getBlockByNumber('latest', true)
this.query.getBlockByNumber('latest', true, (err, block) => { const estimatedGasHex = await this.estimateTxGas(txMeta, block.gasLimit)
if (err) return cb(err) this.setTxGas(txMeta, block.gasLimit, estimatedGasHex)
async.waterfall([ return txMeta
self.estimateTxGas.bind(self, txMeta, block.gasLimit),
self.setTxGas.bind(self, txMeta, block.gasLimit),
], cb)
})
} }
estimateTxGas (txMeta, blockGasLimitHex, cb) { async estimateTxGas (txMeta, blockGasLimitHex) {
const txParams = txMeta.txParams const txParams = txMeta.txParams
// check if gasLimit is already specified // check if gasLimit is already specified
txMeta.gasLimitSpecified = Boolean(txParams.gas) txMeta.gasLimitSpecified = Boolean(txParams.gas)
@ -38,10 +32,10 @@ module.exports = class txProviderUtils {
txParams.gas = bnToHex(saferGasLimitBN) txParams.gas = bnToHex(saferGasLimitBN)
} }
// run tx, see if it will OOG // run tx, see if it will OOG
this.query.estimateGas(txParams, cb) return this.query.estimateGas(txParams)
} }
setTxGas (txMeta, blockGasLimitHex, estimatedGasHex, cb) { setTxGas (txMeta, blockGasLimitHex, estimatedGasHex) {
txMeta.estimatedGas = estimatedGasHex txMeta.estimatedGas = estimatedGasHex
const txParams = txMeta.txParams const txParams = txMeta.txParams
@ -49,14 +43,12 @@ module.exports = class txProviderUtils {
// use original specified amount // use original specified amount
if (txMeta.gasLimitSpecified) { if (txMeta.gasLimitSpecified) {
txMeta.estimatedGas = txParams.gas txMeta.estimatedGas = txParams.gas
cb()
return return
} }
// if gasLimit not originally specified, // if gasLimit not originally specified,
// try adding an additional gas buffer to our estimation for safety // try adding an additional gas buffer to our estimation for safety
const recommendedGasHex = this.addGasBuffer(txMeta.estimatedGas, blockGasLimitHex) const recommendedGasHex = this.addGasBuffer(txMeta.estimatedGas, blockGasLimitHex)
txParams.gas = recommendedGasHex txParams.gas = recommendedGasHex
cb()
return return
} }
@ -74,22 +66,6 @@ module.exports = class txProviderUtils {
return bnToHex(upperGasLimitBn) return bnToHex(upperGasLimitBn)
} }
fillInTxParams (txParams, cb) {
const fromAddress = txParams.from
const reqs = {}
if (isUndef(txParams.gas)) reqs.gas = (cb) => this.query.estimateGas(txParams, cb)
if (isUndef(txParams.gasPrice)) reqs.gasPrice = (cb) => this.query.gasPrice(cb)
if (isUndef(txParams.nonce)) reqs.nonce = (cb) => this.query.getTransactionCount(fromAddress, 'pending', cb)
async.parallel(reqs, function (err, result) {
if (err) return cb(err)
// write results to txParams obj
Object.assign(txParams, result)
cb()
})
}
// builds ethTx from txParams object // builds ethTx from txParams object
buildEthTxFromParams (txParams) { buildEthTxFromParams (txParams) {
// normalize values // normalize values
@ -106,20 +82,13 @@ module.exports = class txProviderUtils {
return ethTx return ethTx
} }
publishTransaction (rawTx) { async publishTransaction (rawTx) {
return new Promise((resolve, reject) => { return await this.query.sendRawTransaction(rawTx)
this.query.sendRawTransaction(rawTx, (err, ress) => {
if (err) reject(err)
else resolve(ress)
})
})
} }
validateTxParams (txParams, cb) { async validateTxParams (txParams) {
if (('value' in txParams) && txParams.value.indexOf('-') === 0) { if (('value' in txParams) && txParams.value.indexOf('-') === 0) {
cb(new Error(`Invalid transaction value of ${txParams.value} not a positive number.`)) throw new Error(`Invalid transaction value of ${txParams.value} not a positive number.`)
} else {
cb()
} }
} }
@ -137,10 +106,6 @@ module.exports = class txProviderUtils {
// util // util
function isUndef (value) {
return value === undefined
}
function bnToHex (inputBn) { function bnToHex (inputBn) {
return ethUtil.addHexPrefix(inputBn.toString(16)) return ethUtil.addHexPrefix(inputBn.toString(16))
} }

30
app/scripts/metamask-controller.js
Unescape View File

@ -113,6 +113,7 @@ module.exports = class MetamaskController extends EventEmitter {
ethQuery: this.ethQuery, ethQuery: this.ethQuery,
ethStore: this.ethStore, ethStore: this.ethStore,
}) })
this.txController.on('newUnaprovedTx', opts.showUnapprovedTx.bind(opts))
// notices // notices
this.noticeController = new NoticeController({ this.noticeController = new NoticeController({
@ -203,7 +204,7 @@ module.exports = class MetamaskController extends EventEmitter {
cb(null, result) cb(null, result)
}, },
// tx signing // tx signing
processTransaction: (txParams, cb) => this.newUnapprovedTransaction(txParams, cb), processTransaction: nodeify(async (txParams) => await this.txController.newUnapprovedTransaction(txParams), this),
// old style msg signing // old style msg signing
processMessage: this.newUnsignedMessage.bind(this), processMessage: this.newUnsignedMessage.bind(this),
@ -316,7 +317,7 @@ module.exports = class MetamaskController extends EventEmitter {
exportAccount: nodeify(keyringController.exportAccount, keyringController), exportAccount: nodeify(keyringController.exportAccount, keyringController),
// txController // txController
cancelTransaction: txController.cancelTransaction.bind(txController), cancelTransaction: nodeify(txController.cancelTransaction, txController),
updateAndApproveTransaction: nodeify(txController.updateAndApproveTransaction, txController), updateAndApproveTransaction: nodeify(txController.updateAndApproveTransaction, txController),
// messageManager // messageManager
@ -461,27 +462,6 @@ module.exports = class MetamaskController extends EventEmitter {
// Identity Management // Identity Management
// //
newUnapprovedTransaction (txParams, cb) {
log.debug(`MetaMaskController newUnapprovedTransaction ${JSON.stringify(txParams)}`)
const self = this
self.txController.addUnapprovedTransaction(txParams, (err, txMeta) => {
if (err) return cb(err)
self.sendUpdate()
self.opts.showUnapprovedTx(txMeta)
// listen for tx completion (success, fail)
self.txController.once(`${txMeta.id}:finished`, (completedTx) => {
switch (completedTx.status) {
case 'submitted':
return cb(null, completedTx.hash)
case 'rejected':
return cb(new Error('MetaMask Tx Signature: User denied transaction signature.'))
default:
return cb(new Error(`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(completedTx.txParams)}`))
}
})
})
}
newUnsignedMessage (msgParams, cb) { newUnsignedMessage (msgParams, cb) {
const msgId = this.messageManager.addUnapprovedMessage(msgParams) const msgId = this.messageManager.addUnapprovedMessage(msgParams)
this.sendUpdate() this.sendUpdate()
@ -667,6 +647,4 @@ module.exports = class MetamaskController extends EventEmitter {
return Promise.resolve(rpcTarget) return Promise.resolve(rpcTarget)
}) })
} }
}
}

1
package.json
Unescape View File

@ -77,6 +77,7 @@
"ethereumjs-util": "ethereumjs/ethereumjs-util#ac5d0908536b447083ea422b435da27f26615de9", "ethereumjs-util": "ethereumjs/ethereumjs-util#ac5d0908536b447083ea422b435da27f26615de9",
"ethereumjs-wallet": "^0.6.0", "ethereumjs-wallet": "^0.6.0",
"ethjs-ens": "^2.0.0", "ethjs-ens": "^2.0.0",
"ethjs-query": "^0.2.6",
"express": "^4.14.0", "express": "^4.14.0",
"extension-link-enabler": "^1.0.0", "extension-link-enabler": "^1.0.0",
"extensionizer": "^1.0.0", "extensionizer": "^1.0.0",

164
test/unit/tx-controller-test.js
Unescape View File

@ -1,11 +1,11 @@
const assert = require('assert') const assert = require('assert')
const ethUtil = require('ethereumjs-util') const ethUtil = require('ethereumjs-util')
const EthTx = require('ethereumjs-tx') const EthTx = require('ethereumjs-tx')
const EthQuery = require('eth-query')
const ObservableStore = require('obs-store') const ObservableStore = require('obs-store')
const clone = require('clone') const clone = require('clone')
const sinon = require('sinon') const sinon = require('sinon')
const TransactionController = require('../../app/scripts/controllers/transactions') const TransactionController = require('../../app/scripts/controllers/transactions')
const TxProvideUtils = require('../../app/scripts/lib/tx-utils')
const noop = () => true const noop = () => true
const currentNetworkId = 42 const currentNetworkId = 42
const otherNetworkId = 36 const otherNetworkId = 36
@ -20,7 +20,6 @@ describe('Transaction Controller', function () {
txHistoryLimit: 10, txHistoryLimit: 10,
blockTracker: { getCurrentBlock: noop, on: noop, once: noop }, blockTracker: { getCurrentBlock: noop, on: noop, once: noop },
provider: { sendAsync: noop }, provider: { sendAsync: noop },
ethQuery: new EthQuery({ sendAsync: noop }),
ethStore: { getState: noop }, ethStore: { getState: noop },
signTransaction: (ethTx) => new Promise((resolve) => { signTransaction: (ethTx) => new Promise((resolve) => {
ethTx.sign(privKey) ethTx.sign(privKey)
@ -28,24 +27,147 @@ describe('Transaction Controller', function () {
}), }),
}) })
txController.nonceTracker.getNonceLock = () => Promise.resolve({ nextNonce: 0, releaseLock: noop }) txController.nonceTracker.getNonceLock = () => Promise.resolve({ nextNonce: 0, releaseLock: noop })
txController.query = new Proxy({}, {
get: (queryStubResult, key) => {
if (key === 'stubResult') {
return function (method, ...args) {
queryStubResult[method] = args
}
} else {
const returnValues = queryStubResult[key]
return () => Promise.resolve(...returnValues)
}
},
})
txController.txProviderUtils = new TxProvideUtils(txController.query)
})
describe('#newUnapprovedTransaction', function () {
let stub, txMeta, txParams
beforeEach(function () {
txParams = {
'from':'0xc684832530fcbddae4b4230a47e991ddcec2831d',
'to':'0xc684832530fcbddae4b4230a47e991ddcec2831d',
},
txMeta = {
status: 'unapproved',
id: 1,
metamaskNetworkId: currentNetworkId,
txParams,
}
txController._saveTxList([txMeta])
stub = sinon.stub(txController, 'addUnapprovedTransaction').returns(Promise.resolve(txMeta))
})
afterEach(function () {
stub.restore()
})
it('should emit newUnaprovedTx event and pass txMeta as the first argument', function (done) {
txController.once('newUnaprovedTx', (txMetaFromEmit) => {
assert(txMetaFromEmit, 'txMeta is falsey')
assert.equal(txMetaFromEmit.id, 1, 'the right txMeta was passed')
done()
})
txController.newUnapprovedTransaction(txParams)
.catch(done)
})
it('should resolve when finished and status is submitted and resolve with the hash', function (done) {
txController.once('newUnaprovedTx', (txMetaFromEmit) => {
setTimeout(() => {
console.log('HELLLO')
txController.setTxHash(txMetaFromEmit.id, '0x0')
txController.setTxStatusSubmitted(txMetaFromEmit.id)
}, 10)
})
txController.newUnapprovedTransaction(txParams)
.then((hash) => {
assert(hash, 'newUnapprovedTransaction needs to return the hash')
done()
})
.catch(done)
})
it('should reject when finished and status is rejected', function (done) {
txController.once('newUnaprovedTx', (txMetaFromEmit) => {
setTimeout(() => {
console.log('HELLLO')
txController.setTxStatusRejected(txMetaFromEmit.id)
}, 10)
})
txController.newUnapprovedTransaction(txParams)
.catch((err) => {
if (err.message === 'MetaMask Tx Signature: User denied transaction signature.') done()
else done(err)
})
})
})
describe('#addUnapprovedTransaction', function () {
it('should add an unapproved transaction and return a valid txMeta', function (done) {
const addTxDefaultsStub = sinon.stub(txController, 'addTxDefaults').callsFake(() => Promise.resolve())
txController.addUnapprovedTransaction({})
.then((txMeta) => {
assert(('id' in txMeta), 'should have a id')
assert(('time' in txMeta), 'should have a time stamp')
assert(('metamaskNetworkId' in txMeta), 'should have a metamaskNetworkId')
assert(('txParams' in txMeta), 'should have a txParams')
assert(('history' in txMeta), 'should have a history')
const memTxMeta = txController.getTx(txMeta.id)
assert.deepEqual(txMeta, memTxMeta, `txMeta should be stored in txController after adding it\n expected: ${txMeta} \n got: ${memTxMeta}`)
addTxDefaultsStub.restore()
done()
}).catch(done)
})
})
describe('#addTxDefaults', function () {
it('should add the tx defaults if their are none', function (done) {
let txMeta = {
'txParams': {
'from':'0xc684832530fcbddae4b4230a47e991ddcec2831d',
'to':'0xc684832530fcbddae4b4230a47e991ddcec2831d',
},
}
txController.query.stubResult('gasPrice', '0x4a817c800')
txController.query.stubResult('getBlockByNumber', { gasLimit: '0x47b784' })
txController.query.stubResult('estimateGas', '0x5209')
txController.addTxDefaults(txMeta)
.then((txMetaWithDefaults) => {
assert(txMetaWithDefaults.txParams.value, '0x0','should have added 0x0 as the value')
assert(txMetaWithDefaults.txParams.gasPrice, 'should have added the gas price')
assert(txMetaWithDefaults.txParams.gas, 'should have added the gas field')
done()
})
.catch(done)
})
}) })
describe('#validateTxParams', function () { describe('#validateTxParams', function () {
it('returns null for positive values', function () { it('does not throw for positive values', function (done) {
var sample = { var sample = {
value: '0x01', value: '0x01',
} }
txController.txProviderUtils.validateTxParams(sample, (err) => { txController.txProviderUtils.validateTxParams(sample).then(() => {
assert.equal(err, null, 'no error') done()
}) }).catch(done)
}) })
it('returns error for negative values', function () { it('returns error for negative values', function (done) {
var sample = { var sample = {
value: '-0x01', value: '-0x01',
} }
txController.txProviderUtils.validateTxParams(sample, (err) => { txController.txProviderUtils.validateTxParams(sample)
.then(() => done('expected to thrown on negativity values but didn\'t'))
.catch((err) => {
assert.ok(err, 'error') assert.ok(err, 'error')
done()
}) })
}) })
}) })
@ -56,9 +178,6 @@ describe('Transaction Controller', function () {
assert.ok(Array.isArray(result)) assert.ok(Array.isArray(result))
assert.equal(result.length, 0) assert.equal(result.length, 0)
}) })
it('should also return transactions from local storage if any', function () {
})
}) })
describe('#addTx', function () { describe('#addTx', function () {
@ -276,16 +395,15 @@ describe('Transaction Controller', function () {
txController.addTx(txMeta) txController.addTx(txMeta)
const estimateStub = sinon.stub(txController.txProviderUtils.query, 'estimateGas') txController.query.stubResult('estimateGas', wrongValue)
.callsArgWithAsync(1, null, wrongValue) txController.query.stubResult('gasPrice', wrongValue)
const priceStub = sinon.stub(txController.txProviderUtils.query, 'gasPrice') const signStub = sinon.stub(txController, 'signTransaction').callsFake(() => Promise.resolve())
.callsArgWithAsync(0, null, wrongValue)
const pubStub = sinon.stub(txController, 'publishTransaction').callsFake(() => {
const signStub = sinon.stub(txController, 'signTransaction', () => Promise.resolve()) txController.setTxHash('1', originalValue)
txController.setTxStatusSubmitted('1')
const pubStub = sinon.stub(txController.txProviderUtils, 'publishTransaction', () => Promise.resolve(originalValue)) })
txController.approveTransaction(txMeta.id).then(() => { txController.approveTransaction(txMeta.id).then(() => {
const result = txController.getTx(txMeta.id) const result = txController.getTx(txMeta.id)
@ -294,9 +412,6 @@ describe('Transaction Controller', function () {
assert.equal(params.gas, originalValue, 'gas unmodified') assert.equal(params.gas, originalValue, 'gas unmodified')
assert.equal(params.gasPrice, originalValue, 'gas price unmodified') assert.equal(params.gasPrice, originalValue, 'gas price unmodified')
assert.equal(result.hash, originalValue, `hash was set \n got: ${result.hash} \n expected: ${originalValue}`) assert.equal(result.hash, originalValue, `hash was set \n got: ${result.hash} \n expected: ${originalValue}`)
estimateStub.restore()
priceStub.restore()
signStub.restore() signStub.restore()
pubStub.restore() pubStub.restore()
done() done()
@ -352,9 +467,8 @@ describe('Transaction Controller', function () {
}) })
.catch((err) => { .catch((err) => {
assert.ifError(err, 'should not throw an error') assert.ifError(err, 'should not throw an error')
done() done(err)
}) })
}) })
}) })
}) })
Write Preview
Loading…
Cancel
Save