/** * fullchain.js - fullnode blockchain management for bcoin * Copyright (c) 2014-2015, Fedor Indutny (MIT License) * https://github.com/indutny/bcoin */ var inherits = require('inherits'); var EventEmitter = require('events').EventEmitter; var bcoin = require('../bcoin'); var bn = require('bn.js'); var constants = bcoin.protocol.constants; var network = bcoin.protocol.network; var utils = bcoin.utils; var assert = utils.assert; /** * Chain */ function Chain(options) { if (!(this instanceof Chain)) return new Chain(options); EventEmitter.call(this); this.options = options || {}; this.prefix = 'bt/chain/'; this.storage = this.options.storage; this.strict = this.options.strict || false; this.tip = null; this.orphan = { map: {}, bmap: {}, count: 0, size: 0 }; this.index = { entries: [], // Get hash by height hashes: [], // Get height by hash heights: {}, count: 0, lastTs: 0 }; this.request = new utils.RequestCache(); if (process.env.BCOIN_START_HEIGHT) { this.storage = null; this.fromJSON(require('./protocol/preload-full')); this.resetHeight(+process.env.BCOIN_START_HEIGHT); } else { this.fromJSON({ v: 2, type: 'chain', network: network.type, entries: [ { hash: utils.toHex(network.genesis._hash), version: network.genesis.version, prevBlock: utils.toHex(network.genesis.prevBlock), ts: network.genesis.ts, bits: network.genesis.bits, height: 0 } ] }); if (!this.options.fullNode) this.fromJSON(network.preload); } this.tip = this.index.entries[this.index.entries.length - 1]; // Last TS after preload, needed for fill percent this.index.lastTs = this.index.entries[this.index.entries.length - 1].ts; Chain.global = this; this.loading = false; this._init(); } inherits(Chain, EventEmitter); Chain.codes = { okay: 0, newOrphan: 1, knownOrphan: 2, forked: 3, invalid: 4, badCheckpoint: 4, unchanged: 5 }; Chain.messages = { 0: 'Block was added successfully', 1: 'Block is a new orphan', 2: 'Block is a known orphan', 3: 'Block is a greater fork', 4: 'Block verification failed', 5: 'Block does not match checkpoint', 6: 'Chain is unchanged' }; Chain.msg = function msg(code) { return Chain.messages[code] || 'Unknown'; }; Chain.prototype._init = function _init() { var self = this; var s; this.loading = true; if (!this.storage) { utils.nextTick(function() { self.loading = false; self.emit('load'); }); return; } utils.nextTick(function() { self.emit('debug', 'Chain is loading.'); }); s = this.storage.createReadStream({ start: this.prefix, end: this.prefix + 'z' }); s.on('data', function(data) { data.value.hash = data.key.slice(self.prefix.length); self._addIndex(ChainBlock.fromJSON(self, data.value)); }); s.on('error', function(err) { self.emit('error', err); }); s.on('end', function() { self.loading = false; self.emit('load'); self.emit('debug', 'Chain successfully loaded.'); }); }; Chain.prototype._addIndex = function _addIndex(entry, save) { var self = this; // Already added if (this.index.heights[entry.hash] != null) { assert(this.index.heights[entry.hash] === entry.height); return Chain.codes.unchanged; } // Duplicate height if (this.index.hashes[entry.height] === entry.hash) return Chain.codes.unchanged; // Fork at checkpoint checkpoint = network.checkpoints[entry.height]; if (checkpoint) { this.emit('checkpoint', entry.height, entry.hash, checkpoint); if (hash !== checkpoint) { // Resetting to the last checkpoint _really_ isn't // necessary (even bitcoind doesn't do it), but it // could be used if you want to be on the overly // safe (see: paranoid) side. // this.resetLastCheckpoint(entry.height); this.emit('fork', { height: entry.height, expected: checkpoint, received: entry.hash, checkpoint: true }); return Chain.codes.badCheckpoint; } } this.index.entries[entry.height] = entry; this.index.hashes[entry.height] = entry.hash; this.index.heights[entry.hash] = entry.height; this.index.count++; this.tip = this.index.entries[this.index.entries.length - 1]; this.emit('tip', this.tip); if (save) this._save(entry.hash, entry); return Chain.codes.okay; }; Chain.prototype.resetLastCheckpoint = function resetLastCheckpoint(height) { var heights = Object.keys(network.checkpoints).sort(); var index = heights.indexOf(height) - 1; var checkpoint = network.checkpoint[index]; assert(index >= 0); assert(checkpoint); // This is the safest way to do it, the other // possibility is to simply reset ignore the // bad checkpoint block. The likelihood of // someone carrying on an entire fork between // to checkpoints is absurd, so this is // probably _a lot_ of work for nothing. this.resetHeight(checkpoint.height); }; Chain.prototype.resetHeight = function resetHeight(height) { var self = this; var ahead = this.index.entries.slice(height + 1); assert(height < this.index.entries.length); // Nothing to do. if (height === this.index.entries.length - 1) return; // Reset the orphan map completely. There may // have been some orphans on a forked chain we // no longer need. this.orphan.map = {}; this.orphan.bmap = {}; this.orphan.count = 0; this.orphan.size = 0; // Rebuild the index from our new (lower) height. this.index.entries.length = height + 1; this.index.heights = this.index.entries.reduce(function(out, entry) { if (!self.options.fullNode) { if (!entry) return out; } out[entry.hash] = entry.height; return out; }, {}); this.index.hashes.length = height + 1; if (!this.options.fullNode) this.index.count -= this._count(ahead); else this.index.count = height + 1; // Set and emit our new (old) tip. this.tip = this.index.entries[this.index.entries.length - 1]; this.emit('tip', this.tip); // The lastTs is supposed to be the last ts // after the preload, but we're not sure where // we're resetting to. It may be lower, it may // be higher. Reset it if necessary. this.index.lastTs = Math.min( this.index.lastTs, this.index.entries[this.index.entries.length - 1].ts ); // Delete all the blocks now above us. ahead.forEach(function(entry) { if (!self.options.fullNode) { if (!entry) return; } self._delete(entry.hash); }); }; Chain.prototype.resetTime = function resetTime(ts) { var entry = this.byTime(ts); if (!entry) return; return this.resetHeight(entry.height); }; Chain.prototype.add = function add(block, peer) { var initial = block; var code = Chain.codes.unchanged; var hash, prevHash, prevHeight, entry, tip; var total = 0; for (;;) { // Validate the block we want to add. // This is only necessary for new // blocks coming in, not the resolving // orphans. if (block === initial && !block.verify()) { code = Chain.codes.invalid; break; } hash = block.hash('hex'); prevHash = block.prevBlock; // If the block is already known to be // an orphan, ignore it. if (this.orphan.map[prevHash]) { // If the orphan chain forked, simply // reset the orphans and find a new peer. if (this.orphan.map[prevHash].hash('hex') !== hash) { this.orphan.map = {}; this.orphan.bmap = {}; this.orphan.count = 0; this.orphan.size = 0; this.emit('fork', { height: -1, expected: this.orphan.map[prevHash].hash('hex'), received: hash, checkpoint: null }); code = Chain.codes.forked; break; } code = Chain.codes.knownOrphan; break; } // Find the previous block height/index. prevHeight = this.index.heights[prevHash]; // If previous block wasn't ever seen, // add it current to orphans and break. if (prevHeight == null) { this.orphan.count++; this.orphan.size += block.size(); this.orphan.map[prevHash] = block; this.orphan.bmap[hash] = block; code = Chain.codes.newOrphan; total++; break; } entry = new ChainBlock(this, { hash: hash, version: block.version, prevBlock: prevHash, ts: block.ts, bits: block.bits, height: prevHeight + 1 }); // Add entry if we do not have it (or if // there is another entry at its height) if (this.index.hashes[entry.height] !== hash) { assert(this.index.heights[entry.hash] == null); // A valid block with an already existing // height came in, that spells fork. We // don't store by hash so we can't compare // chainworks. We reset the chain, find a // new peer, and wait to see who wins. if (this.index.hashes[entry.height]) { // The tip has more chainwork, it is a // higher height than the entry. This is // not an alternate tip. Ignore it. if (this.tip.chainwork.cmp(entry.chainwork) > 0) { code = Chain.codes.unchanged; break; } // Get _our_ tip as opposed to // the attempted alternate tip. tip = this.index.entries[entry.height]; // The block has equal chainwork (an // alternate tip). Reset the chain, find // a new peer, and wait to see who wins. this.resetHeight(entry.height - 1); this.emit('fork', { height: prevHeight + 1, expected: tip.hash, received: entry.hash, checkpoint: null }); code = Chain.codes.forked; break; } // Do "contextual" verification on our block // now that we're certain its previous // block is in the chain. if (!block.postVerify()) { throw new Error; code = Chain.codes.invalid; break; } // Attempt to add block to the chain index. code = this._addIndex(entry, true); // Result should never be `unchanged` since // we already verified there were no // duplicate heights, etc. assert(code !== Chain.codes.unchanged); // Block did not match the checkpoint. The // chain could be reset to the last sane // checkpoint, but it really isn't necessary, // so we don't do it. The misbehaving peer has // been killed and hopefully we find a peer // who isn't trying to fool us. if (code !== Chain.codes.okay) break; // Keep track of the number of blocks we // added and the number of orphans resolved. total++; // Emit our block (and potentially resolved // orphan) so the programmer can save it. this.emit('block', block, peer); this.emit('entry', entry); if (block !== initial) this.emit('resolved', entry); } // Fullfill request this.request.fullfill(hash, block); if (!this.orphan.map[hash]) break; // An orphan chain was found, start resolving. block = this.orphan.map[hash]; delete this.orphan.bmap[block.hash('hex')]; delete this.orphan.map[hash]; this.orphan.count--; this.orphan.size -= block.size(); } // Failsafe for large orphan chains. Do not // allow more than 20mb stored in memory. if (this.orphan.size > 20971520) { this.orphan.map = {}; this.orphan.bmap = {}; this.orphan.count = 0; this.orphan.size = 0; } // Potentially compact the chain here. A // full chain is not necessary for spv. // if (!this.options.fullNode) { // if (this.size() > 100000) // this.compact(); // } if (code !== Chain.codes.okay) this.emit('debug', 'Chain Error: %s', Chain.msg(code)); return total; }; Chain.prototype.has = function has(hash, cb) { if (this.loading) { this.once('load', function() { this.has(hash, noIndex, cb); }); return; } cb = utils.asyncify(cb); return cb(this.hasBlock(hash) || this.hasOrphan(hash)); }; Chain.prototype.byHeight = function byHeight(height) { return this.index.entries[height] || null; }; Chain.prototype.byHash = function byHash(hash) { if (utils.isBuffer(hash)) hash = utils.toHex(hash); else if (hash.hash) hash = hash.hash('hex'); return this.byHeight(this.index.heights[hash]); }; Chain.prototype.byTime = function byTime(ts) { for (var i = this.index.entries.length - 1; i >= 0; i--) { if (!this.options.fullNode) { if (!this.index.entries[i]) continue; } if (ts >= this.index.entries[i].ts) return this.index.entries[i]; } return null; }; Chain.prototype.hasBlock = function hasBlock(hash) { return !!this.byHash(hash); }; Chain.prototype.hasOrphan = function hasOrphan(hash) { return !!this.getOrphan(hash); }; Chain.prototype.getBlock = function getBlock(hash) { if (typeof hash === 'number') return this.byHeight(hash); return this.byHash(hash); }; Chain.prototype.getOrphan = function getOrphan(hash) { if (utils.isBuffer(hash)) hash = utils.toHex(hash); else if (hash.hash) hash = hash.hash('hex'); return this.orphan.bmap[hash] || null; }; Chain.prototype.getTip = function getTip() { return this.index.entries[this.index.entries.length - 1]; }; Chain.prototype.isFull = function isFull() { var last = this.index.entries[this.index.entries.length - 1].ts; var delta = utils.now() - last; return delta < 40 * 60; }; Chain.prototype.fillPercent = function fillPercent() { var total = (utils.now() - 40 * 60) - this.index.lastTs; var current = this.getTip().ts - this.index.lastTs; return Math.max(0, Math.min(current / total, 1)); }; Chain.prototype.hashRange = function hashRange(start, end) { var hashes; start = this.byTime(start); end = this.byTime(end); if (!start || !end) return []; hashes = this.index.hashes.slice(start.height, end.height + 1); if (!this.options.fullNode) hashes = this._filter(hashes); return hashes; }; Chain.prototype.getStartHeight = function getStartHeight() { return this.index.entries[this.index.entries.length - 1].height; }; Chain.prototype.locatorHashes = function locatorHashes(start) { var chain = this.index.hashes; var hashes = []; var top = chain.length - 1; var step = 1; var i; if (start) { if (utils.isBuffer(start)) start = utils.toHex(start); else if (start.hash) start = start.hash('hex'); } if (typeof start === 'string') { top = this.index.heights[start]; if (top == null) { // We could simply `return [start]` here, // but there is no standardized "spacing" // for locator hashes. Pretend this hash // is our tip. This is useful for getheaders // when not using headers-first. hashes.push(start); top = chain.length - 1; } } else if (typeof start === 'number') { top = start; } assert(chain[top]); i = top; for (;;) { if (chain[i]) hashes.push(chain[i]); i = i - step; if (i <= 0) { if (i + step !== 0) hashes.push(chain[0]); break; } if (hashes.length >= 10) step *= 2; } return hashes; }; Chain.prototype.getOrphanRoot = function getOrphanRoot(hash) { var self = this; var root = hash; if (utils.isBuffer(hash)) hash = utils.toHex(hash); else if (hash.hash) hash = hash.hash('hex'); while (this.orphan.bmap[hash]) { root = hash; hash = this.orphan.bmap[hash].prevBlock; } return root; }; Chain.prototype.getHeight = function getHeight(hash) { var entry = this.byHash(hash); if (!entry) return -1; return entry.height; }; Chain.prototype.getNextBlock = function getNextBlock(hash) { var entry = this.byHash(hash); if (!entry || !entry.next) return null; return entry.next.hash; }; Chain.prototype.size = function size() { return this.index.count; }; Chain.prototype.height = function height() { return this.getTip().height; }; Chain.prototype.currentTarget = function currentTarget() { return this.target(this.getTip()); }; Chain.prototype.target = function target(last, block) { var powLimit = utils.toCompact(network.powLimit); var ts, first, i; // Genesis if (!last) return powLimit; // Do not retarget if ((last.height + 1) % network.powDiffInterval !== 0) { if (network.powAllowMinDifficultyBlocks) { // Special behavior for testnet: ts = block ? (block.ts || block) : utils.now(); if (ts > last.ts + network.powTargetSpacing * 2) return powLimit; while (last.prev && last.height % network.powDiffInterval !== 0 && last.bits !== powLimit) { last = last.prev; } return last.bits; } return last.bits; } // Back 2 weeks // first = last; // for (i = 0; first && i < network.powDiffInterval - 1; i++) // first = first.prev; // Back 2 weeks first = this.index.entries[last.height - (network.powDiffInterval - 1)]; assert(first); return this.retarget(last, first); }; Chain.prototype.retarget = function retarget(last, first) { var powTargetTimespan = new bn(network.powTargetTimespan); var actualTimespan, target; if (network.powNoRetargeting) return last.bits; actualTimespan = new bn(last.ts - first.ts); target = utils.fromCompact(last.bits); if (actualTimespan.cmp(powTargetTimespan.divn(4)) < 0) actualTimespan = powTargetTimespan.divn(4); if (actualTimespan.cmp(powTargetTimespan.muln(4)) > 0) actualTimespan = powTargetTimespan.muln(4); target.imul(actualTimespan); target = target.div(powTargetTimespan); if (target.cmp(network.powLimit) > 0) target = network.powLimit.clone(); return utils.toCompact(target); }; Chain.prototype.compact = function compact(keep) { var entries = this._compact(keep); this.index.entries = {}; this.index.hashes = []; this.index.heights = {}; this.index.count = 0; json.entries.forEach(function(entry) { this._addIndex(ChainBlock.fromJSON(this, entry)); }, this); }; Chain.prototype._compact = function _compact(keep) { var entries = this._filter(this.index.entries); if (!keep) keep = network.powDiffInterval + 10; // Keep only last 1000 consequent blocks, dilate others at: // 7 day range for blocks before 2013 // 12 hour for blocks before 2014 // 6 hour for blocks in 2014 and after it // (or at maximum 250 block range) var last = entries.slice(-keep); var first = []; var delta1 = 7 * 24 * 3600; var delta2 = 12 * 3600; var delta3 = 6 * 3600; var lastTs = 0; var lastHeight = -1000; var i, ts, delta, hdelta; for (i = 0; i < entries.length - keep; i++) { ts = entries[i].ts; delta = ts < 1356984000 ? delta1 : ts < 1388520000 ? delta2 : delta3; hdelta = entries[i].height - lastHeight; if (ts - lastTs < delta && hdelta < 250) continue; lastTs = ts; lastHeight = entries[i].height; first.push(this.index.entries[i]); } return first.concat(last); }; Chain.prototype._save = function(hash, obj) { var self = this; if (!this.storage) return; this.storage.put(this.prefix + hash, obj.toJSON(), function(err) { if (err) self.emit('error', err); }); }; Chain.prototype._delete = function(hash) { var self = this; if (!this.storage) return; this.storage.del(this.prefix + hash, function(err) { if (err) self.emit('error', err); }); }; Chain.prototype._count = function(obj) { for (var i = 0, c = 0; i < obj.length; i++) if (obj[i]) c++; return c; }; Chain.prototype._filter = function(obj) { for (var i = 0, a = []; i < obj.length; i++) if (obj[i]) a.push(obj[i]); return a; }; Chain.prototype.toJSON = function toJSON() { var entries = this.index.entries; if (!this.options.fullNode) entries = this._compact(); return { v: 2, type: 'chain', network: network.type, entries: entries.map(function(entry) { return entry.toJSON(); }) }; }; Chain.prototype.fromJSON = function fromJSON(json) { assert.equal(json.v, 2); assert.equal(json.type, 'chain'); assert.equal(json.network, network.type); json.entries.forEach(function(entry) { this._addIndex(ChainBlock.fromJSON(this, entry)); }, this); assert(this.index.entries.length > 0); }; /** * ChainBlock */ function ChainBlock(chain, data) { this.chain = chain; this.hash = data.hash; this.version = data.version; this.prevBlock = data.prevBlock; this.ts = data.ts; this.bits = data.bits; this.height = data.height; this.chainwork = this.getChainwork(); } ChainBlock.prototype.__defineGetter__('prev', function() { return this.chain.index.entries[this.height - 1]; }); ChainBlock.prototype.__defineGetter__('next', function() { return this.chain.index.entries[this.height + 1]; }); ChainBlock.prototype.__defineGetter__('proof', function() { var target = utils.fromCompact(this.bits); if (target.isNeg() || target.cmpn(0) === 0) return new bn(0); return new bn(1).ushln(256).div(target.addn(1)); }); ChainBlock.prototype.getChainwork = function() { if (!this.prev) return new bn(0); return (this.prev ? this.prev.chainwork : new bn(0)).add(this.proof); }; ChainBlock.prototype.getMedianTime = function() { var entry = this; var median = []; var timeSpan = constants.block.medianTimespan; var i; for (i = 0; i < timeSpan && entry; i++, entry = entry.prev) median.push(entry.ts); median = median.sort(); return median[median.length / 2 | 0]; }; ChainBlock.prototype.isOutdated = function(version) { return this.isSuperMajority(version, network.block.majorityRejectOutdated); }; ChainBlock.prototype.isUpgraded = function(version) { return this.isSuperMajority(version, network.block.majorityEnforceUpgrade); }; ChainBlock.prototype.isSuperMajority = function(version, required) { var entry = this; var found = 0; var majorityWindow = network.block.majorityWindow; var i; for (i = 0; i < majorityWindow && found < required && entry; i++) { if (entry.version >= version) found++; entry = entry.prev; } return found >= required; }; ChainBlock.prototype.toJSON = function() { // return [ // this.hash, // this.version, // this.prevBlock, // this.ts, // this.bits, // this.height // }; return { hash: this.hash, version: this.version, prevBlock: this.prevBlock, ts: this.ts, bits: this.bits, height: this.height }; }; ChainBlock.fromJSON = function(chain, json) { // return new ChainBlock(chain, { // hash: json[0], // version: json[1], // prevBlock: json[2], // ts: json[3], // bits: json[4], // height: json[5] // }); return new ChainBlock(chain, json); }; /** * Expose */ module.exports = Chain;