Merge branch 'master' into nm

5 files changed, 269 insertions, 128 deletions

diff --git a/test/unit/actions/tx_test.js b/test/unit/actions/tx_test.js
index 67c72e9a5..ea6dfda6a 100644
--- a/test/unit/actions/tx_test.js
+++ b/test/unit/actions/tx_test.js
@@ -53,7 +53,7 @@ describe('tx confirmation screen', function () {
           result = reducers(initialState, action)
           done()
         })
-        
+
       })
 
       it('should transition to the account detail view', function () {
@@ -65,91 +65,6 @@ describe('tx confirmation screen', function () {
         assert.equal(count, 0)
       })
     })
-
-    describe('sendTx', function () {
-      var result
-
-      describe('when there is an error', function () {
-        before(function (done) {
-          actions._setBackgroundConnection({
-            approveTransaction (txId, cb) { cb({message: 'An error!'}) },
-          })
-
-          actions.sendTx({id: firstTxId})(function (action) {
-            result = reducers(initialState, action)
-            done()
-          })
-        })
-
-        it('should stay on the page', function () {
-          assert.equal(result.appState.currentView.name, 'confTx')
-        })
-
-        it('should set errorMessage on the currentView', function () {
-          assert(result.appState.currentView.errorMessage)
-        })
-      })
-
-      describe('when there is success', function () {
-        it('should complete tx and go home', function () {
-          actions._setBackgroundConnection({
-            approveTransaction (txId, cb) { cb() },
-          })
-
-          var dispatchExpect = sinon.mock()
-          dispatchExpect.twice()
-
-          actions.sendTx({id: firstTxId})(dispatchExpect)
-        })
-      })
-    })
-
-    describe('when there are two pending txs', function () {
-      var firstTxId = 1457634084250832
-      var result, initialState
-      before(function (done) {
-        initialState = {
-          appState: {
-            currentView: {
-              name: 'confTx',
-            },
-          },
-          metamask: {
-            unapprovedTxs: {
-              '1457634084250832': {
-                id: firstTxId,
-                status: 'unconfirmed',
-                time: 1457634084250,
-              },
-              '1457634084250833': {
-                id: 1457634084250833,
-                status: 'unconfirmed',
-                time: 1457634084255,
-              },
-            },
-          },
-        }
-        freeze(initialState)
-
-        // Mocking a background connection:
-        actions._setBackgroundConnection({
-          approveTransaction (firstTxId, cb) { cb() },
-        })
-
-        actions.sendTx({id: firstTxId})(function (action) {
-          result = reducers(initialState, action)
-        })
-        done()
-      })
-
-      it('should stay on the confTx view', function () {
-        assert.equal(result.appState.currentView.name, 'confTx')
-      })
-
-      it('should transition to the first tx', function () {
-        assert.equal(result.appState.currentView.context, 0)
-      })
-    })
   })
 })
 
diff --git a/test/unit/nonce-tracker-test.js b/test/unit/nonce-tracker-test.js
index 36025a360..8970cf84d 100644
--- a/test/unit/nonce-tracker-test.js
+++ b/test/unit/nonce-tracker-test.js
@@ -1,41 +1,203 @@
 const assert = require('assert')
 const NonceTracker = require('../../app/scripts/lib/nonce-tracker')
