Merge PR handshake-org#671 from 'nodech/mempool-spent-port'

Author: pinheadmz

lib/mempool/mempool.js

@@ -790,6 +790,28 @@ class Mempool extends EventEmitter {
     return Coin.fromTX(entry.tx, index, -1);
   }
 
+  /**
+   * Check whether coin is still unspent.
+   * @param {Hash} hash
+   * @param {Number} index
+   * @returns {boolean}
+   */
+
+  hasCoin(hash, index) {
+    const entry = this.map.get(hash);
+
+    if (!entry)
+      return false;
+
+    if (this.isSpent(hash, index))
+      return false;
+
+    if (index >= entry.tx.outputs.length)
+      return false;
+
+    return true;
+  }
+
   /**
    * Check to see if a coin has been spent. This differs from
    * {@link ChainDB#isSpent} in that it actually maintains a
@@ -2404,6 +2426,8 @@ class Mempool extends EventEmitter {
 
   /**
    * Get coin viewpoint (lock).
+   * Note: this does not return the historical
+   * view of coins from the indexers
    * @method
    * @param {TX} tx
    * @returns {Promise} - Returns {@link CoinView}.
@@ -2412,12 +2436,40 @@ class Mempool extends EventEmitter {
   async getSpentView(tx) {
     const unlock = await this.locker.lock();
     try {
-      return await this.getCoinView(tx);
+      return await this._getSpentView(tx);
     } finally {
       unlock();
     }
   }
 
+  /**
+   * Get coin viewpoint
+   * @param {TX} tx
+   * @returns {Promise} - Returns {@link CoinView}
+   */
+
+  async _getSpentView(tx) {
+    const view = new CoinView();
+
+    for (const {prevout} of tx.inputs) {
+      const {hash, index} = prevout;
+      const tx = this.getTX(hash);
+
+      if (tx) {
+        if (index < tx.outputs.length)
+          view.addIndex(tx, index, -1);
+        continue;
+      }
+
+      const coin = await this.chain.readCoin(prevout);
+
+      if (coin)
+        view.addEntry(prevout, coin);
+    }
+
+    return view;
+  }
+
   /**
    * Get coin viewpoint (no lock).
    * @method
@@ -2433,7 +2485,7 @@ class Mempool extends EventEmitter {
       const tx = this.getTX(hash);
 
       if (tx) {
-        if (index < tx.outputs.length)
+        if (this.hasCoin(hash, index))
           view.addIndex(tx, index, -1);
         continue;
       }

test/mempool-test.js

@@ -5,6 +5,7 @@
 
 const assert = require('bsert');
 const random = require('bcrypto/lib/random');
+const Network = require('../lib/protocol/network');
 const MempoolEntry = require('../lib/mempool/mempoolentry');
 const Mempool = require('../lib/mempool/mempool');
 const WorkerPool = require('../lib/workers/workerpool');
@@ -36,13 +37,14 @@ const ownership = require('../lib/covenants/ownership');
 const ONE_HASH = Buffer.alloc(32, 0x00);
 ONE_HASH[0] = 0x01;
 
+const network = Network.get('regtest');
 const workers = new WorkerPool({
   enabled: true
 });
 
 const chain = new Chain({
-  network: 'regtest',
   memory: true,
+  network,
   workers
 });
 
@@ -52,7 +54,7 @@ const mempool = new Mempool({
   workers
 });
 
-const wallet = new MemWallet();
+const wallet = new MemWallet({ network });
 
 let cachedTX = null;
 
@@ -225,6 +227,62 @@ describe('Mempool', function() {
     }));
   });
 
+  it('should get spent coins and reflect in coinview', async () => {
+    const wallet = new MemWallet({ network });
+    const addr = wallet.getAddress();
+
+    const dummyCoin = dummyInput(addr, random.randomBytes(32));
+
+    const mtx1 = new MTX();
+    mtx1.addOutput(wallet.getAddress(), 50000);
+    mtx1.addCoin(dummyCoin);
+
+    wallet.sign(mtx1);
+
+    const tx1 = mtx1.toTX();
+    const coin1 = Coin.fromTX(tx1, 0, -1);
+
+    const mtx2 = new MTX();
+    mtx2.addOutput(wallet.getAddress(), 10000);
+    mtx2.addOutput(wallet.getAddress(), 30000); // 10k fee
+    mtx2.addCoin(coin1);
+
+    wallet.sign(mtx2);
+
+    const tx2 = mtx2.toTX();
+
+    await mempool.addTX(tx1);
+
+    {
+      const view = await mempool.getCoinView(tx2);
+      const sview = await mempool.getSpentView(tx2);
+      assert(view.hasEntry(coin1));
+      assert(sview.hasEntry(coin1));
+      assert.strictEqual(mempool.hasCoin(coin1.hash, coin1.index), true);
+      assert.strictEqual(mempool.isSpent(coin1.hash, coin1.index), false);
+    }
+
+    await mempool.addTX(tx2);
+
+    {
+      const view = await mempool.getCoinView(tx1);
+      const sview = await mempool.getSpentView(tx1);
+      assert(!view.hasEntry(dummyCoin));
+      assert(sview.hasEntry(dummyCoin));
+      assert.strictEqual(mempool.hasCoin(coin1.hash, coin1.index), false);
+      assert.strictEqual(mempool.isSpent(coin1.hash, coin1.index), true);
+    }
+
+    {
+      const view = await mempool.getCoinView(tx2);
+      const sview = await mempool.getSpentView(tx2);
+      assert(!view.hasEntry(coin1));
+      assert(sview.hasEntry(coin1));
+      assert.strictEqual(mempool.hasCoin(coin1.hash, coin1.index), false);
+      assert.strictEqual(mempool.isSpent(coin1.hash, coin1.index), true);
+    }
+  });
+
   it('should handle locktime', async () => {
     const key = KeyRing.generate();
     const addr = key.getAddress();
@@ -416,7 +474,7 @@ describe('Mempool', function() {
     const chain = new Chain({
       memory: true,
       workers,
-      network: 'regtest'
+      network
     });
 
     const mempool = new Mempool({
@@ -425,6 +483,8 @@ describe('Mempool', function() {
       memory: true
     });
 
+    const wallet = new MemWallet({ network });
+
     const COINBASE_MATURITY = mempool.network.coinbaseMaturity;
     const TREE_INTERVAL = mempool.network.names.treeInterval;
     mempool.network.names.auctionStart = 0;
@@ -444,9 +504,7 @@ describe('Mempool', function() {
     // Number of coins available in
     // chaincoins (100k satoshi per coin).
     const N = 100;
-    const chaincoins = new MemWallet({
-      network: 'regtest'
-    });
+    const chaincoins = new MemWallet({ network });
 
     chain.on('block', (block, entry) => {
       chaincoins.addBlock(entry, block.txs);
@@ -1180,7 +1238,7 @@ describe('Mempool', function() {
     const chain = new Chain({
       memory: true,
       workers,
-      network: 'regtest'
+      network
     });
 
     const mempool = new Mempool({
@@ -1206,8 +1264,8 @@ describe('Mempool', function() {
     // Number of coins available in
     // chaincoins (100k satoshi per coin).
     const N = 100;
-    const chaincoins = new MemWallet();
-    const wallet = new MemWallet();
+    const chaincoins = new MemWallet({ network });
+    const wallet = new MemWallet({ network });
 
     async function getMockBlock(chain, txs = [], cb = true) {
       if (cb) {