Merge pull request #2035 from MetaMask/transactionControllerRefractorPt3
Transaction controller refractor pt3feature/default_network_editable
kumavis
7 years ago
committed by
GitHub
commit
5bbea78306
@ -0,0 +1,245 @@ |
||||
const extend = require('xtend') |
||||
const EventEmitter = require('events') |
||||
const ObservableStore = require('obs-store') |
||||
const ethUtil = require('ethereumjs-util') |
||||
const txStateHistoryHelper = require('./tx-state-history-helper') |
||||
|
||||
module.exports = class TransactionStateManger extends EventEmitter { |
||||
constructor ({ initState, txHistoryLimit, getNetwork }) { |
||||
super() |
||||
|
||||
this.store = new ObservableStore( |
||||
extend({ |
||||
transactions: [], |
||||
}, initState)) |
||||
this.txHistoryLimit = txHistoryLimit |
||||
this.getNetwork = getNetwork |
||||
} |
||||
|
||||
// Returns the number of txs for the current network.
|
||||
getTxCount () { |
||||
return this.getTxList().length |
||||
} |
||||
|
||||
getTxList () { |
||||
const network = this.getNetwork() |
||||
const fullTxList = this.getFullTxList() |
||||
return fullTxList.filter((txMeta) => txMeta.metamaskNetworkId === network) |
||||
} |
||||
|
||||
getFullTxList () { |
||||
return this.store.getState().transactions |
||||
} |
||||
|
||||
// Returns the tx list
|
||||
getUnapprovedTxList () { |
||||
const txList = this.getTxsByMetaData('status', 'unapproved') |
||||
return txList.reduce((result, tx) => { |
||||
result[tx.id] = tx |
||||
return result |
||||
}, {}) |
||||
} |
||||
|
||||
getPendingTransactions (address) { |
||||
const opts = { status: 'submitted' } |
||||
if (address) opts.from = address |
||||
return this.getFilteredTxList(opts) |
||||
} |
||||
|
||||
addTx (txMeta) { |
||||
this.once(`${txMeta.id}:signed`, function (txId) { |
||||
this.removeAllListeners(`${txMeta.id}:rejected`) |
||||
}) |
||||
this.once(`${txMeta.id}:rejected`, function (txId) { |
||||
this.removeAllListeners(`${txMeta.id}:signed`) |
||||
}) |
||||
// initialize history
|
||||
txMeta.history = [] |
||||
// capture initial snapshot of txMeta for history
|
||||
const snapshot = txStateHistoryHelper.snapshotFromTxMeta(txMeta) |
||||
txMeta.history.push(snapshot) |
||||
|
||||
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) { |
||||
const index = transactions.findIndex((metaTx) => metaTx.status === 'confirmed' || metaTx.status === 'rejected') |
||||
transactions.splice(index, 1) |
||||
} |
||||
transactions.push(txMeta) |
||||
this._saveTxList(transactions) |
||||
return txMeta |
||||
} |
||||
// gets tx by Id and returns it
|
||||
getTx (txId) { |
||||
const txMeta = this.getTxsByMetaData('id', txId)[0] |
||||
return txMeta |
||||
} |
||||
|
||||
updateTx (txMeta) { |
||||
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') |
||||
}) |
||||
} |
||||
|
||||
// create txMeta snapshot for history
|
||||
const currentState = txStateHistoryHelper.snapshotFromTxMeta(txMeta) |
||||
// recover previous tx state obj
|
||||
const previousState = txStateHistoryHelper.replayHistory(txMeta.history) |
||||
// generate history entry and add to history
|
||||
const entry = txStateHistoryHelper.generateHistoryEntry(previousState, currentState) |
||||
txMeta.history.push(entry) |
||||
|
||||
// commit txMeta to state
|
||||
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) |
||||
this.updateTx(txMeta) |
||||
} |
||||
|
||||
/* |
||||
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') |
||||
} |
||||
|
||||
setTxStatusFailed (txId, err) { |
||||
const txMeta = this.getTx(txId) |
||||
txMeta.err = { |
||||
message: err.toString(), |
||||
stack: err.stack, |
||||
} |
||||
this.updateTx(txMeta) |
||||
this._setTxStatus(txId, 'failed') |
||||
} |
||||
|
||||
//
|
||||
// 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.
|
||||
// - `'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) |
||||
this.emit(`tx:status-update`, txId, status) |
||||
if (status === 'submitted' || status === 'rejected') { |
||||
this.emit(`${txMeta.id}:finished`, txMeta) |
||||
} |
||||
this.updateTx(txMeta) |
||||
this.emit('update:badge') |
||||
} |
||||
|
||||
// Saves the new/updated txList.
|
||||
// Function is intended only for internal use
|
||||
_saveTxList (transactions) { |
||||
this.store.updateState({ transactions }) |
||||
} |
||||
} |
||||
@ -0,0 +1,241 @@ |
||||
const assert = require('assert') |
||||
const clone = require('clone') |
||||
const ObservableStore = require('obs-store') |
||||
const TxStateManager = require('../../app/scripts/lib/tx-state-manager') |
||||
const txStateHistoryHelper = require('../../app/scripts/lib/tx-state-history-helper') |
||||
const noop = () => true |
||||
|
||||
describe('TransactionStateManger', function () { |
||||
let txStateManager |
||||
const currentNetworkId = 42 |
||||
const otherNetworkId = 2 |
||||
|
||||
beforeEach(function () { |
||||
txStateManager = new TxStateManager({ |
||||
initState: { |
||||
transactions: [], |
||||
}, |
||||
txHistoryLimit: 10, |
||||
getNetwork: () => currentNetworkId |
||||
}) |
||||
}) |
||||
|
||||
describe('#setTxStatusSigned', function () { |
||||
it('sets the tx status to signed', function () { |
||||
let tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx, noop) |
||||
txStateManager.setTxStatusSigned(1) |
||||
let result = txStateManager.getTxList() |
||||
assert.ok(Array.isArray(result)) |
||||
assert.equal(result.length, 1) |
||||
assert.equal(result[0].status, 'signed') |
||||
}) |
||||
|
||||
it('should emit a signed event to signal the exciton of callback', (done) => { |
||||
let tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
const noop = function () { |
||||
assert(true, 'event listener has been triggered and noop executed') |
||||
done() |
||||
} |
||||
txStateManager.addTx(tx) |
||||
txStateManager.on('1:signed', noop) |
||||
txStateManager.setTxStatusSigned(1) |
||||
|
||||
}) |
||||
}) |
||||
|
||||
describe('#setTxStatusRejected', function () { |
||||
it('sets the tx status to rejected', function () { |
||||
let tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx) |
||||
txStateManager.setTxStatusRejected(1) |
||||
let result = txStateManager.getTxList() |
||||
assert.ok(Array.isArray(result)) |
||||
assert.equal(result.length, 1) |
||||
assert.equal(result[0].status, 'rejected') |
||||
}) |
||||
|
||||
it('should emit a rejected event to signal the exciton of callback', (done) => { |
||||
let tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx) |
||||
const noop = function (err, txId) { |
||||
assert(true, 'event listener has been triggered and noop executed') |
||||
done() |
||||
} |
||||
txStateManager.on('1:rejected', noop) |
||||
txStateManager.setTxStatusRejected(1) |
||||
}) |
||||
}) |
||||
|
||||
describe('#getFullTxList', function () { |
||||
it('when new should return empty array', function () { |
||||
let result = txStateManager.getTxList() |
||||
assert.ok(Array.isArray(result)) |
||||
assert.equal(result.length, 0) |
||||
}) |
||||
}) |
||||
|
||||
describe('#getTxList', function () { |
||||
it('when new should return empty array', function () { |
||||
let result = txStateManager.getTxList() |
||||
assert.ok(Array.isArray(result)) |
||||
assert.equal(result.length, 0) |
||||
}) |
||||
}) |
||||
|
||||
describe('#addTx', function () { |
||||
it('adds a tx returned in getTxList', function () { |
||||
let tx = { id: 1, status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx, noop) |
||||
let result = txStateManager.getTxList() |
||||
assert.ok(Array.isArray(result)) |
||||
assert.equal(result.length, 1) |
||||
assert.equal(result[0].id, 1) |
||||
}) |
||||
|
||||
it('does not override txs from other networks', function () { |
||||
let tx = { id: 1, status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
let tx2 = { id: 2, status: 'confirmed', metamaskNetworkId: otherNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx, noop) |
||||
txStateManager.addTx(tx2, noop) |
||||
let result = txStateManager.getFullTxList() |
||||
let result2 = txStateManager.getTxList() |
||||
assert.equal(result.length, 2, 'txs were deleted') |
||||
assert.equal(result2.length, 1, 'incorrect number of txs on network.') |
||||
}) |
||||
|
||||
it('cuts off early txs beyond a limit', function () { |
||||
const limit = txStateManager.txHistoryLimit |
||||
for (let i = 0; i < limit + 1; i++) { |
||||
const tx = { id: i, time: new Date(), status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx, noop) |
||||
} |
||||
let result = txStateManager.getTxList() |
||||
assert.equal(result.length, limit, `limit of ${limit} txs enforced`) |
||||
assert.equal(result[0].id, 1, 'early txs truncted') |
||||
}) |
||||
|
||||
it('cuts off early txs beyond a limit whether or not it is confirmed or rejected', function () { |
||||
const limit = txStateManager.txHistoryLimit |
||||
for (let i = 0; i < limit + 1; i++) { |
||||
const tx = { id: i, time: new Date(), status: 'rejected', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx, noop) |
||||
} |
||||
let result = txStateManager.getTxList() |
||||
assert.equal(result.length, limit, `limit of ${limit} txs enforced`) |
||||
assert.equal(result[0].id, 1, 'early txs truncted') |
||||
}) |
||||
|
||||
it('cuts off early txs beyond a limit but does not cut unapproved txs', function () { |
||||
let unconfirmedTx = { id: 0, time: new Date(), status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(unconfirmedTx, noop) |
||||
const limit = txStateManager.txHistoryLimit |
||||
for (let i = 1; i < limit + 1; i++) { |
||||
const tx = { id: i, time: new Date(), status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} } |
||||
txStateManager.addTx(tx, noop) |
||||
} |
||||
let result = txStateManager.getTxList() |
||||
assert.equal(result.length, limit, `limit of ${limit} txs enforced`) |
||||
assert.equal(result[0].id, 0, 'first tx should still be there') |
||||
assert.equal(result[0].status, 'unapproved', 'first tx should be unapproved') |
||||
assert.equal(result[1].id, 2, 'early txs truncted') |
||||
}) |
||||
}) |
||||
|
||||
describe('#updateTx', function () { |
||||
it('replaces the tx with the same id', function () { |
||||
txStateManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop) |
||||
txStateManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop) |
||||
const txMeta = txStateManager.getTx('1') |
||||
txMeta.hash = 'foo' |
||||
txStateManager.updateTx(txMeta) |
||||
let result = txStateManager.getTx('1') |
||||
assert.equal(result.hash, 'foo') |
||||
}) |
||||
|
||||
it('updates gas price and adds history items', function () { |
||||
const originalGasPrice = '0x01' |
||||
const desiredGasPrice = '0x02' |
||||
|
||||
const txMeta = { |
||||
id: '1', |
||||
status: 'unapproved', |
||||
metamaskNetworkId: currentNetworkId, |
||||
txParams: { |
||||
gasPrice: originalGasPrice, |
||||
}, |
||||
} |
||||
|
||||
const updatedMeta = clone(txMeta) |
||||
|
||||
txStateManager.addTx(txMeta) |
||||
const updatedTx = txStateManager.getTx('1') |
||||
// verify tx was initialized correctly
|
||||
assert.equal(updatedTx.history.length, 1, 'one history item (initial)') |
||||
assert.equal(Array.isArray(updatedTx.history[0]), false, 'first history item is initial state') |
||||
assert.deepEqual(updatedTx.history[0], txStateHistoryHelper.snapshotFromTxMeta(updatedTx), 'first history item is initial state') |
||||
// modify value and updateTx
|
||||
updatedTx.txParams.gasPrice = desiredGasPrice |
||||
txStateManager.updateTx(updatedTx) |
||||
// check updated value
|
||||
const result = txStateManager.getTx('1') |
||||
assert.equal(result.txParams.gasPrice, desiredGasPrice, 'gas price updated') |
||||
// validate history was updated
|
||||
assert.equal(result.history.length, 2, 'two history items (initial + diff)') |
||||
const expectedEntry = { op: 'replace', path: '/txParams/gasPrice', value: desiredGasPrice } |
||||
assert.deepEqual(result.history[1], [expectedEntry], 'two history items (initial + diff)') |
||||
}) |
||||
}) |
||||
|
||||
describe('#getUnapprovedTxList', function () { |
||||
it('returns unapproved txs in a hash', function () { |
||||
txStateManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop) |
||||
txStateManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop) |
||||
const result = txStateManager.getUnapprovedTxList() |
||||
assert.equal(typeof result, 'object') |
||||
assert.equal(result['1'].status, 'unapproved') |
||||
assert.equal(result['2'], undefined) |
||||
}) |
||||
}) |
||||
|
||||
describe('#getTx', function () { |
||||
it('returns a tx with the requested id', function () { |
||||
txStateManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop) |
||||
txStateManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop) |
||||
assert.equal(txStateManager.getTx('1').status, 'unapproved') |
||||
assert.equal(txStateManager.getTx('2').status, 'confirmed') |
||||
}) |
||||
}) |
||||
|
||||
describe('#getFilteredTxList', function () { |
||||
it('returns a tx with the requested data', function () { |
||||
const txMetas = [ |
||||
{ id: 0, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 1, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 2, status: 'unapproved', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 3, status: 'unapproved', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 4, status: 'unapproved', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 5, status: 'confirmed', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 6, status: 'confirmed', txParams: { from: '0xaa', to: '0xbb' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 7, status: 'confirmed', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 8, status: 'confirmed', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId }, |
||||
{ id: 9, status: 'confirmed', txParams: { from: '0xbb', to: '0xaa' }, metamaskNetworkId: currentNetworkId }, |
||||
] |
||||
txMetas.forEach((txMeta) => txStateManager.addTx(txMeta, noop)) |
||||
let filterParams |
||||
|
||||
filterParams = { status: 'unapproved', from: '0xaa' } |
||||
assert.equal(txStateManager.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`) |
||||
filterParams = { status: 'unapproved', to: '0xaa' } |
||||
assert.equal(txStateManager.getFilteredTxList(filterParams).length, 2, `getFilteredTxList - ${JSON.stringify(filterParams)}`) |
||||
filterParams = { status: 'confirmed', from: '0xbb' } |
||||
assert.equal(txStateManager.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`) |
||||
filterParams = { status: 'confirmed' } |
||||
assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`) |
||||
filterParams = { from: '0xaa' } |
||||
assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`) |
||||
filterParams = { to: '0xaa' } |
||||
assert.equal(txStateManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`) |
||||
}) |
||||
}) |
||||
}) |
||||
Loading…
Reference in new issue