Merge pull request #881 from braydonf/merkle-serialize

Add option to serialize merkle block with transactions

lib/primitives/merkleblock.js

@@ -14,6 +14,7 @@ const util = require('../utils/util');
 const hash256 = require('bcrypto/lib/hash256');
 const consensus = require('../protocol/consensus');
 const AbstractBlock = require('./abstractblock');
+const TX = require('./tx');
 const Headers = require('./headers');
 const DUMMY = Buffer.from([0]);
 const {encoding} = bio;
@@ -316,7 +317,9 @@ class MerkleBlock extends AbstractBlock {
       }),
       flags: this.flags,
       map: this.getTree().map,
-      txs: this.txs.length
+      txs: this.txs.map((tx, i) => {
+        return tx.format(view, null, i);
+      })
     };
   }
 
@@ -336,6 +339,22 @@ class MerkleBlock extends AbstractBlock {
     return size;
   }
 
+  /**
+   * Get merkleblock size with transactions.
+   * @returns {Number} Size.
+   */
+
+  getExtendedSize() {
+    let size = this.getSize();
+
+    size += encoding.sizeVarint(this.txs.length);
+
+    for (const tx of this.txs)
+      size += tx.getSize();
+
+    return size;
+  }
+
   /**
    * Write the merkleblock to a buffer writer.
    * @param {BufferWriter} bw
@@ -356,6 +375,22 @@ class MerkleBlock extends AbstractBlock {
     return bw;
   }
 
+  /**
+   * Write the merkleblock to a buffer writer with transactions.
+   * @param {BufferWriter} bw
+   */
+
+  toExtendedWriter(bw) {
+    this.toWriter(bw);
+
+    bw.writeVarint(this.txs.length);
+
+    for (const tx of this.txs)
+      tx.toWriter(bw);
+
+    return bw;
+  }
+
   /**
    * Serialize the merkleblock.
    * @param {String?} enc - Encoding, can be `'hex'` or null.
@@ -367,6 +402,16 @@ class MerkleBlock extends AbstractBlock {
     return this.toWriter(bio.write(size)).render();
   }
 
+  /**
+   * Serialize the merkleblock with transactions.
+   * @returns {Buffer}
+   */
+
+  toExtendedRaw() {
+    const size = this.getExtendedSize();
+    return this.toExtendedWriter(bio.write(size)).render();
+  }
+
   /**
    * Inject properties from buffer reader.
    * @private
@@ -388,6 +433,23 @@ class MerkleBlock extends AbstractBlock {
     return this;
   }
 
+  /**
+   * Inject properties with transactions from buffer reader.
+   * @private
+   * @param {BufferReader} br
+   */
+
+  fromExtendedReader(br)  {
+    this.fromReader(br);
+
+    const count = br.readVarint();
+
+    for (let i = 0; i < count; i++)
+      this.txs.push(TX.fromReader(br));
+
+    return this;
+  }
+
   /**
    * Inject properties from serialized data.
    * @private
@@ -398,6 +460,16 @@ class MerkleBlock extends AbstractBlock {
     return this.fromReader(bio.read(data));
   }
 
+  /**
+   * Inject properties with transactions from serialized data.
+   * @private
+   * @param {Buffer} data
+   */
+
+  fromExtendedRaw(data) {
+    return this.fromExtendedReader(bio.read(data));
+  }
+
   /**
    * Instantiate a merkleblock from a buffer reader.
    * @param {BufferReader} br
@@ -408,6 +480,16 @@ class MerkleBlock extends AbstractBlock {
     return new this().fromReader(br);
   }
 
+  /**
+   * Instantiate a merkleblock with transactions from a buffer reader.
+   * @param {BufferReader} br
+   * @returns {MerkleBlock}
+   */
+
+  static fromExtendedReader(br) {
+    return new this().fromExtendedReader(br);
+  }
+
   /**
    * Instantiate a merkleblock from a serialized data.
    * @param {Buffer} data
@@ -421,6 +503,19 @@ class MerkleBlock extends AbstractBlock {
     return new this().fromRaw(data);
   }
 
+  /**
+   * Instantiate a merkleblock with transactions from a serialized data.
+   * @param {Buffer} data
+   * @param {String?} enc - Encoding, can be `'hex'` or null.
+   * @returns {MerkleBlock}
+   */
+
+  static fromExtendedRaw(data, enc) {
+    if (typeof data === 'string')
+      data = Buffer.from(data, enc);
+    return new this().fromExtendedRaw(data);
+  }
+
   /**
    * Convert the block to an object suitable
    * for JSON serialization.

test/block-test.js

@@ -7,6 +7,7 @@ const assert = require('bsert');
 const common = require('./util/common');
 const {BloomFilter} = require('bfilter');
 const {BufferMap} = require('buffer-map');
+const TX = require('../lib/primitives/tx');
 const Block = require('../lib/primitives/block');
 const MerkleBlock = require('../lib/primitives/merkleblock');
 const consensus = require('../lib/protocol/consensus');
@@ -101,6 +102,21 @@ describe('Block', function() {
     assert(block2.verify());
   });
 
+  it('should serialize merkle block with transactions', () => {
+    const [full] = block300025.getBlock();
+    const [block] = merkle300025.getBlock();
+
+    const tree = block.getTree();
+
+    for (const tx of full.txs) {
+      if (tree.map.has(tx.hash()))
+        block.txs.push(TX.fromRaw(tx.toRaw()));
+    }
+
+    const block2 = MerkleBlock.fromExtendedRaw(block.toExtendedRaw());
+    assert.deepEqual(block.txs, block2.txs);
+  });
+
   it('should parse JSON', () => {
     const [block1] = block300025.getBlock();
     const block2 = Block.fromJSON(block1.toJSON());