fcoin/lib/bcoin/txdb.js
2016-04-25 17:02:47 -04:00

1985 lines
47 KiB
JavaScript

/*!
* txdb.js - persistent transaction pool
* Copyright (c) 2014-2015, Fedor Indutny (MIT License)
* Copyright (c) 2014-2016, Christopher Jeffrey (MIT License).
* https://github.com/indutny/bcoin
*/
module.exports = function(bcoin) {
var bn = require('bn.js');
var utils = require('./utils');
var assert = bcoin.utils.assert;
var EventEmitter = require('events').EventEmitter;
var DUMMY = new Buffer([0]);
var pad32 = utils.pad32;
var BufferReader = require('./reader');
var BufferWriter = require('./writer');
/**
* TXDB
* @exports TXDB
* @constructor
* @param {String} prefix - The prefix for
* the database (`txdb/` by default).
* @param {LowlevelUp} db
* @param {Object?} options
* @param {Boolean?} options.mapAddress - Map addresses to IDs.
* @param {Boolean?} options.indexAddress - Index addresses/IDs.
* @param {Boolean?} options.indexExtra - Index timestamps, heights, etc.
* @param {Boolean?} options.verify - Verify transactions as they
* come in (note that this will not happen on the worker pool).
* @property {String} prefix
*/
function TXDB(prefix, db, options) {
if (!(this instanceof TXDB))
return new TXDB(prefix, db, options);
EventEmitter.call(this);
if (!options)
options = {};
this.db = db;
this.prefix = prefix || 'txdb';
this.options = options;
this.busy = false;
this.jobs = [];
this.locker = new bcoin.locker(this);
if (this.options.mapAddress)
this.options.indexAddress = true;
}
utils.inherits(TXDB, EventEmitter);
TXDB.prototype._lock = function _lock(func, args, force) {
return this.locker.lock(func, args, force);
};
/**
* The wallet ID (when mapAddress is enabled)
* or a {@link Base58Address} otherwise.
* @typedef {String} WalletID
*/
/**
* Table of address->id.
* @global
* @typedef {Object} AddressTable
*/
/**
* @typedef {Object} AddressMap
* @global
* @property {Object} table - Table of address->id.
* @property {String[]} input - Input IDs.
* @property {String[]} output - Output IDs.
* @property {String[]} all - Both input and output IDs.
*/
/**
* Map a transactions' addresses to wallet IDs.
* @param {TX} tx
* @param {Function} callback - Returns [Error, {@link AddressMap}].
*/
TXDB.prototype.getMap = function getMap(tx, callback) {
var input, output, addresses, table, map;
if (!this.options.indexAddress)
return callback();
input = tx.getInputAddresses();
output = tx.getOutputAddresses();
addresses = utils.uniqs(input.concat(output));
function cb(err, table) {
if (err)
return callback(err);
map = {
table: table,
input: [],
output: [],
all: []
};
input.forEach(function(address) {
assert(map.table[address]);
map.input = map.input.concat(map.table[address]);
});
output.forEach(function(address) {
assert(map.table[address]);
map.output = map.output.concat(map.table[address]);
});
map.input = utils.uniqs(map.input);
map.output = utils.uniqs(map.output);
map.all = utils.uniqs(map.input.concat(map.output));
return callback(null, map);
}
if (!this.options.mapAddress) {
table = addresses.reduce(function(out, address) {
out[address] = [address];
return out;
}, {});
return cb(null, table);
}
return this.mapAddresses(addresses, cb);
};
/**
* Map an address to a wallet ID.
* @param {Base58Address|Base58Address[]} address
* @param {Function} callback - Returns [Error, {@link AddressTable}].
*/
TXDB.prototype.mapAddresses = function mapAddresses(address, callback) {
var self = this;
var prefix = this.prefix + '/';
var table = {};
var iter;
if (Array.isArray(address)) {
return utils.forEachSerial(address, function(address, next) {
self.mapAddresses(address, function(err, res) {
if (err)
return next(err);
assert(res[address]);
table[address] = res[address];
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, table);
});
}
iter = this.db.iterator({
gte: prefix + 'a/' + address,
lte: prefix + 'a/' + address + '~',
keys: true,
values: false,
fillCache: false,
keyAsBuffer: false
});
callback = utils.ensure(callback);
table[address] = [];
(function next() {
iter.next(function(err, key, value) {
if (err) {
return iter.end(function() {
callback(err);
});
}
if (key === undefined) {
return iter.end(function(err) {
if (err)
return callback(err);
return callback(null, table);
});
}
key = key.split('/')[3];
table[address].push(key);
next();
});
})();
};
/**
* Add an orphan (tx hash + input index)
* to orphan list. Stored by its required coin ID.
* @private
* @param {String} key - Required coin hash + index.
* @param {Hash} hash - Orphan transaction hash.
* @param {Number} index - Orphan input index.
* @param {Function} callback - Returns [Error, Buffer].
*/
TXDB.prototype._addOrphan = function _addOrphan(key, hash, index, callback) {
var prefix = this.prefix + '/';
var p;
this.db.get(prefix + 'o/' + key, function(err, buf) {
if (err && err.type !== 'NotFoundError')
return callback(err);
p = new BufferWriter();
if (buf)
p.writeBytes(buf);
p.writeHash(hash);
p.writeU32(index);
return callback(null, p.render());
});
};
/**
* @typedef {Object} Orphan
* @property {Hash} hash - Orphan TX hash.
* @property {Number} index - Orphan input index.
*/
/**
* Retrieve orphan list by coin ID.
* @private
* @param {String} key
* @param {Function} callback - Returns [Error, {@link Orphan}].
*/
TXDB.prototype._getOrphans = function _getOrphans(key, callback) {
var self = this;
var prefix = this.prefix + '/';
var p, orphans;
this.db.get(prefix + 'o/' + key, function(err, buf) {
if (err && err.type !== 'NotFoundError')
return callback(err);
if (!buf)
return callback();
p = new BufferReader(buf);
orphans = [];
try {
while (p.left()) {
orphans.push({
hash: p.readHash('hex'),
index: p.readU32()
});
}
} catch (e) {
return callback(e);
}
utils.forEach(orphans, function(orphan, next) {
self.getTX(orphan.hash, function(err, tx) {
if (err)
return next(err);
orphan.tx = tx;
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, orphans);
});
});
};
/**
* Add a transaction to the database, map addresses
* to wallet IDs, potentially store orphans, resolve
* orphans, or confirm a transaction.
* @param {TX} tx
* @param {Function} callback - Returns [Error].
*/
TXDB.prototype.add = function add(tx, callback, force) {
var self = this;
if (Array.isArray(tx)) {
return utils.forEachSerial(tx, function(tx, next) {
self.add(tx, next, force);
}, callback);
}
return this.getMap(tx, function(err, map) {
if (err)
return callback(err);
if (self.options.mapAddress) {
if (map.all.length === 0)
return callback(null, false);
}
return self._add(tx, map, callback, force);
});
};
// This big scary function is what a persistent tx pool
// looks like. It's a semi mempool in that it can handle
// receiving txs out of order.
TXDB.prototype._add = function add(tx, map, callback, force) {
var self = this;
var prefix = this.prefix + '/';
var hash = tx.hash('hex');
var updated = false;
var batch;
assert(tx.ts > 0 || tx.ps > 0);
var unlock = this._lock(add, [tx, map, callback], force);
if (!unlock)
return;
callback = utils.wrap(callback, unlock);
if (tx.mutable)
tx = tx.toTX();
// Attempt to confirm tx before adding it.
this._confirm(tx, map, function(err, existing) {
if (err)
return callback(err);
// Ignore if we already have this tx.
if (existing)
return callback(null, true);
batch = self.db.batch();
batch.put(prefix + 't/t/' + hash, tx.toExtended());
if (self.options.indexExtra) {
if (tx.ts === 0) {
assert(tx.ps > 0);
batch.put(prefix + 't/p/t/' + hash, DUMMY);
batch.put(prefix + 't/s/s/' + pad32(tx.ps) + '/' + hash, DUMMY);
} else {
batch.put(prefix + 't/h/h/' + pad32(tx.height) + '/' + hash, DUMMY);
batch.put(prefix + 't/s/s/' + pad32(tx.ts) + '/' + hash, DUMMY);
}
if (self.options.indexAddress) {
map.all.forEach(function(id) {
batch.put(prefix + 't/a/' + id + '/' + hash, DUMMY);
if (tx.ts === 0) {
batch.put(prefix + 't/p/a/' + id + '/' + hash, DUMMY);
batch.put(
prefix + 't/s/a/' + id + '/' + pad32(tx.ps) + '/' + hash, DUMMY);
} else {
batch.put(
prefix + 't/h/a/' + id + '/' + pad32(tx.height) + '/' + hash, DUMMY);
batch.put(
prefix + 't/s/a/' + id + '/' + pad32(tx.ts) + '/' + hash, DUMMY);
}
});
}
}
// Consume unspent money or add orphans
utils.forEachSerial(tx.inputs, function(input, next, i) {
var key, address;
if (tx.isCoinbase())
return next();
address = input.getAddress();
// Only add orphans if this input is ours.
if (self.options.mapAddress) {
if (!address || !map.table[address].length)
return next();
}
self.getCoin(input.prevout.hash, input.prevout.index, function(err, coin) {
if (err)
return next(err);
key = input.prevout.hash + '/' + input.prevout.index;
if (coin) {
// Add TX to inputs and spend money
input.coin = coin;
// Skip invalid transactions
if (self.options.verify) {
if (!tx.verify(i))
return callback(null, false);
}
updated = true;
if (self.options.indexAddress && address) {
map.table[address].forEach(function(id) {
batch.del(prefix + 'u/a/' + id + '/' + key);
});
}
batch.del(prefix + 'u/t/' + key);
batch.put(prefix + 's/t/' + key, tx.hash());
return next();
}
input.coin = null;
self.isSpent(input.prevout.hash, input.prevout.index, function(err, spentBy) {
if (err)
return next(err);
// Are we double-spending?
// Replace older txs with newer ones.
if (spentBy) {
return self.getTX(input.prevout.hash, function(err, prev) {
if (err)
return next(err);
if (!prev)
return callback(new Error('Could not find double-spent coin.'));
input.coin = bcoin.coin(prev, input.prevout.index);
// Skip invalid transactions
if (self.options.verify) {
if (!tx.verify(i))
return callback(null, false);
}
return self._removeSpenders(spentBy, tx, function(err, result) {
if (err)
return next(err);
if (!result) {
assert(tx.ts === 0, 'I\'m confused');
return callback(null, false);
}
batch.clear();
self._add(tx, map, callback, true);
});
});
}
// Add orphan, if no parent transaction is yet known
self._addOrphan(key, hash, i, function(err, orphans) {
if (err)
return next(err);
batch.put(prefix + 'o/' + key, orphans);
return next();
});
});
});
}, function(err) {
if (err)
return callback(err);
// Add unspent outputs or resolve orphans
utils.forEachSerial(tx.outputs, function(output, next, i) {
var address = output.getAddress();
var key, coin;
// Do not add unspents for outputs that aren't ours.
if (self.options.mapAddress) {
if (!address || !map.table[address].length)
return next();
}
key = hash + '/' + i;
coin = bcoin.coin(tx, i);
self._getOrphans(key, function(err, orphans) {
var some = false;
if (err)
return callback(err);
if (!orphans)
return finish();
// Add input to orphan
utils.forEachSerial(orphans, function(orphan, next) {
if (some)
return next();
// Probably removed by some other means.
if (!orphan.tx)
return next();
orphan.tx.inputs[orphan.index].coin = coin;
assert(orphan.tx.inputs[orphan.index].prevout.hash === hash);
assert(orphan.tx.inputs[orphan.index].prevout.index === i);
// Verify that input script is correct, if not - add
// output to unspent and remove orphan from storage
if (!self.options.verify) {
some = true;
return next();
}
if (orphan.tx.verify(orphan.index)) {
some = true;
return next();
}
self.lazyRemove(orphan.tx, function(err) {
if (err)
return next(err);
return next();
}, true);
}, function(err) {
if (err)
return next(err);
if (!some)
orphans = null;
self.db.del(prefix + 'o/' + key, finish);
});
function finish(err) {
if (err)
return next(err);
if (!orphans) {
if (self.options.indexAddress && address) {
map.table[address].forEach(function(id) {
batch.put(prefix + 'u/a/' + id + '/' + key, DUMMY);
});
}
batch.put(prefix + 'u/t/' + key, coin.toRaw());
updated = true;
}
next();
}
});
}, function(err) {
if (err)
return callback(err);
batch.write(function(err) {
if (err)
return callback(err);
self.emit('tx', tx, map);
if (updated) {
if (tx.ts !== 0)
self.emit('confirmed', tx, map);
self.emit('updated', tx, map);
}
return callback(null, true);
});
});
});
}, true);
};
/**
* Remove spenders that have not been confirmed. We do this in the
* odd case of stuck transactions or when a coin is double-spent
* by a newer transaction. All previously-spending transactions
* of that coin that are _not_ confirmed will be removed from
* the database.
* @private
* @param {Hash} hash
* @param {TX} ref - Reference tx, the tx that double-spent.
* @param {Function} callback - Returns [Error, Boolean].
*/
TXDB.prototype._removeSpenders = function removeSpenders(hash, ref, callback) {
var self = this;
this.getTX(hash, function(err, tx) {
if (err)
return callback(err);
if (!tx)
return callback(new Error('Could not find spender.'));
if (tx.ts !== 0)
return callback(null, false);
if (ref.ts === 0 && ref.ps < ts.ps)
return callback(null, false);
utils.forEachSerial(tx.outputs, function(output, next, i) {
self.isSpent(hash, i, function(err, spent) {
if (err)
return next(err);
if (spent)
return self._removeSpenders(spent, ref, next);
next();
});
}, function(err) {
if (err)
return callback(err);
return self.lazyRemove(tx, function(err) {
if (err)
return callback(err);
return callback(null, true);
}, true);
});
});
};
/**
* Test an entire transaction to see
* if any of its outpoints are a double-spend.
* @param {TX} tx
* @param {Function} callback - Returns [Error, Boolean].
*/
TXDB.prototype.isDoubleSpend = function isDoubleSpend(tx, callback) {
var self = this;
utils.everySerial(tx.inputs, function(input, next) {
self.isSpent(input.prevout.hash, input.prevout.index, function(err, spent) {
if (err)
return next(err);
if (spent)
return next(null, false);
return next(null, true);
});
}, function(err, result) {
if (err)
return callback(err);
return callback(null, !result);
});
};
/**
* Test a whether a coin has been spent.
* @param {Hash} hash
* @param {Number} index
* @param {Function} callback - Returns [Error, Boolean].
*/
TXDB.prototype.isSpent = function isSpent(hash, index, callback) {
var self = this;
var prefix = this.prefix + '/';
var key = prefix + 's/t/' + hash + '/' + index;
return this.db.get(key, function(err, hash) {
if (err && err.type !== 'NotFoundError')
return callback(err);
if (!hash)
return callback(null, null);
return callback(null, hash.toString('hex'));
});
};
/**
* Attempt to confirm a transaction.
* @private
* @param {TX} tx
* @param {AddressMap} map
* @param {Function} callback - Returns [Error, Boolean]. `false` if
* the transaction should be added to the database, `true` if the
* transaction was confirmed, or should be ignored.
*/
TXDB.prototype._confirm = function _confirm(tx, map, callback, force) {
var self = this;
var prefix = this.prefix + '/';
var hash = tx.hash('hex');
var batch;
var unlock = this._lock(_confirm, [tx, map, callback], force);
if (!unlock)
return;
callback = utils.wrap(callback, unlock);
this.getTX(hash, function(err, existing) {
if (err)
return callback(err);
// Haven't seen this tx before, add it.
if (!existing)
return callback(null, false);
// Existing tx is already confirmed. Ignore.
if (existing.ts !== 0)
return callback(null, true);
// The incoming tx won't confirm the existing one anyway. Ignore.
if (tx.ts === 0)
return callback(null, true);
batch = self.db.batch();
// Tricky - update the tx and coin in storage,
// and remove pending flag to mark as confirmed.
assert(tx.height >= 0);
assert(existing.ps > 0);
batch.put(prefix + 't/t/' + hash, tx.toExtended());
if (self.options.indexExtra) {
batch.del(prefix + 't/p/t/' + hash);
batch.put(prefix + 't/h/h/' + pad32(tx.height) + '/' + hash, DUMMY);
batch.del(prefix + 't/s/s/' + pad32(existing.ps) + '/' + hash);
batch.put(prefix + 't/s/s/' + pad32(tx.ts) + '/' + hash, DUMMY);
if (self.options.indexAddress) {
map.all.forEach(function(id) {
batch.del(prefix + 't/p/a/' + id + '/' + hash);
batch.put(prefix + 't/h/a/' + id + '/' + pad32(tx.height) + '/' + hash, DUMMY);
batch.del(prefix + 't/s/a/' + id + '/' + pad32(existing.ps) + '/' + hash);
batch.put(prefix + 't/s/a/' + id + '/' + pad32(tx.ts) + '/' + hash, DUMMY);
});
}
}
utils.forEachSerial(tx.outputs, function(output, next, i) {
var address = output.getAddress();
// Only update coins if this output is ours.
if (self.options.mapAddress) {
if (!address || !map.table[address].length)
return next();
}
self.getCoin(hash, i, function(err, coin) {
if (err)
return next(err);
if (!coin)
return next();
coin.height = tx.height;
batch.put(prefix + 'u/t/' + hash + '/' + i, coin.toRaw());
next();
});
}, function(err) {
if (err)
return callback(err);
batch.write(function(err) {
if (err)
return callback(err);
self.emit('confirmed', tx, map);
self.emit('tx', tx, map);
return callback(null, true);
});
});
});
};
/**
* Remove a transaction from the database. Disconnect inputs.
* @param {Hash} hash
* @param {Function} callback - Returns [Error].
*/
TXDB.prototype.remove = function remove(hash, callback, force) {
var self = this;
if (Array.isArray(hash)) {
return utils.forEachSerial(hash, function(hash, next) {
self.remove(hash, next, force);
}, callback);
}
if (hash.hash)
hash = hash.hash('hex');
this.getTX(hash, function(err, tx) {
if (err)
return callback(err);
if (!tx)
return callback(null, true);
assert(tx.hash('hex') === hash);
return self.getMap(tx, function(err, map) {
if (err)
return callback(err);
if (self.options.mapAddress) {
if (map.all.length === 0)
return callback(null, false);
}
return self._remove(tx, map, callback, force);
});
});
};
/**
* Remove a transaction from the database, but do not
* look up the transaction. Use the passed-in transaction
* to disconnect.
* @param {TX} tx
* @param {Function} callback - Returns [Error].
*/
TXDB.prototype.lazyRemove = function lazyRemove(tx, callback, force) {
var self = this;
if (Array.isArray(tx)) {
return utils.forEachSerial(tx, function(tx, next) {
self.lazyRemove(tx, next, force);
}, callback);
}
return this.getMap(tx, function(err, map) {
if (err)
return callback(err);
if (self.options.mapAddress) {
if (map.all.length === 0)
return callback(null, false);
}
return self._remove(tx, map, callback, force);
});
};
/**
* Remove a transaction from the database. Disconnect inputs.
* @private
* @param {TX} tx
* @param {AddressMap} map
* @param {Function} callback - Returns [Error].
*/
TXDB.prototype._remove = function remove(tx, map, callback, force) {
var self = this;
var prefix = this.prefix + '/';
var hash = tx.hash('hex');
var batch;
var unlock = this._lock(remove, [tx, map, callback], force);
if (!unlock)
return;
callback = utils.wrap(callback, unlock);
batch = this.db.batch();
batch.del(prefix + 't/t/' + hash);
if (self.options.indexExtra) {
if (tx.ts === 0) {
batch.del(prefix + 't/p/t/' + hash);
batch.del(prefix + 't/s/s/' + pad32(tx.ps) + '/' + hash);
} else {
batch.del(prefix + 't/h/h/' + pad32(tx.height) + '/' + hash);
batch.del(prefix + 't/s/s/' + pad32(tx.ts) + '/' + hash);
}
if (self.options.indexAddress) {
map.all.forEach(function(id) {
batch.del(prefix + 't/a/' + id + '/' + hash);
if (tx.ts === 0) {
batch.del(prefix + 't/p/a/' + id + '/' + hash);
batch.del(prefix + 't/s/a/' + id + '/' + pad32(tx.ps) + '/' + hash);
} else {
batch.del(prefix + 't/h/a/' + id + '/' + pad32(tx.height) + '/' + hash);
batch.del(prefix + 't/s/a/' + id + '/' + pad32(tx.ts) + '/' + hash);
}
});
}
}
this.fillHistory(tx, function(err) {
if (err)
return callback(err);
tx.inputs.forEach(function(input) {
var key = input.prevout.hash + '/' + input.prevout.index;
var address = input.getAddress();
if (tx.isCoinbase())
return;
if (!input.coin)
return;
if (self.options.mapAddress) {
if (!address || !map.table[address].length)
return;
}
if (self.options.indexAddress && address) {
map.table[address].forEach(function(id) {
batch.put(prefix + 'u/a/' + id + '/' + key, DUMMY);
});
}
batch.put(prefix + 'u/t/' + key, input.coin.toRaw());
batch.del(prefix + 's/t/' + key);
batch.del(prefix + 'o/' + key);
});
tx.outputs.forEach(function(output, i) {
var key = hash + '/' + i;
var address = output.getAddress();
if (self.options.mapAddress) {
if (!address || !map.table[address].length)
return;
}
if (self.options.indexAddress && address) {
map.table[address].forEach(function(id) {
batch.del(prefix + 'u/a/' + id + '/' + key);
});
}
batch.del(prefix + 'u/t/' + key);
});
batch.write(function(err) {
if (err)
return callback(err);
self.emit('remove tx', tx, map);
return callback(null, true);
});
});
};
/**
* Unconfirm a transaction. This is usually necessary after a reorg.
* @param {Hash} hash
* @param {Function} callback
*/
TXDB.prototype.unconfirm = function unconfirm(hash, callback, force) {
var self = this;
if (Array.isArray(hash)) {
return utils.forEachSerial(hash, function(hash, next) {
self.unconfirm(hash, next, force);
}, callback);
}
if (hash.hash)
hash = hash.hash('hex');
callback = utils.ensure(callback);
this.getTX(hash, function(err, tx) {
if (err)
return callback(err);
if (!tx)
return callback(null, true);
assert(tx.hash('hex') === hash);
return self.getMap(tx, function(err, map) {
if (err)
return callback(err);
if (self.options.mapAddress) {
if (map.all.length === 0)
return callback(null, false);
}
return self._unconfirm(tx, map, callback, force);
});
});
};
/**
* Unconfirm a transaction. This is usually necessary after a reorg.
* @param {Hash} hash
* @param {AddressMap} map
* @param {Function} callback
*/
TXDB.prototype._unconfirm = function unconfirm(tx, map, callback, force) {
var self = this;
var prefix = this.prefix + '/';
var hash, batch, height, ts;
var unlock = this._lock(unconfirm, [tx, map, callback], force);
if (!unlock)
return;
callback = utils.wrap(callback, unlock);
hash = tx.hash('hex');
batch = this.db.batch();
height = tx.height;
ts = tx.ts;
if (height !== -1)
return callback(null, false);
tx.height = -1;
tx.ps = utils.now();
tx.ts = 0;
tx.index = -1;
tx.block = null;
batch.put(prefix + 't/t/' + hash, tx.toExtended());
if (self.options.indexExtra) {
batch.put(prefix + 't/p/t/' + hash, DUMMY);
batch.del(prefix + 't/h/h/' + pad32(height) + '/' + hash);
batch.del(prefix + 't/s/s/' + pad32(ts) + '/' + hash);
batch.put(prefix + 't/s/s/' + pad32(tx.ps) + '/' + hash, DUMMY);
if (self.options.indexAddress) {
map.all.forEach(function(id) {
batch.put(prefix + 't/p/a/' + id + '/' + hash, DUMMY);
batch.del(prefix + 't/h/a/' + id + '/' + pad32(height) + '/' + hash);
batch.del(prefix + 't/s/a/' + id + '/' + pad32(ts) + '/' + hash);
batch.put(prefix + 't/s/a/' + id + '/' + pad32(tx.ps) + '/' + hash, DUMMY);
});
}
}
utils.forEachSerial(tx.outputs, function(output, next, i) {
self.getCoin(hash, i, function(err, coin) {
if (err)
return next(err);
if (!coin)
return next();
coin.height = tx.height;
batch.put(prefix + 'u/t/' + hash + '/' + i, coin.toRaw());
next();
});
}, function(err) {
if (err)
return callback(err);
batch.write(function(err) {
if (err)
return callback(err);
self.emit('unconfirmed', tx, map);
return callback(null, true);
});
});
};
/**
* Get hashes of all transactions in the database.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getHistoryHashes = function getHistoryHashes(address, callback) {
var self = this;
var prefix = this.prefix + '/';
var txs = [];
var iter;
if (typeof address === 'function') {
callback = address;
address = null;
}
callback = utils.ensure(callback);
if (Array.isArray(address)) {
return utils.forEachSerial(address, function(address, next) {
self.getHistoryHashes(address, function(err, tx) {
if (err)
return next(err);
txs = txs.concat(tx);
next();
});
}, function(err) {
if (err)
return callback(err);
txs = utils.uniqs(txs);
return callback(null, txs);
});
}
iter = this.db.iterator({
gte: address ? prefix + 't/a/' + address : prefix + 't/t',
lte: address ? prefix + 't/a/' + address + '~' : prefix + 't/t~',
keys: true,
values: false,
fillCache: false,
keyAsBuffer: false
});
(function next() {
iter.next(function(err, key, value) {
if (err) {
return iter.end(function() {
callback(err);
});
}
if (key === undefined) {
return iter.end(function(err) {
if (err)
return callback(err);
return callback(null, txs);
});
}
if (address)
txs.push(key.split('/')[4]);
else
txs.push(key.split('/')[3]);
next();
});
})();
};
/**
* Get hashes of all unconfirmed transactions in the database.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getUnconfirmedHashes = function getUnconfirmedHashes(address, callback) {
var self = this;
var prefix = this.prefix + '/';
var txs = [];
var iter;
if (typeof address === 'function') {
callback = address;
address = null;
}
callback = utils.ensure(callback);
if (Array.isArray(address)) {
return utils.forEachSerial(address, function(address, next) {
assert(address);
self.getUnconfirmedHashes(address, function(err, tx) {
if (err)
return next(err);
txs = txs.concat(tx);
next();
});
}, function(err) {
if (err)
return callback(err);
txs = utils.uniqs(txs);
return callback(null, txs);
});
}
iter = this.db.iterator({
gte: address ? prefix + 't/p/a/' + address : prefix + 't/p/t',
lte: address ? prefix + 't/p/a/' + address + '~' : prefix + 't/p/t~',
keys: true,
values: false,
fillCache: false,
keyAsBuffer: false
});
(function next() {
iter.next(function(err, key, value) {
if (err) {
return iter.end(function() {
callback(err);
});
}
if (key === undefined) {
return iter.end(function(err) {
if (err)
return callback(err);
return callback(null, txs);
});
}
if (address)
txs.push(key.split('/')[5]);
else
txs.push(key.split('/')[4]);
next();
});
})();
};
/**
* Get all coin hashes in the database.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getCoinHashes = function getCoinHashes(address, callback) {
var self = this;
var prefix = this.prefix + '/';
var coins = [];
var iter;
if (typeof address === 'function') {
callback = address;
address = null;
}
callback = utils.ensure(callback);
if (Array.isArray(address)) {
return utils.forEachSerial(address, function(address, next) {
self.getCoinHashes(address, function(err, coin) {
if (err)
return next(err);
coins = coins.concat(coin);
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, coins);
});
}
iter = this.db.iterator({
gte: address
? prefix + 'u/a/' + address
: prefix + 'u/t',
lte: address
? prefix + 'u/a/' + address + '~'
: prefix + 'u/t~',
keys: true,
values: false,
fillCache: false,
keyAsBuffer: false
});
(function next() {
iter.next(function(err, key, value) {
if (err) {
return iter.end(function() {
callback(err);
});
}
if (key === undefined) {
return iter.end(function(err) {
if (err)
return callback(err);
return callback(null, coins);
});
}
key = key.split('/');
if (address)
coins.push([key[4], +key[5]]);
else
coins.push([key[3], +key[4]]);
next();
});
})();
};
/**
* Get TX hashes by height range.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Object} options
* @param {Number} options.start - Start height.
* @param {Number} options.end - End height.
* @param {Number?} options.limit - Max number of records.
* @param {Boolean?} options.reverse - Reverse order.
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getHeightRangeHashes = function getHeightRangeHashes(address, options, callback) {
var prefix = this.prefix + '/';
var txs = [];
var iter;
if (typeof address === 'function') {
callback = address;
address = null;
} else if (address && typeof address === 'object') {
callback = options;
options = address;
address = null;
}
callback = utils.ensure(callback);
iter = this.db.iterator({
gte: address
? prefix + 't/h/a/' + address + '/' + pad32(options.start) + '/'
: prefix + 't/h/h/' + pad32(options.start) + '/',
lte: address
? prefix + 't/h/a/' + address + '/' + pad32(options.end) + '/~'
: prefix + 't/h/h/' + pad32(options.end) + '/~',
keys: true,
values: false,
fillCache: false,
keyAsBuffer: false,
limit: options.limit,
reverse: options.reverse
});
(function next() {
iter.next(function(err, key, value) {
if (err) {
return iter.end(function() {
callback(err);
});
}
if (key === undefined) {
return iter.end(function(err) {
if (err)
return callback(err);
return callback(null, txs);
});
}
if (address)
txs.push(key.split('/')[6]);
else
txs.push(key.split('/')[5]);
next();
});
})();
};
/**
* Get TX hashes by height.
* @param {Number} height
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getHeightHashes = function getHeightHashes(height, callback) {
return this.getHeightRangeHashes({ start: height, end: height }, callback);
};
/**
* Get TX hashes by timestamp range.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Object} options
* @param {Number} options.start - Start height.
* @param {Number} options.end - End height.
* @param {Number?} options.limit - Max number of records.
* @param {Boolean?} options.reverse - Reverse order.
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getRangeHashes = function getRangeHashes(address, options, callback) {
var prefix = this.prefix + '/';
var txs = [];
var iter;
if (typeof address === 'function') {
callback = address;
address = null;
}
callback = utils.ensure(callback);
iter = this.db.iterator({
gte: address
? prefix + 't/s/a/' + address + '/' + pad32(options.start) + '/'
: prefix + 't/s/s/' + pad32(options.start) + '/',
lte: address
? prefix + 't/s/a/' + address + '/' + pad32(options.end) + '/~'
: prefix + 't/s/s/' + pad32(options.end) + '/~',
keys: true,
values: false,
fillCache: false,
keyAsBuffer: false,
limit: options.limit,
reverse: options.reverse
});
(function next() {
iter.next(function(err, key, value) {
if (err) {
return iter.end(function() {
callback(err);
});
}
if (key === undefined) {
return iter.end(function(err) {
if (err)
return callback(err);
return callback(null, txs);
});
}
if (address)
txs.push(key.split('/')[6]);
else
txs.push(key.split('/')[5]);
next();
});
})();
};
/**
* Get transactions by timestamp range.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Object} options
* @param {Number} options.start - Start height.
* @param {Number} options.end - End height.
* @param {Number?} options.limit - Max number of records.
* @param {Boolean?} options.reverse - Reverse order.
* @param {Function} callback - Returns [Error, {@link TX}[]].
*/
TXDB.prototype.getRange = function getLast(address, options, callback) {
var self = this;
var txs = [];
if (typeof address === 'function') {
callback = address;
address = null;
}
return this.getRangeHashes(address, options, function(err, hashes) {
if (err)
return callback(err);
utils.forEachSerial(hashes, function(hash, next) {
self.getTX(hash, function(err, tx) {
if (err)
return callback(err);
if (!tx)
return next();
txs.push(tx);
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, txs);
});
});
};
/**
* Get last N transactions.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Number} limit - Max number of transactions.
* @param {Function} callback - Returns [Error, {@link TX}[]].
*/
TXDB.prototype.getLast = function getLast(address, limit, callback) {
if (typeof limit === 'function') {
callback = limit;
limit = address;
address = null;
}
return this.getRange(address, {
start: 0,
end: 0xffffffff,
reverse: true,
limit: limit
}, callback);
};
/**
* Get all transactions.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link TX}[]].
*/
TXDB.prototype.getHistory = function getHistory(address, callback) {
var self = this;
var txs = [];
if (typeof address === 'function') {
callback = address;
address = null;
}
return this.getHistoryHashes(address, function(err, hashes) {
if (err)
return callback(err);
utils.forEachSerial(hashes, function(hash, next) {
self.getTX(hash, function(err, tx) {
if (err)
return callback(err);
if (!tx)
return next();
txs.push(tx);
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, utils.sortTX(txs));
});
});
};
/**
* Get last active timestamp and height.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, Number(ts), Number(height)].
*/
TXDB.prototype.getLastTime = function getLastTime(address, callback) {
if (typeof address === 'function') {
callback = address;
address = null;
}
return this.getHistory(address, function(err, txs) {
var lastTs, lastHeight;
if (err)
return callback(err);
lastTs = 0;
lastHeight = -1;
txs.forEach(function(tx) {
if (tx.ts > lastTs)
lastTs = tx.ts;
if (tx.height > lastHeight)
lastHeight = tx.height;
});
return callback(null, lastTs, lastHeight);
});
};
/**
* Get unconfirmed transactions.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link TX}[]].
*/
TXDB.prototype.getUnconfirmed = function getUnconfirmed(address, callback) {
var self = this;
var txs = [];
if (typeof address === 'function') {
callback = address;
address = null;
}
return this.getUnconfirmedHashes(address, function(err, hashes) {
if (err)
return callback(err);
utils.forEachSerial(hashes, function(hash, next) {
self.getTX(hash, function(err, tx) {
if (err)
return callback(err);
if (!tx)
return next();
txs.push(tx);
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, txs);
});
});
};
/**
* Get coins.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Coin}[]].
*/
TXDB.prototype.getCoins = function getCoins(address, callback) {
var self = this;
var coins = [];
if (typeof address === 'function') {
callback = address;
address = null;
}
return this.getCoinHashes(address, function(err, hashes) {
if (err)
return callback(err);
utils.forEachSerial(hashes, function(key, next) {
self.getCoin(key[0], key[1], function(err, coin) {
if (err)
return callback(err);
if (!coin)
return next();
coins.push(coin);
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, coins);
});
});
};
/**
* Fill a transaction with coins (all historical coins).
* @param {TX} tx
* @param {Function} callback - Returns [Error, {@link TX}].
*/
TXDB.prototype.fillHistory = function fillHistory(tx, callback) {
var self = this;
if (Array.isArray(tx)) {
return utils.forEachSerial(tx, function(tx, next) {
self.fillHistory(tx, function(err) {
if (err)
return next(err);
next();
});
}, callback);
}
callback = utils.asyncify(callback);
if (tx.isCoinbase())
return callback(null, tx);
utils.forEach(tx.inputs, function(input, next) {
if (input.coin)
return next();
self.getTX(input.prevout.hash, function(err, tx) {
if (err)
return next(err);
if (tx)
input.coin = bcoin.coin(tx, input.prevout.index);
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, tx);
});
};
/**
* Fill a transaction with coins.
* @param {TX} tx
* @param {Function} callback - Returns [Error, {@link TX}].
*/
TXDB.prototype.fillCoins = function fillCoins(tx, callback) {
var self = this;
if (Array.isArray(tx)) {
return utils.forEachSerial(tx, function(tx, next) {
self.fillCoins(tx, function(err) {
if (err)
return next(err);
next();
});
}, callback);
}
callback = utils.asyncify(callback);
if (tx.isCoinbase())
return callback(null, tx);
utils.forEach(tx.inputs, function(input, next) {
if (input.coin)
return next();
self.getCoin(input.prevout.hash, input.prevout.index, function(err, coin) {
if (err)
return callback(err);
if (coin)
input.coin = coin;
next();
});
}, function(err) {
if (err)
return callback(err);
return callback(null, tx);
});
};
/**
* Get transaction.
* @param {Hash} hash
* @param {Function} callback - Returns [Error, {@link TX}].
*/
TXDB.prototype.getTX = function getTX(hash, callback) {
var prefix = this.prefix + '/';
var key = prefix + 't/t/' + hash;
this.db.get(key, function(err, tx) {
if (err && err.type !== 'NotFoundError')
return callback(err);
if (!tx)
return callback();
try {
tx = bcoin.tx.fromExtended(tx);
} catch (e) {
return callback(e);
}
return callback(null, tx);
});
};
/**
* Test whether the database has a transaction.
* @param {Hash} hash
* @param {Function} callback - Returns [Error, Boolean].
*/
TXDB.prototype.hasTX = function hasTX(hash, callback) {
return this.getTX(hash, function(err, tx) {
if (err)
return callback(err);
return callback(null, tx != null);
});
};
/**
* Get coin.
* @param {Hash} hash
* @param {Number} index
* @param {Function} callback - Returns [Error, {@link Coin}].
*/
TXDB.prototype.getCoin = function getCoin(hash, index, callback) {
var prefix = this.prefix + '/';
var key = prefix + 'u/t/' + hash + '/' + index;
this.db.get(key, function(err, coin) {
if (err && err.type !== 'NotFoundError')
return callback(err);
if (!coin)
return callback();
try {
coin = bcoin.coin.fromRaw(coin);
coin.hash = hash;
coin.index = index;
} catch (e) {
return callback(e);
}
return callback(null, coin);
});
};
/**
* Test whether the database has a transaction.
* @param {Hash} hash
* @param {Function} callback - Returns [Error, Boolean].
*/
TXDB.prototype.hasCoin = function hasCoin(hash, index, callback) {
return this.getCoin(hash, index, function(err, coin) {
if (err)
return callback(err);
return callback(null, coin != null);
});
};
/**
* Calculate balance.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Balance}].
*/
TXDB.prototype.getBalance = function getBalance(address, callback) {
var confirmed = new bn(0);
var unconfirmed = new bn(0);
var i;
if (typeof address === 'function') {
callback = address;
address = null;
}
return this.getCoins(address, function(err, coins) {
if (err)
return callback(err);
for (i = 0; i < coins.length; i++) {
if (coins[i].height === -1)
unconfirmed.iadd(coins[i].value);
else
confirmed.iadd(coins[i].value);
}
return callback(null, {
confirmed: confirmed,
unconfirmed: unconfirmed,
total: confirmed.add(unconfirmed)
});
});
};
/**
* Get hashes of all transactions in the database.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Hash}[]].
*/
TXDB.prototype.getHistoryHashesByAddress = function getHistoryHashesByAddress(address, callback) {
return this.getHistoryHashes(address, callback);
};
/**
* Get all transactions.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link TX}[]].
*/
TXDB.prototype.getHistoryByAddress = function getHistoryByAddress(address, callback) {
return this.getHistory(address, callback);
};
/**
* Get coins.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Coin}[]].
*/
TXDB.prototype.getCoinsByAddress = function getCoins(address, callback) {
return this.getCoins(address, callback);
};
/**
* Get unconfirmed transactions.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link TX}[]].
*/
TXDB.prototype.getUnconfirmedByAddress = function getUnconfirmedByAddress(address, callback) {
return this.getUnconfirmed(address, callback);
};
/**
* Calculate balance.
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Function} callback - Returns [Error, {@link Balance}].
*/
TXDB.prototype.getBalanceByAddress = function getBalanceByAddress(address, callback) {
return this.getBalance(address, callback);
};
/**
* @param {WalletID|WalletID[]} address - By address (can be null).
* @param {Number} now - Current time.
* @param {Number} age - Age delta (delete transactions older than `now - age`).
* @param {Function} callback
*/
TXDB.prototype.zap = function zap(address, now, age, callback, force) {
var self = this;
if (typeof address !== 'string') {
force = callback;
callback = age;
age = now;
now = address;
address = null;
}
var unlock = this._lock(zap, [address, now, age, callback], force);
if (!unlock)
return;
callback = utils.wrap(callback, unlock);
assert(utils.isFinite(now));
assert(utils.isFinite(age));
assert(now >= age);
return this.getRange(address, {
start: 0,
end: now - age
}, function(err, txs) {
if (err)
return callback(err);
self.fillHistory(txs, function(err) {
if (err)
return callback(err);
utils.forEachSerial(txs, function(tx, next) {
if (tx.ts !== 0)
return next();
self.lazyRemove(tx, next);
}, callback);
});
});
};
return TXDB;
};