+const MockTxGen = require('../lib/mock-tx-gen')
+let providerResultStub = {}
 
 describe('Nonce Tracker', function () {
-  let nonceTracker, provider, getPendingTransactions, pendingTxs
-
-
-  beforeEach(function () {
-    pendingTxs = [{
-      'status': 'submitted',
-      'txParams': {
-        'from': '0x7d3517b0d011698406d6e0aed8453f0be2697926',
-        'gas': '0x30d40',
-        'value': '0x0',
-        'nonce': '0x0',
-      },
-    }]
-
-
-    getPendingTransactions = () => pendingTxs
-    provider = {
-      sendAsync: (_, cb) => { cb(undefined, {result: '0x0'}) },
-      _blockTracker: {
-        getCurrentBlock: () => '0x11b568',
-      },
-    }
-    nonceTracker = new NonceTracker({
-      provider,
-      getPendingTransactions,
-    })
-  })
+  let nonceTracker, provider
+  let getPendingTransactions, pendingTxs
+  let getConfirmedTransactions, confirmedTxs
 
   describe('#getNonceLock', function () {
-    it('should work', async function () {
-      this.timeout(15000)
-      const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
-      assert.equal(nonceLock.nextNonce, '1', 'nonce should be 1')
-      await nonceLock.releaseLock()
+
+    describe('with 3 confirmed and 1 pending', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        confirmedTxs = txGen.generate({ status: 'confirmed' }, { count: 3 })
+        pendingTxs = txGen.generate({ status: 'submitted' }, { count: 1 })
+        nonceTracker = generateNonceTrackerWith(pendingTxs, confirmedTxs, '0x1')
+      })
+
+      it('should return 4', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '4', `nonce should be 4 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+
+      it('should use localNonce if network returns a nonce lower then a confirmed tx in state', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '4', 'nonce should be 4')
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('with no previous txs', function () {
+      beforeEach(function () {
+        nonceTracker = generateNonceTrackerWith([], [])
+      })
+
+      it('should return 0', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '0', `nonce should be 0 returned ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('with multiple previous txs with same nonce', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        confirmedTxs = txGen.generate({ status: 'confirmed' }, { count: 1 })
+        pendingTxs = txGen.generate({
+          status: 'submitted',
+          txParams: { nonce: '0x01' },
+        }, { count: 5 })
+
+        nonceTracker = generateNonceTrackerWith(pendingTxs, confirmedTxs, '0x0')
+      })
+
+      it('should return nonce after those', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '2', `nonce should be 2 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('when local confirmed count is higher than network nonce', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        confirmedTxs = txGen.generate({ status: 'confirmed' }, { count: 3 })
+        nonceTracker = generateNonceTrackerWith([], confirmedTxs, '0x1')
+      })
+
+      it('should return nonce after those', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '3', `nonce should be 3 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('when local pending count is higher than other metrics', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        pendingTxs = txGen.generate({ status: 'submitted' }, { count: 2 })
+        nonceTracker = generateNonceTrackerWith(pendingTxs, [])
+      })
+
+      it('should return nonce after those', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '2', `nonce should be 2 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('when provider nonce is higher than other metrics', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        pendingTxs = txGen.generate({ status: 'submitted' }, { count: 2 })
+        nonceTracker = generateNonceTrackerWith(pendingTxs, [], '0x05')
+      })
+
+      it('should return nonce after those', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '5', `nonce should be 5 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('when there are some pending nonces below the remote one and some over.', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        pendingTxs = txGen.generate({ status: 'submitted' }, { count: 5 })
+        nonceTracker = generateNonceTrackerWith(pendingTxs, [], '0x03')
+      })
+
+      it('should return nonce after those', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '5', `nonce should be 5 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('when there are pending nonces non sequentially over the network nonce.', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        txGen.generate({ status: 'submitted' }, { count: 5 })
+        // 5 over that number
+        pendingTxs = txGen.generate({ status: 'submitted' }, { count: 5 })
+        nonceTracker = generateNonceTrackerWith(pendingTxs, [], '0x00')
+      })
+
+      it('should return nonce after network nonce', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '0', `nonce should be 0 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('When all three return different values', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        const confirmedTxs = txGen.generate({ status: 'confirmed' }, { count: 10 })
+        const pendingTxs = txGen.generate({
+          status: 'submitted',
+          nonce: 100,
+        }, { count: 1 })
+                                         // 0x32 is 50 in hex:
+        nonceTracker = generateNonceTrackerWith(pendingTxs, confirmedTxs, '0x32')
+      })
+
+      it('should return nonce after network nonce', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '50', `nonce should be 50 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
+    })
+
+    describe('Faq issue 67', function () {
+      beforeEach(function () {
+        const txGen = new MockTxGen()
+        const confirmedTxs = txGen.generate({ status: 'confirmed' }, { count: 64 })
+        const pendingTxs = txGen.generate({
+          status: 'submitted',
+        }, { count: 10 })
+                                         // 0x40 is 64 in hex:
+        nonceTracker = generateNonceTrackerWith(pendingTxs, [], '0x40')
+      })
+
+      it('should return nonce after network nonce', async function () {
+        this.timeout(15000)
+        const nonceLock = await nonceTracker.getNonceLock('0x7d3517b0d011698406d6e0aed8453f0be2697926')
+        assert.equal(nonceLock.nextNonce, '74', `nonce should be 74 got ${nonceLock.nextNonce}`)
+        await nonceLock.releaseLock()
+      })
     })
   })
 })
+
+function generateNonceTrackerWith (pending, confirmed, providerStub = '0x0') {
+  const getPendingTransactions = () => pending
+  const getConfirmedTransactions = () => confirmed
+  providerResultStub.result = providerStub
+  const provider = {
+    sendAsync: (_, cb) => { cb(undefined, providerResultStub) },
+    _blockTracker: {
+      getCurrentBlock: () => '0x11b568',
+    },
+  }
+  return new NonceTracker({
+    provider,
+    getPendingTransactions,
+    getConfirmedTransactions,
+  })
+}
+
diff --git a/test/unit/tx-controller-test.js b/test/unit/tx-controller-test.js
index 57d7deccd..7bb193242 100644
--- a/test/unit/tx-controller-test.js
+++ b/test/unit/tx-controller-test.js
@@ -6,12 +6,15 @@ const clone = require('clone')
 const sinon = require('sinon')
 const TransactionController = require('../../app/scripts/controllers/transactions')
 const TxProvideUtils = require('../../app/scripts/lib/tx-utils')
+const txStateHistoryHelper = require('../../app/scripts/lib/tx-state-history-helper')
+
 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, engine, provider, providerResultStub
 
@@ -47,7 +50,7 @@ describe('Transaction Controller', function () {
         metamaskNetworkId: currentNetworkId,
         txParams,
       }
-      txController._saveTxList([txMeta])
+      txController.addTx(txMeta)
       stub = sinon.stub(txController, 'addUnapprovedTransaction').returns(Promise.resolve(txMeta))
     })
 
@@ -279,12 +282,15 @@ describe('Transaction Controller', function () {
     it('replaces the tx with the same id', function () {
       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')
+      const tx1 = txController.getTx('1')
+      tx1.status = 'blah'
+      tx1.hash = 'foo'
+      txController.updateTx(tx1)
+      const savedResult = txController.getTx('1')
+      assert.equal(savedResult.hash, 'foo')
     })
 
-    it('updates gas price', function () {
+    it('updates gas price and adds history items', function () {
       const originalGasPrice = '0x01'
       const desiredGasPrice = '0x02'
 
@@ -297,13 +303,22 @@ describe('Transaction Controller', function () {
         },
       }
 
-      const updatedMeta = clone(txMeta)
-
       txController.addTx(txMeta)
-      updatedMeta.txParams.gasPrice = desiredGasPrice
-      txController.updateTx(updatedMeta)
-      var result = txController.getTx('1')
+      const updatedTx = txController.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
+      txController.updateTx(updatedTx)
+      // check updated value
+      const result = txController.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)')
     })
   })
 
diff --git a/test/unit/tx-state-history-helper-test.js b/test/unit/tx-state-history-helper-test.js
new file mode 100644
index 000000000..90cb10713
--- /dev/null
+++ b/test/unit/tx-state-history-helper-test.js
@@ -0,0 +1,26 @@
+const assert = require('assert')
+const clone = require('clone')
+const txStateHistoryHelper = require('../../app/scripts/lib/tx-state-history-helper')
+
+describe('deepCloneFromTxMeta', function () {
+  it('should clone deep', function () {
+    const input = {
+      foo: {
+        bar: {
+          bam: 'baz'
+        }
+      }
+    }
+    const output = txStateHistoryHelper.snapshotFromTxMeta(input)
+    assert('foo' in output, 'has a foo key')
+    assert('bar' in output.foo, 'has a bar key')
+    assert('bam' in output.foo.bar, 'has a bar key')
+    assert.equal(output.foo.bar.bam, 'baz', 'has a baz value')
+  })
+
+  it('should remove the history key', function () {
+    const input = { foo: 'bar', history: 'remembered' }
+    const output = txStateHistoryHelper.snapshotFromTxMeta(input)
+    assert(typeof output.history, 'undefined', 'should remove history')
+  })
+})
diff --git a/test/unit/tx-state-history-helper.js b/test/unit/tx-state-history-helper.js
new file mode 100644
index 000000000..5bb6c9bee
--- /dev/null
+++ b/test/unit/tx-state-history-helper.js
@@ -0,0 +1,23 @@
+const assert = require('assert')
+const txStateHistoryHelper = require('../../app/scripts/lib/tx-state-history-helper')
+const testVault = require('../data/v17-long-history.json')
+
+
+describe('tx-state-history-helper', function () {
+  it('migrates history to diffs and can recover original values', function () {
+    testVault.data.TransactionController.transactions.forEach((tx, index) => {
+      const newHistory = txStateHistoryHelper.migrateFromSnapshotsToDiffs(tx.history)
+      newHistory.forEach((newEntry, index) => {
+        if (index === 0) {
+          assert.equal(Array.isArray(newEntry), false, 'initial history item IS NOT a json patch obj')
+        } else {
+          assert.equal(Array.isArray(newEntry), true, 'non-initial history entry IS a json patch obj')
+        }
+        const oldEntry = tx.history[index]
+        const historySubset = newHistory.slice(0, index + 1)
+        const reconstructedValue = txStateHistoryHelper.replayHistory(historySubset)
+        assert.deepEqual(oldEntry, reconstructedValue, 'was able to reconstruct old entry from diffs')
+      })
+    })
+  })
+})