8#include <blockfilter.h>
10#include <chainparams.h>
57#include <condition_variable>
76 const std::function<
void()>& interruption_point = {})
87 const std::function<
void()>& interruption_point = {});
93 int nShift = (blockindex.
nBits >> 24) & 0xff;
95 (double)0x0000ffff / (
double)(blockindex.
nBits & 0x00ffffff);
114 if (next && next->
pprev == &blockindex) {
118 return &blockindex == &tip ? 1 : -1;
127 const int height{param.
getInt<
int>()};
131 const int current_tip{active_chain.
Height()};
132 if (height > current_tip) {
136 return active_chain[height];
158 result.
pushKV(
"confirmations", confirmations);
172 if (blockindex.
pprev)
198 const bool is_not_pruned{
WITH_LOCK(
::cs_main,
return !blockman.IsBlockPruned(blockindex))};
200 if (have_undo && !blockman.
ReadBlockUndo(blockUndo, blockindex)) {
201 throw JSONRPCError(
RPC_INTERNAL_ERROR,
"Undo data expected but can't be read. This could be due to disk corruption or a conflict with a pruning event.");
203 for (
size_t i = 0; i < block.
vtx.size(); ++i) {
206 const CTxUndo* txundo = (have_undo && i > 0) ? &blockUndo.
vtxundo.at(i - 1) :
nullptr;
214 result.
pushKV(
"tx", std::move(txs));
222 "\nReturns the height of the most-work fully-validated chain.\n"
223 "The genesis block has height 0.\n",
243 "\nReturns the hash of the best (tip) block in the most-work fully-validated chain.\n",
263 "\nWaits for any new block and returns useful info about it.\n"
264 "\nReturns the current block on timeout or exit.\n"
265 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
282 if (!request.params[0].isNull())
283 timeout = request.params[0].
getInt<
int>();
295 ret.pushKV(
"hash", block.hash.GetHex());
296 ret.pushKV(
"height", block.height);
305 "\nWaits for a specific new block and returns useful info about it.\n"
306 "\nReturns the current block on timeout or exit.\n"
307 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
319 HelpExampleCli(
"waitforblock",
"\"0000000000079f8ef3d2c688c244eb7a4570b24c9ed7b4a8c619eb02596f8862\" 1000")
320 +
HelpExampleRpc(
"waitforblock",
"\"0000000000079f8ef3d2c688c244eb7a4570b24c9ed7b4a8c619eb02596f8862\", 1000")
328 if (!request.params[1].isNull())
329 timeout = request.params[1].getInt<
int>();
336 const auto deadline{std::chrono::steady_clock::now() + 1ms * timeout};
339 auto now{std::chrono::steady_clock::now()};
340 if (now >= deadline)
break;
349 ret.pushKV(
"hash", block.hash.GetHex());
350 ret.pushKV(
"height", block.height);
359 "\nWaits for (at least) block height and returns the height and hash\n"
360 "of the current tip.\n"
361 "\nReturns the current block on timeout or exit.\n"
362 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
381 int height = request.params[0].
getInt<
int>();
383 if (!request.params[1].isNull())
384 timeout = request.params[1].getInt<
int>();
391 const auto deadline{std::chrono::steady_clock::now() + 1ms * timeout};
395 auto now{std::chrono::steady_clock::now()};
396 if (now >= deadline)
break;
405 ret.pushKV(
"hash", block.hash.GetHex());
406 ret.pushKV(
"height", block.height);
414 return RPCHelpMan{
"syncwithvalidationinterfacequeue",
415 "\nWaits for the validation interface queue to catch up on everything that was there when we entered this function.\n",
434 "\nReturns the proof-of-work difficulty as a multiple of the minimum difficulty.\n",
437 RPCResult::Type::NUM,
"",
"the proof-of-work difficulty as a multiple of the minimum difficulty."},
455 "Attempt to fetch block from a given peer.\n\n"
456 "We must have the header for this block, e.g. using submitheader.\n"
457 "The block will not have any undo data which can limit the usage of the block data in a context where the undo data is needed.\n"
458 "Subsequent calls for the same block may cause the response from the previous peer to be ignored.\n"
459 "Peers generally ignore requests for a stale block that they never fully verified, or one that is more than a month old.\n"
460 "When a peer does not respond with a block, we will disconnect.\n"
461 "Note: The block could be re-pruned as soon as it is received.\n\n"
462 "Returns an empty JSON object if the request was successfully scheduled.",
469 HelpExampleCli(
"getblockfrompeer",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" 0")
470 +
HelpExampleRpc(
"getblockfrompeer",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" 0")
479 const NodeId peer_id{request.params[1].getInt<int64_t>()};
490 throw JSONRPCError(
RPC_MISC_ERROR,
"In prune mode, only blocks that the node has already synced previously can be fetched from a peer");
494 if (block_has_data) {
498 if (
const auto err{peerman.
FetchBlock(peer_id, *index)}) {
509 "\nReturns hash of block in best-block-chain at height provided.\n",
525 int nHeight = request.params[0].getInt<
int>();
526 if (nHeight < 0 || nHeight > active_chain.
Height())
538 "\nIf verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'.\n"
539 "If verbose is true, returns an Object with information about blockheader <hash>.\n",
549 {
RPCResult::Type::NUM,
"confirmations",
"The number of confirmations, or -1 if the block is not on the main chain"},
569 HelpExampleCli(
"getblockheader",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
570 +
HelpExampleRpc(
"getblockheader",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
576 bool fVerbose =
true;
577 if (!request.params[1].isNull())
578 fVerbose = request.params[1].get_bool();
597 std::string strHex =
HexStr(ssBlock);
610 if (!(blockindex.nStatus & flag)) {
611 if (blockman.IsBlockPruned(blockindex)) {
614 if (check_for_undo) {
629 if (!blockman.
ReadBlock(block, blockindex)) {
640 std::vector<uint8_t>
data{};
662 if (blockindex.
nHeight == 0)
return blockUndo;
692 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
703 "\nIf verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.\n"
704 "If verbosity is 1, returns an Object with information about block <hash>.\n"
705 "If verbosity is 2, returns an Object with information about block <hash> and information about each transaction.\n"
706 "If verbosity is 3, returns an Object with information about block <hash> and information about each transaction, including prevout information for inputs (only for unpruned blocks in the current best chain).\n",
709 {
"verbosity|verbose",
RPCArg::Type::NUM,
RPCArg::Default{1},
"0 for hex-encoded data, 1 for a JSON object, 2 for JSON object with transaction data, and 3 for JSON object with transaction data including prevout information for inputs",
719 {
RPCResult::Type::NUM,
"confirmations",
"The number of confirmations, or -1 if the block is not on the main chain"},
735 {
RPCResult::Type::STR_HEX,
"chainwork",
"Expected number of hashes required to produce the chain up to this block (in hex)"},
748 {
RPCResult::Type::ELISION,
"",
"The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 \"tx\" result"},
767 HelpExampleCli(
"getblock",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
768 +
HelpExampleRpc(
"getblock",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
791 if (verbosity <= 0) {
792 return HexStr(block_data);
800 if (verbosity == 1) {
802 }
else if (verbosity == 2) {
824 if (!first_block || !chain_tip)
return std::nullopt;
830 if (&first_unpruned == first_block) {
844 " to prune blocks whose block time is at least 2 hours older than the provided timestamp."},
863 int heightParam = request.params[0].getInt<
int>();
864 if (heightParam < 0) {
870 if (heightParam > 1000000000) {
879 unsigned int height = (
unsigned int) heightParam;
880 unsigned int chainHeight = (
unsigned int) active_chain.
Height();
883 }
else if (height > chainHeight) {
886 LogDebug(
BCLog::RPC,
"Attempt to prune blocks close to the tip. Retaining the minimum number of blocks.\n");
898 if (hash_type_input ==
"hash_serialized_3") {
899 return CoinStatsHashType::HASH_SERIALIZED;
900 }
else if (hash_type_input ==
"muhash") {
901 return CoinStatsHashType::MUHASH;
902 }
else if (hash_type_input ==
"none") {
916 const std::function<
void()>& interruption_point = {},
918 bool index_requested =
true)
942 "\nReturns statistics about the unspent transaction output set.\n"
943 "Note this call may take some time if you are not using coinstatsindex.\n",
945 {
"hash_type",
RPCArg::Type::STR,
RPCArg::Default{
"hash_serialized_3"},
"Which UTXO set hash should be calculated. Options: 'hash_serialized_3' (the legacy algorithm), 'muhash', 'none'."},
949 .type_str = {
"",
"string or numeric"},
959 {
RPCResult::Type::NUM,
"bogosize",
"Database-independent, meaningless metric indicating the UTXO set size"},
960 {
RPCResult::Type::STR_HEX,
"hash_serialized_3",
true,
"The serialized hash (only present if 'hash_serialized_3' hash_type is chosen)"},
962 {
RPCResult::Type::NUM,
"transactions",
true,
"The number of transactions with unspent outputs (not available when coinstatsindex is used)"},
963 {
RPCResult::Type::NUM,
"disk_size",
true,
"The estimated size of the chainstate on disk (not available when coinstatsindex is used)"},
965 {
RPCResult::Type::STR_AMOUNT,
"total_unspendable_amount",
true,
"The total amount of coins permanently excluded from the UTXO set (only available if coinstatsindex is used)"},
966 {
RPCResult::Type::OBJ,
"block_info",
true,
"Info on amounts in the block at this block height (only available if coinstatsindex is used)",
985 HelpExampleCli("gettxoutsetinfo", R
"("none" '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"')") +
986 HelpExampleCli("-named gettxoutsetinfo", R
"(hash_type='muhash' use_index='false')") +
990 HelpExampleRpc("gettxoutsetinfo", R
"("none", "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09")")
998 bool index_requested = request.params[2].isNull() || request.params[2].get_bool();
1009 coins_view = &active_chainstate.
CoinsDB();
1014 if (!request.params[1].isNull()) {
1019 if (hash_type == CoinStatsHashType::HASH_SERIALIZED) {
1023 if (!index_requested) {
1035 if (pindex->
nHeight > summary.best_block_height) {
1041 const std::optional<CCoinsStats> maybe_stats =
GetUTXOStats(coins_view, *blockman, hash_type,
node.rpc_interruption_point, pindex, index_requested);
1042 if (maybe_stats.has_value()) {
1044 ret.pushKV(
"height", (int64_t)stats.
nHeight);
1048 if (hash_type == CoinStatsHashType::HASH_SERIALIZED) {
1051 if (hash_type == CoinStatsHashType::MUHASH) {
1064 const std::optional<CCoinsStats> maybe_prev_stats =
GetUTXOStats(coins_view, *blockman, hash_type,
node.rpc_interruption_point, pindex->
pprev, index_requested);
1065 if (!maybe_prev_stats) {
1068 prev_stats = maybe_prev_stats.value();
1082 block_info.
pushKV(
"unspendables", std::move(unspendables));
1084 ret.pushKV(
"block_info", std::move(block_info));
1097 "\nReturns details about an unspent transaction output.\n",
1101 {
"include_mempool",
RPCArg::Type::BOOL,
RPCArg::Default{
true},
"Whether to include the mempool. Note that an unspent output that is spent in the mempool won't appear."},
1114 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
1120 "\nGet unspent transactions\n"
1122 "\nView the details\n"
1124 "\nAs a JSON-RPC call\n"
1136 COutPoint out{hash, request.params[1].getInt<uint32_t>()};
1137 bool fMempool =
true;
1138 if (!request.params[2].isNull())
1139 fMempool = request.params[2].get_bool();
1144 std::optional<Coin> coin;
1158 ret.pushKV(
"confirmations", 0);
1160 ret.pushKV(
"confirmations", (int64_t)(pindex->
nHeight - coin->nHeight + 1));
1165 ret.pushKV(
"scriptPubKey", std::move(o));
1166 ret.pushKV(
"coinbase", (
bool)coin->fCoinBase);
1176 "\nVerifies blockchain database.\n",
1183 RPCResult::Type::BOOL,
"",
"Verification finished successfully. If false, check debug.log for reason."},
1191 const int check_depth{request.params[1].isNull() ?
DEFAULT_CHECKBLOCKS : request.params[1].getInt<
int>()};
1210 rv.
pushKV(
"type",
"buried");
1223 if (blockindex ==
nullptr)
return;
1225 auto get_state_name = [](
const ThresholdState state) -> std::string {
1252 bip9.
pushKV(
"status", get_state_name(current_state));
1254 bip9.
pushKV(
"status_next", get_state_name(next_state));
1259 std::vector<bool> signals;
1268 bip9.
pushKV(
"statistics", std::move(statsUV));
1271 sig.reserve(signals.size());
1272 for (
const bool s : signals) {
1273 sig.push_back(
s ?
'#' :
'-');
1275 bip9.
pushKV(
"signalling", sig);
1279 rv.
pushKV(
"type",
"bip9");
1284 rv.
pushKV(
"bip9", std::move(bip9));
1293 "Returns an object containing various state info regarding blockchain processing.\n",
1299 {
RPCResult::Type::NUM,
"blocks",
"the height of the most-work fully-validated chain. The genesis block has height 0"},
1308 {
RPCResult::Type::BOOL,
"initialblockdownload",
"(debug information) estimate of whether this node is in Initial Block Download mode"},
1310 {
RPCResult::Type::NUM,
"size_on_disk",
"the estimated size of the block and undo files on disk"},
1312 {
RPCResult::Type::NUM,
"pruneheight",
true,
"height of the last block pruned, plus one (only present if pruning is enabled)"},
1313 {
RPCResult::Type::BOOL,
"automatic_pruning",
true,
"whether automatic pruning is enabled (only present if pruning is enabled)"},
1314 {
RPCResult::Type::NUM,
"prune_target_size",
true,
"the target size used by pruning (only present if automatic pruning is enabled)"},
1315 {
RPCResult::Type::STR_HEX,
"signet_challenge",
true,
"the block challenge (aka. block script), in hexadecimal (only present if the current network is a signet)"},
1318 RPCResult{
RPCResult::Type::ARR,
"warnings",
"any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",
1336 const int height{tip.
nHeight};
1339 obj.
pushKV(
"blocks", height);
1340 obj.
pushKV(
"headers", chainman.m_best_header ? chainman.m_best_header->nHeight : -1);
1354 obj.
pushKV(
"pruneheight", prune_height ? prune_height.value() + 1 : 0);
1357 obj.
pushKV(
"automatic_pruning", automatic_pruning);
1358 if (automatic_pruning) {
1363 const std::vector<uint8_t>& signet_challenge =
1365 obj.
pushKV(
"signet_challenge",
HexStr(signet_challenge));
1376const std::vector<RPCResult> RPCHelpForDeployment{
1378 {
RPCResult::Type::NUM,
"height",
true,
"height of the first block which the rules are or will be enforced (only for \"buried\" type, or \"bip9\" type with \"active\" status)"},
1379 {
RPCResult::Type::BOOL,
"active",
"true if the rules are enforced for the mempool and the next block"},
1382 {
RPCResult::Type::NUM,
"bit",
true,
"the bit (0-28) in the block version field used to signal this softfork (only for \"started\" and \"locked_in\" status)"},
1383 {
RPCResult::Type::NUM_TIME,
"start_time",
"the minimum median time past of a block at which the bit gains its meaning"},
1384 {
RPCResult::Type::NUM_TIME,
"timeout",
"the median time past of a block at which the deployment is considered failed if not yet locked in"},
1385 {
RPCResult::Type::NUM,
"min_activation_height",
"minimum height of blocks for which the rules may be enforced"},
1386 {
RPCResult::Type::STR,
"status",
"status of deployment at specified block (one of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\")"},
1389 {
RPCResult::Type::OBJ,
"statistics",
true,
"numeric statistics about signalling for a softfork (only for \"started\" and \"locked_in\" status)",
1392 {
RPCResult::Type::NUM,
"threshold",
true,
"the number of blocks with the version bit set required to activate the feature (only for \"started\" status)"},
1393 {
RPCResult::Type::NUM,
"elapsed",
"the number of blocks elapsed since the beginning of the current period"},
1394 {
RPCResult::Type::NUM,
"count",
"the number of blocks with the version bit set in the current period"},
1395 {
RPCResult::Type::BOOL,
"possible",
true,
"returns false if there are not enough blocks left in this period to pass activation threshold (only for \"started\" status)"},
1397 {
RPCResult::Type::STR,
"signalling",
true,
"indicates blocks that signalled with a # and blocks that did not with a -"},
1418 "Returns an object containing various state info regarding deployments of consensus changes.",
1439 if (request.params[0].isNull()) {
1452 deploymentinfo.
pushKV(
"deployments", DeploymentInfo(blockindex, chainman));
1453 return deploymentinfo;
1476 "Return information about all known tips in the block tree,"
1477 " including the main chain as well as orphaned branches.\n",
1485 {
RPCResult::Type::NUM,
"branchlen",
"zero for main chain, otherwise length of branch connecting the tip to the main chain"},
1487 "Possible values for status:\n"
1488 "1. \"invalid\" This branch contains at least one invalid block\n"
1489 "2. \"headers-only\" Not all blocks for this branch are available, but the headers are valid\n"
1490 "3. \"valid-headers\" All blocks are available for this branch, but they were never fully validated\n"
1491 "4. \"valid-fork\" This branch is not part of the active chain, but is fully validated\n"
1492 "5. \"active\" This is the tip of the active main chain, which is certainly valid"},
1511 std::set<const CBlockIndex*, CompareBlocksByHeight> setTips;
1512 std::set<const CBlockIndex*> setOrphans;
1513 std::set<const CBlockIndex*> setPrevs;
1515 for (
const auto& [
_, block_index] : chainman.
BlockIndex()) {
1516 if (!active_chain.
Contains(&block_index)) {
1517 setOrphans.insert(&block_index);
1518 setPrevs.insert(block_index.pprev);
1522 for (std::set<const CBlockIndex*>::iterator it = setOrphans.begin(); it != setOrphans.end(); ++it) {
1523 if (setPrevs.erase(*it) == 0) {
1524 setTips.insert(*it);
1529 setTips.insert(active_chain.
Tip());
1535 obj.
pushKV(
"height", block->nHeight);
1536 obj.
pushKV(
"hash", block->phashBlock->GetHex());
1538 const int branchLen = block->nHeight - active_chain.
FindFork(block)->
nHeight;
1539 obj.
pushKV(
"branchlen", branchLen);
1542 if (active_chain.
Contains(block)) {
1548 }
else if (!block->HaveNumChainTxs()) {
1550 status =
"headers-only";
1553 status =
"valid-fork";
1556 status =
"valid-headers";
1561 obj.
pushKV(
"status", status);
1574 "\nTreats a block as if it were received before others with the same work.\n"
1575 "\nA later preciousblock call can override the effect of an earlier one.\n"
1576 "\nThe effects of preciousblock are not retained across restarts.\n",
1635 "\nPermanently marks a block as invalid, as if it violated a consensus rule.\n",
1665 chainman.RecalculateBestHeader();
1679 "\nRemoves invalidity status of a block, its ancestors and its descendants, reconsider them for activation.\n"
1680 "This can be used to undo the effects of invalidateblock.\n",
1704 "\nCompute statistics about the total number and rate of transactions in the chain.\n",
1714 "The total number of transactions in the chain up to that point, if known. "
1715 "It may be unknown when using assumeutxo."},
1717 {
RPCResult::Type::NUM,
"window_final_block_height",
"The height of the final block in the window."},
1719 {
RPCResult::Type::NUM,
"window_interval",
true,
"The elapsed time in the window in seconds. Only returned if \"window_block_count\" is > 0"},
1721 "The number of transactions in the window. "
1722 "Only returned if \"window_block_count\" is > 0 and if txcount exists for the start and end of the window."},
1724 "The average rate of transactions per second in the window. "
1725 "Only returned if \"window_interval\" is > 0 and if window_tx_count exists."},
1737 if (request.params[1].isNull()) {
1754 if (request.params[0].isNull()) {
1755 blockcount = std::max(0, std::min(blockcount, pindex->
nHeight - 1));
1757 blockcount = request.params[0].getInt<
int>();
1759 if (blockcount < 0 || (blockcount > 0 && blockcount >= pindex->
nHeight)) {
1765 const int64_t nTimeDiff{pindex->
GetMedianTimePast() - past_block.GetMedianTimePast()};
1768 ret.pushKV(
"time", (int64_t)pindex->
nTime);
1773 ret.pushKV(
"window_final_block_height", pindex->
nHeight);
1774 ret.pushKV(
"window_block_count", blockcount);
1775 if (blockcount > 0) {
1776 ret.pushKV(
"window_interval", nTimeDiff);
1778 const auto window_tx_count = pindex->
m_chain_tx_count - past_block.m_chain_tx_count;
1779 ret.pushKV(
"window_tx_count", window_tx_count);
1780 if (nTimeDiff > 0) {
1781 ret.pushKV(
"txrate",
double(window_tx_count) / nTimeDiff);
1794 size_t size = scores.size();
1799 std::sort(scores.begin(), scores.end());
1800 if (size % 2 == 0) {
1801 return (scores[size / 2 - 1] + scores[size / 2]) / 2;
1803 return scores[size / 2];
1809 if (scores.empty()) {
1813 std::sort(scores.begin(), scores.end());
1817 total_weight / 10.0, total_weight / 4.0, total_weight / 2.0, (total_weight * 3.0) / 4.0, (total_weight * 9.0) / 10.0
1820 int64_t next_percentile_index = 0;
1821 int64_t cumulative_weight = 0;
1822 for (
const auto& element : scores) {
1823 cumulative_weight += element.second;
1824 while (next_percentile_index < NUM_GETBLOCKSTATS_PERCENTILES && cumulative_weight >= weights[next_percentile_index]) {
1825 result[next_percentile_index] = element.first;
1826 ++next_percentile_index;
1832 result[i] = scores.back().first;
1837static inline bool SetHasKeys(
const std::set<T>& set) {
return false;}
1838template<
typename T,
typename Tk,
typename... Args>
1839static inline bool SetHasKeys(
const std::set<T>& set,
const Tk& key,
const Args&...
args)
1850 "\nCompute per block statistics for a given window. All amounts are in satoshis.\n"
1851 "It won't work for some heights with pruning.\n",
1856 .type_str = {
"",
"string or numeric"},
1872 {
RPCResult::Type::ARR_FIXED,
"feerate_percentiles",
true,
"Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)",
1897 {
RPCResult::Type::NUM,
"total_out",
true,
"Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])"},
1902 {
RPCResult::Type::NUM,
"utxo_increase",
true,
"The increase/decrease in the number of unspent outputs (not discounting op_return and similar)"},
1903 {
RPCResult::Type::NUM,
"utxo_size_inc",
true,
"The increase/decrease in size for the utxo index (not discounting op_return and similar)"},
1904 {
RPCResult::Type::NUM,
"utxo_increase_actual",
true,
"The increase/decrease in the number of unspent outputs, not counting unspendables"},
1905 {
RPCResult::Type::NUM,
"utxo_size_inc_actual",
true,
"The increase/decrease in size for the utxo index, not counting unspendables"},
1908 HelpExampleCli(
"getblockstats", R
"('"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' '["minfeerate","avgfeerate"]')") +
1909 HelpExampleCli("getblockstats", R
"(1000 '["minfeerate","avgfeerate"]')") +
1910 HelpExampleRpc("getblockstats", R
"("00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", ["minfeerate","avgfeerate"])") +
1911 HelpExampleRpc("getblockstats", R
"(1000, ["minfeerate","avgfeerate"])")
1918 std::set<std::string> stats;
1919 if (!request.params[1].isNull()) {
1921 for (
unsigned int i = 0; i < stats_univalue.
size(); i++) {
1922 const std::string stat = stats_univalue[i].
get_str();
1930 const bool do_all = stats.size() == 0;
1931 const bool do_mediantxsize = do_all || stats.count(
"mediantxsize") != 0;
1932 const bool do_medianfee = do_all || stats.count(
"medianfee") != 0;
1933 const bool do_feerate_percentiles = do_all || stats.count(
"feerate_percentiles") != 0;
1934 const bool loop_inputs = do_all || do_medianfee || do_feerate_percentiles ||
1935 SetHasKeys(stats,
"utxo_increase",
"utxo_increase_actual",
"utxo_size_inc",
"utxo_size_inc_actual",
"totalfee",
"avgfee",
"avgfeerate",
"minfee",
"maxfee",
"minfeerate",
"maxfeerate");
1936 const bool loop_outputs = do_all || loop_inputs || stats.count(
"total_out");
1937 const bool do_calculate_size = do_mediantxsize ||
1938 SetHasKeys(stats,
"total_size",
"avgtxsize",
"mintxsize",
"maxtxsize",
"swtotal_size");
1939 const bool do_calculate_weight = do_all ||
SetHasKeys(stats,
"total_weight",
"avgfeerate",
"swtotal_weight",
"avgfeerate",
"feerate_percentiles",
"minfeerate",
"maxfeerate");
1940 const bool do_calculate_sw = do_all ||
SetHasKeys(stats,
"swtxs",
"swtotal_size",
"swtotal_weight");
1949 int64_t maxtxsize = 0;
1951 int64_t outputs = 0;
1952 int64_t swtotal_size = 0;
1953 int64_t swtotal_weight = 0;
1955 int64_t total_size = 0;
1956 int64_t total_weight = 0;
1958 int64_t utxo_size_inc = 0;
1959 int64_t utxo_size_inc_actual = 0;
1960 std::vector<CAmount> fee_array;
1961 std::vector<std::pair<CAmount, int64_t>> feerate_array;
1962 std::vector<int64_t> txsize_array;
1964 for (
size_t i = 0; i < block.
vtx.size(); ++i) {
1965 const auto& tx = block.
vtx.at(i);
1966 outputs += tx->vout.size();
1971 tx_total_out +=
out.nValue;
1974 utxo_size_inc += out_size;
1980 if (
out.scriptPubKey.IsUnspendable())
continue;
1983 utxo_size_inc_actual += out_size;
1987 if (tx->IsCoinBase()) {
1991 inputs += tx->vin.size();
1992 total_out += tx_total_out;
1994 int64_t tx_size = 0;
1995 if (do_calculate_size) {
1997 tx_size = tx->GetTotalSize();
1998 if (do_mediantxsize) {
1999 txsize_array.push_back(tx_size);
2001 maxtxsize = std::max(maxtxsize, tx_size);
2002 mintxsize = std::min(mintxsize, tx_size);
2003 total_size += tx_size;
2007 if (do_calculate_weight) {
2009 total_weight += weight;
2012 if (do_calculate_sw && tx->HasWitness()) {
2014 swtotal_size += tx_size;
2015 swtotal_weight += weight;
2020 const auto& txundo = blockUndo.
vtxundo.at(i - 1);
2021 for (
const Coin& coin: txundo.vprevout) {
2024 tx_total_in += prevoutput.
nValue;
2026 utxo_size_inc -= prevout_size;
2027 utxo_size_inc_actual -= prevout_size;
2030 CAmount txfee = tx_total_in - tx_total_out;
2033 fee_array.push_back(txfee);
2035 maxfee = std::max(maxfee, txfee);
2036 minfee = std::min(minfee, txfee);
2041 if (do_feerate_percentiles) {
2042 feerate_array.emplace_back(feerate, weight);
2044 maxfeerate = std::max(maxfeerate, feerate);
2045 minfeerate = std::min(minfeerate, feerate);
2054 feerates_res.
push_back(feerate_percentiles[i]);
2058 ret_all.
pushKV(
"avgfee", (block.
vtx.size() > 1) ? totalfee / (block.
vtx.size() - 1) : 0);
2060 ret_all.
pushKV(
"avgtxsize", (block.
vtx.size() > 1) ? total_size / (block.
vtx.size() - 1) : 0);
2062 ret_all.
pushKV(
"feerate_percentiles", std::move(feerates_res));
2064 ret_all.
pushKV(
"ins", inputs);
2065 ret_all.
pushKV(
"maxfee", maxfee);
2066 ret_all.
pushKV(
"maxfeerate", maxfeerate);
2067 ret_all.
pushKV(
"maxtxsize", maxtxsize);
2072 ret_all.
pushKV(
"minfeerate", (minfeerate ==
MAX_MONEY) ? 0 : minfeerate);
2074 ret_all.
pushKV(
"outs", outputs);
2076 ret_all.
pushKV(
"swtotal_size", swtotal_size);
2077 ret_all.
pushKV(
"swtotal_weight", swtotal_weight);
2078 ret_all.
pushKV(
"swtxs", swtxs);
2080 ret_all.
pushKV(
"total_out", total_out);
2081 ret_all.
pushKV(
"total_size", total_size);
2082 ret_all.
pushKV(
"total_weight", total_weight);
2083 ret_all.
pushKV(
"totalfee", totalfee);
2084 ret_all.
pushKV(
"txs", (int64_t)block.
vtx.size());
2085 ret_all.
pushKV(
"utxo_increase", outputs - inputs);
2086 ret_all.
pushKV(
"utxo_size_inc", utxo_size_inc);
2087 ret_all.
pushKV(
"utxo_increase_actual", utxos - inputs);
2088 ret_all.
pushKV(
"utxo_size_inc_actual", utxo_size_inc_actual);
2095 for (
const std::string& stat : stats) {
2096 const UniValue& value = ret_all[stat];
2100 ret.pushKV(stat, value);
2109bool FindScriptPubKey(std::atomic<int>& scan_progress,
const std::atomic<bool>& should_abort, int64_t&
count,
CCoinsViewCursor* cursor,
const std::set<CScript>& needles, std::map<COutPoint, Coin>& out_results, std::function<
void()>& interruption_point)
2113 while (cursor->
Valid()) {
2116 if (!cursor->
GetKey(key) || !cursor->
GetValue(coin))
return false;
2117 if (++
count % 8192 == 0) {
2118 interruption_point();
2124 if (
count % 256 == 0) {
2127 scan_progress = (int)(high * 100.0 / 65536.0 + 0.5);
2130 out_results.emplace(key, coin);
2134 scan_progress = 100;
2170 "\"start\" for starting a scan\n"
2171 "\"abort\" for aborting the current scan (returns true when abort was successful)\n"
2172 "\"status\" for progress report (in %) of the current scan"
2177 "Every scan object is either a string descriptor or an object:",
2191 "True if scan will be aborted (not necessarily before this RPC returns), or false if there is no scan to abort"
2194 "when action=='status' and no scan is in progress - possibly already completed",
RPCResult::Type::NONE,
"",
""
2205 const std::string EXAMPLE_DESCRIPTOR_RAW =
"raw(76a91411b366edfc0a8b66feebae5c2e25a7b6a5d1cf3188ac)#fm24fxxy";
2208 "\nScans the unspent transaction output set for entries that match certain output descriptors.\n"
2209 "Examples of output descriptors are:\n"
2210 " addr(<address>) Outputs whose output script corresponds to the specified address (does not include P2PK)\n"
2211 " raw(<hex script>) Outputs whose output script equals the specified hex-encoded bytes\n"
2212 " combo(<pubkey>) P2PK, P2PKH, P2WPKH, and P2SH-P2WPKH outputs for the given pubkey\n"
2213 " pkh(<pubkey>) P2PKH outputs for the given pubkey\n"
2214 " sh(multi(<n>,<pubkey>,<pubkey>,...)) P2SH-multisig outputs for the given threshold and pubkeys\n"
2215 " tr(<pubkey>) P2TR\n"
2216 " tr(<pubkey>,{pk(<pubkey>)}) P2TR with single fallback pubkey in tapscript\n"
2217 " rawtr(<pubkey>) P2TR with the specified key as output key rather than inner\n"
2218 " wsh(and_v(v:pk(<pubkey>),after(2))) P2WSH miniscript with mandatory pubkey and a timelock\n"
2219 "\nIn the above, <pubkey> either refers to a fixed public key in hexadecimal notation, or to an xpub/xprv optionally followed by one\n"
2220 "or more path elements separated by \"/\", and optionally ending in \"/*\" (unhardened), or \"/*'\" or \"/*h\" (hardened) to specify all\n"
2221 "unhardened or hardened child keys.\n"
2222 "In the latter case, a range needs to be specified by below if different from 1000.\n"
2223 "For more information on output descriptors, see the documentation in the doc/descriptors.md file.\n",
2246 {
RPCResult::Type::NUM,
"confirmations",
"Number of confirmations of the unspent transaction output when the scan was done"},
2256 HelpExampleCli(
"scantxoutset",
"start \'[\"" + EXAMPLE_DESCRIPTOR_RAW +
"\"]\'") +
2259 HelpExampleRpc(
"scantxoutset",
"\"start\", [\"" + EXAMPLE_DESCRIPTOR_RAW +
"\"]") +
2266 const auto action{self.
Arg<std::string>(
"action")};
2267 if (action ==
"status") {
2275 }
else if (action ==
"abort") {
2284 }
else if (action ==
"start") {
2290 if (request.params.size() < 2) {
2294 std::set<CScript> needles;
2295 std::map<CScript, std::string> descriptors;
2305 descriptors.emplace(std::move(
script), std::move(inferred));
2311 std::vector<CTxOut> input_txos;
2312 std::map<COutPoint, Coin> coins;
2315 std::unique_ptr<CCoinsViewCursor> pcursor;
2327 result.
pushKV(
"success", res);
2332 for (
const auto& it : coins) {
2334 const Coin& coin = it.second;
2337 input_txos.push_back(txo);
2342 unspent.
pushKV(
"vout", outpoint.
n);
2348 unspent.
pushKV(
"blockhash", coinb_block.GetBlockHash().GetHex());
2353 result.
pushKV(
"unspents", std::move(unspents));
2397 for (
const auto& tx : block.vtx) {
2398 if (std::any_of(tx->vout.cbegin(), tx->vout.cend(), [&](
const auto& txout) {
2399 return needles.count(std::vector<unsigned char>(txout.scriptPubKey.begin(), txout.scriptPubKey.end())) != 0;
2405 for (
const auto& txundo : block_undo.vtxundo) {
2406 if (std::any_of(txundo.vprevout.cbegin(), txundo.vprevout.cend(), [&](
const auto& coin) {
2407 return needles.count(std::vector<unsigned char>(coin.out.scriptPubKey.begin(), coin.out.scriptPubKey.end())) != 0;
2419 "\nReturn relevant blockhashes for given descriptors (requires blockfilterindex).\n"
2420 "This call may take several minutes. Make sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2429 {
"filter_false_positives",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"Filter false positives (slower and may fail on pruned nodes). Otherwise they may occur at a rate of 1/M"},
2451 HelpExampleCli(
"scanblocks",
"start '[\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"]' 300000") +
2452 HelpExampleCli(
"scanblocks",
"start '[\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"]' 100 150 basic") +
2454 HelpExampleRpc(
"scanblocks",
"\"start\", [\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"], 300000") +
2455 HelpExampleRpc(
"scanblocks",
"\"start\", [\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"], 100, 150, \"basic\"") +
2461 if (request.params[0].get_str() ==
"status") {
2470 }
else if (request.params[0].get_str() ==
"abort") {
2479 }
else if (request.params[0].get_str() ==
"start") {
2484 const std::string filtertype_name{request.params[4].isNull() ?
"basic" : request.params[4].get_str()};
2492 bool filter_false_positives{options.exists(
"filter_false_positives") ? options[
"filter_false_positives"].get_bool() :
false};
2508 start_index = active_chain.
Genesis();
2509 stop_block = active_chain.
Tip();
2510 if (!request.params[2].isNull()) {
2511 start_index = active_chain[request.params[2].getInt<
int>()];
2516 if (!request.params[3].isNull()) {
2517 stop_block = active_chain[request.params[3].getInt<
int>()];
2536 const int amount_per_chunk = 10000;
2537 std::vector<BlockFilter> filters;
2538 int start_block_height = start_index->
nHeight;
2539 const int total_blocks_to_process = stop_block->
nHeight - start_block_height;
2544 bool completed =
true;
2548 node.rpc_interruption_point();
2555 int start_block = !end_range ? start_index->
nHeight : start_index->
nHeight + 1;
2556 end_range = (start_block + amount_per_chunk < stop_block->
nHeight) ?
2563 if (filter.GetFilter().MatchAny(needle_set)) {
2564 if (filter_false_positives) {
2573 blocks.
push_back(filter.GetBlockHash().GetHex());
2577 start_index = end_range;
2580 int blocks_processed = end_range->
nHeight - start_block_height;
2581 if (total_blocks_to_process > 0) {
2589 }
while (start_index != stop_block);
2591 ret.pushKV(
"from_height", start_block_height);
2592 ret.pushKV(
"to_height", start_index->
nHeight);
2593 ret.pushKV(
"relevant_blocks", std::move(blocks));
2594 ret.pushKV(
"completed", completed);
2607 "\nGet spend and receive activity associated with a set of descriptors for a set of blocks. "
2608 "This command pairs well with the `relevant_blocks` output of `scanblocks()`.\n"
2609 "This call may take several minutes. If you encounter timeouts, try specifying no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2645 HelpExampleCli(
"getdescriptoractivity",
"'[\"000000000000000000001347062c12fded7c528943c8ce133987e2e2f5a840ee\"]' '[\"addr(bc1qzl6nsgqzu89a66l50cvwapnkw5shh23zarqkw9)\"]'")
2654 struct CompareByHeightAscending {
2660 std::set<const CBlockIndex*, CompareByHeightAscending> blockindexes_sorted;
2674 blockindexes_sorted.insert(pindex);
2678 std::set<CScript> scripts_to_watch;
2686 scripts_to_watch.insert(
script);
2690 const auto AddSpend = [&](
2702 event.pushKV(
"type",
"spend");
2705 event.pushKV(
"blockhash", index->GetBlockHash().ToString());
2706 event.pushKV(
"height", index->nHeight);
2708 event.pushKV(
"spend_txid", tx->GetHash().ToString());
2709 event.pushKV(
"spend_vin", vin);
2710 event.pushKV(
"prevout_txid", txin.prevout.hash.ToString());
2711 event.pushKV(
"prevout_vout", txin.prevout.n);
2712 event.pushKV(
"prevout_spk", spkUv);
2722 event.pushKV(
"type",
"receive");
2725 event.pushKV(
"blockhash", index->GetBlockHash().ToString());
2726 event.pushKV(
"height", index->nHeight);
2728 event.pushKV(
"txid", tx->GetHash().ToString());
2729 event.pushKV(
"vout", vout);
2730 event.pushKV(
"output_spk", spkUv);
2742 for (
const CBlockIndex* blockindex : blockindexes_sorted) {
2746 for (
size_t i = 0; i < block.vtx.size(); ++i) {
2747 const auto& tx = block.vtx.at(i);
2749 if (!tx->IsCoinBase()) {
2751 const auto& txundo = block_undo.
vtxundo.at(i - 1);
2753 for (
size_t vin_idx = 0; vin_idx < tx->vin.size(); ++vin_idx) {
2754 const auto& coin = txundo.vprevout.at(vin_idx);
2755 const auto& txin = tx->vin.at(vin_idx);
2763 for (
size_t vout_idx = 0; vout_idx < tx->vout.size(); ++vout_idx) {
2764 const auto& vout = tx->vout.at(vout_idx);
2765 if (scripts_to_watch.contains(vout.scriptPubKey)) {
2766 activity.
push_back(AddReceive(vout, blockindex, vout_idx, tx));
2772 bool search_mempool =
true;
2773 if (!request.params[2].isNull()) {
2774 search_mempool = request.params[2].get_bool();
2777 if (search_mempool) {
2784 const auto& tx = e.GetSharedTx();
2786 for (
size_t vin_idx = 0; vin_idx < tx->vin.size(); ++vin_idx) {
2789 const auto& txin = tx->vin.at(vin_idx);
2790 std::optional<Coin> coin = coins_view.
GetCoin(txin.prevout);
2798 if (txin.prevout.n >= prev_tx->vout.size()) {
2799 throw std::runtime_error(
"Invalid output index");
2801 const CTxOut&
out = prev_tx->vout[txin.prevout.n];
2802 scriptPubKey =
out.scriptPubKey;
2807 scriptPubKey =
out.scriptPubKey;
2811 if (scripts_to_watch.contains(scriptPubKey)) {
2814 scriptPubKey, value, tx, vin_idx, txin,
nullptr));
2818 for (
size_t vout_idx = 0; vout_idx < tx->vout.size(); ++vout_idx) {
2819 const auto& vout = tx->vout.at(vout_idx);
2820 if (scripts_to_watch.contains(vout.scriptPubKey)) {
2821 activity.
push_back(AddReceive(vout,
nullptr, vout_idx, tx));
2827 ret.pushKV(
"activity", activity);
2836 "\nRetrieve a BIP 157 content filter for a particular block.\n",
2848 HelpExampleCli(
"getblockfilter",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" \"basic\"") +
2849 HelpExampleRpc(
"getblockfilter",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\", \"basic\"")
2855 if (!request.params[1].isNull()) {
2856 filtertype_name = request.params[1].get_str();
2870 bool block_was_connected;
2881 bool index_ready = index->BlockUntilSyncedToCurrentChain();
2888 std::string errmsg =
"Filter not found.";
2890 if (!block_was_connected) {
2892 errmsg +=
" Block was not connected to active chain.";
2893 }
else if (!index_ready) {
2895 errmsg +=
" Block filters are still in the process of being indexed.";
2898 errmsg +=
" This error is unexpected and indicates index corruption.";
2906 ret.pushKV(
"header", filter_header.
GetHex());
2957 "Write the serialized UTXO set to a file. This can be used in loadtxoutset afterwards if this snapshot height is supported in the chainparams as well.\n\n"
2958 "Unless the \"latest\" type is requested, the node will roll back to the requested height and network activity will be suspended during this process. "
2959 "Because of this it is discouraged to interact with the node in any other way during the execution of this call to avoid inconsistent results and race conditions, particularly RPCs that interact with blockstorage.\n\n"
2960 "This call may take several minutes. Make sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2963 {
"type",
RPCArg::Type::STR,
RPCArg::Default(
""),
"The type of snapshot to create. Can be \"latest\" to create a snapshot of the current UTXO set or \"rollback\" to temporarily roll back the state of the node to a historical block before creating the snapshot of a historical UTXO set. This parameter can be omitted if a separate \"rollback\" named parameter is specified indicating the height or hash of a specific historical block. If \"rollback\" is specified and separate \"rollback\" named parameter is not specified, this will roll back to the latest valid snapshot block that can currently be loaded with loadtxoutset."},
2967 "Height or hash of the block to roll back to before creating the snapshot. Note: The further this number is from the tip, the longer this process will take. Consider setting a higher -rpcclienttimeout value in this case.",
2980 {
RPCResult::Type::NUM,
"nchaintx",
"the number of transactions in the chain up to and including the base block"},
2984 HelpExampleCli(
"-rpcclienttimeout=0 dumptxoutset",
"utxo.dat latest") +
2985 HelpExampleCli(
"-rpcclienttimeout=0 dumptxoutset",
"utxo.dat rollback") +
2986 HelpExampleCli(
"-rpcclienttimeout=0 -named dumptxoutset", R
"(utxo.dat rollback=853456)")
2993 const std::string snapshot_type{self.
Arg<std::string>(
"type")};
2995 if (options.exists(
"rollback")) {
2996 if (!snapshot_type.empty() && snapshot_type !=
"rollback") {
3000 }
else if (snapshot_type ==
"rollback") {
3001 auto snapshot_heights =
node.chainman->GetParams().GetAvailableSnapshotHeights();
3003 auto max_height = std::max_element(snapshot_heights.begin(), snapshot_heights.end());
3005 }
else if (snapshot_type ==
"latest") {
3020 path.
utf8string() +
" already exists. If you are sure this is what you want, "
3021 "move it out of the way first");
3029 "Couldn't open file " + temppath.
utf8string() +
" for writing.");
3034 std::optional<NetworkDisable> disable_network;
3035 std::optional<TemporaryRollback> temporary_rollback;
3039 if (target_index != tip) {
3042 if (
node.chainman->m_blockman.IsPruneMode()) {
3046 if (first_block->nHeight > target_index->nHeight) {
3060 disable_network.emplace(connman);
3064 temporary_rollback.emplace(*
node.chainman, *invalidate_index);
3068 std::unique_ptr<CCoinsViewCursor> cursor;
3078 chainstate = &
node.chainman->ActiveChainstate();
3085 if (target_index != chainstate->
m_chain.
Tip()) {
3086 LogWarning(
"dumptxoutset failed to roll back to requested height, reverting to tip.\n");
3094 fs::rename(temppath, path);
3105 const std::function<
void()>& interruption_point)
3107 std::unique_ptr<CCoinsViewCursor> pcursor;
3108 std::optional<CCoinsStats> maybe_stats;
3148 const std::function<
void()>& interruption_point)
3161 unsigned int iter{0};
3162 size_t written_coins_count{0};
3163 std::vector<std::pair<uint32_t, Coin>> coins;
3172 auto write_coins_to_file = [&](
AutoFile& afile,
const Txid& last_hash,
const std::vector<std::pair<uint32_t, Coin>>& coins,
size_t& written_coins_count) {
3175 for (
const auto& [n, coin] : coins) {
3178 ++written_coins_count;
3183 last_hash = key.
hash;
3184 while (pcursor->
Valid()) {
3185 if (iter % 5000 == 0) interruption_point();
3188 if (key.
hash != last_hash) {
3189 write_coins_to_file(afile, last_hash, coins, written_coins_count);
3190 last_hash = key.
hash;
3193 coins.emplace_back(key.
n, coin);
3198 if (!coins.empty()) {
3199 write_coins_to_file(afile, last_hash, coins, written_coins_count);
3207 result.
pushKV(
"coins_written", written_coins_count);
3224 return WriteUTXOSnapshot(chainstate, cursor.get(), &stats, tip, afile, path, tmppath,
node.rpc_interruption_point);
3231 "Load the serialized UTXO set from a file.\n"
3232 "Once this snapshot is loaded, its contents will be "
3233 "deserialized into a second chainstate data structure, which is then used to sync to "
3234 "the network's tip. "
3235 "Meanwhile, the original chainstate will complete the initial block download process in "
3236 "the background, eventually validating up to the block that the snapshot is based upon.\n\n"
3238 "The result is a usable bitcoind instance that is current with the network tip in a "
3239 "matter of minutes rather than hours. UTXO snapshot are typically obtained from "
3240 "third-party sources (HTTP, torrent, etc.) which is reasonable since their "
3241 "contents are always checked by hash.\n\n"
3243 "You can find more information on this process in the `assumeutxo` design "
3244 "document (<https://github.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo.md>).",
3249 "path to the snapshot file. If relative, will be prefixed by datadir."},
3274 "Couldn't open file " + path.
utf8string() +
" for reading.");
3280 }
catch (
const std::ios_base::failure& e) {
3285 if (!activation_result) {
3299 result.
pushKV(
"coins_loaded", metadata.m_coins_count);
3300 result.
pushKV(
"tip_hash", snapshot_index.GetBlockHash().ToString());
3301 result.
pushKV(
"base_height", snapshot_index.nHeight);
3315 {
RPCResult::Type::STR_HEX,
"snapshot_blockhash",
true,
"the base block of the snapshot this chainstate is based on, if any"},
3318 {
RPCResult::Type::BOOL,
"validated",
"whether the chainstate is fully validated. True if all blocks in the chainstate were validated, false if the chain is based on a snapshot and the snapshot has not yet been validated."},
3325 "\nReturn information about chainstates.\n",
3347 if (!
cs.m_chain.Tip()) {
3359 data.pushKV(
"coins_db_cache_bytes",
cs.m_coinsdb_cache_size_bytes);
3360 data.pushKV(
"coins_tip_cache_bytes",
cs.m_coinstip_cache_size_bytes);
3361 if (
cs.m_from_snapshot_blockhash) {
3362 data.pushKV(
"snapshot_blockhash",
cs.m_from_snapshot_blockhash->ToString());
3364 data.pushKV(
"validated", validated);
3368 obj.
pushKV(
"headers", chainman.m_best_header ? chainman.m_best_header->nHeight : -1);
3370 const auto& chainstates = chainman.
GetAll();
3373 obj_chainstates.push_back(make_chain_data(*
cs, !
cs->m_from_snapshot_blockhash || chainstates.size() == 1));
3375 obj.
pushKV(
"chainstates", std::move(obj_chainstates));
3416 for (
const auto& c : commands) {
3417 t.appendCommand(c.name, &c);
static constexpr CAmount MAX_MONEY
No amount larger than this (in satoshi) is valid.
bool MoneyRange(const CAmount &nValue)
int64_t CAmount
Amount in satoshis (Can be negative)
fs::path AbsPathForConfigVal(const ArgsManager &args, const fs::path &path, bool net_specific=true)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
static RPCHelpMan getblock()
static RPCHelpMan getdifficulty()
static const auto scan_result_abort
static std::atomic< bool > g_scan_in_progress
static bool SetHasKeys(const std::set< T > &set)
static RPCHelpMan reconsiderblock()
static T CalculateTruncatedMedian(std::vector< T > &scores)
static RPCHelpMan invalidateblock()
static int ComputeNextBlockAndDepth(const CBlockIndex &tip, const CBlockIndex &blockindex, const CBlockIndex *&next)
const RPCResult getblock_vin
static RPCHelpMan syncwithvalidationinterfacequeue()
static CBlockUndo GetUndoChecked(BlockManager &blockman, const CBlockIndex &blockindex)
static RPCHelpMan getchaintips()
static RPCHelpMan loadtxoutset()
static RPCHelpMan gettxoutsetinfo()
static RPCHelpMan getchainstates()
std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot(Chainstate &chainstate, const std::function< void()> &interruption_point)
static std::atomic< int > g_scanfilter_progress_height
static RPCHelpMan getblockstats()
void CheckBlockDataAvailability(BlockManager &blockman, const CBlockIndex &blockindex, bool check_for_undo)
static std::atomic< bool > g_scanfilter_should_abort_scan
static std::atomic< int > g_scanfilter_progress
RAII object to prevent concurrency issue when scanning blockfilters.
static void SoftForkDescPushBack(const CBlockIndex *blockindex, UniValue &softforks, const ChainstateManager &chainman, Consensus::BuriedDeployment dep)
static RPCHelpMan preciousblock()
static constexpr size_t PER_UTXO_OVERHEAD
static RPCHelpMan getdescriptoractivity()
double GetDifficulty(const CBlockIndex &blockindex)
Get the difficulty of the net wrt to the given block index.
static const auto scan_objects_arg_desc
static RPCHelpMan scantxoutset()
CoinStatsHashType ParseHashType(const std::string &hash_type_input)
static bool CheckBlockFilterMatches(BlockManager &blockman, const CBlockIndex &blockindex, const GCSFilter::ElementSet &needles)
void InvalidateBlock(ChainstateManager &chainman, const uint256 block_hash)
static std::atomic< int > g_scan_progress
RAII object to prevent concurrency issue when scanning the txout set.
static CBlock GetBlockChecked(BlockManager &blockman, const CBlockIndex &blockindex)
std::optional< int > GetPruneHeight(const BlockManager &blockman, const CChain &chain)
Return height of highest block that has been pruned, or std::nullopt if no blocks have been pruned.
UniValue blockToJSON(BlockManager &blockman, const CBlock &block, const CBlockIndex &tip, const CBlockIndex &blockindex, TxVerbosity verbosity, const uint256 pow_limit)
Block description to JSON.
RPCHelpMan getdeploymentinfo()
static RPCHelpMan getblockfilter()
static RPCHelpMan getbestblockhash()
RPCHelpMan getblockchaininfo()
void ReconsiderBlock(ChainstateManager &chainman, uint256 block_hash)
static RPCHelpMan getchaintxstats()
UniValue CreateUTXOSnapshot(node::NodeContext &node, Chainstate &chainstate, AutoFile &afile, const fs::path &path, const fs::path &tmppath)
Test-only helper to create UTXO snapshots given a chainstate and a file handle.
static RPCHelpMan waitforblock()
std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot(Chainstate &chainstate, const std::function< void()> &interruption_point={}) EXCLUSIVE_LOCKS_REQUIRED(UniValue WriteUTXOSnapshot(Chainstate &chainstate, CCoinsViewCursor *pcursor, CCoinsStats *maybe_stats, const CBlockIndex *tip, AutoFile &afile, const fs::path &path, const fs::path &temppath, const std::function< void()> &interruption_point={})
UniValue blockheaderToJSON(const CBlockIndex &tip, const CBlockIndex &blockindex, const uint256 pow_limit)
Block header to JSON.
static RPCHelpMan getblockfrompeer()
static const auto scan_result_status_some
static RPCHelpMan getblockhash()
void RegisterBlockchainRPCCommands(CRPCTable &t)
void CalculatePercentilesByWeight(CAmount result[NUM_GETBLOCKSTATS_PERCENTILES], std::vector< std::pair< CAmount, int64_t > > &scores, int64_t total_weight)
Used by getblockstats to get feerates at different percentiles by weight
static std::optional< kernel::CCoinsStats > GetUTXOStats(CCoinsView *view, node::BlockManager &blockman, kernel::CoinStatsHashType hash_type, const std::function< void()> &interruption_point={}, const CBlockIndex *pindex=nullptr, bool index_requested=true)
Calculate statistics about the unspent transaction output set.
static RPCHelpMan gettxout()
static RPCHelpMan verifychain()
static std::atomic< bool > g_should_abort_scan
const std::vector< RPCResult > RPCHelpForChainstate
static const auto scan_action_arg_desc
static RPCHelpMan waitforblockheight()
static const CBlockIndex * ParseHashOrHeight(const UniValue ¶m, ChainstateManager &chainman)
static RPCHelpMan pruneblockchain()
static RPCHelpMan getblockheader()
static RPCHelpMan scanblocks()
static std::atomic< bool > g_scanfilter_in_progress
static RPCHelpMan dumptxoutset()
Serialize the UTXO set to a file for loading elsewhere.
static std::vector< uint8_t > GetRawBlockChecked(BlockManager &blockman, const CBlockIndex &blockindex)
static RPCHelpMan getblockcount()
static RPCHelpMan waitfornewblock()
static const auto scan_result_status_none
static constexpr int NUM_GETBLOCKSTATS_PERCENTILES
const std::string & BlockFilterTypeName(BlockFilterType filter_type)
Get the human-readable name for a filter type.
bool BlockFilterTypeByName(const std::string &name, BlockFilterType &filter_type)
Find a filter type by its human-readable name.
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
@ BLOCK_VALID_SCRIPTS
Scripts & signatures ok.
@ BLOCK_VALID_TREE
All parent headers found, difficulty matches, timestamp >= median previous, checkpoint.
@ BLOCK_HAVE_UNDO
undo data available in rev*.dat
@ BLOCK_HAVE_DATA
full block available in blk*.dat
static constexpr int64_t TIMESTAMP_WINDOW
Timestamp window used as a grace period by code that compares external timestamps (such as timestamps...
#define LIST_CHAIN_NAMES
List of possible chain / network names
#define CHECK_NONFATAL(condition)
Identity function.
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Non-refcounted RAII wrapper for FILE*.
bool IsNull() const
Return true if the wrapped FILE* is nullptr, false otherwise.
Complete block filter struct as defined in BIP 157.
const std::vector< unsigned char > & GetEncodedFilter() const LIFETIMEBOUND
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
bool LookupFilterRange(int start_height, const CBlockIndex *stop_index, std::vector< BlockFilter > &filters_out) const
Get a range of filters between two heights on a chain.
bool LookupFilter(const CBlockIndex *block_index, BlockFilter &filter_out) const
Get a single filter by block.
bool LookupFilterHeader(const CBlockIndex *block_index, uint256 &header_out) EXCLUSIVE_LOCKS_REQUIRED(!m_cs_headers_cache)
Get a single filter header by block.
BlockFiltersScanReserver()=default
~BlockFiltersScanReserver()
std::vector< CTransactionRef > vtx
The block chain is a tree shaped structure starting with the genesis block at the root,...
CBlockIndex * pprev
pointer to the index of the predecessor of this block
uint64_t m_chain_tx_count
(memory only) Number of transactions in the chain up to and including this block.
CBlockHeader GetBlockHeader() const
arith_uint256 nChainWork
(memory only) Total amount of work (expected number of hashes) in the chain up to and including this ...
uint256 GetBlockHash() const
int64_t GetBlockTime() const
int64_t GetMedianTimePast() const
unsigned int nTx
Number of transactions in this block.
bool IsValid(enum BlockStatus nUpTo=BLOCK_VALID_TRANSACTIONS) const EXCLUSIVE_LOCKS_REQUIRED(
Check whether this block index entry is valid up to the passed validity level.
int32_t nVersion
block header
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
int nHeight
height of the entry in the chain. The genesis block has height 0
FlatFilePos GetBlockPos() const EXCLUSIVE_LOCKS_REQUIRED(
Undo information for a CBlock.
std::vector< CTxUndo > vtxundo
An in-memory indexed chain of blocks.
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
CBlockIndex * FindEarliestAtLeast(int64_t nTime, int height) const
Find the earliest block with timestamp equal or greater than the given time and height equal or great...
int Height() const
Return the maximal height in the chain.
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
std::string GetChainTypeString() const
Return the chain type string.
const MessageStartChars & MessageStart() const
const Consensus::Params & GetConsensus() const
uint64_t PruneAfterHeight() const
ChainType GetChainType() const
Return the chain type.
CCoinsView that adds a memory cache for transactions to another CCoinsView.
uint256 GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
Retrieve the Coin (unspent transaction output) for a given outpoint.
Cursor for iterating over CoinsView state.
virtual bool Valid() const =0
virtual bool GetKey(COutPoint &key) const =0
virtual bool GetValue(Coin &coin) const =0
std::unique_ptr< CCoinsViewCursor > Cursor() const override
Get a cursor to iterate over the whole state.
Abstract view on the open txout dataset.
virtual uint256 GetBestBlock() const
Retrieve the block hash whose state this CCoinsView currently represents.
CCoinsView that brings transactions from a mempool into view.
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
GetCoin, returning whether it exists and is not spent.
bool GetNetworkActive() const
void SetNetworkActive(bool active)
An outpoint - a combination of a transaction hash and an index n into its vout.
Serialized script, used inside transaction inputs and outputs.
An input of a transaction.
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
CTransactionRef get(const uint256 &hash) const
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
bool isSpent(const COutPoint &outpoint) const
An output of a transaction.
Undo information for a CTransaction.
RAII wrapper for VerifyDB: Verify consistency of the block and coin databases.
VerifyDBResult VerifyDB(Chainstate &chainstate, const Consensus::Params &consensus_params, CCoinsView &coinsview, int nCheckLevel, int nCheckDepth) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Chainstate stores and provides an API to update our local knowledge of the current best chain.
CChain m_chain
The current chain of blockheaders we consult and build on.
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
void ForceFlushStateToDisk()
Unconditionally flush all changes to disk.
CCoinsViewDB & CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(
ChainstateManager & m_chainman
The chainstate manager that owns this chainstate.
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances.
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(Chainstate ActiveChainstate)() const
Once the background validation chainstate has reached the height which is the base of the UTXO snapsh...
double GuessVerificationProgress(const CBlockIndex *pindex) const
Guess verification progress (as a fraction between 0.0=genesis and 1.0=current tip).
kernel::Notifications & GetNotifications() const
bool IsInitialBlockDownload() const
Check whether we are doing an initial block download (synchronizing from disk or network)
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
VersionBitsCache m_versionbitscache
Track versionbit status.
const CChainParams & GetParams() const
const Consensus::Params & GetConsensus() const
util::Result< CBlockIndex * > ActivateSnapshot(AutoFile &coins_file, const node::SnapshotMetadata &metadata, bool in_memory)
Construct and activate a Chainstate on the basis of UTXO snapshot data.
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
CTxOut out
unspent transaction output
uint32_t nHeight
at which height this containing transaction was included in the active block chain
CoinsViewScanReserver()=default
Double ended buffer combining vector and stream-like interfaces.
std::unordered_set< Element, ByteVectorHash > ElementSet
RAII class that disables the network in its constructor and enables it in its destructor.
NetworkDisable(CConnman &connman)
virtual std::optional< std::string > FetchBlock(NodeId peer_id, const CBlockIndex &block_index)=0
Attempt to manually fetch block from a given peer.
auto Arg(std::string_view key) const
Helper to get a required or default-valued request argument.
RAII class that temporarily rolls back the local chain in it's constructor and rolls it forward again...
TemporaryRollback(ChainstateManager &chainman, const CBlockIndex &index)
const CBlockIndex & m_invalidate_index
ChainstateManager & m_chainman
void push_back(UniValue val)
const std::string & get_str() const
const std::vector< UniValue > & getValues() const
const UniValue & get_array() const
void pushKV(std::string key, UniValue val)
std::string ToString() const
int StateSinceHeight(const CBlockIndex *pindexPrev, const Consensus::Params ¶ms, Consensus::DeploymentPos pos) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Get the block height at which the BIP9 deployment switched into the state for the block after pindexP...
static BIP9Stats Statistics(const CBlockIndex *pindex, const Consensus::Params ¶ms, Consensus::DeploymentPos pos, std::vector< bool > *signalling_blocks=nullptr)
Get the numerical statistics for a given deployment for the signalling period that includes pindex.
ThresholdState State(const CBlockIndex *pindexPrev, const Consensus::Params ¶ms, Consensus::DeploymentPos pos) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Get the BIP9 state for a given deployment for the block after pindexPrev.
std::string ToString() const
std::string GetHex() const
std::string GetHex() const
Hex encoding of the number (with the most significant digits first).
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
std::string utf8string() const
Return a UTF-8 representation of the path as a std::string, for compatibility with code using std::st...
Interface giving clients (RPC, Stratum v2 Template Provider in the future) ability to create block te...
virtual std::optional< BlockRef > getTip()=0
Returns the hash and height for the tip of this chain.
virtual BlockRef waitTipChanged(uint256 current_tip, MillisecondsDouble timeout=MillisecondsDouble::max())=0
Waits for the connected tip to change.
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
bool ReadRawBlock(std::vector< uint8_t > &block, const FlatFilePos &pos) const
uint64_t GetPruneTarget() const
Attempt to stay below this number of bytes of block files.
uint64_t CalculateCurrentUsage()
Calculate the amount of disk space the block & undo files currently use.
bool IsPruneMode() const
Whether running in -prune mode.
bool ReadBlock(CBlock &block, const FlatFilePos &pos) const
Functions for disk access for blocks.
constexpr const std::byte * begin() const
std::string GetHex() const
static transaction_identifier FromUint256(const uint256 &id)
std::unique_ptr< CoinStatsIndex > g_coin_stats_index
The global UTXO set hash object.
static int64_t GetBlockWeight(const CBlock &block)
static int32_t GetTransactionWeight(const CTransaction &tx)
static const unsigned int MAX_BLOCK_SERIALIZED_SIZE
The maximum allowed size for a serialized block, in bytes (only for buffer size limits)
static const int WITNESS_SCALE_FACTOR
void TxToUniv(const CTransaction &tx, const uint256 &block_hash, UniValue &entry, bool include_hex=true, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS)
TxVerbosity
Verbose level for block's transaction.
@ SHOW_DETAILS_AND_PREVOUT
The same as previous option with information about prevouts if available.
@ SHOW_TXID
Only TXID for each block's transaction.
@ SHOW_DETAILS
Include TXID, inputs, outputs, and other common block's transaction information.
void ScriptToUniv(const CScript &script, UniValue &out, bool include_hex=true, bool include_address=false, const SigningProvider *provider=nullptr)
UniValue ValueFromAmount(const CAmount amount)
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
std::string DeploymentName(Consensus::BuriedDeployment dep)
bool DeploymentActiveAfter(const CBlockIndex *pindexPrev, const Consensus::Params ¶ms, Consensus::BuriedDeployment dep, VersionBitsCache &versionbitscache)
Determine if a deployment is active for the next block.
bool DeploymentEnabled(const Consensus::Params ¶ms, Consensus::BuriedDeployment dep)
Determine if a deployment is enabled (can ever be active)
const std::string CURRENCY_UNIT
#define T(expected, seed, data)
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
#define LogDebug(category,...)
BuriedDeployment
A buried deployment is one where the height of the activation has been hardcoded into the client impl...
static path u8path(const std::string &utf8_str)
static bool exists(const path &p)
static std::string PathToString(const path &path)
Convert path object to a byte string.
FILE * fopen(const fs::path &p, const char *mode)
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
static bool ComputeUTXOStats(CCoinsView *view, CCoinsStats &stats, T hash_obj, const std::function< void()> &interruption_point)
Calculate statistics about the unspent transaction output set.
UniValue GetWarningsForRpc(const Warnings &warnings, bool use_deprecated)
RPC helper function that wraps warnings.GetMessages().
bilingual_str ErrorString(const Result< T > &result)
std::string MakeUnorderedList(const std::vector< std::string > &items)
Create an unordered multi-line list of items.
static constexpr TransactionSerParams TX_NO_WITNESS
static constexpr TransactionSerParams TX_WITH_WITNESS
std::shared_ptr< const CTransaction > CTransactionRef
UniValue JSONRPCError(int code, const std::string &message)
@ RPC_MISC_ERROR
General application defined errors.
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
@ RPC_DATABASE_ERROR
Database error.
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
std::vector< CScript > EvalDescriptorStringOrObject(const UniValue &scanobject, FlatSigningProvider &provider, const bool expand_priv)
Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range ...
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
uint256 GetTarget(const CBlockIndex &blockindex, const uint256 pow_limit)
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency.
std::string GetAllOutputTypes()
Gets all existing output types formatted for RPC help sections.
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
std::vector< RPCResult > ScriptPubKeyDoc()
std::unique_ptr< Descriptor > InferDescriptor(const CScript &script, const SigningProvider &provider)
Find a descriptor for the specified script, using information from provider where possible.
size_t GetSerializeSize(const T &t)
void WriteCompactSize(SizeComputer &os, uint64_t nSize)
bool IsDeprecatedRPCEnabled(const std::string &method)
bool IsRPCRunning()
Query whether RPC is running.
ChainstateManager & EnsureAnyChainman(const std::any &context)
NodeContext & EnsureAnyNodeContext(const std::any &context)
CTxMemPool & EnsureMemPool(const NodeContext &node)
PeerManager & EnsurePeerman(const NodeContext &node)
ChainstateManager & EnsureChainman(const NodeContext &node)
ArgsManager & EnsureArgsman(const NodeContext &node)
interfaces::Mining & EnsureMining(const NodeContext &node)
CConnman & EnsureConnman(const NodeContext &node)
ArgsManager & EnsureAnyArgsman(const std::any &context)
unsigned char * UCharCast(char *c)
Display status of an in-progress BIP9 softfork.
int count
Number of blocks with the version bit set since the beginning of the current period.
int elapsed
Number of blocks elapsed since the beginning of the current period.
int threshold
Number of blocks with the version bit set required to activate the softfork.
bool possible
False if there are not enough blocks left in this period to pass activation threshold.
int period
Length of blocks of the BIP9 signalling period.
Comparison function for sorting the getchaintips heads.
bool operator()(const CBlockIndex *a, const CBlockIndex *b) const
int min_activation_height
If lock in occurs, delay activation until at least this block height.
int bit
Bit position to select the particular bit in nVersion.
int64_t nTimeout
Timeout/expiry MedianTime for the deployment attempt.
int64_t nStartTime
Start MedianTime for version bits miner confirmation.
std::vector< uint8_t > signet_challenge
BIP9Deployment vDeployments[MAX_VERSION_BITS_DEPLOYMENTS]
uint256 powLimit
Proof of work parameters.
int DeploymentHeight(BuriedDeployment dep) const
int64_t nPowTargetSpacing
@ RANGE
Special type that is a NUM or [NUM,NUM].
@ STR_HEX
Special type that is a STR with only hex chars.
@ OBJ_NAMED_PARAMS
Special type that behaves almost exactly like OBJ, defining an options object with a list of pre-defi...
std::string DefaultHint
Hint for default value.
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
UniValue Default
Default constant value.
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
@ ELISION
Special type to denote elision (...)
@ NUM_TIME
Special numeric to denote unix epoch time.
@ ARR_FIXED
Special array that has a fixed number of entries.
@ OBJ_DYN
Special dictionary with keys that are not literals.
@ STR_HEX
Special string with only hex chars.
@ STR_AMOUNT
Special string to represent a floating point amount.
std::optional< CAmount > total_amount
The total amount, or nullopt if an overflow occurred calculating it.
CAmount total_unspendable_amount
Total cumulative amount of unspendable coins up to and including this block.
CAmount total_unspendables_scripts
Total cumulative amount of outputs sent to unspendable scripts (OP_RETURN for example) up to and incl...
uint64_t coins_count
The number of coins contained.
CAmount total_new_outputs_ex_coinbase_amount
Total cumulative amount of outputs created up to and including this block.
uint64_t nTransactionOutputs
CAmount total_coinbase_amount
Total cumulative amount of coinbase outputs up to and including this block.
bool index_used
Signals if the coinstatsindex was used to retrieve the statistics.
CAmount total_unspendables_bip30
The two unspendable coinbase outputs total amount caused by BIP30.
CAmount total_unspendables_genesis_block
The unspendable coinbase amount from the genesis block.
CAmount total_prevout_spent_amount
Total cumulative amount of prevouts spent up to and including this block.
CAmount total_unspendables_unclaimed_rewards
Total cumulative amount of coins lost due to unclaimed miner rewards up to and including this block.
NodeContext struct containing references to chain state and connection state.
#define AssertLockNotHeld(cs)
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
#define EXCLUSIVE_LOCKS_REQUIRED(...)
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
#define LOG_TIME_SECONDS(end_msg)
consteval auto _(util::TranslatedLiteral str)
static const uint32_t MEMPOOL_HEIGHT
Fake height value used in Coin to signify they are only in the memory pool (since 0....
const UniValue NullUniValue
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
void PruneBlockFilesManual(Chainstate &active_chainstate, int nManualPruneHeight)
Prune block files up to a given height.
bool IsBIP30Repeat(const CBlockIndex &block_index)
Identifies blocks that overwrote an existing coinbase output in the UTXO set (see BIP30)
static constexpr int DEFAULT_CHECKLEVEL
static const unsigned int MIN_BLOCKS_TO_KEEP
Block files containing a block-height within MIN_BLOCKS_TO_KEEP of ActiveChain().Tip() will not be pr...
static const signed int DEFAULT_CHECKBLOCKS
ThresholdState
BIP 9 defines a finite-state-machine to deploy a softfork in multiple stages.