]> Git Repo - VerusCoin.git/blame - src/rpcblockchain.cpp
Auto merge of #1907 - bitcartel:1903_z_sendmany_fee_parameter, r=ebfull
[VerusCoin.git] / src / rpcblockchain.cpp
CommitLineData
c625ae04 1// Copyright (c) 2010 Satoshi Nakamoto
f914f1a7 2// Copyright (c) 2009-2014 The Bitcoin Core developers
72fb3d29 3// Distributed under the MIT software license, see the accompanying
c625ae04
JG
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
ac14bcc1 6#include "checkpoints.h"
da29ecbc 7#include "consensus/validation.h"
51ed9ec9 8#include "main.h"
da29ecbc 9#include "primitives/transaction.h"
ac14bcc1 10#include "rpcserver.h"
51ed9ec9 11#include "sync.h"
ad49c256 12#include "util.h"
51ed9ec9
BD
13
14#include <stdint.h>
15
16#include "json/json_spirit_value.h"
c625ae04
JG
17
18using namespace json_spirit;
19using namespace std;
20
73351c36 21extern void TxToJSON(const CTransaction& tx, const uint256 hashBlock, Object& entry);
be066fad 22void ScriptPubKeyToJSON(const CScript& scriptPubKey, Object& out, bool fIncludeHex);
4e68391a 23
695a7a88 24double GetDifficultyINTERNAL(const CBlockIndex* blockindex, bool networkDifficulty)
c625ae04
JG
25{
26 // Floating point number that is a multiple of the minimum difficulty,
27 // minimum difficulty = 1.0.
28 if (blockindex == NULL)
29 {
4c6d41b8 30 if (chainActive.Tip() == NULL)
c625ae04
JG
31 return 1.0;
32 else
4c6d41b8 33 blockindex = chainActive.Tip();
c625ae04
JG
34 }
35
333ea3c4
JG
36 uint32_t bits;
37 if (networkDifficulty) {
38 bits = GetNextWorkRequired(blockindex, nullptr, Params().GetConsensus());
39 } else {
40 bits = blockindex->nBits;
695a7a88
JG
41 }
42
333ea3c4 43 uint32_t powLimit =
f50e8313 44 UintToArith256(Params().GetConsensus().powLimit).GetCompact();
333ea3c4 45 int nShift = (bits >> 24) & 0xff;
24809b16 46 int nShiftAmount = (powLimit >> 24) & 0xff;
c625ae04
JG
47
48 double dDiff =
24809b16 49 (double)(powLimit & 0x00ffffff) /
333ea3c4 50 (double)(bits & 0x00ffffff);
c625ae04 51
24809b16 52 while (nShift < nShiftAmount)
c625ae04
JG
53 {
54 dDiff *= 256.0;
55 nShift++;
56 }
24809b16 57 while (nShift > nShiftAmount)
c625ae04
JG
58 {
59 dDiff /= 256.0;
60 nShift--;
61 }
62
63 return dDiff;
64}
65
695a7a88
JG
66double GetDifficulty(const CBlockIndex* blockindex)
67{
68 return GetDifficultyINTERNAL(blockindex, false);
69}
70
71double GetNetworkDifficulty(const CBlockIndex* blockindex)
72{
73 return GetDifficultyINTERNAL(blockindex, true);
74}
75
c625ae04 76
73351c36 77Object blockToJSON(const CBlock& block, const CBlockIndex* blockindex, bool txDetails = false)
c625ae04
JG
78{
79 Object result;
80 result.push_back(Pair("hash", block.GetHash().GetHex()));
57153d4e
WL
81 int confirmations = -1;
82 // Only report confirmations if the block is on the main chain
83 if (chainActive.Contains(blockindex))
84 confirmations = chainActive.Height() - blockindex->nHeight + 1;
85 result.push_back(Pair("confirmations", confirmations));
c625ae04
JG
86 result.push_back(Pair("size", (int)::GetSerializeSize(block, SER_NETWORK, PROTOCOL_VERSION)));
87 result.push_back(Pair("height", blockindex->nHeight));
88 result.push_back(Pair("version", block.nVersion));
89 result.push_back(Pair("merkleroot", block.hashMerkleRoot.GetHex()));
90 Array txs;
91 BOOST_FOREACH(const CTransaction&tx, block.vtx)
73351c36
JS
92 {
93 if(txDetails)
94 {
95 Object objTx;
4f152496 96 TxToJSON(tx, uint256(), objTx);
73351c36
JS
97 txs.push_back(objTx);
98 }
99 else
805344dc 100 txs.push_back(tx.GetHash().GetHex());
73351c36 101 }
c625ae04 102 result.push_back(Pair("tx", txs));
d56e30ca 103 result.push_back(Pair("time", block.GetBlockTime()));
fdda3c50 104 result.push_back(Pair("nonce", block.nNonce.GetHex()));
e1dde421 105 result.push_back(Pair("solution", HexStr(block.nSolution)));
645d497a 106 result.push_back(Pair("bits", strprintf("%08x", block.nBits)));
c625ae04 107 result.push_back(Pair("difficulty", GetDifficulty(blockindex)));
1b3656d5 108 result.push_back(Pair("chainwork", blockindex->nChainWork.GetHex()));
c625ae04
JG
109
110 if (blockindex->pprev)
111 result.push_back(Pair("previousblockhash", blockindex->pprev->GetBlockHash().GetHex()));
4c6d41b8 112 CBlockIndex *pnext = chainActive.Next(blockindex);
0fe8010a
PW
113 if (pnext)
114 result.push_back(Pair("nextblockhash", pnext->GetBlockHash().GetHex()));
c625ae04
JG
115 return result;
116}
117
118
119Value getblockcount(const Array& params, bool fHelp)
120{
121 if (fHelp || params.size() != 0)
122 throw runtime_error(
123 "getblockcount\n"
a6099ef3 124 "\nReturns the number of blocks in the longest block chain.\n"
125 "\nResult:\n"
126 "n (numeric) The current block count\n"
127 "\nExamples:\n"
128 + HelpExampleCli("getblockcount", "")
129 + HelpExampleRpc("getblockcount", "")
130 );
c625ae04 131
4401b2d7 132 LOCK(cs_main);
4c6d41b8 133 return chainActive.Height();
c625ae04
JG
134}
135
091aa8da
JG
136Value getbestblockhash(const Array& params, bool fHelp)
137{
138 if (fHelp || params.size() != 0)
139 throw runtime_error(
140 "getbestblockhash\n"
a6099ef3 141 "\nReturns the hash of the best (tip) block in the longest block chain.\n"
142 "\nResult\n"
143 "\"hex\" (string) the block hash hex encoded\n"
144 "\nExamples\n"
145 + HelpExampleCli("getbestblockhash", "")
146 + HelpExampleRpc("getbestblockhash", "")
147 );
091aa8da 148
4401b2d7 149 LOCK(cs_main);
4c6d41b8 150 return chainActive.Tip()->GetBlockHash().GetHex();
091aa8da 151}
c625ae04
JG
152
153Value getdifficulty(const Array& params, bool fHelp)
154{
155 if (fHelp || params.size() != 0)
156 throw runtime_error(
157 "getdifficulty\n"
a6099ef3 158 "\nReturns the proof-of-work difficulty as a multiple of the minimum difficulty.\n"
159 "\nResult:\n"
160 "n.nnn (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty.\n"
161 "\nExamples:\n"
162 + HelpExampleCli("getdifficulty", "")
163 + HelpExampleRpc("getdifficulty", "")
164 );
c625ae04 165
4401b2d7 166 LOCK(cs_main);
695a7a88 167 return GetNetworkDifficulty();
c625ae04
JG
168}
169
170
c625ae04
JG
171Value getrawmempool(const Array& params, bool fHelp)
172{
4d707d51 173 if (fHelp || params.size() > 1)
c625ae04 174 throw runtime_error(
4d707d51 175 "getrawmempool ( verbose )\n"
a6099ef3 176 "\nReturns all transaction ids in memory pool as a json array of string transaction ids.\n"
4d707d51
GA
177 "\nArguments:\n"
178 "1. verbose (boolean, optional, default=false) true for a json object, false for array of transaction ids\n"
179 "\nResult: (for verbose = false):\n"
180 "[ (json array of string)\n"
a6099ef3 181 " \"transactionid\" (string) The transaction id\n"
182 " ,...\n"
183 "]\n"
4d707d51
GA
184 "\nResult: (for verbose = true):\n"
185 "{ (json object)\n"
186 " \"transactionid\" : { (json object)\n"
187 " \"size\" : n, (numeric) transaction size in bytes\n"
188 " \"fee\" : n, (numeric) transaction fee in bitcoins\n"
189 " \"time\" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT\n"
190 " \"height\" : n, (numeric) block height when transaction entered pool\n"
191 " \"startingpriority\" : n, (numeric) priority when transaction entered pool\n"
192 " \"currentpriority\" : n, (numeric) transaction priority now\n"
193 " \"depends\" : [ (array) unconfirmed transactions used as inputs for this transaction\n"
194 " \"transactionid\", (string) parent transaction id\n"
195 " ... ]\n"
196 " }, ...\n"
803f51ef 197 "}\n"
a6099ef3 198 "\nExamples\n"
4d707d51
GA
199 + HelpExampleCli("getrawmempool", "true")
200 + HelpExampleRpc("getrawmempool", "true")
a6099ef3 201 );
c625ae04 202
4401b2d7
EL
203 LOCK(cs_main);
204
4d707d51
GA
205 bool fVerbose = false;
206 if (params.size() > 0)
207 fVerbose = params[0].get_bool();
c625ae04 208
4d707d51
GA
209 if (fVerbose)
210 {
211 LOCK(mempool.cs);
212 Object o;
213 BOOST_FOREACH(const PAIRTYPE(uint256, CTxMemPoolEntry)& entry, mempool.mapTx)
214 {
215 const uint256& hash = entry.first;
216 const CTxMemPoolEntry& e = entry.second;
217 Object info;
218 info.push_back(Pair("size", (int)e.GetTxSize()));
219 info.push_back(Pair("fee", ValueFromAmount(e.GetFee())));
d56e30ca 220 info.push_back(Pair("time", e.GetTime()));
4d707d51
GA
221 info.push_back(Pair("height", (int)e.GetHeight()));
222 info.push_back(Pair("startingpriority", e.GetPriority(e.GetHeight())));
223 info.push_back(Pair("currentpriority", e.GetPriority(chainActive.Height())));
224 const CTransaction& tx = e.GetTx();
225 set<string> setDepends;
226 BOOST_FOREACH(const CTxIn& txin, tx.vin)
227 {
228 if (mempool.exists(txin.prevout.hash))
229 setDepends.insert(txin.prevout.hash.ToString());
230 }
231 Array depends(setDepends.begin(), setDepends.end());
232 info.push_back(Pair("depends", depends));
233 o.push_back(Pair(hash.ToString(), info));
234 }
235 return o;
236 }
237 else
238 {
239 vector<uint256> vtxid;
240 mempool.queryHashes(vtxid);
c625ae04 241
4d707d51
GA
242 Array a;
243 BOOST_FOREACH(const uint256& hash, vtxid)
244 a.push_back(hash.ToString());
245
246 return a;
247 }
c625ae04
JG
248}
249
250Value getblockhash(const Array& params, bool fHelp)
251{
252 if (fHelp || params.size() != 1)
253 throw runtime_error(
a6099ef3 254 "getblockhash index\n"
255 "\nReturns hash of block in best-block-chain at index provided.\n"
256 "\nArguments:\n"
257 "1. index (numeric, required) The block index\n"
258 "\nResult:\n"
259 "\"hash\" (string) The block hash\n"
260 "\nExamples:\n"
261 + HelpExampleCli("getblockhash", "1000")
262 + HelpExampleRpc("getblockhash", "1000")
263 );
c625ae04 264
4401b2d7
EL
265 LOCK(cs_main);
266
c625ae04 267 int nHeight = params[0].get_int();
4c6d41b8 268 if (nHeight < 0 || nHeight > chainActive.Height())
6261e6e6 269 throw JSONRPCError(RPC_INVALID_PARAMETER, "Block height out of range");
c625ae04 270
4c6d41b8
PW
271 CBlockIndex* pblockindex = chainActive[nHeight];
272 return pblockindex->GetBlockHash().GetHex();
c625ae04
JG
273}
274
275Value getblock(const Array& params, bool fHelp)
276{
23319521 277 if (fHelp || params.size() < 1 || params.size() > 2)
c625ae04 278 throw runtime_error(
a6099ef3 279 "getblock \"hash\" ( verbose )\n"
280 "\nIf verbose is false, returns a string that is serialized, hex-encoded data for block 'hash'.\n"
281 "If verbose is true, returns an Object with information about block <hash>.\n"
282 "\nArguments:\n"
283 "1. \"hash\" (string, required) The block hash\n"
284 "2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data\n"
285 "\nResult (for verbose = true):\n"
286 "{\n"
287 " \"hash\" : \"hash\", (string) the block hash (same as provided)\n"
57153d4e 288 " \"confirmations\" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain\n"
a6099ef3 289 " \"size\" : n, (numeric) The block size\n"
290 " \"height\" : n, (numeric) The block height or index\n"
291 " \"version\" : n, (numeric) The block version\n"
292 " \"merkleroot\" : \"xxxx\", (string) The merkle root\n"
293 " \"tx\" : [ (array of string) The transaction ids\n"
294 " \"transactionid\" (string) The transaction id\n"
295 " ,...\n"
296 " ],\n"
297 " \"time\" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)\n"
298 " \"nonce\" : n, (numeric) The nonce\n"
299 " \"bits\" : \"1d00ffff\", (string) The bits\n"
300 " \"difficulty\" : x.xxx, (numeric) The difficulty\n"
301 " \"previousblockhash\" : \"hash\", (string) The hash of the previous block\n"
302 " \"nextblockhash\" : \"hash\" (string) The hash of the next block\n"
303 "}\n"
304 "\nResult (for verbose=false):\n"
305 "\"data\" (string) A string that is serialized, hex-encoded data for block 'hash'.\n"
306 "\nExamples:\n"
307 + HelpExampleCli("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
308 + HelpExampleRpc("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
23319521 309 );
c625ae04 310
4401b2d7
EL
311 LOCK(cs_main);
312
c625ae04 313 std::string strHash = params[0].get_str();
34cdc411 314 uint256 hash(uint256S(strHash));
c625ae04 315
23319521
LD
316 bool fVerbose = true;
317 if (params.size() > 1)
318 fVerbose = params[1].get_bool();
319
c625ae04 320 if (mapBlockIndex.count(hash) == 0)
738835d7 321 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
c625ae04
JG
322
323 CBlock block;
324 CBlockIndex* pblockindex = mapBlockIndex[hash];
954d2e72 325
03c56872
JS
326 if (fHavePruned && !(pblockindex->nStatus & BLOCK_HAVE_DATA) && pblockindex->nTx > 0)
327 throw JSONRPCError(RPC_INTERNAL_ERROR, "Block not available (pruned data)");
328
954d2e72
RDP
329 if(!ReadBlockFromDisk(block, pblockindex))
330 throw JSONRPCError(RPC_INTERNAL_ERROR, "Can't read block from disk");
c625ae04 331
23319521
LD
332 if (!fVerbose)
333 {
334 CDataStream ssBlock(SER_NETWORK, PROTOCOL_VERSION);
335 ssBlock << block;
336 std::string strHex = HexStr(ssBlock.begin(), ssBlock.end());
337 return strHex;
338 }
339
c625ae04
JG
340 return blockToJSON(block, pblockindex);
341}
342
beeb5761
PW
343Value gettxoutsetinfo(const Array& params, bool fHelp)
344{
345 if (fHelp || params.size() != 0)
346 throw runtime_error(
347 "gettxoutsetinfo\n"
a6099ef3 348 "\nReturns statistics about the unspent transaction output set.\n"
349 "Note this call may take some time.\n"
350 "\nResult:\n"
351 "{\n"
352 " \"height\":n, (numeric) The current block height (index)\n"
353 " \"bestblock\": \"hex\", (string) the best block hash hex\n"
354 " \"transactions\": n, (numeric) The number of transactions\n"
355 " \"txouts\": n, (numeric) The number of output transactions\n"
356 " \"bytes_serialized\": n, (numeric) The serialized size\n"
357 " \"hash_serialized\": \"hash\", (string) The serialized hash\n"
358 " \"total_amount\": x.xxx (numeric) The total amount\n"
359 "}\n"
360 "\nExamples:\n"
361 + HelpExampleCli("gettxoutsetinfo", "")
362 + HelpExampleRpc("gettxoutsetinfo", "")
363 );
beeb5761 364
4401b2d7
EL
365 LOCK(cs_main);
366
beeb5761
PW
367 Object ret;
368
369 CCoinsStats stats;
51ce901a 370 FlushStateToDisk();
beeb5761 371 if (pcoinsTip->GetStats(stats)) {
4b61a6a4 372 ret.push_back(Pair("height", (int64_t)stats.nHeight));
e31aa7c9 373 ret.push_back(Pair("bestblock", stats.hashBlock.GetHex()));
4b61a6a4
KD
374 ret.push_back(Pair("transactions", (int64_t)stats.nTransactions));
375 ret.push_back(Pair("txouts", (int64_t)stats.nTransactionOutputs));
376 ret.push_back(Pair("bytes_serialized", (int64_t)stats.nSerializedSize));
e31aa7c9
PW
377 ret.push_back(Pair("hash_serialized", stats.hashSerialized.GetHex()));
378 ret.push_back(Pair("total_amount", ValueFromAmount(stats.nTotalAmount)));
beeb5761
PW
379 }
380 return ret;
381}
c625ae04 382
beeb5761
PW
383Value gettxout(const Array& params, bool fHelp)
384{
385 if (fHelp || params.size() < 2 || params.size() > 3)
386 throw runtime_error(
a6099ef3 387 "gettxout \"txid\" n ( includemempool )\n"
388 "\nReturns details about an unspent transaction output.\n"
389 "\nArguments:\n"
390 "1. \"txid\" (string, required) The transaction id\n"
391 "2. n (numeric, required) vout value\n"
392 "3. includemempool (boolean, optional) Whether to included the mem pool\n"
393 "\nResult:\n"
394 "{\n"
395 " \"bestblock\" : \"hash\", (string) the block hash\n"
396 " \"confirmations\" : n, (numeric) The number of confirmations\n"
397 " \"value\" : x.xxx, (numeric) The transaction value in btc\n"
398 " \"scriptPubKey\" : { (json object)\n"
399 " \"asm\" : \"code\", (string) \n"
400 " \"hex\" : \"hex\", (string) \n"
401 " \"reqSigs\" : n, (numeric) Number of required signatures\n"
402 " \"type\" : \"pubkeyhash\", (string) The type, eg pubkeyhash\n"
403 " \"addresses\" : [ (array of string) array of bitcoin addresses\n"
404 " \"bitcoinaddress\" (string) bitcoin address\n"
405 " ,...\n"
406 " ]\n"
407 " },\n"
408 " \"version\" : n, (numeric) The version\n"
409 " \"coinbase\" : true|false (boolean) Coinbase or not\n"
410 "}\n"
411
412 "\nExamples:\n"
413 "\nGet unspent transactions\n"
414 + HelpExampleCli("listunspent", "") +
415 "\nView the details\n"
416 + HelpExampleCli("gettxout", "\"txid\" 1") +
417 "\nAs a json rpc call\n"
418 + HelpExampleRpc("gettxout", "\"txid\", 1")
419 );
c625ae04 420
4401b2d7
EL
421 LOCK(cs_main);
422
beeb5761
PW
423 Object ret;
424
425 std::string strHash = params[0].get_str();
34cdc411 426 uint256 hash(uint256S(strHash));
beeb5761
PW
427 int n = params[1].get_int();
428 bool fMempool = true;
429 if (params.size() > 2)
430 fMempool = params[2].get_bool();
431
432 CCoins coins;
433 if (fMempool) {
434 LOCK(mempool.cs);
7c70438d 435 CCoinsViewMemPool view(pcoinsTip, mempool);
beeb5761
PW
436 if (!view.GetCoins(hash, coins))
437 return Value::null;
438 mempool.pruneSpent(hash, coins); // TODO: this should be done by the CCoinsViewMemPool
439 } else {
440 if (!pcoinsTip->GetCoins(hash, coins))
441 return Value::null;
442 }
443 if (n<0 || (unsigned int)n>=coins.vout.size() || coins.vout[n].IsNull())
444 return Value::null;
445
145d5be8 446 BlockMap::iterator it = mapBlockIndex.find(pcoinsTip->GetBestBlock());
84674082
PW
447 CBlockIndex *pindex = it->second;
448 ret.push_back(Pair("bestblock", pindex->GetBlockHash().GetHex()));
beeb5761
PW
449 if ((unsigned int)coins.nHeight == MEMPOOL_HEIGHT)
450 ret.push_back(Pair("confirmations", 0));
451 else
84674082 452 ret.push_back(Pair("confirmations", pindex->nHeight - coins.nHeight + 1));
4e68391a 453 ret.push_back(Pair("value", ValueFromAmount(coins.vout[n].nValue)));
beeb5761 454 Object o;
be066fad 455 ScriptPubKeyToJSON(coins.vout[n].scriptPubKey, o, true);
beeb5761
PW
456 ret.push_back(Pair("scriptPubKey", o));
457 ret.push_back(Pair("version", coins.nVersion));
458 ret.push_back(Pair("coinbase", coins.fCoinBase));
459
460 return ret;
461}
c625ae04 462
f5906533
JG
463Value verifychain(const Array& params, bool fHelp)
464{
465 if (fHelp || params.size() > 2)
466 throw runtime_error(
a6099ef3 467 "verifychain ( checklevel numblocks )\n"
468 "\nVerifies blockchain database.\n"
469 "\nArguments:\n"
6943cb9b
PK
470 "1. checklevel (numeric, optional, 0-4, default=3) How thorough the block verification is.\n"
471 "2. numblocks (numeric, optional, default=288, 0=all) The number of blocks to check.\n"
a6099ef3 472 "\nResult:\n"
473 "true|false (boolean) Verified or not\n"
474 "\nExamples:\n"
475 + HelpExampleCli("verifychain", "")
476 + HelpExampleRpc("verifychain", "")
477 );
f5906533 478
4401b2d7
EL
479 LOCK(cs_main);
480
f5906533
JG
481 int nCheckLevel = GetArg("-checklevel", 3);
482 int nCheckDepth = GetArg("-checkblocks", 288);
483 if (params.size() > 0)
484 nCheckLevel = params[0].get_int();
485 if (params.size() > 1)
486 nCheckDepth = params[1].get_int();
487
2e280311 488 return CVerifyDB().VerifyDB(pcoinsTip, nCheckLevel, nCheckDepth);
f5906533 489}
c625ae04 490
ba1da90b
WL
491/** Implementation of IsSuperMajority with better feedback */
492Object SoftForkMajorityDesc(int minVersion, CBlockIndex* pindex, int nRequired, const Consensus::Params& consensusParams)
493{
494 int nFound = 0;
495 CBlockIndex* pstart = pindex;
496 for (int i = 0; i < consensusParams.nMajorityWindow && pstart != NULL; i++)
497 {
498 if (pstart->nVersion >= minVersion)
499 ++nFound;
500 pstart = pstart->pprev;
501 }
502
503 Object rv;
504 rv.push_back(Pair("status", nFound >= nRequired));
505 rv.push_back(Pair("found", nFound));
506 rv.push_back(Pair("required", nRequired));
507 rv.push_back(Pair("window", consensusParams.nMajorityWindow));
508 return rv;
509}
510
511Object SoftForkDesc(const std::string &name, int version, CBlockIndex* pindex, const Consensus::Params& consensusParams)
512{
513 Object rv;
514 rv.push_back(Pair("id", name));
515 rv.push_back(Pair("version", version));
516 rv.push_back(Pair("enforce", SoftForkMajorityDesc(version, pindex, consensusParams.nMajorityEnforceBlockUpgrade, consensusParams)));
517 rv.push_back(Pair("reject", SoftForkMajorityDesc(version, pindex, consensusParams.nMajorityRejectBlockOutdated, consensusParams)));
518 return rv;
519}
520
d387b8ec
WL
521Value getblockchaininfo(const Array& params, bool fHelp)
522{
523 if (fHelp || params.size() != 0)
524 throw runtime_error(
525 "getblockchaininfo\n"
526 "Returns an object containing various state info regarding block chain processing.\n"
527 "\nResult:\n"
528 "{\n"
f6984e81 529 " \"chain\": \"xxxx\", (string) current network name as defined in BIP70 (main, test, regtest)\n"
d387b8ec 530 " \"blocks\": xxxxxx, (numeric) the current number of blocks processed in the server\n"
ad6e6017 531 " \"headers\": xxxxxx, (numeric) the current number of headers we have validated\n"
d387b8ec
WL
532 " \"bestblockhash\": \"...\", (string) the hash of the currently best block\n"
533 " \"difficulty\": xxxxxx, (numeric) the current difficulty\n"
534 " \"verificationprogress\": xxxx, (numeric) estimate of verification progress [0..1]\n"
535 " \"chainwork\": \"xxxx\" (string) total amount of work in active chain, in hexadecimal\n"
ba1da90b
WL
536 " \"softforks\": [ (array) status of softforks in progress\n"
537 " {\n"
538 " \"id\": \"xxxx\", (string) name of softfork\n"
539 " \"version\": xx, (numeric) block version\n"
540 " \"enforce\": { (object) progress toward enforcing the softfork rules for new-version blocks\n"
541 " \"status\": xx, (boolean) true if threshold reached\n"
542 " \"found\": xx, (numeric) number of blocks with the new version found\n"
543 " \"required\": xx, (numeric) number of blocks required to trigger\n"
544 " \"window\": xx, (numeric) maximum size of examined window of recent blocks\n"
545 " },\n"
546 " \"reject\": { ... } (object) progress toward rejecting pre-softfork blocks (same fields as \"enforce\")\n"
547 " }, ...\n"
548 " ]\n"
d387b8ec
WL
549 "}\n"
550 "\nExamples:\n"
551 + HelpExampleCli("getblockchaininfo", "")
552 + HelpExampleRpc("getblockchaininfo", "")
553 );
554
4401b2d7
EL
555 LOCK(cs_main);
556
d387b8ec 557 Object obj;
f5ae6c98
PK
558 obj.push_back(Pair("chain", Params().NetworkIDString()));
559 obj.push_back(Pair("blocks", (int)chainActive.Height()));
ad6e6017 560 obj.push_back(Pair("headers", pindexBestHeader ? pindexBestHeader->nHeight : -1));
f5ae6c98 561 obj.push_back(Pair("bestblockhash", chainActive.Tip()->GetBlockHash().GetHex()));
695a7a88 562 obj.push_back(Pair("difficulty", (double)GetNetworkDifficulty()));
11982d36 563 obj.push_back(Pair("verificationprogress", Checkpoints::GuessVerificationProgress(Params().Checkpoints(), chainActive.Tip())));
f5ae6c98 564 obj.push_back(Pair("chainwork", chainActive.Tip()->nChainWork.GetHex()));
1b2e5555 565 obj.push_back(Pair("pruned", fPruneMode));
ba1da90b
WL
566
567 const Consensus::Params& consensusParams = Params().GetConsensus();
568 CBlockIndex* tip = chainActive.Tip();
569 Array softforks;
570 softforks.push_back(SoftForkDesc("bip34", 2, tip, consensusParams));
571 softforks.push_back(SoftForkDesc("bip66", 3, tip, consensusParams));
6af25b0f 572 softforks.push_back(SoftForkDesc("bip65", 4, tip, consensusParams));
ba1da90b
WL
573 obj.push_back(Pair("softforks", softforks));
574
1b2e5555
JS
575 if (fPruneMode)
576 {
577 CBlockIndex *block = chainActive.Tip();
578 while (block && block->pprev && (block->pprev->nStatus & BLOCK_HAVE_DATA))
579 block = block->pprev;
580
581 obj.push_back(Pair("pruneheight", block->nHeight));
582 }
d387b8ec
WL
583 return obj;
584}
b33bd7a3 585
72fb3d29 586/** Comparison function for sorting the getchaintips heads. */
b33bd7a3
DK
587struct CompareBlocksByHeight
588{
589 bool operator()(const CBlockIndex* a, const CBlockIndex* b) const
590 {
591 /* Make sure that unequal blocks with the same height do not compare
771d5002 592 equal. Use the pointers themselves to make a distinction. */
b33bd7a3
DK
593
594 if (a->nHeight != b->nHeight)
595 return (a->nHeight > b->nHeight);
596
597 return a < b;
598 }
599};
600
601Value getchaintips(const Array& params, bool fHelp)
602{
603 if (fHelp || params.size() != 0)
604 throw runtime_error(
605 "getchaintips\n"
606 "Return information about all known tips in the block tree,"
607 " including the main chain as well as orphaned branches.\n"
608 "\nResult:\n"
609 "[\n"
610 " {\n"
611 " \"height\": xxxx, (numeric) height of the chain tip\n"
612 " \"hash\": \"xxxx\", (string) block hash of the tip\n"
613 " \"branchlen\": 0 (numeric) zero for main chain\n"
1b91be49 614 " \"status\": \"active\" (string) \"active\" for the main chain\n"
b33bd7a3
DK
615 " },\n"
616 " {\n"
617 " \"height\": xxxx,\n"
618 " \"hash\": \"xxxx\",\n"
619 " \"branchlen\": 1 (numeric) length of branch connecting the tip to the main chain\n"
1b91be49 620 " \"status\": \"xxxx\" (string) status of the chain (active, valid-fork, valid-headers, headers-only, invalid)\n"
b33bd7a3
DK
621 " }\n"
622 "]\n"
32b93a1b
PW
623 "Possible values for status:\n"
624 "1. \"invalid\" This branch contains at least one invalid block\n"
625 "2. \"headers-only\" Not all blocks for this branch are available, but the headers are valid\n"
626 "3. \"valid-headers\" All blocks are available for this branch, but they were never fully validated\n"
627 "4. \"valid-fork\" This branch is not part of the active chain, but is fully validated\n"
628 "5. \"active\" This is the tip of the active main chain, which is certainly valid\n"
b33bd7a3
DK
629 "\nExamples:\n"
630 + HelpExampleCli("getchaintips", "")
631 + HelpExampleRpc("getchaintips", "")
632 );
633
4401b2d7
EL
634 LOCK(cs_main);
635
b33bd7a3
DK
636 /* Build up a list of chain tips. We start with the list of all
637 known blocks, and successively remove blocks that appear as pprev
638 of another block. */
639 std::set<const CBlockIndex*, CompareBlocksByHeight> setTips;
640 BOOST_FOREACH(const PAIRTYPE(const uint256, CBlockIndex*)& item, mapBlockIndex)
641 setTips.insert(item.second);
642 BOOST_FOREACH(const PAIRTYPE(const uint256, CBlockIndex*)& item, mapBlockIndex)
643 {
644 const CBlockIndex* pprev = item.second->pprev;
645 if (pprev)
646 setTips.erase(pprev);
647 }
648
1b91be49
PW
649 // Always report the currently active tip.
650 setTips.insert(chainActive.Tip());
651
b33bd7a3
DK
652 /* Construct the output array. */
653 Array res;
654 BOOST_FOREACH(const CBlockIndex* block, setTips)
655 {
656 Object obj;
657 obj.push_back(Pair("height", block->nHeight));
658 obj.push_back(Pair("hash", block->phashBlock->GetHex()));
659
660 const int branchLen = block->nHeight - chainActive.FindFork(block)->nHeight;
661 obj.push_back(Pair("branchlen", branchLen));
662
1b91be49
PW
663 string status;
664 if (chainActive.Contains(block)) {
665 // This block is part of the currently active chain.
666 status = "active";
667 } else if (block->nStatus & BLOCK_FAILED_MASK) {
668 // This block or one of its ancestors is invalid.
669 status = "invalid";
670 } else if (block->nChainTx == 0) {
671 // This block cannot be connected because full block data for it or one of its parents is missing.
672 status = "headers-only";
673 } else if (block->IsValid(BLOCK_VALID_SCRIPTS)) {
674 // This block is fully validated, but no longer part of the active chain. It was probably the active block once, but was reorganized.
675 status = "valid-fork";
676 } else if (block->IsValid(BLOCK_VALID_TREE)) {
677 // The headers for this block are valid, but it has not been validated. It was probably never part of the most-work chain.
678 status = "valid-headers";
679 } else {
680 // No clue.
681 status = "unknown";
682 }
683 obj.push_back(Pair("status", status));
684
b33bd7a3
DK
685 res.push_back(obj);
686 }
687
688 return res;
689}
6f2c26a4
JG
690
691Value getmempoolinfo(const Array& params, bool fHelp)
692{
693 if (fHelp || params.size() != 0)
694 throw runtime_error(
695 "getmempoolinfo\n"
696 "\nReturns details on the active state of the TX memory pool.\n"
697 "\nResult:\n"
698 "{\n"
699 " \"size\": xxxxx (numeric) Current tx count\n"
700 " \"bytes\": xxxxx (numeric) Sum of all tx sizes\n"
701 "}\n"
702 "\nExamples:\n"
703 + HelpExampleCli("getmempoolinfo", "")
704 + HelpExampleRpc("getmempoolinfo", "")
705 );
706
707 Object ret;
708 ret.push_back(Pair("size", (int64_t) mempool.size()));
709 ret.push_back(Pair("bytes", (int64_t) mempool.GetTotalTxSize()));
710
711 return ret;
712}
713
9b0a8d31
PW
714Value invalidateblock(const Array& params, bool fHelp)
715{
716 if (fHelp || params.size() != 1)
717 throw runtime_error(
718 "invalidateblock \"hash\"\n"
719 "\nPermanently marks a block as invalid, as if it violated a consensus rule.\n"
720 "\nArguments:\n"
721 "1. hash (string, required) the hash of the block to mark as invalid\n"
722 "\nResult:\n"
723 "\nExamples:\n"
724 + HelpExampleCli("invalidateblock", "\"blockhash\"")
725 + HelpExampleRpc("invalidateblock", "\"blockhash\"")
726 );
727
728 std::string strHash = params[0].get_str();
34cdc411 729 uint256 hash(uint256S(strHash));
9b0a8d31
PW
730 CValidationState state;
731
732 {
733 LOCK(cs_main);
734 if (mapBlockIndex.count(hash) == 0)
735 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
736
737 CBlockIndex* pblockindex = mapBlockIndex[hash];
738 InvalidateBlock(state, pblockindex);
739 }
740
741 if (state.IsValid()) {
742 ActivateBestChain(state);
743 }
744
745 if (!state.IsValid()) {
746 throw JSONRPCError(RPC_DATABASE_ERROR, state.GetRejectReason());
747 }
748
749 return Value::null;
750}
751
752Value reconsiderblock(const Array& params, bool fHelp)
753{
754 if (fHelp || params.size() != 1)
755 throw runtime_error(
756 "reconsiderblock \"hash\"\n"
757 "\nRemoves invalidity status of a block and its descendants, reconsider them for activation.\n"
758 "This can be used to undo the effects of invalidateblock.\n"
759 "\nArguments:\n"
760 "1. hash (string, required) the hash of the block to reconsider\n"
761 "\nResult:\n"
762 "\nExamples:\n"
763 + HelpExampleCli("reconsiderblock", "\"blockhash\"")
764 + HelpExampleRpc("reconsiderblock", "\"blockhash\"")
765 );
766
767 std::string strHash = params[0].get_str();
34cdc411 768 uint256 hash(uint256S(strHash));
9b0a8d31
PW
769 CValidationState state;
770
771 {
772 LOCK(cs_main);
773 if (mapBlockIndex.count(hash) == 0)
774 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
775
776 CBlockIndex* pblockindex = mapBlockIndex[hash];
777 ReconsiderBlock(state, pblockindex);
778 }
779
780 if (state.IsValid()) {
781 ActivateBestChain(state);
782 }
783
784 if (!state.IsValid()) {
785 throw JSONRPCError(RPC_DATABASE_ERROR, state.GetRejectReason());
786 }
787
788 return Value::null;
789}
This page took 0.219555 seconds and 4 git commands to generate.