const EventEmitter = require('events') const async = require('async') const extend = require('xtend') const Semaphore = require('semaphore') const ethUtil = require('ethereumjs-util') const TxProviderUtil = require('./lib/tx-utils') const createId = require('./lib/random-id') module.exports = class TransactionManager extends EventEmitter { constructor (opts) { super() this.txList = opts.txList || [] this._setTxList = opts.setTxList this.txHistoryLimit = opts.txHistoryLimit this.getSelectedAccount = opts.getSelectedAccount this.provider = opts.provider this.query = opts.query this.blockTracker = opts.blockTracker this.txProviderUtils = new TxProviderUtil(this.provider) this.blockTracker.on('block', this.checkForTxInBlock.bind(this)) this.getGasMultiplier = opts.getGasMultiplier this.getNetwork = opts.getNetwork this.signEthTx = opts.signTransaction this.nonceLock = Semaphore(1) } getState () { var selectedAccount = this.getSelectedAccount() return { transactions: this.getTxList(), unconfTxs: this.getUnapprovedTxList(), selectedAccountTxList: this.getFilteredTxList({metamaskNetworkId: this.getNetwork(), from: selectedAccount}), } } // Returns the tx list getTxList () { return this.txList } // Adds a tx to the txlist addTx (txMeta) { var txList = this.getTxList() var txHistoryLimit = this.txHistoryLimit // checks if the length of th tx history is // longer then desired persistence limit // and then if it is removes only confirmed // or rejected tx's. // not tx's that are pending or unapproved if (txList.length > txHistoryLimit - 1) { var index = txList.findIndex((metaTx) => metaTx.status === 'confirmed' || metaTx.status === 'rejected') txList.splice(index, 1) } txList.push(txMeta) this._saveTxList(txList) this.once(`${txMeta.id}:signed`, function (txId) { this.removeAllListeners(`${txMeta.id}:rejected`) }) this.once(`${txMeta.id}:rejected`, function (txId) { this.removeAllListeners(`${txMeta.id}:signed`) }) this.emit('updateBadge') this.emit(`${txMeta.id}:unapproved`, txMeta) } // gets tx by Id and returns it getTx (txId, cb) { var txList = this.getTxList() var txMeta = txList.find(txData => txData.id === txId) return cb ? cb(txMeta) : txMeta } // updateTx (txMeta) { var txId = txMeta.id var txList = this.getTxList() var index = txList.findIndex(txData => txData.id === txId) txList[index] = txMeta this._saveTxList(txList) } get unapprovedTxCount () { return Object.keys(this.getUnapprovedTxList()).length } get pendingTxCount () { return this.getTxsByMetaData('status', 'signed').length } addUnapprovedTransaction (txParams, done) { let txMeta async.waterfall([ // validate (cb) => this.validateTxParams(txParams, cb), // prepare txMeta (cb) => { // create txMeta obj with parameters and meta data let time = (new Date()).getTime() let txId = createId() txParams.metamaskId = txId txParams.metamaskNetworkId = this.getNetwork() txMeta = { id: txId, time: time, status: 'unapproved', gasMultiplier: this.getGasMultiplier() || 1, metamaskNetworkId: this.getNetwork(), txParams: txParams, } // calculate metadata for tx this.txProviderUtils.analyzeGasUsage(txMeta, cb) }, // save txMeta (cb) => { this.addTx(txMeta) cb(null, txMeta) }, ], done) } getUnapprovedTxList () { var txList = this.getTxList() return txList.filter((txMeta) => txMeta.status === 'unapproved') .reduce((result, tx) => { result[tx.id] = tx return result }, {}) } approveTransaction (txId, cb = warn) { const self = this // approve self.setTxStatusApproved(txId) // only allow one tx at a time for atomic nonce usage self.nonceLock.take(() => { // begin signature process async.waterfall([ (cb) => self.fillInTxParams(txId, cb), (cb) => self.signTransaction(txId, cb), (rawTx, cb) => self.publishTransaction(txId, rawTx, cb), ], (err) => { self.nonceLock.leave() // TODO: move tx to error state if (err) return cb(err) cb() }) }) } cancelTransaction (txId, cb = warn) { this.setTxStatusRejected(txId) cb() } fillInTxParams (txId, cb) { let txMeta = this.getTx(txId) this.txProviderUtils.fillInTxParams(txMeta.txParams, (err) => { if (err) return cb(err) this.updateTx(txMeta) cb() }) } signTransaction (txId, cb) { let txMeta = this.getTx(txId) let txParams = txMeta.txParams let fromAddress = txParams.from let ethTx = this.txProviderUtils.buildEthTxFromParams(txParams, txMeta.gasMultiplier) this.signEthTx(ethTx, fromAddress).then(() => { this.updateTxAsSigned(txMeta.id, ethTx) cb(null, ethUtil.bufferToHex(ethTx.serialize())) }).catch((err) => { cb(err) }) } publishTransaction (txId, rawTx, cb) { this.txProviderUtils.publishTransaction(rawTx, (err) => { if (err) return cb(err) this.setTxStatusSubmitted(txId, rawTx) cb() }) } validateTxParams (txParams, cb) { if (('value' in txParams) && txParams.value.indexOf('-') === 0) { cb(new Error(`Invalid transaction value of ${txParams.value} not a positive number.`)) } else { cb() } } // receives a signed tx object and updates the tx hash updateTxAsSigned (txId, ethTx) { // Add the tx hash to the persisted meta-tx object let txHash = ethUtil.bufferToHex(ethTx.hash()) let txMeta = this.getTx(txId) txMeta.hash = txHash this.updateTx(txMeta) this.setTxStatusSigned(txMeta.id) } /* Takes an object of fields to search for eg: var thingsToLookFor = { to: '0x0..', from: '0x0..', status: 'signed', } and returns a list of tx with all options matching this is for things like filtering a the tx list for only tx's from 1 account or for filltering for all txs from one account and that have been 'confirmed' */ getFilteredTxList (opts) { var filteredTxList Object.keys(opts).forEach((key) => { filteredTxList = this.getTxsByMetaData(key, opts[key], filteredTxList) }) return filteredTxList } getTxsByMetaData (key, value, txList = this.getTxList()) { return txList.filter((txMeta) => { if (key in txMeta.txParams) { return txMeta.txParams[key] === value } else { return txMeta[key] === value } }) } // STATUS METHODS // get::set status // should return the status of the tx. getTxStatus (txId) { const txMeta = this.getTx(txId) return txMeta.status } // should update the status of the tx to 'rejected'. setTxStatusRejected (txId) { this._setTxStatus(txId, 'rejected') } // should update the status of the tx to 'approved'. setTxStatusApproved (txId) { this._setTxStatus(txId, 'approved') } // should update the status of the tx to 'signed'. setTxStatusSigned (txId) { this._setTxStatus(txId, 'signed') } // should update the status of the tx to 'submitted'. setTxStatusSubmitted (txId, rawTx) { this._setTxStatus(txId, 'submitted', rawTx) } // should update the status of the tx to 'confirmed'. setTxStatusConfirmed (txId) { this._setTxStatus(txId, 'confirmed') } // merges txParams obj onto txData.txParams // use extend to ensure that all fields are filled updateTxParams (txId, txParams) { var txMeta = this.getTx(txId) txMeta.txParams = extend(txMeta.txParams, txParams) this.updateTx(txMeta) } // checks if a signed tx is in a block and // if included sets the tx status as 'confirmed' checkForTxInBlock () { var signedTxList = this.getFilteredTxList({status: 'signed', err: undefined}) if (!signedTxList.length) return signedTxList.forEach((tx) => { var txHash = tx.hash var txId = tx.id if (!txHash) return this.txProviderUtils.query.getTransactionByHash(txHash, (err, txMeta) => { if (err || !txMeta) { tx.err = err || 'Tx could possibly have not been submitted' this.updateTx(tx) return txMeta ? console.error(err) : console.debug(`txMeta is ${txMeta} for:`, tx) } if (txMeta.blockNumber) { this.setTxStatusConfirmed(txId) } }) }) } // PRIVATE METHODS // Should find the tx in the tx list and // update it. // should set the status in txData // - `'unapproved'` the user has not responded // - `'rejected'` the user has responded no! // - `'approved'` the user has approved the tx // - `'signed'` the tx is signed // - `'submitted'` the tx is sent to a server // - `'confirmed'` the tx has been included in a block. // "value" is an optional parameter to emit _setTxStatus (txId, status, value) { var txMeta = this.getTx(txId) txMeta.status = status this.emit(`${txMeta.id}:${status}`, value) this.emit('updateBadge') this.updateTx(txMeta) } // Saves the new/updated txList. // Function is intended only for internal use _saveTxList (txList) { this.txList = txList this._setTxList(txList) } } const warn = () => console.warn('warn was used no cb provided')