Merge pull request #1438 from MetaMask/TxController

Rename tx manager to tx controller

4 files changed, 74 insertions, 74 deletions

diff --git a/app/scripts/background.js b/app/scripts/background.js
index e738a9712..63c8a7252 100644
--- a/app/scripts/background.js
+++ b/app/scripts/background.js
@@ -114,13 +114,13 @@ function setupController (initState) {
   //
 
   updateBadge()
-  controller.txManager.on('updateBadge', updateBadge)
+  controller.txController.on('updateBadge', updateBadge)
   controller.messageManager.on('updateBadge', updateBadge)
 
   // plugin badge text
   function updateBadge () {
     var label = ''
-    var unapprovedTxCount = controller.txManager.unapprovedTxCount
+    var unapprovedTxCount = controller.txController.unapprovedTxCount
     var unapprovedMsgCount = controller.messageManager.unapprovedMsgCount
     var count = unapprovedTxCount + unapprovedMsgCount
     if (count) {
diff --git a/app/scripts/transaction-manager.js b/app/scripts/controllers/transactions.js
index 9f267160f..21dd25b30 100644
--- a/app/scripts/transaction-manager.js
+++ b/app/scripts/controllers/transactions.js
@@ -5,8 +5,8 @@ const Semaphore = require('semaphore')
 const ObservableStore = require('obs-store')
 const ethUtil = require('ethereumjs-util')
 const EthQuery = require('eth-query')
-const TxProviderUtil = require('./lib/tx-utils')
-const createId = require('./lib/random-id')
+const TxProviderUtil = require('../lib/tx-utils')
+const createId = require('../lib/random-id')
 
 module.exports = class TransactionManager extends EventEmitter {
   constructor (opts) {
diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
index 175602ec1..f18da9033 100644
--- a/app/scripts/metamask-controller.js
+++ b/app/scripts/metamask-controller.js
@@ -17,7 +17,7 @@ const ShapeShiftController = require('./controllers/shapeshift')
 const AddressBookController = require('./controllers/address-book')
 const MessageManager = require('./lib/message-manager')
 const PersonalMessageManager = require('./lib/personal-message-manager')
-const TxManager = require('./transaction-manager')
+const TransactionController = require('./controllers/transactions')
 const ConfigManager = require('./lib/config-manager')
 const autoFaucet = require('./lib/auto-faucet')
 const nodeify = require('./lib/nodeify')
@@ -90,8 +90,8 @@ module.exports = class MetamaskController extends EventEmitter {
     }, this.keyringController)
 
     // tx mgmt
-    this.txManager = new TxManager({
-      initState: initState.TransactionManager,
+    this.txController = new TransactionController({
+      initState: initState.TransactionController || initState.TransactionManager,
       networkStore: this.networkStore,
       preferencesStore: this.preferencesController.store,
       txHistoryLimit: 40,
@@ -119,8 +119,8 @@ module.exports = class MetamaskController extends EventEmitter {
     this.publicConfigStore = this.initPublicConfigStore()
 
     // manual disk state subscriptions
-    this.txManager.store.subscribe((state) => {
-      this.store.updateState({ TransactionManager: state })
+    this.txController.store.subscribe((state) => {
+      this.store.updateState({ TransactionController: state })
     })
     this.keyringController.store.subscribe((state) => {
       this.store.updateState({ KeyringController: state })
@@ -144,7 +144,7 @@ module.exports = class MetamaskController extends EventEmitter {
     // manual mem state subscriptions
     this.networkStore.subscribe(this.sendUpdate.bind(this))
     this.ethStore.subscribe(this.sendUpdate.bind(this))
-    this.txManager.memStore.subscribe(this.sendUpdate.bind(this))
+    this.txController.memStore.subscribe(this.sendUpdate.bind(this))
     this.messageManager.memStore.subscribe(this.sendUpdate.bind(this))
     this.personalMessageManager.memStore.subscribe(this.sendUpdate.bind(this))
     this.keyringController.memStore.subscribe(this.sendUpdate.bind(this))
@@ -223,7 +223,7 @@ module.exports = class MetamaskController extends EventEmitter {
       },
       this.networkStore.getState(),
       this.ethStore.getState(),
-      this.txManager.memStore.getState(),
+      this.txController.memStore.getState(),
       this.messageManager.memStore.getState(),
       this.personalMessageManager.memStore.getState(),
       this.keyringController.memStore.getState(),
@@ -248,7 +248,7 @@ module.exports = class MetamaskController extends EventEmitter {
   getApi () {
     const keyringController = this.keyringController
     const preferencesController = this.preferencesController
-    const txManager = this.txManager
+    const txController = this.txController
     const noticeController = this.noticeController
     const addressBookController = this.addressBookController
 
@@ -289,9 +289,9 @@ module.exports = class MetamaskController extends EventEmitter {
       saveAccountLabel: nodeify(keyringController.saveAccountLabel).bind(keyringController),
       exportAccount: nodeify(keyringController.exportAccount).bind(keyringController),
 
-      // txManager
-      approveTransaction: txManager.approveTransaction.bind(txManager),
-      cancelTransaction: txManager.cancelTransaction.bind(txManager),
+      // txController
+      approveTransaction: txController.approveTransaction.bind(txController),
+      cancelTransaction: txController.cancelTransaction.bind(txController),
       updateAndApproveTransaction: this.updateAndApproveTx.bind(this),
 
       // messageManager
@@ -421,12 +421,12 @@ module.exports = class MetamaskController extends EventEmitter {
   newUnapprovedTransaction (txParams, cb) {
     log.debug(`MetaMaskController newUnapprovedTransaction ${JSON.stringify(txParams)}`)
     const self = this
-    self.txManager.addUnapprovedTransaction(txParams, (err, txMeta) => {
+    self.txController.addUnapprovedTransaction(txParams, (err, txMeta) => {
       if (err) return cb(err)
       self.sendUpdate()
       self.opts.showUnapprovedTx(txMeta)
       // listen for tx completion (success, fail)
-      self.txManager.once(`${txMeta.id}:finished`, (completedTx) => {
+      self.txController.once(`${txMeta.id}:finished`, (completedTx) => {
         switch (completedTx.status) {
           case 'submitted':
             return cb(null, completedTx.hash)
@@ -477,9 +477,9 @@ module.exports = class MetamaskController extends EventEmitter {
 
   updateAndApproveTx (txMeta, cb) {
     log.debug(`MetaMaskController - updateAndApproveTx: ${JSON.stringify(txMeta)}`)
-    const txManager = this.txManager
-    txManager.updateTx(txMeta)
-    txManager.approveTransaction(txMeta.id, cb)
+    const txController = this.txController
+    txController.updateTx(txMeta)
+    txController.approveTransaction(txMeta.id, cb)
   }
 
   signMessage (msgParams, cb) {
diff --git a/test/unit/tx-manager-test.js b/test/unit/tx-controller-test.js
index b5d148723..d0b32ff41 100644
--- a/test/unit/tx-manager-test.js
+++ b/test/unit/tx-controller-test.js
@@ -3,17 +3,17 @@ const EventEmitter = require('events')
 const ethUtil = require('ethereumjs-util')
 const EthTx = require('ethereumjs-tx')
 const ObservableStore = require('obs-store')
-const TransactionManager = require('../../app/scripts/transaction-manager')
+const TransactionController = require('../../app/scripts/controllers/transactions')
 const noop = () => true
 const currentNetworkId = 42
 const otherNetworkId = 36
 const privKey = new Buffer('8718b9618a37d1fc78c436511fc6df3c8258d3250635bba617f33003270ec03e', 'hex')
 
 describe('Transaction Manager', function () {
-  let txManager
+  let txController
 
   beforeEach(function () {
-    txManager = new TransactionManager({
+    txController = new TransactionController({
       networkStore: new ObservableStore({ network: currentNetworkId }),
       txHistoryLimit: 10,
       blockTracker: new EventEmitter(),
@@ -29,7 +29,7 @@ describe('Transaction Manager', function () {
       var sample = {
         value: '0x01',
       }
-      txManager.txProviderUtils.validateTxParams(sample, (err) => {
+      txController.txProviderUtils.validateTxParams(sample, (err) => {
         assert.equal(err, null, 'no error')
       })
     })
@@ -38,7 +38,7 @@ describe('Transaction Manager', function () {
       var sample = {
         value: '-0x01',
       }
-      txManager.txProviderUtils.validateTxParams(sample, (err) => {
+      txController.txProviderUtils.validateTxParams(sample, (err) => {
         assert.ok(err, 'error')
       })
     })
@@ -46,7 +46,7 @@ describe('Transaction Manager', function () {
 
   describe('#getTxList', function () {
     it('when new should return empty array', function () {
-      var result = txManager.getTxList()
+      var result = txController.getTxList()
       assert.ok(Array.isArray(result))
       assert.equal(result.length, 0)
     })
@@ -58,8 +58,8 @@ describe('Transaction Manager', function () {
   describe('#addTx', function () {
     it('adds a tx returned in getTxList', function () {
       var tx = { id: 1, status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
-      txManager.addTx(tx, noop)
-      var result = txManager.getTxList()
+      txController.addTx(tx, noop)
+      var result = txController.getTxList()
       assert.ok(Array.isArray(result))
       assert.equal(result.length, 1)
       assert.equal(result[0].id, 1)
@@ -68,45 +68,45 @@ describe('Transaction Manager', function () {
     it('does not override txs from other networks', function () {
       var tx = { id: 1, status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
       var tx2 = { id: 2, status: 'confirmed', metamaskNetworkId: otherNetworkId, txParams: {} }
-      txManager.addTx(tx, noop)
-      txManager.addTx(tx2, noop)
-      var result = txManager.getFullTxList()
-      var result2 = txManager.getTxList()
+      txController.addTx(tx, noop)
+      txController.addTx(tx2, noop)
+      var result = txController.getFullTxList()
+      var result2 = txController.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 = txManager.txHistoryLimit
+      const limit = txController.txHistoryLimit
       for (let i = 0; i < limit + 1; i++) {
         const tx = { id: i, time: new Date(), status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
-        txManager.addTx(tx, noop)
+        txController.addTx(tx, noop)
       }
-      var result = txManager.getTxList()
+      var result = txController.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 = txManager.txHistoryLimit
+      const limit = txController.txHistoryLimit
       for (let i = 0; i < limit + 1; i++) {
         const tx = { id: i, time: new Date(), status: 'rejected', metamaskNetworkId: currentNetworkId, txParams: {} }
-        txManager.addTx(tx, noop)
+        txController.addTx(tx, noop)
       }
-      var result = txManager.getTxList()
+      var result = txController.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 () {
       var unconfirmedTx = { id: 0, time: new Date(), status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
-      txManager.addTx(unconfirmedTx, noop)
-      const limit = txManager.txHistoryLimit
+      txController.addTx(unconfirmedTx, noop)
+      const limit = txController.txHistoryLimit
       for (let i = 1; i < limit + 1; i++) {
         const tx = { id: i, time: new Date(), status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }
-        txManager.addTx(tx, noop)
+        txController.addTx(tx, noop)
       }
-      var result = txManager.getTxList()
+      var result = txController.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')
@@ -117,9 +117,9 @@ describe('Transaction Manager', function () {
   describe('#setTxStatusSigned', function () {
     it('sets the tx status to signed', function () {
       var tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
-      txManager.addTx(tx, noop)
-      txManager.setTxStatusSigned(1)
-      var result = txManager.getTxList()
+      txController.addTx(tx, noop)
+      txController.setTxStatusSigned(1)
+      var result = txController.getTxList()
       assert.ok(Array.isArray(result))
       assert.equal(result.length, 1)
       assert.equal(result[0].status, 'signed')
@@ -132,18 +132,18 @@ describe('Transaction Manager', function () {
         assert(true, 'event listener has been triggered and noop executed')
         done()
       }
-      txManager.addTx(tx)
-      txManager.on('1:signed', noop)
-      txManager.setTxStatusSigned(1)
+      txController.addTx(tx)
+      txController.on('1:signed', noop)
+      txController.setTxStatusSigned(1)
     })
   })
 
   describe('#setTxStatusRejected', function () {
     it('sets the tx status to rejected', function () {
       var tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
-      txManager.addTx(tx)
-      txManager.setTxStatusRejected(1)
-      var result = txManager.getTxList()
+      txController.addTx(tx)
+      txController.setTxStatusRejected(1)
+      var result = txController.getTxList()
       assert.ok(Array.isArray(result))
       assert.equal(result.length, 1)
       assert.equal(result[0].status, 'rejected')
@@ -152,31 +152,31 @@ describe('Transaction Manager', function () {
     it('should emit a rejected event to signal the exciton of callback', (done) => {
       this.timeout(10000)
       var tx = { id: 1, status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }
-      txManager.addTx(tx)
+      txController.addTx(tx)
       const noop = function (err, txId) {
         assert(true, 'event listener has been triggered and noop executed')
         done()
       }
-      txManager.on('1:rejected', noop)
-      txManager.setTxStatusRejected(1)
+      txController.on('1:rejected', noop)
+      txController.setTxStatusRejected(1)
     })
   })
 
   describe('#updateTx', function () {
     it('replaces the tx with the same id', function () {
-      txManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      txManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      txManager.updateTx({ id: '1', status: 'blah', hash: 'foo', metamaskNetworkId: currentNetworkId, txParams: {} })
-      var result = txManager.getTx('1')
+      txController.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      txController.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      txController.updateTx({ id: '1', status: 'blah', hash: 'foo', metamaskNetworkId: currentNetworkId, txParams: {} })
+      var result = txController.getTx('1')
       assert.equal(result.hash, 'foo')
     })
   })
 
   describe('#getUnapprovedTxList', function () {
     it('returns unapproved txs in a hash', function () {
-      txManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      txManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      const result = txManager.getUnapprovedTxList()
+      txController.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      txController.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      const result = txController.getUnapprovedTxList()
       assert.equal(typeof result, 'object')
       assert.equal(result['1'].status, 'unapproved')
       assert.equal(result['2'], undefined)
@@ -185,10 +185,10 @@ describe('Transaction Manager', function () {
 
   describe('#getTx', function () {
     it('returns a tx with the requested id', function () {
-      txManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      txManager.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      assert.equal(txManager.getTx('1').status, 'unapproved')
-      assert.equal(txManager.getTx('2').status, 'confirmed')
+      txController.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      txController.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      assert.equal(txController.getTx('1').status, 'unapproved')
+      assert.equal(txController.getTx('2').status, 'confirmed')
     })
   })
 
@@ -206,28 +206,28 @@ describe('Transaction Manager', function () {
         { 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) => txManager.addTx(txMeta, noop))
+      txMetas.forEach((txMeta) => txController.addTx(txMeta, noop))
       let filterParams
 
       filterParams = { status: 'unapproved', from: '0xaa' }
-      assert.equal(txManager.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
+      assert.equal(txController.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
       filterParams = { status: 'unapproved', to: '0xaa' }
-      assert.equal(txManager.getFilteredTxList(filterParams).length, 2, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
+      assert.equal(txController.getFilteredTxList(filterParams).length, 2, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
       filterParams = { status: 'confirmed', from: '0xbb' }
-      assert.equal(txManager.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
+      assert.equal(txController.getFilteredTxList(filterParams).length, 3, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
       filterParams = { status: 'confirmed' }
-      assert.equal(txManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
+      assert.equal(txController.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
       filterParams = { from: '0xaa' }
-      assert.equal(txManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
+      assert.equal(txController.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
       filterParams = { to: '0xaa' }
-      assert.equal(txManager.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
+      assert.equal(txController.getFilteredTxList(filterParams).length, 5, `getFilteredTxList - ${JSON.stringify(filterParams)}`)
     })
   })
 
   describe('#sign replay-protected tx', function () {
     it('prepares a tx with the chainId set', function () {
-      txManager.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      txManager.signTransaction('1', (err, rawTx) => {
+      txController.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
+      txController.signTransaction('1', (err, rawTx) => {
         if (err) return assert.fail('it should not fail')
         const ethTx = new EthTx(ethUtil.toBuffer(rawTx))
         assert.equal(ethTx.getChainId(), currentNetworkId)