fcoin/lib/bcoin/chain.js
2016-01-20 20:10:05 -08:00

1042 lines
24 KiB
JavaScript

/**
* 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 fs = require('fs');
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.db = new ChainDB(this);
if (this.options.debug)
bcoin.debug = this.options.debug;
this.tip = null;
this.orphan = {
map: {},
bmap: {},
count: 0,
size: 0
};
this.index = {
heights: {},
count: 0,
lastTs: 0
};
this.request = new utils.RequestCache();
this._addIndex(ChainBlock.fromJSON(this, {
hash: network.genesis.hash,
version: network.genesis.version,
prevBlock: network.genesis.prevBlock,
merkleRoot: network.genesis.merkleRoot,
ts: network.genesis.ts,
bits: network.genesis.bits,
nonce: network.genesis.nonce,
height: 0
}), true);
// Last TS after preload, needed for fill percent
this.index.lastTs = this.tip.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;
utils.debug('Chain is loading.');
utils.nextTick(function() {
var count = self.db.count();
var i, entry;
for (i = 1; i < self.index.count; i++)
self._addIndex(self.db.get(i));
self.loading = false;
self.emit('load');
utils.debug('Chain successfully loaded.');
});
};
Chain.prototype._addIndex = function _addIndex(entry, save) {
var self = this;
var existing;
// Already added
if (this.index.heights[entry.hash] != null) {
assert(this.index.heights[entry.hash] === entry.height);
return Chain.codes.unchanged;
}
// Duplicate height
existing = this.db.get(entry.height);
if (existing && existing.hash === 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);
return Chain.codes.badCheckpoint;
}
}
if (save)
this.db.save(entry);
this.index.heights[entry.hash] = entry.height;
this.index.count++;
if (!this.tip || entry.height > this.tip.height)
this.tip = entry;
this.emit('tip', this.tip);
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;
assert(height < this.index.count);
// 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;
for (var i = height + 1; height < this.index.count; i++) {
var existing = this.db.get(i);
this.db.del(i);
delete this.index.heights[existing.hash];
}
this.tip = this.db.get(height);
this.index.count = height + 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.tip.ts
);
};
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, existing;
var total = 0;
for (;;) {
hash = block.hash('hex');
prevHash = block.prevBlock;
// Find the previous block height/index.
prevHeight = this.index.heights[prevHash];
// 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;
this.emit('invalid', {
height: prevHeight + 1,
hash: hash
}, peer);
break;
}
// 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: false
}, peer);
code = Chain.codes.forked;
break;
}
code = Chain.codes.knownOrphan;
break;
}
// 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;
}
// Create a new chain entry.
entry = new ChainBlock(this, {
hash: hash,
version: block.version,
prevBlock: prevHash,
merkleRoot: block.merkleRoot,
ts: block.ts,
bits: block.bits,
nonce: block.nonce,
height: prevHeight + 1
});
// Add entry if we do not have it (or if
// there is another entry at its height)
existing = this.db.get(entry.height);
if (!existing || existing.hash !== 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 (existing) {
// 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 = existing;
// 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: hash,
checkpoint: false
}, peer);
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.verifyContext()) {
code = Chain.codes.invalid;
this.emit('invalid', {
height: prevHeight + 1,
hash: hash
}, peer);
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.badCheckpoint) {
this.emit('fork', {
height: entry.height,
expected: network.checkpoints[entry.height],
received: entry.hash,
checkpoint: true
});
break;
}
// Should never happen, but... something
// went wrong. Ignore this block.
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;
}
if (code !== Chain.codes.okay) {
if (!(this.options.multiplePeers && code === Chain.codes.newOrphan))
utils.debug('Chain Error: %s', Chain.msg(code));
}
return total;
};
Chain.prototype.has = function has(hash) {
if (this.hasBlock(hash))
return true;
if (this.hasOrphan(hash))
return true;
return false;
};
Chain.prototype.byHeight = function byHeight(height) {
if (height == null)
return;
return this.db.get(height);
};
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) {
var i, delta, existing;
var step = 1;
if (ts >= this.tip.ts)
return this.tip;
for (i = this.index.count - 1; i >= 0; i -= step) {
existing = this.db.get(i);
if (ts >= existing.ts)
return existing;
delta = existing.ts - ts;
// If they're more than 1000 blocks apart
if (delta > 1000 * 60 * 10)
step *= 2;
}
return this.db.get(0);
};
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.tip;
};
Chain.prototype.isFull = function isFull() {
var last = this.tip.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 [];
for (var i = start.height; i < end.height + 1; i++)
hashes.push(this.db.get(i).hash);
return hashes;
};
Chain.prototype.locatorHashes = function locatorHashes(start) {
var hashes = [];
var top = this.height();
var step = 1;
var i, existing;
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 = this.index.count - 1;
}
} else if (typeof start === 'number') {
top = start;
}
assert(this.db.get(top));
i = top;
for (;;) {
existing = this.db.get(i);
if (existing)
hashes.push(existing.hash);
i = i - step;
if (i <= 0) {
if (i + step !== 0)
hashes.push(this.db.get(0).hash);
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 = this.db.get(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.toJSON = function toJSON() {
var entries = this.index.entries;
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);
};
/**
* ChainDB
*/
var BLOCK_SIZE = 112;
function ChainDB(chain) {
var exists;
this.chain = chain;
this.file = process.env.HOME + '/bcoin-' + network.type + '.blockchain';
this._queue = [];
this._cache = {};
this._bufferPool = {};
this._nullBlock = new Buffer(BLOCK_SIZE);
this._nullBlock.fill(0);
try {
fs.unlinkSync(this.file);
} catch (e) {
;
}
try {
fs.accessSync(file);
exists = true;
} catch (e) {
exists = false;
}
if (!exists) {
fs.writeFileSync(this.file, new Buffer(0));
fs.truncateSync(this.file, 0);
}
this.fd = fs.openSync(this.file, 'r+');
}
ChainDB.prototype.getBuffer = function(size) {
if (!this._bufferPool[size])
this._bufferPool[size] = new Buffer(size);
return this._bufferPool[size];
};
ChainDB.prototype.size = function size() {
try {
return fs.statSync(this.file).size;
} catch (e) {
return 0;
}
};
ChainDB.prototype.count = function count() {
return this.size() / BLOCK_SIZE | 0;
};
ChainDB.prototype.get = function get(height) {
var data;
if (this._cache[height])
return this._cache[height];
if (this._queue[height])
return this._queue[height];
data = this._read(BLOCK_SIZE, height * BLOCK_SIZE);
if (!data)
return;
if (utils.read32(data, 0) === 0)
return;
return ChainBlock.fromRaw(this.chain, height, data);
};
ChainDB.prototype.save = function save(entry, callback) {
var self = this;
var raw, offset;
// Cache the past 2016 blocks in memory
this._cache[entry.height] = entry;
delete this._cache[entry.height - network.powDiffInterval];
assert(Object.keys(this._cache).length < network.powDiffInterval + 1);
// Something is already writing. Cancel it
// and synchronously write the data after
// it cancels.
if (this._queue[entry.height]) {
this._queue[entry.height] = entry;
return;
}
// Speed up writes by doing them asynchronously
// and keeping the data to be written in memory.
this._queue[entry.height] = entry;
// Write asynchronously to the db.
raw = entry.toRaw();
offset = entry.height * BLOCK_SIZE;
return this._write(raw, offset, function(err, success) {
var item = self._queue[entry.height];
assert(item);
// Something tried to write here but couldn't.
// Synchronously write it and get it over with.
try {
if (item !== entry)
success = self._writeSync(item.toRaw(), offset);
} catch (e) {
err = e;
}
delete self._queue[entry.height];
if (err) {
if (callback)
return callback(err);
else
throw err;
}
if (callback)
return callback(null, success);
});
};
ChainDB.prototype.del = function del(height) {
assert(height >= 0);
this._writeSync(this._nullBlock, height * BLOCK_SIZE);
// If we deleted several blocks at the end, go back
// to the last non-null block and truncate the file
// beyond that point.
if (height * BLOCK_SIZE + BLOCK_SIZE === this.size()) {
while (this.isNull(height))
height--;
fs.ftruncateSync(this.fd, height * BLOCK_SIZE + BLOCK_SIZE);
}
return true;
};
ChainDB.prototype.isNull = function isNull(height) {
var data = this._read(4, height * BLOCK_SIZE);
if (!data)
return false;
return utils.read32(data, 0) === 0;
};
ChainDB.prototype._read = function _read(size, offset) {
var data = this.getBuffer(size);
var bytes = 0;
var index = 0;
if (offset < 0 || offset == null)
return;
try {
while (bytes = fs.readSync(this.fd, data, index, size, offset)) {
index += bytes;
size -= bytes;
offset += bytes;
if (index === data.length)
return data;
}
} catch (e) {
return;
}
};
ChainDB.prototype._write = function _write(data, offset, callback) {
var self = this;
var size, bytes, index;
if (offset < 0 || offset == null)
return false;
size = data.length;
bytes = 0;
index = 0;
(function callee() {
fs.write(self.fd, data, index, size, offset, function(err, bytes) {
if (err)
return callback(err);
index += bytes;
size -= bytes;
offset += bytes;
if (index === data.length)
return callback(null, true);
callee();
});
})();
};
ChainDB.prototype._writeSync = function _writeSync(data, offset) {
var size, bytes, index;
if (offset < 0 || offset == null)
return false;
size = data.length;
bytes = 0;
index = 0;
while (bytes = fs.writeSync(this.fd, data, index, size, offset)) {
index += bytes;
size -= bytes;
offset += bytes;
if (index === data.length)
return true;
}
return false;
};
/**
* ChainBlock
*/
function ChainBlock(chain, data) {
this.chain = chain;
this.hash = data.hash;
this.version = data.version;
this.prevBlock = data.prevBlock;
this.merkleRoot = data.merkleRoot;
this.ts = data.ts;
this.bits = data.bits;
this.nonce = data.nonce;
this.height = data.height;
this.chainwork = data.chainwork || this.getChainwork();
}
ChainBlock.prototype.__defineGetter__('prev', function() {
return this.chain.db.get(this.height - 1);
});
ChainBlock.prototype.__defineGetter__('next', function() {
return this.chain.db.get(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 {
hash: this.hash,
version: this.version,
prevBlock: this.prevBlock,
merkleRoot: this.merkleRoot,
ts: this.ts,
bits: this.bits,
nonce: this.nonce,
height: this.height
};
};
ChainBlock.fromJSON = function(chain, json) {
return new ChainBlock(chain, json);
};
ChainBlock.prototype.toRaw = function toRaw() {
var res = new Buffer(BLOCK_SIZE);
utils.writeU32(res, this.version, 0);
utils.copy(utils.toArray(this.prevBlock, 'hex'), res, 4);
utils.copy(utils.toArray(this.merkleRoot, 'hex'), res, 36);
utils.writeU32(res, this.ts, 68);
utils.writeU32(res, this.bits, 72);
utils.writeU32(res, this.nonce, 76);
utils.copy(this.chainwork.toArray('be', 32), res, 80);
return res;
};
ChainBlock.fromRaw = function fromRaw(chain, height, p) {
return new ChainBlock(chain, {
hash: utils.toHex(utils.dsha256(p.slice(0, 80))),
version: utils.read32(p, 0),
prevBlock: utils.toHex(p.slice(4, 36)),
merkleRoot: utils.toHex(p.slice(36, 68)),
ts: utils.readU32(p, 68),
bits: utils.readU32(p, 72),
nonce: utils.readU32(p, 76),
height: height,
chainwork: new bn(p.slice(80, 112), 'be')
});
};
/**
* Expose
*/
module.exports = Chain;