8 #include <blockfilter.h> 10 #include <chainparams.h> 44 #include <txmempool.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) {
842 "Attempts to delete block and undo data up to a specified height or timestamp, if eligible for pruning.\n" 843 "Requires `-prune` to be enabled at startup. While pruned data may be re-fetched in some cases (e.g., via `getblockfrompeer`), local deletion is irreversible.\n",
846 " to prune blocks whose block time is at least 2 hours older than the provided timestamp."},
865 int heightParam = request.params[0].getInt<
int>();
866 if (heightParam < 0) {
872 if (heightParam > 1000000000) {
881 unsigned int height = (
unsigned int) heightParam;
882 unsigned int chainHeight = (
unsigned int) active_chain.
Height();
885 }
else if (height > chainHeight) {
888 LogDebug(
BCLog::RPC,
"Attempt to prune blocks close to the tip. Retaining the minimum number of blocks.\n");
900 if (hash_type_input ==
"hash_serialized_3") {
901 return CoinStatsHashType::HASH_SERIALIZED;
902 }
else if (hash_type_input ==
"muhash") {
903 return CoinStatsHashType::MUHASH;
904 }
else if (hash_type_input ==
"none") {
918 const std::function<
void()>& interruption_point = {},
920 bool index_requested =
true)
944 "\nReturns statistics about the unspent transaction output set.\n" 945 "Note this call may take some time if you are not using coinstatsindex.\n",
947 {
"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'."},
951 .type_str = {
"",
"string or numeric"},
961 {
RPCResult::Type::NUM,
"bogosize",
"Database-independent, meaningless metric indicating the UTXO set size"},
962 {
RPCResult::Type::STR_HEX,
"hash_serialized_3",
true,
"The serialized hash (only present if 'hash_serialized_3' hash_type is chosen)"},
964 {
RPCResult::Type::NUM,
"transactions",
true,
"The number of transactions with unspent outputs (not available when coinstatsindex is used)"},
965 {
RPCResult::Type::NUM,
"disk_size",
true,
"The estimated size of the chainstate on disk (not available when coinstatsindex is used)"},
967 {
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)"},
968 {
RPCResult::Type::OBJ,
"block_info",
true,
"Info on amounts in the block at this block height (only available if coinstatsindex is used)",
987 HelpExampleCli("gettxoutsetinfo", R
"("none" '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"')") + 988 HelpExampleCli("-named gettxoutsetinfo", R
"(hash_type='muhash' use_index='false')") + 992 HelpExampleRpc("gettxoutsetinfo", R
"("none", "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09")") 1000 bool index_requested = request.params[2].isNull() || request.params[2].get_bool();
1011 coins_view = &active_chainstate.
CoinsDB();
1016 if (!request.params[1].isNull()) {
1021 if (hash_type == CoinStatsHashType::HASH_SERIALIZED) {
1025 if (!index_requested) {
1037 if (pindex->
nHeight > summary.best_block_height) {
1043 const std::optional<CCoinsStats> maybe_stats =
GetUTXOStats(coins_view, *blockman, hash_type,
node.rpc_interruption_point, pindex, index_requested);
1044 if (maybe_stats.has_value()) {
1046 ret.pushKV(
"height", (int64_t)stats.
nHeight);
1050 if (hash_type == CoinStatsHashType::HASH_SERIALIZED) {
1053 if (hash_type == CoinStatsHashType::MUHASH) {
1066 const std::optional<CCoinsStats> maybe_prev_stats =
GetUTXOStats(coins_view, *blockman, hash_type,
node.rpc_interruption_point, pindex->
pprev, index_requested);
1067 if (!maybe_prev_stats) {
1070 prev_stats = maybe_prev_stats.value();
1084 block_info.
pushKV(
"unspendables", std::move(unspendables));
1086 ret.pushKV(
"block_info", std::move(block_info));
1099 "\nReturns details about an unspent transaction output.\n",
1103 {
"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."},
1116 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
1122 "\nGet unspent transactions\n" 1124 "\nView the details\n" 1126 "\nAs a JSON-RPC call\n" 1138 COutPoint out{hash, request.params[1].getInt<uint32_t>()};
1139 bool fMempool =
true;
1140 if (!request.params[2].isNull())
1141 fMempool = request.params[2].get_bool();
1146 std::optional<Coin> coin;
1160 ret.pushKV(
"confirmations", 0);
1162 ret.pushKV(
"confirmations", (int64_t)(pindex->
nHeight - coin->nHeight + 1));
1167 ret.pushKV(
"scriptPubKey", std::move(o));
1168 ret.pushKV(
"coinbase", (
bool)coin->fCoinBase);
1178 "\nVerifies blockchain database.\n",
1185 RPCResult::Type::BOOL,
"",
"Verification finished successfully. If false, check debug.log for reason."},
1193 const int check_depth{request.params[1].isNull() ?
DEFAULT_CHECKBLOCKS : request.params[1].getInt<
int>()};
1212 rv.
pushKV(
"type",
"buried");
1225 if (blockindex ==
nullptr)
return;
1227 auto get_state_name = [](
const ThresholdState state) -> std::string {
1254 bip9.
pushKV(
"status", get_state_name(current_state));
1256 bip9.
pushKV(
"status_next", get_state_name(next_state));
1261 std::vector<bool> signals;
1270 bip9.
pushKV(
"statistics", std::move(statsUV));
1273 sig.reserve(signals.size());
1274 for (
const bool s : signals) {
1275 sig.push_back(
s ?
'#' :
'-');
1277 bip9.
pushKV(
"signalling", sig);
1281 rv.
pushKV(
"type",
"bip9");
1286 rv.
pushKV(
"bip9", std::move(bip9));
1295 "Returns an object containing various state info regarding blockchain processing.\n",
1301 {
RPCResult::Type::NUM,
"blocks",
"the height of the most-work fully-validated chain. The genesis block has height 0"},
1310 {
RPCResult::Type::BOOL,
"initialblockdownload",
"(debug information) estimate of whether this node is in Initial Block Download mode"},
1312 {
RPCResult::Type::NUM,
"size_on_disk",
"the estimated size of the block and undo files on disk"},
1314 {
RPCResult::Type::NUM,
"pruneheight",
true,
"height of the last block pruned, plus one (only present if pruning is enabled)"},
1315 {
RPCResult::Type::BOOL,
"automatic_pruning",
true,
"whether automatic pruning is enabled (only present if pruning is enabled)"},
1316 {
RPCResult::Type::NUM,
"prune_target_size",
true,
"the target size used by pruning (only present if automatic pruning is enabled)"},
1317 {
RPCResult::Type::STR_HEX,
"signet_challenge",
true,
"the block challenge (aka. block script), in hexadecimal (only present if the current network is a signet)"},
1320 RPCResult{
RPCResult::Type::ARR,
"warnings",
"any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",
1338 const int height{tip.
nHeight};
1341 obj.
pushKV(
"blocks", height);
1342 obj.
pushKV(
"headers", chainman.m_best_header ? chainman.m_best_header->nHeight : -1);
1356 obj.
pushKV(
"pruneheight", prune_height ? prune_height.value() + 1 : 0);
1359 obj.
pushKV(
"automatic_pruning", automatic_pruning);
1360 if (automatic_pruning) {
1365 const std::vector<uint8_t>& signet_challenge =
1367 obj.
pushKV(
"signet_challenge",
HexStr(signet_challenge));
1378 const std::vector<RPCResult> RPCHelpForDeployment{
1380 {
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)"},
1381 {
RPCResult::Type::BOOL,
"active",
"true if the rules are enforced for the mempool and the next block"},
1384 {
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)"},
1385 {
RPCResult::Type::NUM_TIME,
"start_time",
"the minimum median time past of a block at which the bit gains its meaning"},
1386 {
RPCResult::Type::NUM_TIME,
"timeout",
"the median time past of a block at which the deployment is considered failed if not yet locked in"},
1387 {
RPCResult::Type::NUM,
"min_activation_height",
"minimum height of blocks for which the rules may be enforced"},
1388 {
RPCResult::Type::STR,
"status",
"status of deployment at specified block (one of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\")"},
1391 {
RPCResult::Type::OBJ,
"statistics",
true,
"numeric statistics about signalling for a softfork (only for \"started\" and \"locked_in\" status)",
1394 {
RPCResult::Type::NUM,
"threshold",
true,
"the number of blocks with the version bit set required to activate the feature (only for \"started\" status)"},
1395 {
RPCResult::Type::NUM,
"elapsed",
"the number of blocks elapsed since the beginning of the current period"},
1396 {
RPCResult::Type::NUM,
"count",
"the number of blocks with the version bit set in the current period"},
1397 {
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)"},
1399 {
RPCResult::Type::STR,
"signalling",
true,
"indicates blocks that signalled with a # and blocks that did not with a -"},
1420 "Returns an object containing various state info regarding deployments of consensus changes.",
1441 if (request.params[0].isNull()) {
1454 deploymentinfo.
pushKV(
"deployments", DeploymentInfo(blockindex, chainman));
1455 return deploymentinfo;
1478 "Return information about all known tips in the block tree," 1479 " including the main chain as well as orphaned branches.\n",
1487 {
RPCResult::Type::NUM,
"branchlen",
"zero for main chain, otherwise length of branch connecting the tip to the main chain"},
1489 "Possible values for status:\n" 1490 "1. \"invalid\" This branch contains at least one invalid block\n" 1491 "2. \"headers-only\" Not all blocks for this branch are available, but the headers are valid\n" 1492 "3. \"valid-headers\" All blocks are available for this branch, but they were never fully validated\n" 1493 "4. \"valid-fork\" This branch is not part of the active chain, but is fully validated\n" 1494 "5. \"active\" This is the tip of the active main chain, which is certainly valid"},
1513 std::set<const CBlockIndex*, CompareBlocksByHeight> setTips;
1514 std::set<const CBlockIndex*> setOrphans;
1515 std::set<const CBlockIndex*> setPrevs;
1517 for (
const auto& [
_, block_index] : chainman.
BlockIndex()) {
1518 if (!active_chain.
Contains(&block_index)) {
1519 setOrphans.insert(&block_index);
1520 setPrevs.insert(block_index.
pprev);
1524 for (std::set<const CBlockIndex*>::iterator it = setOrphans.begin(); it != setOrphans.end(); ++it) {
1525 if (setPrevs.erase(*it) == 0) {
1526 setTips.insert(*it);
1531 setTips.insert(active_chain.
Tip());
1537 obj.
pushKV(
"height", block->nHeight);
1538 obj.
pushKV(
"hash", block->phashBlock->GetHex());
1540 const int branchLen = block->nHeight - active_chain.
FindFork(block)->
nHeight;
1541 obj.
pushKV(
"branchlen", branchLen);
1544 if (active_chain.
Contains(block)) {
1550 }
else if (!block->HaveNumChainTxs()) {
1552 status =
"headers-only";
1555 status =
"valid-fork";
1558 status =
"valid-headers";
1563 obj.
pushKV(
"status", status);
1576 "\nTreats a block as if it were received before others with the same work.\n" 1577 "\nA later preciousblock call can override the effect of an earlier one.\n" 1578 "\nThe effects of preciousblock are not retained across restarts.\n",
1637 "\nPermanently marks a block as invalid, as if it violated a consensus rule.\n",
1667 chainman.RecalculateBestHeader();
1681 "\nRemoves invalidity status of a block, its ancestors and its descendants, reconsider them for activation.\n" 1682 "This can be used to undo the effects of invalidateblock.\n",
1706 "\nCompute statistics about the total number and rate of transactions in the chain.\n",
1716 "The total number of transactions in the chain up to that point, if known. " 1717 "It may be unknown when using assumeutxo."},
1719 {
RPCResult::Type::NUM,
"window_final_block_height",
"The height of the final block in the window."},
1721 {
RPCResult::Type::NUM,
"window_interval",
true,
"The elapsed time in the window in seconds. Only returned if \"window_block_count\" is > 0"},
1723 "The number of transactions in the window. " 1724 "Only returned if \"window_block_count\" is > 0 and if txcount exists for the start and end of the window."},
1726 "The average rate of transactions per second in the window. " 1727 "Only returned if \"window_interval\" is > 0 and if window_tx_count exists."},
1739 if (request.params[1].isNull()) {
1756 if (request.params[0].isNull()) {
1757 blockcount = std::max(0, std::min(blockcount, pindex->
nHeight - 1));
1759 blockcount = request.params[0].getInt<
int>();
1761 if (blockcount < 0 || (blockcount > 0 && blockcount >= pindex->
nHeight)) {
1767 const int64_t nTimeDiff{pindex->
GetMedianTimePast() - past_block.GetMedianTimePast()};
1770 ret.pushKV(
"time", (int64_t)pindex->
nTime);
1775 ret.pushKV(
"window_final_block_height", pindex->
nHeight);
1776 ret.pushKV(
"window_block_count", blockcount);
1777 if (blockcount > 0) {
1778 ret.pushKV(
"window_interval", nTimeDiff);
1780 const auto window_tx_count = pindex->
m_chain_tx_count - past_block.m_chain_tx_count;
1781 ret.pushKV(
"window_tx_count", window_tx_count);
1782 if (nTimeDiff > 0) {
1783 ret.pushKV(
"txrate",
double(window_tx_count) / nTimeDiff);
1793 template<
typename T>
1796 size_t size = scores.size();
1801 std::sort(scores.begin(), scores.end());
1802 if (size % 2 == 0) {
1803 return (scores[size / 2 - 1] + scores[size / 2]) / 2;
1805 return scores[size / 2];
1811 if (scores.empty()) {
1815 std::sort(scores.begin(), scores.end());
1819 total_weight / 10.0, total_weight / 4.0, total_weight / 2.0, (total_weight * 3.0) / 4.0, (total_weight * 9.0) / 10.0
1822 int64_t next_percentile_index = 0;
1823 int64_t cumulative_weight = 0;
1824 for (
const auto& element : scores) {
1825 cumulative_weight += element.second;
1826 while (next_percentile_index < NUM_GETBLOCKSTATS_PERCENTILES && cumulative_weight >= weights[next_percentile_index]) {
1827 result[next_percentile_index] = element.first;
1828 ++next_percentile_index;
1834 result[i] = scores.back().first;
1838 template<
typename T>
1839 static inline bool SetHasKeys(
const std::set<T>&
set) {
return false;}
1840 template<
typename T,
typename Tk,
typename... Args>
1841 static inline bool SetHasKeys(
const std::set<T>&
set,
const Tk& key,
const Args&...
args)
1852 "\nCompute per block statistics for a given window. All amounts are in satoshis.\n" 1853 "It won't work for some heights with pruning.\n",
1858 .type_str = {
"",
"string or numeric"},
1874 {
RPCResult::Type::ARR_FIXED,
"feerate_percentiles",
true,
"Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)",
1899 {
RPCResult::Type::NUM,
"total_out",
true,
"Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])"},
1904 {
RPCResult::Type::NUM,
"utxo_increase",
true,
"The increase/decrease in the number of unspent outputs (not discounting op_return and similar)"},
1905 {
RPCResult::Type::NUM,
"utxo_size_inc",
true,
"The increase/decrease in size for the utxo index (not discounting op_return and similar)"},
1906 {
RPCResult::Type::NUM,
"utxo_increase_actual",
true,
"The increase/decrease in the number of unspent outputs, not counting unspendables"},
1907 {
RPCResult::Type::NUM,
"utxo_size_inc_actual",
true,
"The increase/decrease in size for the utxo index, not counting unspendables"},
1910 HelpExampleCli(
"getblockstats", R
"('"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' '["minfeerate","avgfeerate"]')") + 1911 HelpExampleCli("getblockstats", R
"(1000 '["minfeerate","avgfeerate"]')") + 1912 HelpExampleRpc("getblockstats", R
"("00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", ["minfeerate","avgfeerate"])") + 1913 HelpExampleRpc("getblockstats", R
"(1000, ["minfeerate","avgfeerate"])") 1920 std::set<std::string> stats;
1921 if (!request.params[1].isNull()) {
1923 for (
unsigned int i = 0; i < stats_univalue.
size(); i++) {
1924 const std::string stat = stats_univalue[i].
get_str();
1932 const bool do_all = stats.size() == 0;
1933 const bool do_mediantxsize = do_all || stats.count(
"mediantxsize") != 0;
1934 const bool do_medianfee = do_all || stats.count(
"medianfee") != 0;
1935 const bool do_feerate_percentiles = do_all || stats.count(
"feerate_percentiles") != 0;
1936 const bool loop_inputs = do_all || do_medianfee || do_feerate_percentiles ||
1937 SetHasKeys(stats,
"utxo_increase",
"utxo_increase_actual",
"utxo_size_inc",
"utxo_size_inc_actual",
"totalfee",
"avgfee",
"avgfeerate",
"minfee",
"maxfee",
"minfeerate",
"maxfeerate");
1938 const bool loop_outputs = do_all || loop_inputs || stats.count(
"total_out");
1939 const bool do_calculate_size = do_mediantxsize ||
1940 SetHasKeys(stats,
"total_size",
"avgtxsize",
"mintxsize",
"maxtxsize",
"swtotal_size");
1941 const bool do_calculate_weight = do_all ||
SetHasKeys(stats,
"total_weight",
"avgfeerate",
"swtotal_weight",
"avgfeerate",
"feerate_percentiles",
"minfeerate",
"maxfeerate");
1942 const bool do_calculate_sw = do_all ||
SetHasKeys(stats,
"swtxs",
"swtotal_size",
"swtotal_weight");
1951 int64_t maxtxsize = 0;
1953 int64_t outputs = 0;
1954 int64_t swtotal_size = 0;
1955 int64_t swtotal_weight = 0;
1957 int64_t total_size = 0;
1958 int64_t total_weight = 0;
1960 int64_t utxo_size_inc = 0;
1961 int64_t utxo_size_inc_actual = 0;
1962 std::vector<CAmount> fee_array;
1963 std::vector<std::pair<CAmount, int64_t>> feerate_array;
1964 std::vector<int64_t> txsize_array;
1966 for (
size_t i = 0; i < block.
vtx.size(); ++i) {
1967 const auto& tx = block.
vtx.at(i);
1968 outputs += tx->vout.size();
1973 tx_total_out +=
out.nValue;
1976 utxo_size_inc += out_size;
1982 if (
out.scriptPubKey.IsUnspendable())
continue;
1985 utxo_size_inc_actual += out_size;
1989 if (tx->IsCoinBase()) {
1993 inputs += tx->vin.size();
1994 total_out += tx_total_out;
1996 int64_t tx_size = 0;
1997 if (do_calculate_size) {
1999 tx_size = tx->GetTotalSize();
2000 if (do_mediantxsize) {
2001 txsize_array.push_back(tx_size);
2003 maxtxsize = std::max(maxtxsize, tx_size);
2004 mintxsize = std::min(mintxsize, tx_size);
2005 total_size += tx_size;
2009 if (do_calculate_weight) {
2011 total_weight += weight;
2014 if (do_calculate_sw && tx->HasWitness()) {
2016 swtotal_size += tx_size;
2017 swtotal_weight += weight;
2022 const auto& txundo = blockUndo.
vtxundo.at(i - 1);
2023 for (
const Coin& coin: txundo.vprevout) {
2026 tx_total_in += prevoutput.
nValue;
2028 utxo_size_inc -= prevout_size;
2029 utxo_size_inc_actual -= prevout_size;
2032 CAmount txfee = tx_total_in - tx_total_out;
2035 fee_array.push_back(txfee);
2037 maxfee = std::max(maxfee, txfee);
2038 minfee = std::min(minfee, txfee);
2043 if (do_feerate_percentiles) {
2044 feerate_array.emplace_back(feerate, weight);
2046 maxfeerate = std::max(maxfeerate, feerate);
2047 minfeerate = std::min(minfeerate, feerate);
2056 feerates_res.
push_back(feerate_percentiles[i]);
2060 ret_all.
pushKV(
"avgfee", (block.
vtx.size() > 1) ? totalfee / (block.
vtx.size() - 1) : 0);
2062 ret_all.
pushKV(
"avgtxsize", (block.
vtx.size() > 1) ? total_size / (block.
vtx.size() - 1) : 0);
2064 ret_all.
pushKV(
"feerate_percentiles", std::move(feerates_res));
2066 ret_all.
pushKV(
"ins", inputs);
2067 ret_all.
pushKV(
"maxfee", maxfee);
2068 ret_all.
pushKV(
"maxfeerate", maxfeerate);
2069 ret_all.
pushKV(
"maxtxsize", maxtxsize);
2074 ret_all.
pushKV(
"minfeerate", (minfeerate ==
MAX_MONEY) ? 0 : minfeerate);
2076 ret_all.
pushKV(
"outs", outputs);
2078 ret_all.
pushKV(
"swtotal_size", swtotal_size);
2079 ret_all.
pushKV(
"swtotal_weight", swtotal_weight);
2080 ret_all.
pushKV(
"swtxs", swtxs);
2082 ret_all.
pushKV(
"total_out", total_out);
2083 ret_all.
pushKV(
"total_size", total_size);
2084 ret_all.
pushKV(
"total_weight", total_weight);
2085 ret_all.
pushKV(
"totalfee", totalfee);
2086 ret_all.
pushKV(
"txs", (int64_t)block.
vtx.size());
2087 ret_all.
pushKV(
"utxo_increase", outputs - inputs);
2088 ret_all.
pushKV(
"utxo_size_inc", utxo_size_inc);
2089 ret_all.
pushKV(
"utxo_increase_actual", utxos - inputs);
2090 ret_all.
pushKV(
"utxo_size_inc_actual", utxo_size_inc_actual);
2097 for (
const std::string& stat : stats) {
2098 const UniValue& value = ret_all[stat];
2102 ret.pushKV(stat, value);
2111 bool 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)
2115 while (cursor->
Valid()) {
2118 if (!cursor->
GetKey(key) || !cursor->
GetValue(coin))
return false;
2119 if (++
count % 8192 == 0) {
2120 interruption_point();
2126 if (
count % 256 == 0) {
2129 scan_progress = (int)(high * 100.0 / 65536.0 + 0.5);
2132 out_results.emplace(key, coin);
2136 scan_progress = 100;
2172 "\"start\" for starting a scan\n" 2173 "\"abort\" for aborting the current scan (returns true when abort was successful)\n" 2174 "\"status\" for progress report (in %) of the current scan" 2179 "Every scan object is either a string descriptor or an object:",
2193 "True if scan will be aborted (not necessarily before this RPC returns), or false if there is no scan to abort" 2196 "when action=='status' and no scan is in progress - possibly already completed",
RPCResult::Type::NONE,
"",
"" 2207 const std::string EXAMPLE_DESCRIPTOR_RAW =
"raw(76a91411b366edfc0a8b66feebae5c2e25a7b6a5d1cf3188ac)#fm24fxxy";
2210 "\nScans the unspent transaction output set for entries that match certain output descriptors.\n" 2211 "Examples of output descriptors are:\n" 2212 " addr(<address>) Outputs whose output script corresponds to the specified address (does not include P2PK)\n" 2213 " raw(<hex script>) Outputs whose output script equals the specified hex-encoded bytes\n" 2214 " combo(<pubkey>) P2PK, P2PKH, P2WPKH, and P2SH-P2WPKH outputs for the given pubkey\n" 2215 " pkh(<pubkey>) P2PKH outputs for the given pubkey\n" 2216 " sh(multi(<n>,<pubkey>,<pubkey>,...)) P2SH-multisig outputs for the given threshold and pubkeys\n" 2217 " tr(<pubkey>) P2TR\n" 2218 " tr(<pubkey>,{pk(<pubkey>)}) P2TR with single fallback pubkey in tapscript\n" 2219 " rawtr(<pubkey>) P2TR with the specified key as output key rather than inner\n" 2220 " wsh(and_v(v:pk(<pubkey>),after(2))) P2WSH miniscript with mandatory pubkey and a timelock\n" 2221 "\nIn the above, <pubkey> either refers to a fixed public key in hexadecimal notation, or to an xpub/xprv optionally followed by one\n" 2222 "or more path elements separated by \"/\", and optionally ending in \"/*\" (unhardened), or \"/*'\" or \"/*h\" (hardened) to specify all\n" 2223 "unhardened or hardened child keys.\n" 2224 "In the latter case, a range needs to be specified by below if different from 1000.\n" 2225 "For more information on output descriptors, see the documentation in the doc/descriptors.md file.\n",
2248 {
RPCResult::Type::NUM,
"confirmations",
"Number of confirmations of the unspent transaction output when the scan was done"},
2258 HelpExampleCli(
"scantxoutset",
"start \'[\"" + EXAMPLE_DESCRIPTOR_RAW +
"\"]\'") +
2261 HelpExampleRpc(
"scantxoutset",
"\"start\", [\"" + EXAMPLE_DESCRIPTOR_RAW +
"\"]") +
2268 const auto action{
self.Arg<std::string>(
"action")};
2269 if (action ==
"status") {
2277 }
else if (action ==
"abort") {
2286 }
else if (action ==
"start") {
2292 if (request.params.size() < 2) {
2296 std::set<CScript> needles;
2297 std::map<CScript, std::string> descriptors;
2307 descriptors.emplace(std::move(
script), std::move(inferred));
2313 std::vector<CTxOut> input_txos;
2314 std::map<COutPoint, Coin> coins;
2317 std::unique_ptr<CCoinsViewCursor> pcursor;
2329 result.pushKV(
"success", res);
2334 for (
const auto& it : coins) {
2336 const Coin& coin = it.second;
2339 input_txos.push_back(txo);
2344 unspent.
pushKV(
"vout", outpoint.
n);
2350 unspent.
pushKV(
"blockhash", coinb_block.GetBlockHash().GetHex());
2355 result.pushKV(
"unspents", std::move(unspents));
2399 for (
const auto& tx : block.vtx) {
2400 if (std::any_of(tx->vout.cbegin(), tx->vout.cend(), [&](
const auto& txout) {
2401 return needles.count(std::vector<unsigned char>(txout.scriptPubKey.begin(), txout.scriptPubKey.end())) != 0;
2407 for (
const auto& txundo : block_undo.vtxundo) {
2408 if (std::any_of(txundo.vprevout.cbegin(), txundo.vprevout.cend(), [&](
const auto& coin) {
2421 "\nReturn relevant blockhashes for given descriptors (requires blockfilterindex).\n" 2422 "This call may take several minutes. Make sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2431 {
"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"},
2453 HelpExampleCli(
"scanblocks",
"start '[\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"]' 300000") +
2454 HelpExampleCli(
"scanblocks",
"start '[\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"]' 100 150 basic") +
2456 HelpExampleRpc(
"scanblocks",
"\"start\", [\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"], 300000") +
2457 HelpExampleRpc(
"scanblocks",
"\"start\", [\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"], 100, 150, \"basic\"") +
2463 if (request.params[0].get_str() ==
"status") {
2472 }
else if (request.params[0].get_str() ==
"abort") {
2481 }
else if (request.params[0].get_str() ==
"start") {
2486 const std::string filtertype_name{request.params[4].isNull() ?
"basic" : request.params[4].get_str()};
2494 bool filter_false_positives{options.exists(
"filter_false_positives") ? options[
"filter_false_positives"].get_bool() :
false};
2510 start_index = active_chain.
Genesis();
2511 stop_block = active_chain.
Tip();
2512 if (!request.params[2].isNull()) {
2513 start_index = active_chain[request.params[2].getInt<
int>()];
2518 if (!request.params[3].isNull()) {
2519 stop_block = active_chain[request.params[3].getInt<
int>()];
2538 const int amount_per_chunk = 10000;
2539 std::vector<BlockFilter> filters;
2540 int start_block_height = start_index->
nHeight;
2541 const int total_blocks_to_process = stop_block->
nHeight - start_block_height;
2546 bool completed =
true;
2550 node.rpc_interruption_point();
2557 int start_block = !end_range ? start_index->
nHeight : start_index->
nHeight + 1;
2558 end_range = (start_block + amount_per_chunk < stop_block->
nHeight) ?
2565 if (filter.GetFilter().MatchAny(needle_set)) {
2566 if (filter_false_positives) {
2575 blocks.
push_back(filter.GetBlockHash().GetHex());
2579 start_index = end_range;
2582 int blocks_processed = end_range->
nHeight - start_block_height;
2583 if (total_blocks_to_process > 0) {
2591 }
while (start_index != stop_block);
2593 ret.pushKV(
"from_height", start_block_height);
2594 ret.pushKV(
"to_height", start_index->
nHeight);
2595 ret.pushKV(
"relevant_blocks", std::move(blocks));
2596 ret.pushKV(
"completed", completed);
2609 "\nGet spend and receive activity associated with a set of descriptors for a set of blocks. " 2610 "This command pairs well with the `relevant_blocks` output of `scanblocks()`.\n" 2611 "This call may take several minutes. If you encounter timeouts, try specifying no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2647 HelpExampleCli(
"getdescriptoractivity",
"'[\"000000000000000000001347062c12fded7c528943c8ce133987e2e2f5a840ee\"]' '[\"addr(bc1qzl6nsgqzu89a66l50cvwapnkw5shh23zarqkw9)\"]'")
2656 struct CompareByHeightAscending {
2662 std::set<const CBlockIndex*, CompareByHeightAscending> blockindexes_sorted;
2676 blockindexes_sorted.insert(pindex);
2680 std::set<CScript> scripts_to_watch;
2688 scripts_to_watch.insert(
script);
2692 const auto AddSpend = [&](
2704 event.pushKV(
"type",
"spend");
2707 event.pushKV(
"blockhash", index->GetBlockHash().ToString());
2708 event.pushKV(
"height", index->nHeight);
2710 event.pushKV(
"spend_txid", tx->GetHash().ToString());
2711 event.pushKV(
"spend_vin", vin);
2712 event.pushKV(
"prevout_txid", txin.prevout.hash.ToString());
2713 event.pushKV(
"prevout_vout", txin.prevout.n);
2714 event.pushKV(
"prevout_spk", spkUv);
2724 event.pushKV(
"type",
"receive");
2727 event.pushKV(
"blockhash", index->GetBlockHash().ToString());
2728 event.pushKV(
"height", index->nHeight);
2730 event.pushKV(
"txid", tx->GetHash().ToString());
2731 event.pushKV(
"vout", vout);
2732 event.pushKV(
"output_spk", spkUv);
2744 for (
const CBlockIndex* blockindex : blockindexes_sorted) {
2748 for (
size_t i = 0; i < block.vtx.size(); ++i) {
2749 const auto& tx = block.vtx.at(i);
2751 if (!tx->IsCoinBase()) {
2753 const auto& txundo = block_undo.
vtxundo.at(i - 1);
2755 for (
size_t vin_idx = 0; vin_idx < tx->vin.size(); ++vin_idx) {
2756 const auto& coin = txundo.vprevout.at(vin_idx);
2757 const auto& txin = tx->vin.at(vin_idx);
2765 for (
size_t vout_idx = 0; vout_idx < tx->vout.size(); ++vout_idx) {
2766 const auto& vout = tx->vout.at(vout_idx);
2767 if (scripts_to_watch.contains(vout.scriptPubKey)) {
2768 activity.
push_back(AddReceive(vout, blockindex, vout_idx, tx));
2774 bool search_mempool =
true;
2775 if (!request.params[2].isNull()) {
2776 search_mempool = request.params[2].get_bool();
2779 if (search_mempool) {
2786 const auto& tx = e.GetSharedTx();
2788 for (
size_t vin_idx = 0; vin_idx < tx->vin.size(); ++vin_idx) {
2791 const auto& txin = tx->vin.at(vin_idx);
2792 std::optional<Coin> coin = coins_view.
GetCoin(txin.prevout);
2800 if (txin.prevout.n >= prev_tx->vout.size()) {
2801 throw std::runtime_error(
"Invalid output index");
2803 const CTxOut&
out = prev_tx->vout[txin.prevout.n];
2804 scriptPubKey =
out.scriptPubKey;
2809 scriptPubKey =
out.scriptPubKey;
2813 if (scripts_to_watch.contains(scriptPubKey)) {
2816 scriptPubKey, value, tx, vin_idx, txin,
nullptr));
2820 for (
size_t vout_idx = 0; vout_idx < tx->vout.size(); ++vout_idx) {
2821 const auto& vout = tx->vout.at(vout_idx);
2822 if (scripts_to_watch.contains(vout.scriptPubKey)) {
2823 activity.
push_back(AddReceive(vout,
nullptr, vout_idx, tx));
2829 ret.pushKV(
"activity", activity);
2838 "\nRetrieve a BIP 157 content filter for a particular block.\n",
2850 HelpExampleCli(
"getblockfilter",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" \"basic\"") +
2851 HelpExampleRpc(
"getblockfilter",
"\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\", \"basic\"")
2857 if (!request.params[1].isNull()) {
2858 filtertype_name = request.params[1].get_str();
2872 bool block_was_connected;
2883 bool index_ready = index->BlockUntilSyncedToCurrentChain();
2890 std::string errmsg =
"Filter not found.";
2892 if (!block_was_connected) {
2894 errmsg +=
" Block was not connected to active chain.";
2895 }
else if (!index_ready) {
2897 errmsg +=
" Block filters are still in the process of being indexed.";
2900 errmsg +=
" This error is unexpected and indicates index corruption.";
2908 ret.pushKV(
"header", filter_header.
GetHex());
2959 "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" 2960 "Unless the \"latest\" type is requested, the node will roll back to the requested height and network activity will be suspended during this process. " 2961 "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" 2962 "This call may take several minutes. Make sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2965 {
"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."},
2969 "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.",
2982 {
RPCResult::Type::NUM,
"nchaintx",
"the number of transactions in the chain up to and including the base block"},
2986 HelpExampleCli(
"-rpcclienttimeout=0 dumptxoutset",
"utxo.dat latest") +
2987 HelpExampleCli(
"-rpcclienttimeout=0 dumptxoutset",
"utxo.dat rollback") +
2988 HelpExampleCli(
"-rpcclienttimeout=0 -named dumptxoutset", R
"(utxo.dat rollback=853456)") 2995 const std::string snapshot_type{
self.Arg<std::string>(
"type")};
2997 if (options.exists(
"rollback")) {
2998 if (!snapshot_type.empty() && snapshot_type !=
"rollback") {
3002 }
else if (snapshot_type ==
"rollback") {
3003 auto snapshot_heights =
node.chainman->GetParams().GetAvailableSnapshotHeights();
3005 auto max_height = std::max_element(snapshot_heights.begin(), snapshot_heights.end());
3007 }
else if (snapshot_type ==
"latest") {
3022 path.
utf8string() +
" already exists. If you are sure this is what you want, " 3023 "move it out of the way first");
3031 "Couldn't open file " + temppath.
utf8string() +
" for writing.");
3036 std::optional<NetworkDisable> disable_network;
3037 std::optional<TemporaryRollback> temporary_rollback;
3041 if (target_index != tip) {
3044 if (
node.chainman->m_blockman.IsPruneMode()) {
3048 if (first_block->nHeight > target_index->nHeight) {
3062 disable_network.emplace(connman);
3065 invalidate_index =
WITH_LOCK(::
cs_main,
return node.chainman->ActiveChain().Next(target_index));
3066 temporary_rollback.emplace(*
node.chainman, *invalidate_index);
3070 std::unique_ptr<CCoinsViewCursor> cursor;
3080 chainstate = &
node.chainman->ActiveChainstate();
3087 if (target_index != chainstate->m_chain.Tip()) {
3088 LogWarning(
"dumptxoutset failed to roll back to requested height, reverting to tip.\n");
3096 fs::rename(temppath, path);
3098 result.pushKV(
"path", path.utf8string());
3107 const std::function<
void()>& interruption_point)
3109 std::unique_ptr<CCoinsViewCursor> pcursor;
3110 std::optional<CCoinsStats> maybe_stats;
3150 const std::function<
void()>& interruption_point)
3163 unsigned int iter{0};
3164 size_t written_coins_count{0};
3165 std::vector<std::pair<uint32_t, Coin>> coins;
3174 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) {
3177 for (
const auto& [n, coin] : coins) {
3180 ++written_coins_count;
3185 last_hash = key.
hash;
3186 while (pcursor->
Valid()) {
3187 if (iter % 5000 == 0) interruption_point();
3190 if (key.
hash != last_hash) {
3191 write_coins_to_file(afile, last_hash, coins, written_coins_count);
3192 last_hash = key.
hash;
3195 coins.emplace_back(key.
n, coin);
3200 if (!coins.empty()) {
3201 write_coins_to_file(afile, last_hash, coins, written_coins_count);
3209 result.pushKV(
"coins_written", written_coins_count);
3226 return WriteUTXOSnapshot(chainstate, cursor.get(), &stats, tip, afile, path, tmppath,
node.rpc_interruption_point);
3233 "Load the serialized UTXO set from a file.\n" 3234 "Once this snapshot is loaded, its contents will be " 3235 "deserialized into a second chainstate data structure, which is then used to sync to " 3236 "the network's tip. " 3237 "Meanwhile, the original chainstate will complete the initial block download process in " 3238 "the background, eventually validating up to the block that the snapshot is based upon.\n\n" 3240 "The result is a usable bitcoind instance that is current with the network tip in a " 3241 "matter of minutes rather than hours. UTXO snapshot are typically obtained from " 3242 "third-party sources (HTTP, torrent, etc.) which is reasonable since their " 3243 "contents are always checked by hash.\n\n" 3245 "You can find more information on this process in the `assumeutxo` design " 3246 "document (<https://github.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo.md>).",
3251 "path to the snapshot file. If relative, will be prefixed by datadir."},
3276 "Couldn't open file " + path.
utf8string() +
" for reading.");
3282 }
catch (
const std::ios_base::failure& e) {
3287 if (!activation_result) {
3301 result.pushKV(
"coins_loaded", metadata.m_coins_count);
3302 result.pushKV(
"tip_hash", snapshot_index.GetBlockHash().ToString());
3303 result.pushKV(
"base_height", snapshot_index.nHeight);
3317 {
RPCResult::Type::STR_HEX,
"snapshot_blockhash",
true,
"the base block of the snapshot this chainstate is based on, if any"},
3320 {
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."},
3327 "\nReturn information about chainstates.\n",
3349 if (!
cs.m_chain.Tip()) {
3361 data.pushKV(
"coins_db_cache_bytes",
cs.m_coinsdb_cache_size_bytes);
3362 data.pushKV(
"coins_tip_cache_bytes",
cs.m_coinstip_cache_size_bytes);
3363 if (
cs.m_from_snapshot_blockhash) {
3364 data.pushKV(
"snapshot_blockhash",
cs.m_from_snapshot_blockhash->ToString());
3366 data.pushKV(
"validated", validated);
3370 obj.
pushKV(
"headers", chainman.m_best_header ? chainman.m_best_header->nHeight : -1);
3372 const auto& chainstates = chainman.
GetAll();
3375 obj_chainstates.push_back(make_chain_data(*
cs, !
cs->m_from_snapshot_blockhash || chainstates.size() == 1));
3377 obj.
pushKV(
"chainstates", std::move(obj_chainstates));
3418 for (
const auto& c : commands) {
3419 t.appendCommand(c.name, &c);
std::shared_ptr< const CTransaction > CTransactionRef
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
arith_uint256 nChainWork
(memory only) Total amount of work (expected number of hashes) in the chain up to and including this ...
const std::vector< RPCResult > RPCHelpForChainstate
std::vector< RPCResult > ScriptPubKeyDoc()
int min_activation_height
If lock in occurs, delay activation until at least this block height.
std::string GetHex() const
void PruneBlockFilesManual(Chainstate &active_chainstate, int nManualPruneHeight)
Prune block files up to a given height.
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...
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
bool LookupFilter(const CBlockIndex *block_index, BlockFilter &filter_out) const
Get a single filter by block.
static RPCHelpMan syncwithvalidationinterfacequeue()
Display status of an in-progress BIP9 softfork.
static const auto scan_result_abort
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
void push_back(UniValue val)
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
static constexpr int NUM_GETBLOCKSTATS_PERCENTILES
static RPCHelpMan getblock()
static std::atomic< int > g_scanfilter_progress_height
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
The same as previous option with information about prevouts if available.
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
const std::vector< UniValue > & getValues() const
std::unique_ptr< CCoinsViewCursor > Cursor() const override
Get a cursor to iterate over the whole state.
bool ReadRawBlock(std::vector< uint8_t > &block, const FlatFilePos &pos) const
static const int WITNESS_SCALE_FACTOR
bool IsPruneMode() const
Whether running in -prune mode.
int64_t GetBlockTime() const
FILE * fopen(const fs::path &p, const char *mode)
CBlockIndex * pprev
pointer to the index of the predecessor of this block
uint64_t CalculateCurrentUsage()
Calculate the amount of disk space the block & undo files currently use.
bool IsRPCRunning()
Query whether RPC is running.
static RPCHelpMan getblockfrompeer()
uint256 GetTarget(const CBlockIndex &blockindex, const uint256 pow_limit)
std::string GetChainTypeString() const
Return the chain type string.
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances...
CTxMemPool & EnsureMemPool(const NodeContext &node)
bool BlockFilterTypeByName(const std::string &name, BlockFilterType &filter_type)
Find a filter type by its human-readable name.
TxVerbosity
Verbose level for block's transaction.
UniValue blockToJSON(BlockManager &blockman, const CBlock &block, const CBlockIndex &tip, const CBlockIndex &blockindex, TxVerbosity verbosity, const uint256 pow_limit)
Block description to JSON.
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
An in-memory indexed chain of blocks.
static std::atomic< bool > g_scanfilter_should_abort_scan
BlockFiltersScanReserver()=default
NetworkDisable(CConnman &connman)
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
size_t GetSerializeSize(const T &t)
CAmount total_new_outputs_ex_coinbase_amount
Total cumulative amount of outputs created up to and including this block.
bool index_used
Signals if the coinstatsindex was used to retrieve the statistics.
Comparison function for sorting the getchaintips heads.
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...
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...
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
static std::vector< uint8_t > GetRawBlockChecked(BlockManager &blockman, const CBlockIndex &blockindex)
All parent headers found, difficulty matches, timestamp >= median previous, checkpoint.
static constexpr int DEFAULT_CHECKLEVEL
bool MoneyRange(const CAmount &nValue)
CBlockHeader GetBlockHeader() const
#define CHECK_NONFATAL(condition)
Identity function.
int Height() const
Return the maximal height in the chain.
Special type that behaves almost exactly like OBJ, defining an options object with a list of pre-defi...
CTxOut out
unspent transaction output
bool DeploymentActiveAfter(const CBlockIndex *pindexPrev, const Consensus::Params ¶ms, Consensus::BuriedDeployment dep, [[maybe_unused]] VersionBitsCache &versionbitscache)
Determine if a deployment is active for the next block.
std::optional< CAmount > total_amount
The total amount, or nullopt if an overflow occurred calculating it.
constexpr const std::byte * begin() const
#define LOG_TIME_SECONDS(end_msg)
static const auto scan_result_status_some
bool ReadBlock(CBlock &block, const FlatFilePos &pos) const
Functions for disk access for blocks.
const std::string & get_str() const
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
const UniValue & get_array() const
uint64_t coins_count
The number of coins contained.
undo data available in rev*.dat
#define LIST_CHAIN_NAMES
List of possible chain / network names.
static RPCHelpMan scantxoutset()
ThresholdState
BIP 9 defines a finite-state-machine to deploy a softfork in multiple stages.
double GuessVerificationProgress(const CBlockIndex *pindex) const
Guess verification progress (as a fraction between 0.0=genesis and 1.0=current tip).
CChain m_chain
The current chain of blockheaders we consult and build on.
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...
consteval auto _(util::TranslatedLiteral str)
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
Retrieve the Coin (unspent transaction output) for a given outpoint.
static int ComputeNextBlockAndDepth(const CBlockIndex &tip, const CBlockIndex &blockindex, const CBlockIndex *&next)
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
GetCoin, returning whether it exists and is not spent.
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.
static std::atomic< int > g_scan_progress
RAII object to prevent concurrency issue when scanning the txout set.
Non-refcounted RAII wrapper for FILE*.
static int32_t GetTransactionWeight(const CTransaction &tx)
static constexpr int64_t TIMESTAMP_WINDOW
Timestamp window used as a grace period by code that compares external timestamps (such as timestamps...
static RPCHelpMan loadtxoutset()
int threshold
Number of blocks with the version bit set required to activate the softfork.
CAmount total_unspendables_scripts
Total cumulative amount of outputs sent to unspendable scripts (OP_RETURN for example) up to and incl...
std::unique_ptr< Descriptor > InferDescriptor(const CScript &script, const SigningProvider &provider)
Find a descriptor for the specified script, using information from provider where possible...
bool isSpent(const COutPoint &outpoint) const
Invalid, missing or duplicate parameter.
static RPCHelpMan getdescriptoractivity()
CAmount total_coinbase_amount
Total cumulative amount of coinbase outputs up to and including this block.
RAII class that temporarily rolls back the local chain in it's constructor and rolls it forward again...
RPCHelpMan getblockchaininfo()
VersionBitsCache m_versionbitscache
Track versionbit status.
~BlockFiltersScanReserver()
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
bool DeploymentEnabled(const Consensus::Params ¶ms, Consensus::BuriedDeployment dep)
Determine if a deployment is enabled (can ever be active)
CoinStatsHashType ParseHashType(const std::string &hash_type_input)
CoinsViewScanReserver()=default
static RPCHelpMan getchaintxstats()
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.
const RPCResult getblock_vin
int64_t CAmount
Amount in satoshis (Can be negative)
CAmount total_unspendables_unclaimed_rewards
Total cumulative amount of coins lost due to unclaimed miner rewards up to and including this block...
CAmount total_unspendables_bip30
The two unspendable coinbase outputs total amount caused by BIP30.
static T CalculateTruncatedMedian(std::vector< T > &scores)
std::string GetAllOutputTypes()
Gets all existing output types formatted for RPC help sections.
virtual bool GetValue(Coin &coin) const =0
uint256 GetBlockHash() const
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
uint32_t nHeight
at which height this containing transaction was included in the active block chain ...
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...
static const uint32_t MEMPOOL_HEIGHT
Fake height value used in Coin to signify they are only in the memory pool (since 0...
static RPCHelpMan getblockfilter()
uint64_t PruneAfterHeight() const
std::string MakeUnorderedList(const std::vector< std::string > &items)
Create an unordered multi-line list of items.
Special type that is a STR with only hex chars.
NodeContext struct containing references to chain state and connection state.
bool IsBIP30Repeat(const CBlockIndex &block_index)
Identifies blocks that overwrote an existing coinbase output in the UTXO set (see BIP30) ...
uint256 powLimit
Proof of work parameters.
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
ChainstateManager & m_chainman
The chainstate manager that owns this chainstate.
Interface giving clients (RPC, Stratum v2 Template Provider in the future) ability to create block te...
static std::atomic< bool > g_scan_in_progress
UniValue JSONRPCError(int code, const std::string &message)
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={})
void ReconsiderBlock(ChainstateManager &chainman, uint256 block_hash)
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
bool operator()(const CBlockIndex *a, const CBlockIndex *b) const
Special string with only hex chars.
static std::string PathToString(const path &path)
Convert path object to a byte string.
virtual bool Valid() const =0
Chainstate stores and provides an API to update our local knowledge of the current best chain...
static RPCHelpMan waitfornewblock()
Include TXID, inputs, outputs, and other common block's transaction information.
static void SoftForkDescPushBack(const CBlockIndex *blockindex, UniValue &softforks, const ChainstateManager &chainman, Consensus::BuriedDeployment dep)
static const CBlockIndex * ParseHashOrHeight(const UniValue ¶m, ChainstateManager &chainman)
void RegisterBlockchainRPCCommands(CRPCTable &t)
void ScriptToUniv(const CScript &script, UniValue &out, bool include_hex=true, bool include_address=false, const SigningProvider *provider=nullptr)
Abstract view on the open txout dataset.
UniValue blockheaderToJSON(const CBlockIndex &tip, const CBlockIndex &blockindex, const uint256 pow_limit)
Block header to JSON.
An input of a transaction.
uint64_t m_chain_tx_count
(memory only) Number of transactions in the chain up to and including this block. ...
int period
Length of blocks of the BIP9 signalling period.
Double ended buffer combining vector and stream-like interfaces.
int DeploymentHeight(BuriedDeployment dep) const
std::string ToString() const
static RPCHelpMan dumptxoutset()
Serialize the UTXO set to a file for loading elsewhere.
void WriteCompactSize(SizeComputer &os, uint64_t nSize)
bool LookupFilterHeader(const CBlockIndex *block_index, uint256 &header_out) EXCLUSIVE_LOCKS_REQUIRED(!m_cs_headers_cache)
Get a single filter header by block.
static RPCHelpMan getblockheader()
Complete block filter struct as defined in BIP 157.
CAmount total_prevout_spent_amount
Total cumulative amount of prevouts spent up to and including this block.
Special array that has a fixed number of entries.
static RPCHelpMan getchainstates()
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
kernel::Notifications & GetNotifications() const
int64_t nStartTime
Start MedianTime for version bits miner confirmation.
int64_t nPowTargetSpacing
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
RAII wrapper for VerifyDB: Verify consistency of the block and coin databases.
interfaces::Mining & EnsureMining(const NodeContext &node)
static RPCHelpMan getblockstats()
const Consensus::Params & GetConsensus() const
const std::string CURRENCY_UNIT
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
CCoinsViewDB & CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(
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...
General application defined errors.
std::string DefaultHint
Hint for default value.
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.
void ForceFlushStateToDisk()
Unconditionally flush all changes to disk.
int count
Number of blocks with the version bit set since the beginning of the current period.
void SetNetworkActive(bool active)
bool GetNetworkActive() const
An output of a transaction.
CAmount total_unspendable_amount
Total cumulative amount of unspendable coins up to and including this block.
std::string ToString() const
RAII class that disables the network in its constructor and enables it in its destructor.
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
virtual std::optional< std::string > FetchBlock(NodeId peer_id, const CBlockIndex &block_index)=0
Attempt to manually fetch block from a given peer.
static std::atomic< bool > g_scanfilter_in_progress
static const auto scan_result_status_none
An outpoint - a combination of a transaction hash and an index n into its vout.
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
virtual BlockRef waitTipChanged(uint256 current_tip, MillisecondsDouble timeout=MillisecondsDouble::max())=0
Waits for the connected tip to change.
bool IsDeprecatedRPCEnabled(const std::string &method)
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Special numeric to denote unix epoch time.
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
UniValue Default
Default constant value.
int64_t GetMedianTimePast() const
static RPCHelpMan getdifficulty()
static RPCHelpMan invalidateblock()
std::unordered_set< Element, ByteVectorHash > ElementSet
virtual bool GetKey(COutPoint &key) const =0
UniValue GetWarningsForRpc(const Warnings &warnings, bool use_deprecated)
RPC helper function that wraps warnings.GetMessages().
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
static RPCHelpMan getblockcount()
void InvalidateBlock(ChainstateManager &chainman, const uint256 block_hash)
uint256 GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Special type that is a NUM or [NUM,NUM].
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
static bool ComputeUTXOStats(CCoinsView *view, CCoinsStats &stats, T hash_obj, const std::function< void()> &interruption_point)
Calculate statistics about the unspent transaction output set.
const CChainParams & GetParams() const
int64_t nTimeout
Timeout/expiry MedianTime for the deployment attempt.
Optional argument for which the default value is omitted from help text for one of two reasons: ...
static const auto scan_action_arg_desc
static std::atomic< bool > g_should_abort_scan
ChainType GetChainType() const
Return the chain type.
#define EXCLUSIVE_LOCKS_REQUIRED(...)
static RPCHelpMan waitforblock()
std::vector< CTransactionRef > vtx
std::string utf8string() const
Return a UTF-8 representation of the path as a std::string, for compatibility with code using std::st...
static const auto scan_objects_arg_desc
static CBlock GetBlockChecked(BlockManager &blockman, const CBlockIndex &blockindex)
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
#define LogDebug(category,...)
static bool SetHasKeys(const std::set< T > &set)
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.
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
Only TXID for each block's transaction.
Special string to represent a floating point amount.
static RPCHelpMan gettxout()
static RPCHelpMan verifychain()
The block chain is a tree shaped structure starting with the genesis block at the root...
void pushKV(std::string key, UniValue val)
Undo information for a CBlock.
Serialized script, used inside transaction inputs and outputs.
static transaction_identifier FromUint256(const uint256 &id)
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
static const signed int DEFAULT_CHECKBLOCKS
Undo information for a CTransaction.
ChainstateManager & EnsureChainman(const NodeContext &node)
const MessageStartChars & MessageStart() const
virtual std::optional< BlockRef > getTip()=0
Returns the hash and height for the tip of this chain.
virtual uint256 GetBestBlock() const
Retrieve the block hash whose state this CCoinsView currently represents.
bool IsInitialBlockDownload() const
Check whether we are doing an initial block download (synchronizing from disk or network) ...
std::vector< uint8_t > signet_challenge
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
static RPCHelpMan preciousblock()
std::string GetHex() const
static constexpr size_t PER_UTXO_OVERHEAD
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
static RPCHelpMan waitforblockheight()
UniValue ValueFromAmount(const CAmount amount)
static RPCHelpMan gettxoutsetinfo()
ArgsManager & EnsureAnyArgsman(const std::any &context)
const UniValue NullUniValue
static constexpr CAmount MAX_MONEY
No amount larger than this (in satoshi) is valid.
static RPCHelpMan pruneblockchain()
#define AssertLockNotHeld(cs)
int elapsed
Number of blocks elapsed since the beginning of the current period.
bilingual_str ErrorString(const Result< T > &result)
TemporaryRollback(ChainstateManager &chainman, const CBlockIndex &index)
static CBlockUndo GetUndoChecked(BlockManager &blockman, const CBlockIndex &blockindex)
RPCHelpMan getdeploymentinfo()
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 ...
static RPCHelpMan reconsiderblock()
bool possible
False if there are not enough blocks left in this period to pass activation threshold.
PeerManager & EnsurePeerman(const NodeContext &node)
const CBlockIndex & m_invalidate_index
unsigned char * UCharCast(char *c)
ChainstateManager & m_chainman
static RPCHelpMan getchaintips()
std::unique_ptr< CoinStatsIndex > g_coin_stats_index
The global UTXO set hash object.
CTransactionRef get(const uint256 &hash) const
double GetDifficulty(const CBlockIndex &blockindex)
Get the difficulty of the net wrt to the given block index.
static const unsigned int MAX_BLOCK_SERIALIZED_SIZE
The maximum allowed size for a serialized block, in bytes (only for buffer size limits) ...
std::string GetHex() const
Hex encoding of the number (with the most significant digits first).
static bool CheckBlockFilterMatches(BlockManager &blockman, const CBlockIndex &blockindex, const GCSFilter::ElementSet &needles)
CAmount total_unspendables_genesis_block
The unspendable coinbase amount from the genesis block.
static std::atomic< int > g_scanfilter_progress
RAII object to prevent concurrency issue when scanning blockfilters.
int nHeight
height of the entry in the chain. The genesis block has height 0
FlatFilePos GetBlockPos() const EXCLUSIVE_LOCKS_REQUIRED(
const std::vector< unsigned char > & GetEncodedFilter() const LIFETIMEBOUND
const Consensus::Params & GetConsensus() const
int bit
Bit position to select the particular bit in nVersion.
void CheckBlockDataAvailability(BlockManager &blockman, const CBlockIndex &blockindex, bool check_for_undo)
Special dictionary with keys that are not literals.
CCoinsView that adds a memory cache for transactions to another CCoinsView.
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
full block available in blk*.dat
static bool exists(const path &p)
ChainstateManager & EnsureAnyChainman(const std::any &context)
static path u8path(const std::string &utf8_str)
std::vector< CTxUndo > vtxundo
static int64_t GetBlockWeight(const CBlock &block)
static RPCHelpMan scanblocks()
uint64_t nTransactionOutputs
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
uint64_t GetPruneTarget() const
Attempt to stay below this number of bytes of block files.
std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot(Chainstate &chainstate, const std::function< void()> &interruption_point)
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate...
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
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.
CCoinsView that brings transactions from a mempool into view.
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.
#define T(expected, seed, data)
BuriedDeployment
A buried deployment is one where the height of the activation has been hardcoded into the client impl...
unsigned int nTx
Number of transactions in this block.
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...
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
NodeContext & EnsureAnyNodeContext(const std::any &context)
static RPCHelpMan getblockhash()
BIP9Deployment vDeployments[MAX_VERSION_BITS_DEPLOYMENTS]
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it...
ArgsManager & EnsureArgsman(const NodeContext &node)
Error parsing or validating structure in raw format.
CConnman & EnsureConnman(const NodeContext &node)
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency...
static constexpr TransactionSerParams TX_WITH_WITNESS
static constexpr TransactionSerParams TX_NO_WITNESS
Special type to denote elision (...)
const std::string & BlockFilterTypeName(BlockFilterType filter_type)
Get the human-readable name for a filter type.
void TxToUniv(const CTransaction &tx, const uint256 &block_hash, UniValue &entry, bool include_hex=true, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS)
std::string DeploymentName(Consensus::BuriedDeployment dep)
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
bool IsNull() const
Return true if the wrapped FILE* is nullptr, false otherwise.
Cursor for iterating over CoinsView state.
static RPCHelpMan getbestblockhash()