852 lines
17 KiB
JavaScript
852 lines
17 KiB
JavaScript
/*!
|
|
* block.js - block object for bcoin
|
|
* Copyright (c) 2014-2015, Fedor Indutny (MIT License)
|
|
* Copyright (c) 2014-2017, Christopher Jeffrey (MIT License).
|
|
* https://github.com/bcoin-org/bcoin
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const assert = require('bsert');
|
|
const bio = require('bufio');
|
|
const {BufferSet} = require('buffer-map');
|
|
const hash256 = require('bcrypto/lib/hash256');
|
|
const merkle = require('bcrypto/lib/merkle');
|
|
const consensus = require('../protocol/consensus');
|
|
const AbstractBlock = require('./abstractblock');
|
|
const TX = require('./tx');
|
|
const MerkleBlock = require('./merkleblock');
|
|
const Headers = require('./headers');
|
|
const Network = require('../protocol/network');
|
|
const util = require('../utils/util');
|
|
const {encoding} = bio;
|
|
const {inspectSymbol} = require('../utils');
|
|
|
|
/**
|
|
* Block
|
|
* Represents a full block.
|
|
* @alias module:primitives.Block
|
|
* @extends AbstractBlock
|
|
*/
|
|
|
|
class Block extends AbstractBlock {
|
|
/**
|
|
* Create a block.
|
|
* @constructor
|
|
* @param {Object} options
|
|
*/
|
|
|
|
constructor(options) {
|
|
super();
|
|
|
|
this.txs = [];
|
|
|
|
this._raw = null;
|
|
this._size = -1;
|
|
this._witness = -1;
|
|
|
|
if (options)
|
|
this.fromOptions(options);
|
|
}
|
|
|
|
/**
|
|
* Inject properties from options object.
|
|
* @private
|
|
* @param {Object} options
|
|
*/
|
|
|
|
fromOptions(options) {
|
|
this.parseOptions(options);
|
|
|
|
if (options.txs) {
|
|
assert(Array.isArray(options.txs));
|
|
for (const tx of options.txs) {
|
|
assert(tx instanceof TX);
|
|
this.txs.push(tx);
|
|
}
|
|
}
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Instantiate block from options.
|
|
* @param {Object} options
|
|
* @returns {Block}
|
|
*/
|
|
|
|
static fromOptions(options) {
|
|
return new this().fromOptions(options);
|
|
}
|
|
|
|
/**
|
|
* Clear any cached values.
|
|
* @param {Boolean?} all - Clear transactions.
|
|
*/
|
|
|
|
refresh(all) {
|
|
this._refresh();
|
|
|
|
this._raw = null;
|
|
this._size = -1;
|
|
this._witness = -1;
|
|
|
|
if (!all)
|
|
return this;
|
|
|
|
for (const tx of this.txs)
|
|
tx.refresh();
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Serialize the block. Include witnesses if present.
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
toRaw() {
|
|
return this.frame().data;
|
|
}
|
|
|
|
/**
|
|
* Serialize the block, do not include witnesses.
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
toNormal() {
|
|
if (this.hasWitness())
|
|
return this.frameNormal().data;
|
|
return this.toRaw();
|
|
}
|
|
|
|
/**
|
|
* Serialize the block. Include witnesses if present.
|
|
* @param {BufferWriter} bw
|
|
*/
|
|
|
|
toWriter(bw) {
|
|
if (this.mutable)
|
|
return this.writeWitness(bw);
|
|
|
|
const raw = this.frame();
|
|
bw.writeBytes(raw.data);
|
|
|
|
return bw;
|
|
}
|
|
|
|
/**
|
|
* Serialize the block, do not include witnesses.
|
|
* @param {BufferWriter} bw
|
|
*/
|
|
|
|
toNormalWriter(bw) {
|
|
if (this.hasWitness()) {
|
|
this.writeNormal(bw);
|
|
return bw;
|
|
}
|
|
return this.toWriter(bw);
|
|
}
|
|
|
|
/**
|
|
* Get the raw block serialization.
|
|
* Include witnesses if present.
|
|
* @private
|
|
* @returns {RawBlock}
|
|
*/
|
|
|
|
frame() {
|
|
if (this.mutable) {
|
|
assert(!this._raw);
|
|
return this.frameWitness();
|
|
}
|
|
|
|
if (this._raw) {
|
|
assert(this._size >= 0);
|
|
assert(this._witness >= 0);
|
|
const raw = new RawBlock(this._size, this._witness);
|
|
raw.data = this._raw;
|
|
return raw;
|
|
}
|
|
|
|
const raw = this.frameWitness();
|
|
|
|
this._raw = raw.data;
|
|
this._size = raw.size;
|
|
this._witness = raw.witness;
|
|
|
|
return raw;
|
|
}
|
|
|
|
/**
|
|
* Calculate real size and size of the witness bytes.
|
|
* @returns {Object} Contains `size` and `witness`.
|
|
*/
|
|
|
|
getSizes() {
|
|
if (this.mutable)
|
|
return this.getWitnessSizes();
|
|
return this.frame();
|
|
}
|
|
|
|
/**
|
|
* Calculate virtual block size.
|
|
* @returns {Number} Virtual size.
|
|
*/
|
|
|
|
getVirtualSize() {
|
|
const scale = consensus.WITNESS_SCALE_FACTOR;
|
|
return (this.getWeight() + scale - 1) / scale | 0;
|
|
}
|
|
|
|
/**
|
|
* Calculate block weight.
|
|
* @returns {Number} weight
|
|
*/
|
|
|
|
getWeight() {
|
|
const raw = this.getSizes();
|
|
const base = raw.size - raw.witness;
|
|
return base * (consensus.WITNESS_SCALE_FACTOR - 1) + raw.size;
|
|
}
|
|
|
|
/**
|
|
* Get real block size.
|
|
* @returns {Number} size
|
|
*/
|
|
|
|
getSize() {
|
|
return this.getSizes().size;
|
|
}
|
|
|
|
/**
|
|
* Get base block size (without witness).
|
|
* @returns {Number} size
|
|
*/
|
|
|
|
getBaseSize() {
|
|
const raw = this.getSizes();
|
|
return raw.size - raw.witness;
|
|
}
|
|
|
|
/**
|
|
* Test whether the block contains a
|
|
* transaction with a non-empty witness.
|
|
* @returns {Boolean}
|
|
*/
|
|
|
|
hasWitness() {
|
|
if (this._witness !== -1)
|
|
return this._witness !== 0;
|
|
|
|
for (const tx of this.txs) {
|
|
if (tx.hasWitness())
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Test the block's transaction vector against a hash.
|
|
* @param {Hash} hash
|
|
* @returns {Boolean}
|
|
*/
|
|
|
|
hasTX(hash) {
|
|
return this.indexOf(hash) !== -1;
|
|
}
|
|
|
|
/**
|
|
* Find the index of a transaction in the block.
|
|
* @param {Hash} hash
|
|
* @returns {Number} index (-1 if not present).
|
|
*/
|
|
|
|
indexOf(hash) {
|
|
for (let i = 0; i < this.txs.length; i++) {
|
|
const tx = this.txs[i];
|
|
if (tx.hash().equals(hash))
|
|
return i;
|
|
}
|
|
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Calculate merkle root. Returns null
|
|
* if merkle tree has been malleated.
|
|
* @param {String?} enc - Encoding, can be `'hex'` or null.
|
|
* @returns {Hash|null}
|
|
*/
|
|
|
|
createMerkleRoot(enc) {
|
|
const leaves = [];
|
|
|
|
for (const tx of this.txs)
|
|
leaves.push(tx.hash());
|
|
|
|
const [root, malleated] = merkle.createRoot(hash256, leaves);
|
|
|
|
if (malleated)
|
|
return null;
|
|
|
|
return enc === 'hex' ? root.toString('hex') : root;
|
|
}
|
|
|
|
/**
|
|
* Create a witness nonce (for mining).
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
createWitnessNonce() {
|
|
return Buffer.from(consensus.ZERO_HASH);
|
|
}
|
|
|
|
/**
|
|
* Calculate commitment hash (the root of the
|
|
* witness merkle tree hashed with the witnessNonce).
|
|
* @param {String?} enc - Encoding, can be `'hex'` or null.
|
|
* @returns {Hash}
|
|
*/
|
|
|
|
createCommitmentHash(enc) {
|
|
const nonce = this.getWitnessNonce();
|
|
const leaves = [];
|
|
|
|
assert(nonce, 'No witness nonce present.');
|
|
|
|
leaves.push(consensus.ZERO_HASH);
|
|
|
|
for (let i = 1; i < this.txs.length; i++) {
|
|
const tx = this.txs[i];
|
|
leaves.push(tx.witnessHash());
|
|
}
|
|
|
|
const [root] = merkle.createRoot(hash256, leaves);
|
|
|
|
// Note: malleation check ignored here.
|
|
// assert(!malleated);
|
|
|
|
const hash = hash256.root(root, nonce);
|
|
|
|
return enc === 'hex'
|
|
? hash.toString('hex')
|
|
: hash;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the merkle root from the block header.
|
|
* @param {String?} enc
|
|
* @returns {Hash}
|
|
*/
|
|
|
|
getMerkleRoot(enc) {
|
|
if (enc === 'hex')
|
|
return this.merkleRoot.toString('hex');
|
|
return this.merkleRoot;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the witness nonce from the
|
|
* coinbase's witness vector (if present).
|
|
* @returns {Buffer|null}
|
|
*/
|
|
|
|
getWitnessNonce() {
|
|
if (this.txs.length === 0)
|
|
return null;
|
|
|
|
const coinbase = this.txs[0];
|
|
|
|
if (coinbase.inputs.length !== 1)
|
|
return null;
|
|
|
|
const input = coinbase.inputs[0];
|
|
|
|
if (input.witness.items.length !== 1)
|
|
return null;
|
|
|
|
if (input.witness.items[0].length !== 32)
|
|
return null;
|
|
|
|
return input.witness.items[0];
|
|
}
|
|
|
|
/**
|
|
* Retrieve the commitment hash
|
|
* from the coinbase's outputs.
|
|
* @param {String?} enc
|
|
* @returns {Hash|null}
|
|
*/
|
|
|
|
getCommitmentHash(enc) {
|
|
if (this.txs.length === 0)
|
|
return null;
|
|
|
|
const coinbase = this.txs[0];
|
|
|
|
let hash = null;
|
|
|
|
for (let i = coinbase.outputs.length - 1; i >= 0; i--) {
|
|
const output = coinbase.outputs[i];
|
|
if (output.script.isCommitment()) {
|
|
hash = output.script.getCommitment();
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!hash)
|
|
return null;
|
|
|
|
return enc === 'hex'
|
|
? hash.toString('hex')
|
|
: hash;
|
|
}
|
|
|
|
/**
|
|
* Do non-contextual verification on the block. Including checking the block
|
|
* size, the coinbase and the merkle root. This is consensus-critical.
|
|
* @returns {Boolean}
|
|
*/
|
|
|
|
verifyBody() {
|
|
const [valid] = this.checkBody();
|
|
return valid;
|
|
}
|
|
|
|
/**
|
|
* Do non-contextual verification on the block. Including checking the block
|
|
* size, the coinbase and the merkle root. This is consensus-critical.
|
|
* @returns {Array} [valid, reason, score]
|
|
*/
|
|
|
|
checkBody() {
|
|
// Check base size.
|
|
if (this.txs.length === 0
|
|
|| this.txs.length > consensus.MAX_BLOCK_SIZE
|
|
|| this.getBaseSize() > consensus.MAX_BLOCK_SIZE) {
|
|
return [false, 'bad-blk-length', 100];
|
|
}
|
|
|
|
// First TX must be a coinbase.
|
|
if (this.txs.length === 0 || !this.txs[0].isCoinbase())
|
|
return [false, 'bad-cb-missing', 100];
|
|
|
|
// Check merkle root.
|
|
const root = this.createMerkleRoot();
|
|
|
|
// If the merkle is mutated,
|
|
// we have duplicate txs.
|
|
if (!root)
|
|
return [false, 'bad-txns-duplicate', 100];
|
|
|
|
if (!this.merkleRoot.equals(root))
|
|
return [false, 'bad-txnmrklroot', 100];
|
|
|
|
// Test all transactions.
|
|
const scale = consensus.WITNESS_SCALE_FACTOR;
|
|
|
|
let sigops = 0;
|
|
|
|
for (let i = 0; i < this.txs.length; i++) {
|
|
const tx = this.txs[i];
|
|
|
|
// The rest of the txs must not be coinbases.
|
|
if (i > 0 && tx.isCoinbase())
|
|
return [false, 'bad-cb-multiple', 100];
|
|
|
|
// Sanity checks.
|
|
const [valid, reason, score] = tx.checkSanity();
|
|
|
|
if (!valid)
|
|
return [valid, reason, score];
|
|
|
|
// Count legacy sigops (do not count scripthash or witness).
|
|
sigops += tx.getLegacySigops();
|
|
if (sigops * scale > consensus.MAX_BLOCK_SIGOPS_COST)
|
|
return [false, 'bad-blk-sigops', 100];
|
|
}
|
|
|
|
return [true, 'valid', 0];
|
|
}
|
|
|
|
/**
|
|
* Retrieve the coinbase height from the coinbase input script.
|
|
* @returns {Number} height (-1 if not present).
|
|
*/
|
|
|
|
getCoinbaseHeight() {
|
|
if (this.version < 2)
|
|
return -1;
|
|
|
|
if (this.txs.length === 0)
|
|
return -1;
|
|
|
|
const coinbase = this.txs[0];
|
|
|
|
if (coinbase.inputs.length === 0)
|
|
return -1;
|
|
|
|
return coinbase.inputs[0].script.getCoinbaseHeight();
|
|
}
|
|
|
|
/**
|
|
* Get the "claimed" reward by the coinbase.
|
|
* @returns {Amount} claimed
|
|
*/
|
|
|
|
getClaimed() {
|
|
assert(this.txs.length > 0);
|
|
assert(this.txs[0].isCoinbase());
|
|
return this.txs[0].getOutputValue();
|
|
}
|
|
|
|
/**
|
|
* Get all unique outpoint hashes in the
|
|
* block. Coinbases are ignored.
|
|
* @returns {Hash[]} Outpoint hashes.
|
|
*/
|
|
|
|
getPrevout() {
|
|
const prevout = new BufferSet();
|
|
|
|
for (let i = 1; i < this.txs.length; i++) {
|
|
const tx = this.txs[i];
|
|
|
|
for (const input of tx.inputs)
|
|
prevout.add(input.prevout.hash);
|
|
}
|
|
|
|
return prevout.toArray();
|
|
}
|
|
|
|
/**
|
|
* Inspect the block and return a more
|
|
* user-friendly representation of the data.
|
|
* @returns {Object}
|
|
*/
|
|
|
|
[inspectSymbol]() {
|
|
return this.format();
|
|
}
|
|
|
|
/**
|
|
* Inspect the block and return a more
|
|
* user-friendly representation of the data.
|
|
* @param {CoinView} view
|
|
* @param {Number} height
|
|
* @returns {Object}
|
|
*/
|
|
|
|
format(view, height) {
|
|
const commitmentHash = this.getCommitmentHash();
|
|
return {
|
|
hash: this.rhash(),
|
|
height: height != null ? height : -1,
|
|
size: this.getSize(),
|
|
virtualSize: this.getVirtualSize(),
|
|
date: util.date(this.time),
|
|
version: this.version.toString(16),
|
|
prevBlock: util.revHex(this.prevBlock),
|
|
merkleRoot: util.revHex(this.merkleRoot),
|
|
commitmentHash: commitmentHash
|
|
? util.revHex(commitmentHash)
|
|
: null,
|
|
time: this.time,
|
|
bits: this.bits,
|
|
nonce: this.nonce,
|
|
txs: this.txs.map((tx, i) => {
|
|
return tx.format(view, null, i);
|
|
})
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Convert the block to an object suitable
|
|
* for JSON serialization.
|
|
* @returns {Object}
|
|
*/
|
|
|
|
toJSON() {
|
|
return this.getJSON();
|
|
}
|
|
|
|
/**
|
|
* Convert the block to an object suitable
|
|
* for JSON serialization. Note that the hashes
|
|
* will be reversed to abide by bitcoind's legacy
|
|
* of little-endian uint256s.
|
|
* @param {Network} network
|
|
* @param {CoinView} view
|
|
* @param {Number} height
|
|
* @param {Number} depth
|
|
* @returns {Object}
|
|
*/
|
|
|
|
getJSON(network, view, height, depth) {
|
|
network = Network.get(network);
|
|
return {
|
|
hash: this.rhash(),
|
|
height: height,
|
|
depth: depth,
|
|
version: this.version,
|
|
prevBlock: util.revHex(this.prevBlock),
|
|
merkleRoot: util.revHex(this.merkleRoot),
|
|
time: this.time,
|
|
bits: this.bits,
|
|
nonce: this.nonce,
|
|
txs: this.txs.map((tx, i) => {
|
|
return tx.getJSON(network, view, null, i);
|
|
})
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Inject properties from json object.
|
|
* @private
|
|
* @param {Object} json
|
|
*/
|
|
|
|
fromJSON(json) {
|
|
assert(json, 'Block data is required.');
|
|
assert(Array.isArray(json.txs));
|
|
|
|
this.parseJSON(json);
|
|
|
|
for (const tx of json.txs)
|
|
this.txs.push(TX.fromJSON(tx));
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Instantiate a block from a jsonified block object.
|
|
* @param {Object} json - The jsonified block object.
|
|
* @returns {Block}
|
|
*/
|
|
|
|
static fromJSON(json) {
|
|
return new this().fromJSON(json);
|
|
}
|
|
|
|
/**
|
|
* Inject properties from serialized data.
|
|
* @private
|
|
* @param {Buffer} data
|
|
*/
|
|
|
|
fromReader(br) {
|
|
br.start();
|
|
|
|
this.readHead(br);
|
|
|
|
const count = br.readVarint();
|
|
let witness = 0;
|
|
|
|
for (let i = 0; i < count; i++) {
|
|
const tx = TX.fromReader(br);
|
|
witness += tx._witness;
|
|
this.txs.push(tx);
|
|
}
|
|
|
|
if (!this.mutable) {
|
|
this._raw = br.endData();
|
|
this._size = this._raw.length;
|
|
this._witness = witness;
|
|
}
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Inject properties from serialized data.
|
|
* @private
|
|
* @param {Buffer} data
|
|
*/
|
|
|
|
fromRaw(data) {
|
|
return this.fromReader(bio.read(data));
|
|
}
|
|
|
|
/**
|
|
* Instantiate a block from a serialized Buffer.
|
|
* @param {Buffer} data
|
|
* @param {String?} enc - Encoding, can be `'hex'` or null.
|
|
* @returns {Block}
|
|
*/
|
|
|
|
static fromReader(data) {
|
|
return new this().fromReader(data);
|
|
}
|
|
|
|
/**
|
|
* Instantiate a block from a serialized Buffer.
|
|
* @param {Buffer} data
|
|
* @param {String?} enc - Encoding, can be `'hex'` or null.
|
|
* @returns {Block}
|
|
*/
|
|
|
|
static fromRaw(data, enc) {
|
|
if (typeof data === 'string')
|
|
data = Buffer.from(data, enc);
|
|
return new this().fromRaw(data);
|
|
}
|
|
|
|
/**
|
|
* Convert the Block to a MerkleBlock.
|
|
* @param {Bloom} filter - Bloom filter for transactions
|
|
* to match. The merkle block will contain only the
|
|
* matched transactions.
|
|
* @returns {MerkleBlock}
|
|
*/
|
|
|
|
toMerkle(filter) {
|
|
return MerkleBlock.fromBlock(this, filter);
|
|
}
|
|
|
|
/**
|
|
* Serialze block with or without witness data.
|
|
* @private
|
|
* @param {Boolean} witness
|
|
* @param {BufferWriter?} writer
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
writeNormal(bw) {
|
|
this.writeHead(bw);
|
|
|
|
bw.writeVarint(this.txs.length);
|
|
|
|
for (const tx of this.txs)
|
|
tx.toNormalWriter(bw);
|
|
|
|
return bw;
|
|
}
|
|
|
|
/**
|
|
* Serialze block with or without witness data.
|
|
* @private
|
|
* @param {Boolean} witness
|
|
* @param {BufferWriter?} writer
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
writeWitness(bw) {
|
|
this.writeHead(bw);
|
|
|
|
bw.writeVarint(this.txs.length);
|
|
|
|
for (const tx of this.txs)
|
|
tx.toWriter(bw);
|
|
|
|
return bw;
|
|
}
|
|
|
|
/**
|
|
* Serialze block with or without witness data.
|
|
* @private
|
|
* @param {Boolean} witness
|
|
* @param {BufferWriter?} writer
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
frameNormal() {
|
|
const raw = this.getNormalSizes();
|
|
const bw = bio.write(raw.size);
|
|
this.writeNormal(bw);
|
|
raw.data = bw.render();
|
|
return raw;
|
|
}
|
|
|
|
/**
|
|
* Serialze block without witness data.
|
|
* @private
|
|
* @param {BufferWriter?} writer
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
frameWitness() {
|
|
const raw = this.getWitnessSizes();
|
|
const bw = bio.write(raw.size);
|
|
this.writeWitness(bw);
|
|
raw.data = bw.render();
|
|
return raw;
|
|
}
|
|
|
|
/**
|
|
* Convert the block to a headers object.
|
|
* @returns {Headers}
|
|
*/
|
|
|
|
toHeaders() {
|
|
return Headers.fromBlock(this);
|
|
}
|
|
|
|
/**
|
|
* Get real block size without witness.
|
|
* @returns {RawBlock}
|
|
*/
|
|
|
|
getNormalSizes() {
|
|
let size = 0;
|
|
|
|
size += 80;
|
|
size += encoding.sizeVarint(this.txs.length);
|
|
|
|
for (const tx of this.txs)
|
|
size += tx.getBaseSize();
|
|
|
|
return new RawBlock(size, 0);
|
|
}
|
|
|
|
/**
|
|
* Get real block size with witness.
|
|
* @returns {RawBlock}
|
|
*/
|
|
|
|
getWitnessSizes() {
|
|
let size = 0;
|
|
let witness = 0;
|
|
|
|
size += 80;
|
|
size += encoding.sizeVarint(this.txs.length);
|
|
|
|
for (const tx of this.txs) {
|
|
const raw = tx.getSizes();
|
|
size += raw.size;
|
|
witness += raw.witness;
|
|
}
|
|
|
|
return new RawBlock(size, witness);
|
|
}
|
|
|
|
/**
|
|
* Test whether an object is a Block.
|
|
* @param {Object} obj
|
|
* @returns {Boolean}
|
|
*/
|
|
|
|
static isBlock(obj) {
|
|
return obj instanceof Block;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Helpers
|
|
*/
|
|
|
|
class RawBlock {
|
|
constructor(size, witness) {
|
|
this.data = null;
|
|
this.size = size;
|
|
this.witness = witness;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Expose
|
|
*/
|
|
|
|
module.exports = Block;
|