2017-08-11 23:19:35 +02:00
|
|
|
const extend = require('xtend')
|
2017-09-12 18:59:59 +02:00
|
|
|
const EventEmitter = require('events')
|
2017-08-11 23:19:35 +02:00
|
|
|
const ObservableStore = require('obs-store')
|
2017-09-13 23:27:27 +02:00
|
|
|
const ethUtil = require('ethereumjs-util')
|
2017-08-21 20:35:22 +02:00
|
|
|
const txStateHistoryHelper = require('./tx-state-history-helper')
|
2017-08-11 23:19:35 +02:00
|
|
|
|
2017-09-12 18:59:59 +02:00
|
|
|
module.exports = class TransactionStateManger extends EventEmitter {
|
2017-09-27 01:52:08 +02:00
|
|
|
constructor ({ initState, txHistoryLimit, getNetwork }) {
|
2017-09-12 18:59:59 +02:00
|
|
|
super()
|
|
|
|
|
|
|
|
this.store = new ObservableStore(
|
|
|
|
extend({
|
|
|
|
transactions: [],
|
|
|
|
}, initState))
|
2017-08-11 23:19:35 +02:00
|
|
|
this.txHistoryLimit = txHistoryLimit
|
|
|
|
this.getNetwork = getNetwork
|
|
|
|
}
|
2017-09-27 01:52:08 +02:00
|
|
|
|
|
|
|
// Returns the number of txs for the current network.
|
2017-08-11 23:19:35 +02:00
|
|
|
getTxCount () {
|
|
|
|
return this.getTxList().length
|
|
|
|
}
|
|
|
|
|
|
|
|
getTxList () {
|
|
|
|
const network = this.getNetwork()
|
|
|
|
const fullTxList = this.getFullTxList()
|
|
|
|
return fullTxList.filter((txMeta) => txMeta.metamaskNetworkId === network)
|
|
|
|
}
|
|
|
|
|
|
|
|
getFullTxList () {
|
2017-09-12 18:59:59 +02:00
|
|
|
return this.store.getState().transactions
|
2017-08-11 23:19:35 +02:00
|
|
|
}
|
|
|
|
|
2017-08-18 21:23:35 +02:00
|
|
|
// Returns the tx list
|
|
|
|
getUnapprovedTxList () {
|
|
|
|
const txList = this.getTxsByMetaData('status', 'unapproved')
|
|
|
|
return txList.reduce((result, tx) => {
|
|
|
|
result[tx.id] = tx
|
|
|
|
return result
|
|
|
|
}, {})
|
|
|
|
}
|
|
|
|
|
2017-09-08 23:24:40 +02:00
|
|
|
getPendingTransactions (address) {
|
|
|
|
const opts = { status: 'submitted' }
|
|
|
|
if (address) opts.from = address
|
2017-09-09 00:02:36 +02:00
|
|
|
return this.getFilteredTxList(opts)
|
2017-09-08 23:24:40 +02:00
|
|
|
}
|
|
|
|
|
2017-10-06 21:50:33 +02:00
|
|
|
getConfirmedTransactions (address) {
|
|
|
|
const opts = { status: 'confirmed' }
|
|
|
|
if (address) opts.from = address
|
|
|
|
return this.getFilteredTxList(opts)
|
|
|
|
}
|
|
|
|
|
2017-08-11 23:19:35 +02:00
|
|
|
addTx (txMeta) {
|
2017-08-18 21:23:35 +02:00
|
|
|
this.once(`${txMeta.id}:signed`, function (txId) {
|
|
|
|
this.removeAllListeners(`${txMeta.id}:rejected`)
|
|
|
|
})
|
|
|
|
this.once(`${txMeta.id}:rejected`, function (txId) {
|
|
|
|
this.removeAllListeners(`${txMeta.id}:signed`)
|
|
|
|
})
|
2017-08-21 20:35:22 +02:00
|
|
|
// initialize history
|
|
|
|
txMeta.history = []
|
|
|
|
// capture initial snapshot of txMeta for history
|
|
|
|
const snapshot = txStateHistoryHelper.snapshotFromTxMeta(txMeta)
|
|
|
|
txMeta.history.push(snapshot)
|
2017-08-18 21:23:35 +02:00
|
|
|
|
2017-08-11 23:19:35 +02:00
|
|
|
const transactions = this.getFullTxList()
|
|
|
|
const txCount = this.getTxCount()
|
|
|
|
const txHistoryLimit = this.txHistoryLimit
|
|
|
|
|
|
|
|
// checks if the length of the 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 (txCount > txHistoryLimit - 1) {
|
2017-09-27 01:52:08 +02:00
|
|
|
const index = transactions.findIndex((metaTx) => metaTx.status === 'confirmed' || metaTx.status === 'rejected')
|
2017-08-11 23:19:35 +02:00
|
|
|
transactions.splice(index, 1)
|
|
|
|
}
|
|
|
|
transactions.push(txMeta)
|
|
|
|
this._saveTxList(transactions)
|
2017-08-21 20:35:22 +02:00
|
|
|
return txMeta
|
2017-08-11 23:19:35 +02:00
|
|
|
}
|
|
|
|
// gets tx by Id and returns it
|
|
|
|
getTx (txId) {
|
|
|
|
const txMeta = this.getTxsByMetaData('id', txId)[0]
|
|
|
|
return txMeta
|
|
|
|
}
|
|
|
|
|
2017-10-02 22:41:29 +02:00
|
|
|
updateTx (txMeta, note) {
|
2017-09-13 23:27:27 +02:00
|
|
|
if (txMeta.txParams) {
|
|
|
|
Object.keys(txMeta.txParams).forEach((key) => {
|
|
|
|
let value = txMeta.txParams[key]
|
|
|
|
if (typeof value !== 'string') console.error(`${key}: ${value} in txParams is not a string`)
|
|
|
|
if (!ethUtil.isHexPrefixed(value)) console.error('is not hex prefixed, anything on txParams must be hex prefixed')
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2017-08-11 23:19:35 +02:00
|
|
|
// create txMeta snapshot for history
|
2017-08-21 20:35:22 +02:00
|
|
|
const currentState = txStateHistoryHelper.snapshotFromTxMeta(txMeta)
|
|
|
|
// recover previous tx state obj
|
|
|
|
const previousState = txStateHistoryHelper.replayHistory(txMeta.history)
|
|
|
|
// generate history entry and add to history
|
2017-10-02 22:41:29 +02:00
|
|
|
const entry = txStateHistoryHelper.generateHistoryEntry(previousState, currentState, note)
|
|
|
|
txMeta.history.push(entry)
|
2017-08-21 20:35:22 +02:00
|
|
|
|
|
|
|
// commit txMeta to state
|
2017-08-11 23:19:35 +02:00
|
|
|
const txId = txMeta.id
|
|
|
|
const txList = this.getFullTxList()
|
|
|
|
const index = txList.findIndex(txData => txData.id === txId)
|
|
|
|
txList[index] = txMeta
|
|
|
|
this._saveTxList(txList)
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// merges txParams obj onto txData.txParams
|
|
|
|
// use extend to ensure that all fields are filled
|
|
|
|
updateTxParams (txId, txParams) {
|
|
|
|
const txMeta = this.getTx(txId)
|
|
|
|
txMeta.txParams = extend(txMeta.txParams, txParams)
|
2017-10-02 22:41:29 +02:00
|
|
|
this.updateTx(txMeta, `txStateManager#updateTxParams`)
|
2017-08-11 23:19:35 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
Takes an object of fields to search for eg:
|
|
|
|
let thingsToLookFor = {
|
|
|
|
to: '0x0..',
|
|
|
|
from: '0x0..',
|
|
|
|
status: 'signed',
|
|
|
|
err: undefined,
|
|
|
|
}
|
|
|
|
and returns a list of tx with all
|
|
|
|
options matching
|
|
|
|
|
|
|
|
****************HINT****************
|
|
|
|
| `err: undefined` is like looking |
|
|
|
|
| for a tx with no err |
|
|
|
|
| so you can also search txs that |
|
|
|
|
| dont have something as well by |
|
|
|
|
| setting the value as undefined |
|
|
|
|
************************************
|
|
|
|
|
|
|
|
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, initialList) {
|
|
|
|
let filteredTxList = initialList
|
|
|
|
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 (txMeta.txParams[key]) {
|
|
|
|
return txMeta.txParams[key] === value
|
|
|
|
} else {
|
|
|
|
return txMeta[key] === value
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// STATUS METHODS
|
|
|
|
// statuses:
|
|
|
|
// - `'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.
|
|
|
|
// - `'failed'` the tx failed for some reason, included on tx data.
|
|
|
|
|
|
|
|
// 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) {
|
|
|
|
this._setTxStatus(txId, 'submitted')
|
|
|
|
}
|
|
|
|
|
|
|
|
// should update the status of the tx to 'confirmed'.
|
|
|
|
setTxStatusConfirmed (txId) {
|
|
|
|
this._setTxStatus(txId, 'confirmed')
|
|
|
|
}
|
|
|
|
|
2017-09-06 23:01:07 +02:00
|
|
|
setTxStatusFailed (txId, err) {
|
2017-08-11 23:19:35 +02:00
|
|
|
const txMeta = this.getTx(txId)
|
2017-09-06 23:01:07 +02:00
|
|
|
txMeta.err = {
|
|
|
|
message: err.toString(),
|
|
|
|
stack: err.stack,
|
|
|
|
}
|
2017-08-11 23:19:35 +02:00
|
|
|
this.updateTx(txMeta)
|
|
|
|
this._setTxStatus(txId, 'failed')
|
|
|
|
}
|
|
|
|
|
2017-09-12 18:59:59 +02:00
|
|
|
//
|
|
|
|
// PRIVATE METHODS
|
|
|
|
//
|
2017-08-11 23:19:35 +02:00
|
|
|
|
|
|
|
// 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.
|
|
|
|
// - `'failed'` the tx failed for some reason, included on tx data.
|
|
|
|
_setTxStatus (txId, status) {
|
|
|
|
const txMeta = this.getTx(txId)
|
|
|
|
txMeta.status = status
|
|
|
|
this.emit(`${txMeta.id}:${status}`, txId)
|
2017-09-27 01:52:08 +02:00
|
|
|
this.emit(`tx:status-update`, txId, status)
|
2017-08-11 23:19:35 +02:00
|
|
|
if (status === 'submitted' || status === 'rejected') {
|
|
|
|
this.emit(`${txMeta.id}:finished`, txMeta)
|
|
|
|
}
|
2017-10-02 22:41:29 +02:00
|
|
|
this.updateTx(txMeta, `txStateManager: setting status to ${status}`)
|
2017-09-27 01:52:08 +02:00
|
|
|
this.emit('update:badge')
|
2017-08-11 23:19:35 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Saves the new/updated txList.
|
|
|
|
// Function is intended only for internal use
|
|
|
|
_saveTxList (transactions) {
|
2017-09-12 18:59:59 +02:00
|
|
|
this.store.updateState({ transactions })
|
2017-08-11 23:19:35 +02:00
|
|
|
}
|
2017-10-06 21:50:33 +02:00
|
|
|
}
|