use provider stub

test/unit/pending-tx-test.js

@@ -3,19 +3,20 @@ const ethUtil = require('ethereumjs-util')
 const EthTx = require('ethereumjs-tx')
 const ObservableStore = require('obs-store')
 const clone = require('clone')
-const PendingTransactionWatcher = require('../../app/scripts/lib/pending-tx-watchers')
+const { createStubedProvider } = require('../stub/provider')
+const PendingTransactionTracker = require('../../app/scripts/lib/pending-tx-tracker')
 const noop = () => true
 const currentNetworkId = 42
 const otherNetworkId = 36
 const privKey = new Buffer('8718b9618a37d1fc78c436511fc6df3c8258d3250635bba617f33003270ec03e', 'hex')
 
-describe('PendingTransactionWatcher', function () {
-  let pendingTxWatcher, txMeta, txMetaNoHash, txMetaNoRawTx
+describe('PendingTransactionTracker', function () {
+  let pendingTxTracker, txMeta, txMetaNoHash, txMetaNoRawTx, providerResultStub, provider
   this.timeout(10000)
   beforeEach(function () {
     txMeta = {
       id: 1,
-      hash: '0x0593ee121b92e10d63150ad08b4b8f9c7857d1bd160195ee648fb9a0f8d00eebBlock',
+      hash: '0x0593ee121b92e10d63150ad08b4b8f9c7857d1bd160195ee648fb9a0f8d00eeb',
       status: 'signed',
       txParams: {
         from: '0x1678a085c290ebd122dc42cba69373b5953b831d',
@@ -30,13 +31,15 @@ describe('PendingTransactionWatcher', function () {
       txParams: { from: '0x1678a085c290ebd122dc42cba69373b5953b831d'},
     }
     txMetaNoRawTx = {
-      hash: '0x0593ee121b92e10d63150ad08b4b8f9c7857d1bd160195ee648fb9a0f8d00eebBlock',
+      hash: '0x0593ee121b92e10d63150ad08b4b8f9c7857d1bd160195ee648fb9a0f8d00eeb',
       status: 'signed',
       txParams: { from: '0x1678a085c290ebd122dc42cba69373b5953b831d'},
     }
+    providerResultStub = {}
+    provider = createStubedProvider(providerResultStub)
 
-    pendingTxWatcher = new PendingTransactionWatcher({
-      provider: { sendAsync: noop },
+    pendingTxTracker = new PendingTransactionTracker({
+      provider,
       getBalance: () => {},
       nonceTracker: {
         getGlobalLock: async () => {
@@ -47,20 +50,6 @@ describe('PendingTransactionWatcher', function () {
       sufficientBalance: () => {},
       publishTransaction: () => {},
     })
-
-    pendingTxWatcher.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)
-        }
-      },
-    })
-
   })
 
   describe('#checkForTxInBlock', function () {
@@ -68,77 +57,77 @@ describe('PendingTransactionWatcher', function () {
       // throw a type error if it trys to do anything on the block
       // thus failing the test
       const block = Proxy.revocable({}, {}).revoke()
-      pendingTxWatcher.checkForTxInBlock(block)
+      pendingTxTracker.checkForTxInBlock(block)
     })
     it('should emit \'txFailed\' if the txMeta does not have a hash', function (done) {
       const block = Proxy.revocable({}, {}).revoke()
-      pendingTxWatcher.getPendingTransactions = () => [txMetaNoHash]
-      pendingTxWatcher.once('txFailed', (txId, err) => {
+      pendingTxTracker.getPendingTransactions = () => [txMetaNoHash]
+      pendingTxTracker.once('txFailed', (txId, err) => {
         assert(txId, txMetaNoHash.id, 'should pass txId')
         done()
       })
-      pendingTxWatcher.checkForTxInBlock(block)
+      pendingTxTracker.checkForTxInBlock(block)
     })
     it('should emit \'txConfirmed\' if the tx is in the block', function (done) {
       const block = { transactions: [txMeta]}
-      pendingTxWatcher.getPendingTransactions = () => [txMeta]
-      pendingTxWatcher.once('txConfirmed', (txId) => {
+      pendingTxTracker.getPendingTransactions = () => [txMeta]
+      pendingTxTracker.once('txConfirmed', (txId) => {
         assert(txId, txMeta.id, 'should pass txId')
         done()
       })
-      pendingTxWatcher.once('txFailed', (_, err) => { done(err) })
-      pendingTxWatcher.checkForTxInBlock(block)
+      pendingTxTracker.once('txFailed', (_, err) => { done(err) })
+      pendingTxTracker.checkForTxInBlock(block)
     })
   })
   describe('#queryPendingTxs', function () {
     it('should call #_checkPendingTxs if their is no oldBlock', function (done) {
       let newBlock, oldBlock
       newBlock = { number: '0x01' }
-      pendingTxWatcher._checkPendingTxs = done
-      pendingTxWatcher.queryPendingTxs({oldBlock, newBlock})
+      pendingTxTracker._checkPendingTxs = done
+      pendingTxTracker.queryPendingTxs({oldBlock, newBlock})
     })
     it('should call #_checkPendingTxs if oldBlock and the newBlock have a diff of greater then 1', function (done) {
       let newBlock, oldBlock
       oldBlock = { number: '0x01' }
       newBlock = { number: '0x03' }
-      pendingTxWatcher._checkPendingTxs = done
-      pendingTxWatcher.queryPendingTxs({oldBlock, newBlock})
+      pendingTxTracker._checkPendingTxs = done
+      pendingTxTracker.queryPendingTxs({oldBlock, newBlock})
     })
     it('should not call #_checkPendingTxs if oldBlock and the newBlock have a diff of 1 or less', function (done) {
       let newBlock, oldBlock
       oldBlock = { number: '0x1' }
       newBlock = { number: '0x2' }
-      pendingTxWatcher._checkPendingTxs = () => {
+      pendingTxTracker._checkPendingTxs = () => {
         const err = new Error('should not call #_checkPendingTxs if oldBlock and the newBlock have a diff of 1 or less')
         done(err)
       }
-      pendingTxWatcher.queryPendingTxs({oldBlock, newBlock})
+      pendingTxTracker.queryPendingTxs({oldBlock, newBlock})
       done()
     })
   })
 
   describe('#_checkPendingTx', function () {
     it('should emit \'txFailed\' if the txMeta does not have a hash', function (done) {
-      pendingTxWatcher.once('txFailed', (txId, err) => {
+      pendingTxTracker.once('txFailed', (txId, err) => {
         assert(txId, txMetaNoHash.id, 'should pass txId')
         done()
       })
-      pendingTxWatcher._checkPendingTx(txMetaNoHash)
+      pendingTxTracker._checkPendingTx(txMetaNoHash)
     })
 
     it('should should return if query does not return txParams', function () {
-      pendingTxWatcher.query.stubResult('getTransactionByHash', null)
-      pendingTxWatcher._checkPendingTx(txMeta)
+      providerResultStub.eth_getTransactionByHash = null
+      pendingTxTracker._checkPendingTx(txMeta)
     })
 
     it('should emit \'txConfirmed\'', function (done) {
-      pendingTxWatcher.query.stubResult('getTransactionByHash', {blockNumber: '0x01'})
-      pendingTxWatcher.once('txConfirmed', (txId) => {
+      providerResultStub.eth_getTransactionByHash = {blockNumber: '0x01'}
+      pendingTxTracker.once('txConfirmed', (txId) => {
         assert(txId, txMeta.id, 'should pass txId')
         done()
       })
-      pendingTxWatcher.once('txFailed', (_, err) => { done(err) })
-      pendingTxWatcher._checkPendingTx(txMeta)
+      pendingTxTracker.once('txFailed', (_, err) => { done(err) })
+      pendingTxTracker._checkPendingTx(txMeta)
     })
   })
 
@@ -154,14 +143,14 @@ describe('PendingTransactionWatcher', function () {
     })
 
     it('should warp all txMeta\'s in #_checkPendingTx', function (done) {
-      pendingTxWatcher.getPendingTransactions = () => txList
-      pendingTxWatcher._checkPendingTx = (tx) => { tx.resolve(tx) }
+      pendingTxTracker.getPendingTransactions = () => txList
+      pendingTxTracker._checkPendingTx = (tx) => { tx.resolve(tx) }
       const list = txList.map
       Promise.all(txList.map((tx) => tx.processed))
       .then((txCompletedList) => done())
       .catch(done)
 
-      pendingTxWatcher._checkPendingTxs()
+      pendingTxTracker._checkPendingTxs()
     })
   })
 
@@ -175,15 +164,15 @@ describe('PendingTransactionWatcher', function () {
     })
 
     it('should return if no pending transactions', function () {
-      pendingTxWatcher.resubmitPendingTxs()
+      pendingTxTracker.resubmitPendingTxs()
     })
     it('should call #_resubmitTx for all pending tx\'s', function (done) {
-      pendingTxWatcher.getPendingTransactions = () => txList
-      pendingTxWatcher._resubmitTx = async (tx) => { tx.resolve(tx) }
+      pendingTxTracker.getPendingTransactions = () => txList
+      pendingTxTracker._resubmitTx = async (tx) => { tx.resolve(tx) }
       Promise.all(txList.map((tx) => tx.processed))
       .then((txCompletedList) => done())
       .catch(done)
-      pendingTxWatcher.resubmitPendingTxs()
+      pendingTxTracker.resubmitPendingTxs()
     })
     it('should not emit \'txFailed\' if the txMeta throws a known txError', function (done) {
       knownErrors =[
@@ -199,10 +188,10 @@ describe('PendingTransactionWatcher', function () {
       ]
       const enoughForAllErrors = txList.concat(txList)
 
-      pendingTxWatcher.on('txFailed', (_, err) => done(err))
+      pendingTxTracker.on('txFailed', (_, err) => done(err))
 
-      pendingTxWatcher.getPendingTransactions = () => enoughForAllErrors
-      pendingTxWatcher._resubmitTx = async (tx) => {
+      pendingTxTracker.getPendingTransactions = () => enoughForAllErrors
+      pendingTxTracker._resubmitTx = async (tx) => {
         tx.resolve()
         throw new Error(knownErrors.pop())
       }
@@ -210,38 +199,38 @@ describe('PendingTransactionWatcher', function () {
       .then((txCompletedList) => done())
       .catch(done)
 
-      pendingTxWatcher.resubmitPendingTxs()
+      pendingTxTracker.resubmitPendingTxs()
     })
     it('should emit \'txFailed\' if it encountered a real error', function (done) {
-      pendingTxWatcher.once('txFailed', (id, err) => err.message === 'im some real error' ? txList[id - 1].resolve() : done(err))
+      pendingTxTracker.once('txFailed', (id, err) => err.message === 'im some real error' ? txList[id - 1].resolve() : done(err))
 
-      pendingTxWatcher.getPendingTransactions = () => txList
-      pendingTxWatcher._resubmitTx = async (tx) => { throw new TypeError('im some real error') }
+      pendingTxTracker.getPendingTransactions = () => txList
+      pendingTxTracker._resubmitTx = async (tx) => { throw new TypeError('im some real error') }
       Promise.all(txList.map((tx) => tx.processed))
       .then((txCompletedList) => done())
       .catch(done)
 
-      pendingTxWatcher.resubmitPendingTxs()
+      pendingTxTracker.resubmitPendingTxs()
     })
   })
   describe('#_resubmitTx with a too-low balance', function () {
     it('should return before publishing the transaction because to low of balance', function (done) {
     const lowBalance = '0x0'
-    pendingTxWatcher.getBalance = (address) => {
+    pendingTxTracker.getBalance = (address) => {
       assert.equal(address, txMeta.txParams.from, 'Should pass the address')
       return lowBalance
     }
-    pendingTxWatcher.publishTransaction = async (rawTx) => {
+    pendingTxTracker.publishTransaction = async (rawTx) => {
       done(new Error('tried to publish transaction'))
     }
 
     // Stubbing out current account state:
     // Adding the fake tx:
-    pendingTxWatcher.once('txFailed', (txId, err) => {
+    pendingTxTracker.once('txFailed', (txId, err) => {
       assert(err, 'Should have a error')
       done()
     })
-    pendingTxWatcher._resubmitTx(txMeta)
+    pendingTxTracker._resubmitTx(txMeta)
     .catch((err) => {
      assert.ifError(err, 'should not throw an error')
      done(err)
@@ -250,17 +239,17 @@ describe('PendingTransactionWatcher', function () {
 
     it('should publishing the transaction', function (done) {
     const enoughBalance = '0x100000'
-    pendingTxWatcher.getBalance = (address) => {
+    pendingTxTracker.getBalance = (address) => {
       assert.equal(address, txMeta.txParams.from, 'Should pass the address')
       return enoughBalance
     }
-    pendingTxWatcher.publishTransaction = async (rawTx) => {
+    pendingTxTracker.publishTransaction = async (rawTx) => {
       assert.equal(rawTx, txMeta.rawTx, 'Should pass the rawTx')
     }
 
     // Stubbing out current account state:
     // Adding the fake tx:
-    pendingTxWatcher._resubmitTx(txMeta)
+    pendingTxTracker._resubmitTx(txMeta)
     .then(() => done())
     .catch((err) => {
      assert.ifError(err, 'should not throw an error')

test/unit/tx-controller-test.js

@@ -10,16 +10,20 @@ const noop = () => true
 const currentNetworkId = 42
 const otherNetworkId = 36
 const privKey = new Buffer('8718b9618a37d1fc78c436511fc6df3c8258d3250635bba617f33003270ec03e', 'hex')
+const { createStubedProvider } = require('../stub/provider')
 
 describe('Transaction Controller', function () {
-  let txController
+  let txController, engine, provider, providerResultStub
 
   beforeEach(function () {
+    providerResultStub = {}
+    provider = createStubedProvider(providerResultStub)
+
     txController = new TransactionController({
+      provider,
       networkStore: new ObservableStore(currentNetworkId),
       txHistoryLimit: 10,
       blockTracker: { getCurrentBlock: noop, on: noop, once: noop },
-      provider: { sendAsync: noop },
       ethStore: { getState: noop },
       signTransaction: (ethTx) => new Promise((resolve) => {
         ethTx.sign(privKey)
@@ -28,19 +32,6 @@ describe('Transaction Controller', function () {
     })
     txController.nonceTracker.getNonceLock = () => Promise.resolve({ nextNonce: 0, releaseLock: noop })
     txController.txProviderUtils = new TxProvideUtils(txController.provider)
-    txController.query = txController.txProviderUtils.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)
-        }
-      },
-    })
-
   })
 
   describe('#newUnapprovedTransaction', function () {
@@ -132,11 +123,9 @@ describe('Transaction Controller', function () {
           'to':'0xc684832530fcbddae4b4230a47e991ddcec2831d',
         },
       }
-
-      txController.query.stubResult('gasPrice', '0x4a817c800')
-      txController.query.stubResult('getBlockByNumber', { gasLimit: '0x47b784' })
-      txController.query.stubResult('estimateGas', '0x5209')
-
+        providerResultStub.eth_gasPrice = '4a817c800'
+        providerResultStub.eth_getBlockByNumber = { gasLimit: '47b784' }
+        providerResultStub.eth_estimateGas = '5209'
       txController.addTxDefaults(txMeta)
       .then((txMetaWithDefaults) => {
         assert(txMetaWithDefaults.txParams.value, '0x0','should have added 0x0 as the value')
@@ -393,9 +382,8 @@ describe('Transaction Controller', function () {
       const wrongValue = '0x05'
 
       txController.addTx(txMeta)
-
-      txController.query.stubResult('estimateGas', wrongValue)
-      txController.query.stubResult('gasPrice', wrongValue)
+      providerResultStub.eth_gasPrice = wrongValue
+      providerResultStub.eth_estimateGas = '0x5209'
 
       const signStub = sinon.stub(txController, 'signTransaction').callsFake(() => Promise.resolve())