Merge branch 'master' into transactionControllerRefractorPt3

2 files changed, 201 insertions, 32 deletions

diff --git a/test/unit/nonce-tracker-test.js b/test/unit/nonce-tracker-test.js
index 36025a360..3312a3bd0 100644
--- a/test/unit/nonce-tracker-test.js
+++ b/test/unit/nonce-tracker-test.js
@@ -1,41 +1,184 @@
 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()
+      })
     })
   })
 })
+
+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-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')
+  })
+})