Merge pull request #201 from tynes/node-event-tree-commit

node: event tree commit

lib/blockchain/chain.js

@@ -1608,14 +1608,15 @@ class Chain extends AsyncEmitter {
     this.emit('tip', entry);
     this.emit('reconnect', entry, block);
 
+    if ((entry.height % this.network.names.treeInterval) === 0)
+      this.emit('tree commit', this.db.tree.rootHash(), entry, block);
+
     return this.emitAsync('connect', entry, block, view);
   }
 
   /**
-   * Set the best chain. This is called on every valid block
-   * that comes in. It may add and connect the block (main chain),
-   * save the block without connection (alternate chain), or
-   * reorganize the chain (a higher fork).
+   * Set the best chain. This is called on every incoming
+   * block with greater chainwork than the current tip.
    * @private
    * @param {ChainEntry} entry
    * @param {Block} block
@@ -1674,6 +1675,9 @@ class Chain extends AsyncEmitter {
     this.emit('tip', entry);
     this.emit('block', block, entry);
 
+    if ((entry.height % this.network.names.treeInterval) === 0)
+      this.emit('tree commit', this.db.tree.rootHash(), entry, block);
+
     return this.emitAsync('connect', entry, block, view);
   }
 

lib/node/http.js

@@ -698,6 +698,15 @@ class HTTP extends Server {
         socket.fire('tx', raw);
       }
     });
+
+    this.chain.on('tree commit', (root, entry, block) => {
+      const sockets = this.channel('chain');
+
+      if (!sockets)
+        return;
+
+      this.to('chain', 'tree commit', root, entry, block);
+    });
   }
 
   /**

test/node-http-test.js

@@ -0,0 +1,176 @@
+/*!
+ * test/node-http-test.js - test for wallet http endoints
+ * Copyright (c) 2019, Mark Tyneway (MIT License).
+ * https://github.com/handshake-org/hsd
+ */
+
+/* eslint-env mocha */
+/* eslint prefer-arrow-callback: "off" */
+/* eslint no-return-assign: "off" */
+
+'use strict';
+
+const assert = require('bsert');
+const bio = require('bufio');
+const {NodeClient} = require('hs-client');
+const Network = require('../lib/protocol/network');
+const FullNode = require('../lib/node/fullnode');
+const Address = require('../lib/primitives/address');
+const Mnemonic = require('../lib/hd/mnemonic');
+const Witness = require('../lib/script/witness');
+const Script = require('../lib/script/script');
+const HDPrivateKey = require('../lib/hd/private');
+const Output = require('../lib/primitives/output');
+const Coin = require('../lib/primitives/coin');
+const MTX = require('../lib/primitives/mtx');
+const rules = require('../lib/covenants/rules');
+const common = require('./util/common');
+const mnemonics = require('./data/mnemonic-english.json');
+// Commonly used test mnemonic
+const phrase = mnemonics[0][1];
+
+const network = Network.get('regtest');
+const {types} = rules;
+
+const node = new FullNode({
+  network: 'regtest',
+  apiKey: 'foo',
+  walletAuth: true,
+  memory: true,
+  indexTx: true,
+  indexAddress: true,
+  rejectAbsurdFees: false
+});
+
+const nclient = new NodeClient({
+  port: network.rpcPort,
+  apiKey: 'foo'
+});
+
+let cbAddress, privkey, pubkey;
+let socketData, mempoolData;
+
+const {treeInterval} = network.names;
+
+describe('Node HTTP', function() {
+  this.timeout(15000);
+
+  before(async () => {
+    await node.open();
+    await nclient.open();
+    await nclient.call('watch chain');
+
+    const mnemonic = Mnemonic.fromPhrase(phrase);
+    const priv = HDPrivateKey.fromMnemonic(mnemonic);
+    const type = network.keyPrefix.coinType;
+    const key = priv.derive(44, true).derive(type, true).derive(0, true);
+    const xkey = key.derive(0).derive(0);
+
+    pubkey = xkey.publicKey;
+    privkey = xkey.privateKey;
+
+    cbAddress = Address.fromPubkey(pubkey).toString(network.type);
+
+    nclient.bind('tree commit', (root, entry, block) => {
+      assert.ok(root);
+      assert.ok(block);
+      assert.ok(entry);
+
+      socketData.push({root, entry, block});
+    });
+
+    node.mempool.on('tx', (tx) => {
+      mempoolData[tx.txid()] = true;
+    });
+  });
+
+  beforeEach(() => {
+    socketData = [];
+    mempoolData = {};
+  });
+
+  after(async () => {
+    await nclient.close();
+    await node.close();
+  });
+
+  describe('Websockets', function () {
+    describe('tree commit', () => {
+      it('should mine 1 tree interval', async () => {
+        await mineBlocks(treeInterval, cbAddress);
+        assert.equal(socketData.length, 1);
+      });
+
+      it('should send the correct tree root', async () => {
+        const name = await nclient.execute('grindname', [5]);
+        const rawName = Buffer.from(name, 'ascii');
+        const nameHash = rules.hashName(rawName);
+
+        const u32 = Buffer.alloc(4);
+        bio.writeU32(u32, 0, 0);
+
+        const output = new Output({
+          address: cbAddress,
+          value: 0,
+          covenant: {
+            type: types.OPEN,
+            items: [nameHash, u32, rawName]
+          }
+        });
+
+        const mtx = new MTX();
+        mtx.addOutput(output);
+
+        const coins = await nclient.getCoinsByAddresses([cbAddress]);
+        coins.sort((a, b) => a.height - b.height);
+        const coin = Coin.fromJSON(coins[0]);
+
+        assert.ok(node.chain.height > coin.height + network.coinbaseMaturity);
+        mtx.addCoin(coin);
+
+        const addr = Address.fromPubkey(pubkey);
+        const script = Script.fromPubkeyhash(addr.hash);
+
+        const sig = mtx.signature(0, script, coin.value, privkey);
+        mtx.inputs[0].witness = Witness.fromItems([sig, pubkey]);
+
+        const valid = mtx.verify();
+        assert.ok(valid);
+
+        const tx = mtx.toTX();
+        await node.sendTX(tx);
+
+        await common.forValue(mempoolData, tx.txid(), true);
+
+        const pre = await nclient.getInfo();
+
+        const mempool = await nclient.getMempool();
+        assert.equal(mempool[0], mtx.txid());
+
+        await mineBlocks(treeInterval, cbAddress);
+        assert.equal(socketData.length, 1);
+
+        const {root, block, entry} = socketData[0];
+        assert.bufferEqual(node.chain.db.treeRoot(), root);
+
+        const info = await nclient.getInfo();
+        assert.notEqual(pre.chain.tip, info.chain.tip);
+
+        assert.equal(info.chain.tip, block.hash);
+        assert.equal(info.chain.tip, entry.hash);
+      });
+    });
+  });
+});
+
+// take into account race conditions
+async function mineBlocks(count, address) {
+  for (let i = 0; i < count; i++) {
+    const obj = { complete: false };
+    node.once('block', () => {
+      obj.complete = true;
+    });
+    await nclient.execute('generatetoaddress', [1, address]);
+    await common.forValue(obj, 'complete', true);
+  }
+}