hsd
Version:
Cryptocurrency bike-shed
1,824 lines (1,449 loc) • 84.2 kB
JavaScript
/*!
* rpc.js - bitcoind-compatible json rpc for hsd.
* Copyright (c) 2017-2018, Christopher Jeffrey (MIT License).
* https://github.com/handshake-org/hsd
*/
'use strict';
const assert = require('bsert');
const bweb = require('bweb');
const {Lock} = require('bmutex');
const IP = require('binet');
const Validator = require('bval');
const {BufferMap, BufferSet} = require('buffer-map');
const blake2b = require('bcrypto/lib/blake2b');
const {safeEqual} = require('bcrypto/lib/safe');
const secp256k1 = require('bcrypto/lib/secp256k1');
const util = require('../utils/util');
const common = require('../blockchain/common');
const Amount = require('../ui/amount');
const NetAddress = require('../net/netaddress');
const Script = require('../script/script');
const Address = require('../primitives/address');
const Block = require('../primitives/block');
const Input = require('../primitives/input');
const KeyRing = require('../primitives/keyring');
const MerkleBlock = require('../primitives/merkleblock');
const Headers = require('../primitives/headers');
const MTX = require('../primitives/mtx');
const Network = require('../protocol/network');
const Outpoint = require('../primitives/outpoint');
const Output = require('../primitives/output');
const TX = require('../primitives/tx');
const Claim = require('../primitives/claim');
const consensus = require('../protocol/consensus');
const pkg = require('../pkg');
const rules = require('../covenants/rules');
const {Resource} = require('../dns/resource');
const NameState = require('../covenants/namestate');
const {ownership} = require('../covenants/ownership');
const AirdropProof = require('../primitives/airdropproof');
const {EXP} = consensus;
const RPCBase = bweb.RPC;
const RPCError = bweb.RPCError;
/*
* Constants
*/
const errs = {
// Standard JSON-RPC 2.0 errors
INVALID_REQUEST: bweb.errors.INVALID_REQUEST,
METHOD_NOT_FOUND: bweb.errors.METHOD_NOT_FOUND,
INVALID_PARAMS: bweb.errors.INVALID_PARAMS,
INTERNAL_ERROR: bweb.errors.INTERNAL_ERROR,
PARSE_ERROR: bweb.errors.PARSE_ERROR,
// General application defined errors
MISC_ERROR: -1,
FORBIDDEN_BY_SAFE_MODE: -2,
TYPE_ERROR: -3,
INVALID_ADDRESS_OR_KEY: -5,
OUT_OF_MEMORY: -7,
INVALID_PARAMETER: -8,
DATABASE_ERROR: -20,
DESERIALIZATION_ERROR: -22,
VERIFY_ERROR: -25,
VERIFY_REJECTED: -26,
VERIFY_ALREADY_IN_CHAIN: -27,
IN_WARMUP: -28,
// P2P client errors
CLIENT_NOT_CONNECTED: -9,
CLIENT_IN_INITIAL_DOWNLOAD: -10,
CLIENT_NODE_ALREADY_ADDED: -23,
CLIENT_NODE_NOT_ADDED: -24,
CLIENT_NODE_NOT_CONNECTED: -29,
CLIENT_INVALID_IP_OR_SUBNET: -30,
CLIENT_P2P_DISABLED: -31
};
const MAGIC_STRING = `${pkg.currency} signed message:\n`;
/**
* Handshake RPC
* @alias module:http.RPC
* @extends bweb.RPC
*/
class RPC extends RPCBase {
/**
* Create RPC.
* @param {Node} node
*/
constructor(node) {
super();
assert(node, 'RPC requires a Node.');
this.node = node;
this.network = node.network;
this.workers = node.workers;
this.chain = node.chain;
this.mempool = node.mempool;
this.pool = node.pool;
this.fees = node.fees;
this.miner = node.miner;
this.logger = node.logger.context('node-rpc');
this.locker = new Lock();
this.mining = false;
this.procLimit = 0;
this.attempt = null;
this.lastActivity = 0;
this.boundChain = false;
this.mask = Buffer.alloc(32, 0x00);
this.merkleMap = new BufferMap();
this.merkleList = [];
this.pollers = [];
this.init();
}
getCode(err) {
switch (err.type) {
case 'RPCError':
return err.code;
case 'ValidationError':
return errs.TYPE_ERROR;
case 'EncodingError':
return errs.DESERIALIZATION_ERROR;
default:
return errs.INTERNAL_ERROR;
}
}
handleCall(cmd, query) {
if (cmd.method !== 'getwork'
&& cmd.method !== 'getblocktemplate'
&& cmd.method !== 'getbestblockhash') {
this.logger.debug('Handling RPC call: %s.', cmd.method);
if (cmd.method !== 'submitblock')
this.logger.debug(cmd.params);
}
if (cmd.method === 'getwork') {
if (query.longpoll)
cmd.method = 'getworklp';
}
}
handleError(err) {
this.logger.error('RPC internal error.');
this.logger.error(err);
}
init() {
this.add('stop', this.stop);
this.add('help', this.help);
this.add('getblockchaininfo', this.getBlockchainInfo);
this.add('getbestblockhash', this.getBestBlockHash);
this.add('getblockcount', this.getBlockCount);
this.add('getblock', this.getBlock);
this.add('getblockbyheight', this.getBlockByHeight);
this.add('getblockhash', this.getBlockHash);
this.add('getblockheader', this.getBlockHeader);
this.add('getchaintips', this.getChainTips);
this.add('getdifficulty', this.getDifficulty);
this.add('getmempoolancestors', this.getMempoolAncestors);
this.add('getmempooldescendants', this.getMempoolDescendants);
this.add('getmempoolentry', this.getMempoolEntry);
this.add('getmempoolinfo', this.getMempoolInfo);
this.add('getrawmempool', this.getRawMempool);
this.add('gettxout', this.getTXOut);
this.add('gettxoutsetinfo', this.getTXOutSetInfo);
this.add('pruneblockchain', this.pruneBlockchain);
this.add('compacttree', this.compactTree);
this.add('reconstructtree', this.reconstructTree);
this.add('verifychain', this.verifyChain);
this.add('invalidateblock', this.invalidateBlock);
this.add('reconsiderblock', this.reconsiderBlock);
this.add('getnetworkhashps', this.getNetworkHashPS);
this.add('getmininginfo', this.getMiningInfo);
this.add('prioritisetransaction', this.prioritiseTransaction);
this.add('getwork', this.getWork);
this.add('getworklp', this.getWorkLongpoll);
this.add('submitwork', this.submitWork);
this.add('getblocktemplate', this.getBlockTemplate);
this.add('submitblock', this.submitBlock);
this.add('verifyblock', this.verifyBlock);
this.add('setgenerate', this.setGenerate);
this.add('getgenerate', this.getGenerate);
this.add('generate', this.generate);
this.add('generatetoaddress', this.generateToAddress);
this.add('estimatefee', this.estimateFee);
this.add('estimatepriority', this.estimatePriority);
this.add('estimatesmartfee', this.estimateSmartFee);
this.add('estimatesmartpriority', this.estimateSmartPriority);
this.add('getinfo', this.getInfo);
this.add('validateaddress', this.validateAddress);
this.add('createmultisig', this.createMultisig);
this.add('verifymessage', this.verifyMessage);
this.add('verifymessagewithname', this.verifyMessageWithName);
this.add('signmessagewithprivkey', this.signMessageWithPrivkey);
this.add('setmocktime', this.setMockTime);
this.add('getconnectioncount', this.getConnectionCount);
this.add('ping', this.ping);
this.add('getpeerinfo', this.getPeerInfo);
this.add('addnode', this.addNode);
this.add('disconnectnode', this.disconnectNode);
this.add('getaddednodeinfo', this.getAddedNodeInfo);
this.add('getnettotals', this.getNetTotals);
this.add('getnetworkinfo', this.getNetworkInfo);
this.add('setban', this.setBan);
this.add('listbanned', this.listBanned);
this.add('clearbanned', this.clearBanned);
this.add('getrawtransaction', this.getRawTransaction);
this.add('createrawtransaction', this.createRawTransaction);
this.add('decoderawtransaction', this.decodeRawTransaction);
this.add('decodescript', this.decodeScript);
this.add('decoderesource', this.decodeResource);
this.add('sendrawtransaction', this.sendRawTransaction);
this.add('signrawtransaction', this.signRawTransaction);
this.add('gettxoutproof', this.getTXOutProof);
this.add('verifytxoutproof', this.verifyTXOutProof);
this.add('getmemoryinfo', this.getMemoryInfo);
this.add('setloglevel', this.setLogLevel);
this.add('getnames', this.getNames);
this.add('getnameinfo', this.getNameInfo);
this.add('getnameresource', this.getNameResource);
this.add('getnameproof', this.getNameProof);
this.add('getdnssecproof', this.getDNSSECProof);
this.add('getnamebyhash', this.getNameByHash);
this.add('grindname', this.grindName);
this.add('sendrawclaim', this.sendRawClaim);
this.add('sendrawairdrop', this.sendRawAirdrop);
this.add('validateresource', this.validateResource);
this.add('resetrootcache', this.resetRootCache);
// Compat
// this.add('getnameinfo', this.getNameInfo);
// this.add('getnameresource', this.getNameResource);
// this.add('getnameproof', this.getNameProof);
}
/*
* Overall control/query calls
*/
async getInfo(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getinfo');
return {
version: pkg.version,
protocolversion: this.pool.options.version,
walletversion: 0,
balance: 0,
blocks: this.chain.height,
timeoffset: this.network.time.offset,
connections: this.pool.peers.size(),
proxy: '',
difficulty: toDifficulty(this.chain.tip.bits),
testnet: this.network !== Network.main,
keypoololdest: 0,
keypoolsize: 0,
unlocked_until: 0,
paytxfee: Amount.coin(this.network.feeRate, true),
relayfee: Amount.coin(this.network.minRelay, true),
errors: ''
};
}
async help(args, _help) {
if (args.length === 0)
return 'Select a command.';
const json = {
method: args[0],
params: []
};
return this.execute(json, true);
}
async stop(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'stop');
this.node.close().catch((err) => {
setImmediate(() => {
throw err;
});
});
return 'Stopping.';
}
/*
* P2P networking
*/
async getNetworkInfo(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getnetworkinfo');
const hosts = this.pool.hosts;
const locals = [];
for (const local of hosts.local.values()) {
locals.push({
address: local.addr.host,
port: local.addr.port,
score: local.score
});
}
return {
version: pkg.version,
subversion: this.pool.options.agent,
protocolversion: this.pool.options.version,
identitykey: this.pool.hosts.brontide.getKey('base32'),
localservices: util.hex32(this.pool.options.services),
localservicenames: this.pool.getServiceNames(),
localrelay: !this.pool.options.noRelay,
timeoffset: this.network.time.offset,
networkactive: this.pool.connected,
connections: this.pool.peers.size(),
networks: [],
relayfee: Amount.coin(this.network.minRelay, true),
incrementalfee: 0,
localaddresses: locals,
warnings: ''
};
}
async addNode(args, help) {
if (help || args.length !== 2)
throw new RPCError(errs.MISC_ERROR, 'addnode "node" "add|remove|onetry"');
const valid = new Validator(args);
const node = valid.str(0, '');
const cmd = valid.str(1, '');
switch (cmd) {
case 'add': {
this.pool.hosts.addNode(node);
; // fall through
}
case 'onetry': {
const addr = parseNetAddress(node, this.network);
if (!this.pool.peers.get(addr.hostname)) {
const peer = this.pool.createOutbound(addr);
this.pool.peers.add(peer);
}
break;
}
case 'remove': {
this.pool.hosts.removeNode(node);
break;
}
}
return null;
}
async disconnectNode(args, help) {
if (help || args.length !== 1)
throw new RPCError(errs.MISC_ERROR, 'disconnectnode "node"');
const valid = new Validator(args);
const str = valid.str(0, '');
const addr = parseIP(str, this.network);
const peer = this.pool.peers.get(addr.hostname);
if (peer)
peer.destroy();
return null;
}
async getAddedNodeInfo(args, help) {
if (help || args.length > 1)
throw new RPCError(errs.MISC_ERROR, 'getaddednodeinfo ( "node" )');
const hosts = this.pool.hosts;
const valid = new Validator(args);
const addr = valid.str(0, '');
let target;
if (args.length === 1)
target = parseIP(addr, this.network);
const result = [];
for (const node of hosts.nodes) {
if (target) {
if (node.host !== target.host)
continue;
if (node.port !== target.port)
continue;
}
const peer = this.pool.peers.get(node.hostname);
if (!peer || !peer.connected) {
result.push({
addednode: node.hostname,
connected: false,
addresses: []
});
continue;
}
result.push({
addednode: node.hostname,
connected: peer.connected,
addresses: [
{
address: peer.hostname(),
connected: peer.outbound
? 'outbound'
: 'inbound'
}
]
});
}
if (target && result.length === 0) {
throw new RPCError(errs.CLIENT_NODE_NOT_ADDED,
'Node has not been added.');
}
return result;
}
async getConnectionCount(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getconnectioncount');
return this.pool.peers.size();
}
async getNetTotals(args, help) {
let sent = 0;
let recv = 0;
if (help || args.length > 0)
throw new RPCError(errs.MISC_ERROR, 'getnettotals');
for (let peer = this.pool.peers.head(); peer; peer = peer.next) {
sent += peer.socket.bytesWritten;
recv += peer.socket.bytesRead;
}
return {
totalbytesrecv: recv,
totalbytessent: sent,
timemillis: Date.now()
};
}
async getPeerInfo(args, help) {
if (help || args.length > 1)
throw new RPCError(errs.MISC_ERROR, 'getpeerinfo ( "type" )');
const valid = new Validator(args);
const type = valid.str(0);
const peers = [];
for (let peer = this.pool.peers.head(); peer; peer = peer.next) {
if (!peer.connected)
continue;
if (type && peer.outbound !== (type === 'outbound'))
continue;
const offset = this.network.time.known.get(peer.hostname()) || 0;
const hashes = [];
for (const hash in peer.blockMap.keys())
hashes.push(hash.toString('hex'));
peer.getName();
peers.push({
id: peer.id,
addr: peer.hostname(),
addrlocal: !peer.local.isNull()
? peer.local.hostname
: undefined,
name: peer.name || undefined,
services: util.hex32(peer.services),
servicenames: peer.getServiceNames(),
relaytxes: !peer.noRelay,
lastsend: peer.lastSend / 1000 | 0,
lastrecv: peer.lastRecv / 1000 | 0,
bytessent: peer.socket.bytesWritten,
bytesrecv: peer.socket.bytesRead,
conntime: peer.time !== 0 ? (Date.now() - peer.time) / 1000 | 0 : 0,
timeoffset: offset,
pingtime: peer.lastPong !== -1
? (peer.lastPong - peer.lastPing) / 1000
: -1,
minping: peer.minPing !== -1 ? peer.minPing / 1000 : -1,
version: peer.version,
subver: peer.agent,
inbound: !peer.outbound,
startingheight: peer.height,
besthash: peer.bestHash.toString('hex'),
bestheight: peer.bestHeight,
banscore: peer.banScore,
inflight: hashes,
whitelisted: false
});
}
return peers;
}
async ping(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'ping');
for (let peer = this.pool.peers.head(); peer; peer = peer.next)
peer.sendPing();
return null;
}
async setBan(args, help) {
const valid = new Validator(args);
const str = valid.str(0, '');
const action = valid.str(1, '');
if (help
|| args.length < 2
|| (action !== 'add' && action !== 'remove')) {
throw new RPCError(errs.MISC_ERROR,
'setban "ip(/netmask)" "add|remove" (bantime) (absolute)');
}
const addr = parseNetAddress(str, this.network);
switch (action) {
case 'add':
this.pool.ban(addr);
break;
case 'remove':
this.pool.unban(addr);
break;
}
return null;
}
async listBanned(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'listbanned');
const banned = [];
for (const [host, time] of this.pool.hosts.banned) {
banned.push({
address: host,
banned_until: time + this.pool.options.banTime,
ban_created: time,
ban_reason: ''
});
}
return banned;
}
async clearBanned(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'clearbanned');
this.pool.hosts.clearBanned();
return null;
}
/* Block chain and UTXO */
async getBlockchainInfo(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getblockchaininfo');
return {
chain: this.network.type !== 'testnet'
? this.network.type
: 'test',
blocks: this.chain.height,
headers: this.chain.height,
bestblockhash: this.chain.tip.hash.toString('hex'),
treeroot: this.chain.tip.treeRoot.toString('hex'),
difficulty: toDifficulty(this.chain.tip.bits),
mediantime: await this.chain.getMedianTime(this.chain.tip),
verificationprogress: this.chain.getProgress(),
chainwork: this.chain.tip.chainwork.toString('hex', 64),
pruned: this.chain.options.prune,
softforks: await this.getSoftforks(),
deflationary: this.chain.height >= this.network.deflationHeight,
pruneheight: this.chain.options.prune
? Math.max(0, this.chain.height - this.network.block.keepBlocks)
: null
};
}
async getBestBlockHash(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getbestblockhash');
return this.chain.tip.hash.toString('hex');
}
async getBlockCount(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getblockcount');
return this.chain.tip.height;
}
async getBlock(args, help) {
if (help || args.length < 1 || args.length > 3)
throw new RPCError(errs.MISC_ERROR, 'getblock "hash" ( verbose )');
const valid = new Validator(args);
const hash = valid.bhash(0);
const verbose = valid.bool(1, true);
const details = valid.bool(2, false);
if (!hash)
throw new RPCError(errs.TYPE_ERROR, 'Invalid block hash.');
const entry = await this.chain.getEntry(hash);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Block not found');
const block = await this.chain.getBlock(entry.hash);
if (!block) {
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Block not available (spv mode)');
if (this.chain.options.prune) {
throw new RPCError(errs.MISC_ERROR,
'Block not available (pruned data)');
}
throw new RPCError(errs.MISC_ERROR, 'Can\'t read block from disk');
}
if (!verbose)
return block.toHex();
return this.blockToJSON(entry, block, details);
}
async getBlockByHeight(args, help) {
if (help || args.length < 1 || args.length > 3) {
throw new RPCError(errs.MISC_ERROR,
'getblockbyheight "height" ( verbose )');
}
const valid = new Validator(args);
const height = valid.u32(0, -1);
const verbose = valid.bool(1, true);
const details = valid.bool(2, false);
if (height === -1)
throw new RPCError(errs.TYPE_ERROR, 'Invalid block height.');
const entry = await this.chain.getEntry(height);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Block not found');
const block = await this.chain.getBlock(entry.hash);
if (!block) {
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Block not available (spv mode)');
if (this.chain.options.prune) {
throw new RPCError(errs.MISC_ERROR,
'Block not available (pruned data)');
}
throw new RPCError(errs.DATABASE_ERROR, 'Can\'t read block from disk');
}
if (!verbose)
return block.toHex();
return this.blockToJSON(entry, block, details);
}
async getBlockHash(args, help) {
if (help || args.length !== 1)
throw new RPCError(errs.MISC_ERROR, 'getblockhash index');
const valid = new Validator(args);
const height = valid.u32(0);
if (height == null || height > this.chain.height)
throw new RPCError(errs.INVALID_PARAMETER, 'Block height out of range.');
const hash = await this.chain.getHash(height);
if (!hash)
throw new RPCError(errs.MISC_ERROR, 'Not found.');
return hash.toString('hex');
}
async getBlockHeader(args, help) {
if (help || args.length < 1 || args.length > 2)
throw new RPCError(errs.MISC_ERROR, 'getblockheader "hash" ( verbose )');
const valid = new Validator(args);
const hash = valid.bhash(0);
const verbose = valid.bool(1, true);
if (!hash)
throw new RPCError(errs.MISC_ERROR, 'Invalid block hash.');
const entry = await this.chain.getEntry(hash);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Block not found');
if (!verbose)
return entry.encode().toString('hex', 36, 36 + consensus.HEADER_SIZE);
return this.headerToJSON(entry);
}
async getChainTips(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getchaintips');
const tips = await this.chain.getTips();
const result = [];
for (const hash of tips) {
const entry = await this.chain.getEntry(hash);
assert(entry);
const fork = await this.findFork(entry);
const main = await this.chain.isMainChain(entry);
result.push({
height: entry.height,
hash: entry.hash.toString('hex'),
branchlen: entry.height - fork.height,
status: main ? 'active' : 'valid-headers'
});
}
return result;
}
async getDifficulty(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getdifficulty');
return toDifficulty(this.chain.tip.bits);
}
async getMempoolInfo(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getmempoolinfo');
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
return {
size: this.mempool.map.size,
bytes: this.mempool.getSize(),
usage: this.mempool.getSize(),
maxmempool: this.mempool.options.maxSize,
mempoolminfee: Amount.coin(this.mempool.options.minRelay, true)
};
}
async getMempoolAncestors(args, help) {
if (help || args.length < 1 || args.length > 2)
throw new RPCError(errs.MISC_ERROR, 'getmempoolancestors txid (verbose)');
const valid = new Validator(args);
const hash = valid.bhash(0);
const verbose = valid.bool(1, false);
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
if (!hash)
throw new RPCError(errs.TYPE_ERROR, 'Invalid TXID.');
const entry = this.mempool.getEntry(hash);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Transaction not in mempool.');
const entries = this.mempool.getAncestors(entry);
const out = [];
if (verbose) {
for (const entry of entries)
out.push(this.entryToJSON(entry));
} else {
for (const entry of entries)
out.push(entry.txid());
}
return out;
}
async getMempoolDescendants(args, help) {
if (help || args.length < 1 || args.length > 2) {
throw new RPCError(errs.MISC_ERROR,
'getmempooldescendants txid (verbose)');
}
const valid = new Validator(args);
const hash = valid.bhash(0);
const verbose = valid.bool(1, false);
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
if (!hash)
throw new RPCError(errs.TYPE_ERROR, 'Invalid TXID.');
const entry = this.mempool.getEntry(hash);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Transaction not in mempool.');
const entries = this.mempool.getDescendants(entry);
const out = [];
if (verbose) {
for (const entry of entries)
out.push(this.entryToJSON(entry));
} else {
for (const entry of entries)
out.push(entry.txid());
}
return out;
}
async getMempoolEntry(args, help) {
if (help || args.length !== 1)
throw new RPCError(errs.MISC_ERROR, 'getmempoolentry txid');
const valid = new Validator(args);
const hash = valid.bhash(0);
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
if (!hash)
throw new RPCError(errs.TYPE_ERROR, 'Invalid TXID.');
const entry = this.mempool.getEntry(hash);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Transaction not in mempool.');
return this.entryToJSON(entry);
}
async getRawMempool(args, help) {
if (help || args.length > 1)
throw new RPCError(errs.MISC_ERROR, 'getrawmempool ( verbose )');
const valid = new Validator(args);
const verbose = valid.bool(0, false);
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
if (verbose) {
const out = Object.create(null);
for (const entry of this.mempool.map.values())
out[entry.txid()] = this.entryToJSON(entry);
return out;
}
const hashes = this.mempool.getSnapshot();
return hashes.map(hash => hash.toString('hex'));
}
async getTXOut(args, help) {
if (help || args.length < 2 || args.length > 3) {
throw new RPCError(errs.MISC_ERROR,
'gettxout "txid" n ( includemempool )');
}
const valid = new Validator(args);
const hash = valid.bhash(0);
const index = valid.u32(1);
const mempool = valid.bool(2, true);
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Cannot get coins in SPV mode.');
if (this.chain.options.prune)
throw new RPCError(errs.MISC_ERROR, 'Cannot get coins when pruned.');
if (!hash || index == null)
throw new RPCError(errs.TYPE_ERROR, 'Invalid outpoint.');
let coin;
if (mempool) {
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
coin = this.mempool.getCoin(hash, index);
}
if (!coin)
coin = await this.chain.getCoin(hash, index);
if (!coin)
return null;
return {
bestblock: this.chain.tip.hash.toString('hex'),
confirmations: coin.getDepth(this.chain.height),
value: Amount.coin(coin.value, true),
address: this.addrToJSON(coin.address),
version: coin.version,
coinbase: coin.coinbase
};
}
async getTXOutProof(args, help) {
if (help || (args.length !== 1 && args.length !== 2)) {
throw new RPCError(errs.MISC_ERROR,
'gettxoutproof ["txid",...] ( blockhash )');
}
const valid = new Validator(args);
const txids = valid.array(0);
const hash = valid.bhash(1);
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Cannot get coins in SPV mode.');
if (this.chain.options.prune)
throw new RPCError(errs.MISC_ERROR, 'Cannot get coins when pruned.');
if (!txids || txids.length === 0)
throw new RPCError(errs.INVALID_PARAMETER, 'Invalid TXIDs.');
const items = new Validator(txids);
const set = new BufferSet();
const hashes = [];
let last = null;
for (let i = 0; i < txids.length; i++) {
const hash = items.bhash(i);
if (!hash)
throw new RPCError(errs.TYPE_ERROR, 'Invalid TXID.');
if (set.has(hash))
throw new RPCError(errs.INVALID_PARAMETER, 'Duplicate txid.');
set.add(hash);
hashes.push(hash);
last = hash;
}
let block = null;
if (hash) {
block = await this.chain.getBlock(hash);
} else if (this.chain.options.indexTX) {
const tx = await this.chain.getMeta(last);
if (tx)
block = await this.chain.getBlock(tx.block);
} else {
const coin = await this.chain.getCoin(last, 0);
if (coin)
block = await this.chain.getBlock(coin.height);
}
if (!block)
throw new RPCError(errs.MISC_ERROR, 'Block not found.');
const whashes = [];
for (const hash of hashes) {
const index = block.indexOf(hash);
if (index === -1) {
throw new RPCError(errs.VERIFY_ERROR,
'Block does not contain all txids.');
}
const tx = block.txs[index];
whashes.push(tx.hash());
}
const mblock = MerkleBlock.fromHashes(block, whashes);
return mblock.toHex();
}
async verifyTXOutProof(args, help) {
if (help || args.length !== 1)
throw new RPCError(errs.MISC_ERROR, 'verifytxoutproof "proof"');
const valid = new Validator(args);
const data = valid.buf(0);
if (!data)
throw new RPCError(errs.TYPE_ERROR, 'Invalid hex string.');
const block = MerkleBlock.decode(data);
if (!block.verify())
return [];
const entry = await this.chain.getEntry(block.hash());
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Block not found in chain.');
const tree = block.getTree();
const out = [];
for (const hash of tree.matches)
out.push(hash.toString('hex'));
return out;
}
async getTXOutSetInfo(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'gettxoutsetinfo');
if (this.chain.options.spv) {
throw new RPCError(errs.MISC_ERROR,
'Chainstate not available (SPV mode).');
}
return {
height: this.chain.height,
bestblock: this.chain.tip.hash.toString('hex'),
transactions: this.chain.db.state.tx,
txouts: this.chain.db.state.coin,
bytes_serialized: 0,
hash_serialized: 0,
total_amount: Amount.coin(this.chain.db.state.value, true),
total_burned: Amount.coin(this.chain.db.state.burned, true)
};
}
async pruneBlockchain(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'pruneblockchain');
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Cannot prune chain in SPV mode.');
if (this.chain.options.prune)
throw new RPCError(errs.MISC_ERROR, 'Chain is already pruned.');
if (this.chain.height < this.network.block.pruneAfterHeight)
throw new RPCError(errs.MISC_ERROR, 'Chain is too short for pruning.');
try {
await this.chain.prune();
} catch (e) {
throw new RPCError(errs.DATABASE_ERROR, e.message);
}
}
async compactTree(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'compacttree');
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Cannot compact tree in SPV mode.');
try {
await this.chain.compactTree();
} catch (e) {
throw new RPCError(errs.DATABASE_ERROR, e.message);
}
}
async reconstructTree(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'reconstructtree');
if (this.chain.options.spv) {
throw new RPCError(errs.MISC_ERROR,
'Cannot reconstruct tree in SPV mode.');
}
if (this.chain.options.prune) {
throw new RPCError(errs.MISC_ERROR,
'Cannot reconstruct tree in pruned node.');
}
try {
await this.chain.reconstructTree();
} catch (e) {
throw new RPCError(errs.DATABASE_ERROR, e.message);
}
}
async verifyChain(args, help) {
if (help || args.length > 2) {
throw new RPCError(errs.MISC_ERROR,
'verifychain ( checklevel numblocks )');
}
const valid = new Validator(args);
const level = valid.u32(0);
const blocks = valid.u32(1);
if (level == null || blocks == null)
throw new RPCError(errs.TYPE_ERROR, 'Missing parameters.');
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Cannot verify chain in SPV mode.');
if (this.chain.options.prune)
throw new RPCError(errs.MISC_ERROR, 'Cannot verify chain when pruned.');
return null;
}
/*
* Mining
*/
async handleWork(data, mask) {
const unlock = await this.locker.lock();
try {
return await this._handleWork(data, mask);
} finally {
unlock();
}
}
async _handleWork(data, mask) {
if (data.length !== 256)
return [false, 'invalid-data-length'];
const hdr = Headers.fromMiner(data);
const maskHash = blake2b.multi(hdr.prevBlock, mask);
if (!hdr.maskHash().equals(maskHash))
return [false, 'bad-maskhash'];
const attempt = this.merkleMap.get(hdr.witnessRoot);
if (!attempt)
return [false, 'stale'];
if (!hdr.prevBlock.equals(attempt.prevBlock)
|| hdr.bits !== attempt.bits) {
return [false, 'stale'];
}
const {nonce, time, extraNonce} = hdr;
const proof = attempt.getProof(nonce, time, extraNonce, mask);
if (!proof.verify(attempt.target, this.network))
return [false, 'bad-diffbits'];
const block = attempt.commit(proof);
let entry;
try {
entry = await this.chain.add(block);
} catch (err) {
if (err.type === 'VerifyError') {
this.logger.warning('RPC block rejected: %x (%s).',
block.hash(), err.reason);
return [false, err.reason];
}
throw err;
}
if (!entry) {
this.logger.warning('RPC block rejected: %x (bad-prevblk).',
block.hash());
return [false, 'bad-prevblk'];
}
return [true, 'valid'];
}
async createWork() {
const unlock = await this.locker.lock();
try {
return await this._createWork();
} finally {
unlock();
}
}
async _createWork() {
const attempt = await this.updateWork();
const time = attempt.time;
const nonce = consensus.ZERO_NONCE;
const mask = consensus.ZERO_HASH;
const data = attempt.getHeader(0, time, nonce, mask);
return {
network: this.network.type,
data: data.toString('hex'),
target: attempt.target.toString('hex'),
height: attempt.height,
time: this.network.now(),
fee: attempt.fees
};
}
async getWorkLongpoll(args, help) {
await this.longpoll();
return this.createWork();
}
async getWork(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getwork');
return this.createWork();
}
async submitWork(args, help) {
if (help || args.length < 1 || args.length > 2)
throw new RPCError(errs.MISC_ERROR, 'submitwork ( "data" "mask" )');
const valid = new Validator(args);
const data = valid.buf(0);
if (!data)
throw new RPCError(errs.TYPE_ERROR, 'Invalid work data.');
let mask = consensus.ZERO_HASH;
if (args.length === 2) {
mask = valid.bhash(1);
if (!mask)
throw new RPCError(errs.TYPE_ERROR, 'Invalid mask.');
}
return this.handleWork(data, mask);
}
async submitBlock(args, help) {
if (help || args.length < 1 || args.length > 2) {
throw new RPCError(errs.MISC_ERROR,
'submitblock "hexdata" ( "jsonparametersobject" )');
}
const valid = new Validator(args);
const data = valid.buf(0);
const block = Block.decode(data);
return this.addBlock(block);
}
async getBlockTemplate(args, help) {
if (help || args.length > 1) {
throw new RPCError(errs.MISC_ERROR,
'getblocktemplate ( "jsonrequestobject" )');
}
const validator = new Validator(args);
const options = validator.obj(0, {});
const valid = new Validator(options);
const mode = valid.str('mode', 'template');
if (mode !== 'template' && mode !== 'proposal')
throw new RPCError(errs.INVALID_PARAMETER, 'Invalid mode.');
if (mode === 'proposal') {
const data = valid.buf('data');
if (!data)
throw new RPCError(errs.TYPE_ERROR, 'Missing data parameter.');
const block = Block.decode(data);
if (!block.prevBlock.equals(this.chain.tip.hash))
return 'inconclusive-not-best-prevblk';
try {
await this.chain.verifyBlock(block);
} catch (e) {
if (e.type === 'VerifyError')
return e.reason;
throw e;
}
return null;
}
let maxVersion = valid.u32('maxversion', -1);
let rules = valid.array('rules');
if (rules)
maxVersion = -1;
const capabilities = valid.array('capabilities');
let coinbase = false;
if (capabilities) {
let txnCap = false;
let valueCap = false;
for (const capability of capabilities) {
if (typeof capability !== 'string')
throw new RPCError(errs.TYPE_ERROR, 'Invalid capability.');
switch (capability) {
case 'coinbasetxn':
txnCap = true;
break;
case 'coinbasevalue':
// Prefer value if they support it.
valueCap = true;
break;
}
}
if (txnCap && !valueCap) {
if (this.miner.addresses.length === 0) {
throw new RPCError(errs.MISC_ERROR,
'No addresses available for coinbase.');
}
coinbase = true;
}
}
if (!this.network.selfConnect) {
if (this.pool.peers.size() === 0) {
throw new RPCError(errs.CLIENT_NOT_CONNECTED,
'Node is not connected!');
}
if (!this.chain.synced) {
throw new RPCError(errs.CLIENT_IN_INITIAL_DOWNLOAD,
'Node is downloading blocks...');
}
}
const lpid = valid.str('longpollid');
if (lpid)
await this.handleLongpoll(lpid);
if (!rules)
rules = [];
return this.createTemplate(maxVersion, coinbase, rules);
}
async createTemplate(maxVersion, coinbase, rules) {
const unlock = await this.locker.lock();
try {
return await this._createTemplate(maxVersion, coinbase, rules);
} finally {
unlock();
}
}
async _createTemplate(maxVersion, coinbase, rules) {
const attempt = await this.getTemplate();
const scale = attempt.witness ? 1 : consensus.WITNESS_SCALE_FACTOR;
// Default mutable fields.
const mutable = ['time', 'transactions', 'prevblock'];
// The miner doesn't support
// versionbits. Force them to
// encode our version.
if (maxVersion >= 2)
mutable.push('version/force');
// Allow the miner to change
// our provided coinbase.
// Note that these are implied
// without `coinbasetxn`.
if (coinbase) {
mutable.push('coinbase');
mutable.push('coinbase/append');
mutable.push('generation');
}
// Build an index of every transaction.
const index = new BufferMap();
for (let i = 0; i < attempt.items.length; i++) {
const entry = attempt.items[i];
index.set(entry.hash, i + 1);
}
// Calculate dependencies for each transaction.
const txs = [];
for (let i = 0; i < attempt.items.length; i++) {
const entry = attempt.items[i];
const tx = entry.tx;
const deps = [];
for (let j = 0; j < tx.inputs.length; j++) {
const input = tx.inputs[j];
const dep = index.get(input.prevout.hash);
if (dep == null)
continue;
if (deps.indexOf(dep) === -1) {
assert(dep < i + 1);
deps.push(dep);
}
}
txs.push({
data: tx.toHex(),
txid: tx.txid(),
hash: tx.wtxid(),
depends: deps,
fee: entry.fee,
sigops: entry.sigops / scale | 0,
weight: tx.getWeight()
});
}
// Calculate version based on given rules.
let version = attempt.version;
const vbavailable = {};
const vbrules = [];
for (const deploy of this.network.deploys) {
const state = await this.chain.getState(this.chain.tip, deploy);
let name = deploy.name;
switch (state) {
case common.thresholdStates.DEFINED:
case common.thresholdStates.FAILED:
break;
case common.thresholdStates.LOCKED_IN:
version |= 1 << deploy.bit;
case common.thresholdStates.STARTED:
if (!deploy.force) {
if (rules.indexOf(name) === -1)
version &= ~(1 << deploy.bit);
if (deploy.required)
name = '!' + name;
}
vbavailable[name] = deploy.bit;
break;
case common.thresholdStates.ACTIVE:
if (!deploy.force && deploy.required) {
if (rules.indexOf(name) === -1) {
throw new RPCError(errs.INVALID_PARAMETER,
`Client must support ${name}.`);
}
name = '!' + name;
}
vbrules.push(name);
break;
default:
assert(false, 'Bad state.');
break;
}
}
version >>>= 0;
const json = {
capabilities: ['proposal'],
mutable: mutable,
version: version,
rules: vbrules,
vbavailable: vbavailable,
vbrequired: 0,
height: attempt.height,
previousblockhash: attempt.prevBlock.toString('hex'),
merkleroot: undefined,
witnessroot: undefined,
treeroot: attempt.treeRoot.toString('hex'),
reservedroot: attempt.reservedRoot.toString('hex'),
mask: consensus.ZERO_HASH.toString('hex'), // Compat.
target: attempt.target.toString('hex'),
bits: util.hex32(attempt.bits),
noncerange:
Array(consensus.NONCE_SIZE + 1).join('00')
+ Array(consensus.NONCE_SIZE + 1).join('ff'),
curtime: attempt.time,
mintime: attempt.mtp + 1,
maxtime: attempt.time + 7200,
expires: attempt.time + 7200,
sigoplimit: consensus.MAX_BLOCK_SIGOPS,
// sizelimit: consensus.MAX_RAW_BLOCK_SIZE,
sizelimit: consensus.MAX_BLOCK_SIZE,
weightlimit: consensus.MAX_BLOCK_WEIGHT,
longpollid: this.chain.tip.hash.toString('hex')
+ util.hex32(this.totalTX()),
submitold: false,
coinbaseaux: {
flags: attempt.coinbaseFlags.toString('hex')
},
coinbasevalue: attempt.getReward(),
coinbasetxn: undefined,
claims: attempt.claims.map((claim) => {
let value = claim.value;
let fee = claim.fee;
// Account for mining software which creates its own
// coinbase with something other than `coinbasevalue`.
if (attempt.height >= this.network.deflationHeight) {
if (claim.commitHeight !== 1) {
value = claim.value - claim.fee;
fee = 0;
}
}
return {
data: claim.blob.toString('hex'),
name: claim.name.toString('binary'),
namehash: claim.nameHash.toString('hex'),
version: claim.address.version,
hash: claim.address.hash.toString('hex'),
value: value,
fee: fee,
weak: claim.weak,
commitHash: claim.commitHash.toString('hex'),
commitHeight: claim.commitHeight,
weight: claim.getWeight()
};
}),
airdrops: attempt.airdrops.map((airdrop) => {
return {
data: airdrop.blob.toString('hex'),
position: airdrop.position,
version: airdrop.address.version,
address: airdrop.address.hash.toString('hex'),
value: airdrop.value,
fee: airdrop.fee,
rate: airdrop.rate,
weak: airdrop.weak
};
}),
transactions: txs
};
// The client wants a coinbasetxn
// instead of a coinbasevalue.
if (coinbase) {
const tx = attempt.coinbase;
json.merkleroot = attempt.merkleRoot.toString('hex');
json.witnessroot = attempt.witnessRoot.toString('hex');
json.coinbasetxn = {
data: tx.toHex(),
txid: tx.txid(),
hash: tx.wtxid(),
depends: [],
fee: 0,
sigops: tx.getSigops() / scale | 0,
weight: tx.getWeight()
};
}
return json;
}
async getMiningInfo(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getmininginfo');
const attempt = this.attempt;
let size = 0;
let weight = 0;
let txs = 0;
let diff = 0;
if (attempt) {
weight = attempt.weight;
txs = attempt.items.length + 1;
diff = attempt.getDifficulty();
size = 1000;
for (const item of attempt.items)
size += item.tx.getBaseSize();
}
return {
blocks: this.chain.height,
currentblocksize: size,
currentblockweight: weight,
currentblocktx: txs,
difficulty: diff,
errors: '',
genproclimit: this.procLimit,
networkhashps: await this.getHashRate(120),
pooledtx: this.totalTX(),
testnet: this.network !== Network.main,
chain: this.network.type !== 'testnet'
? this.network.type
: 'test',
generate: this.mining
};
}
async getNetworkHashPS(args, help) {
if (help || args.length > 2)
throw new RPCError(errs.MISC_ERROR, 'getnetworkhashps ( blocks height )');
const valid = new Validator(args);
const lookup = valid.u32(0, 120);
const height = valid.u32(1);
return this.getHashRate(lookup, height);
}
async prioritiseTransaction(args, help) {
if (help || args.length !== 3) {
throw new RPCError(errs.MISC_ERROR,
'prioritisetransaction <txid> <priority delta> <fee delta>');
}
const valid = new Validator(args);
const hash = valid.bhash(0);
const pri = valid.i64(1);
const fee = valid.i64(2);
if (!this.mempool)
throw new RPCError(errs.MISC_ERROR, 'No mempool available.');
if (!hash)
throw new RPCError(errs.TYPE_ERROR, 'Invalid TXID');
if (pri == null || fee == null)
throw new RPCError(errs.TYPE_ERROR, 'Invalid fee or priority.');
const entry = this.mempool.getEntry(hash);
if (!entry)
throw new RPCError(errs.MISC_ERROR, 'Transaction not in mempool.');
this.mempool.prioritise(entry, pri, fee);
return true;
}
async verifyBlock(args, help) {
if (help || args.length !== 1)
throw new RPCError(errs.MISC_ERROR, 'verifyblock "block-hex"');
const valid = new Validator(args);
const data = valid.buf(0);
if (!data)
throw new RPCError(errs.TYPE_ERROR, 'Invalid block hex.');
if (this.chain.options.spv)
throw new RPCError(errs.MISC_ERROR, 'Cannot verify block in SPV mode.');
const block = Block.decode(data);
try {
await this.chain.verifyBlock(block);
} catch (e) {
if (e.type === 'VerifyError')
return e.reason;
throw e;
}
return null;
}
/*
* Coin generation
*/
async getGenerate(args, help) {
if (help || args.length !== 0)
throw new RPCError(errs.MISC_ERROR, 'getgenerate');
return this.mining;
}
async setGenerate(args, help) {
if (help || args.length < 1 || args.length > 2)
throw new RPCError(errs.MISC_ERROR, 'setgenerate mine ( proclimit )');
const valid = new Validator(args);
const mine = valid.bool(0, false);
const limit = valid.u32(1, 0);
if (mine && this.miner.addresses.length === 0) {
throw new RPCError(errs.MISC_ERROR,
'No addresses available for coinbase.');
}
this.mining = mine;
this.procLimit = limit;
if (mine) {
this.miner.cpu.start();
return true;
}
await this.miner.cpu.stop();
return false;
}
async generate(args, help) {
if (help || args.length < 1 || args.length > 2)
throw new RPCError(errs.MISC_ERROR, 'generate numblocks ( maxtries )');
const valid = new Validator(args);
const blocks = valid.u32(0, 1);
const tries = valid.u32(1);
if (this.miner.addresses.length === 0) {
throw new RPCError(errs.MISC_ERROR,
'No addresses available for coinbase.');
}
return this.mineBlocks(blocks, null, tries);
}
async generateToAddress(args, help) {
if (help || args.length < 2 || args.length > 3) {
throw new RPCError(errs.MISC_ERROR,
'generatetoaddress numblocks address ( maxtries )');
}
const valid = new Validator(args);
const blocks = valid.u32(0, 1);
const str = valid.str(1, '');
const tries = valid.u32(2);
const addr = parseAddress(str, this.network);
return this.mineBlocks(blocks, addr, tries);
}
/*
* Raw transactions
*/
async createRawTransaction(args, help) {
if (help || args.length < 2 || args.length > 3) {
throw new RPCError(errs.MISC_ERROR,
'createrawtransaction'
+ ' [{"txid":"id","vout":n},...]'
+ ' {"address":amount,"data":"hex",...}'
+ ' ( locktime )');
}
const valid = new Validator(args);
const inputs = valid.array(0);
const sendTo = valid.obj(1);
const locktime = valid.u32(2);
if (!inputs || !sendTo) {
throw new RPCError(errs.TYPE_ERROR,
'Invalid parameters (inputs and sendTo).');
}
const tx = new MTX();
if (locktime != null)
tx.locktime = locktime;
for (const obj of inputs) {
const valid = new Validator(obj);
const hash = valid.bhash('txid');
const index = valid.u32('vout');
let sequence = valid.u32('sequence', 0xffffffff);
if (tx.locktime)
sequence -= 1;
if (!hash || index == null)
throw new RPCError(errs.TYPE