Bitcoin Core 28.99.0
P2P Digital Currency
blockchain.cpp
Go to the documentation of this file.
1// Copyright (c) 2010 Satoshi Nakamoto
2// Copyright (c) 2009-2022 The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <rpc/blockchain.h>
7
8#include <blockfilter.h>
9#include <chain.h>
10#include <chainparams.h>
11#include <chainparamsbase.h>
12#include <clientversion.h>
13#include <coins.h>
14#include <common/args.h>
15#include <consensus/amount.h>
16#include <consensus/params.h>
18#include <core_io.h>
19#include <deploymentinfo.h>
20#include <deploymentstatus.h>
21#include <flatfile.h>
22#include <hash.h>
25#include <interfaces/mining.h>
26#include <kernel/coinstats.h>
27#include <logging/timer.h>
28#include <net.h>
29#include <net_processing.h>
30#include <node/blockstorage.h>
31#include <node/context.h>
32#include <node/transaction.h>
33#include <node/utxo_snapshot.h>
34#include <node/warnings.h>
36#include <rpc/server.h>
37#include <rpc/server_util.h>
38#include <rpc/util.h>
39#include <script/descriptor.h>
40#include <serialize.h>
41#include <streams.h>
42#include <sync.h>
43#include <txdb.h>
44#include <txmempool.h>
45#include <undo.h>
46#include <univalue.h>
47#include <util/check.h>
48#include <util/fs.h>
49#include <util/strencodings.h>
50#include <util/translation.h>
51#include <validation.h>
52#include <validationinterface.h>
53#include <versionbits.h>
54
55#include <stdint.h>
56
57#include <condition_variable>
58#include <iterator>
59#include <memory>
60#include <mutex>
61#include <optional>
62#include <vector>
63
66
72
73std::tuple<std::unique_ptr<CCoinsViewCursor>, CCoinsStats, const CBlockIndex*>
75 Chainstate& chainstate,
76 const std::function<void()>& interruption_point = {})
78
80 Chainstate& chainstate,
81 CCoinsViewCursor* pcursor,
82 CCoinsStats* maybe_stats,
83 const CBlockIndex* tip,
84 AutoFile& afile,
85 const fs::path& path,
86 const fs::path& temppath,
87 const std::function<void()>& interruption_point = {});
88
89/* Calculate the difficulty for a given block index.
90 */
91double GetDifficulty(const CBlockIndex& blockindex)
92{
93 int nShift = (blockindex.nBits >> 24) & 0xff;
94 double dDiff =
95 (double)0x0000ffff / (double)(blockindex.nBits & 0x00ffffff);
96
97 while (nShift < 29)
98 {
99 dDiff *= 256.0;
100 nShift++;
101 }
102 while (nShift > 29)
103 {
104 dDiff /= 256.0;
105 nShift--;
106 }
107
108 return dDiff;
109}
110
111static int ComputeNextBlockAndDepth(const CBlockIndex& tip, const CBlockIndex& blockindex, const CBlockIndex*& next)
112{
113 next = tip.GetAncestor(blockindex.nHeight + 1);
114 if (next && next->pprev == &blockindex) {
115 return tip.nHeight - blockindex.nHeight + 1;
116 }
117 next = nullptr;
118 return &blockindex == &tip ? 1 : -1;
119}
120
121static const CBlockIndex* ParseHashOrHeight(const UniValue& param, ChainstateManager& chainman)
122{
124 CChain& active_chain = chainman.ActiveChain();
125
126 if (param.isNum()) {
127 const int height{param.getInt<int>()};
128 if (height < 0) {
129 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Target block height %d is negative", height));
130 }
131 const int current_tip{active_chain.Height()};
132 if (height > current_tip) {
133 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Target block height %d after current tip %d", height, current_tip));
134 }
135
136 return active_chain[height];
137 } else {
138 const uint256 hash{ParseHashV(param, "hash_or_height")};
139 const CBlockIndex* pindex = chainman.m_blockman.LookupBlockIndex(hash);
140
141 if (!pindex) {
142 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
143 }
144
145 return pindex;
146 }
147}
148
149UniValue blockheaderToJSON(const CBlockIndex& tip, const CBlockIndex& blockindex)
150{
151 // Serialize passed information without accessing chain state of the active chain!
152 AssertLockNotHeld(cs_main); // For performance reasons
153
154 UniValue result(UniValue::VOBJ);
155 result.pushKV("hash", blockindex.GetBlockHash().GetHex());
156 const CBlockIndex* pnext;
157 int confirmations = ComputeNextBlockAndDepth(tip, blockindex, pnext);
158 result.pushKV("confirmations", confirmations);
159 result.pushKV("height", blockindex.nHeight);
160 result.pushKV("version", blockindex.nVersion);
161 result.pushKV("versionHex", strprintf("%08x", blockindex.nVersion));
162 result.pushKV("merkleroot", blockindex.hashMerkleRoot.GetHex());
163 result.pushKV("time", blockindex.nTime);
164 result.pushKV("mediantime", blockindex.GetMedianTimePast());
165 result.pushKV("nonce", blockindex.nNonce);
166 result.pushKV("bits", strprintf("%08x", blockindex.nBits));
167 result.pushKV("difficulty", GetDifficulty(blockindex));
168 result.pushKV("chainwork", blockindex.nChainWork.GetHex());
169 result.pushKV("nTx", blockindex.nTx);
170
171 if (blockindex.pprev)
172 result.pushKV("previousblockhash", blockindex.pprev->GetBlockHash().GetHex());
173 if (pnext)
174 result.pushKV("nextblockhash", pnext->GetBlockHash().GetHex());
175 return result;
176}
177
178UniValue blockToJSON(BlockManager& blockman, const CBlock& block, const CBlockIndex& tip, const CBlockIndex& blockindex, TxVerbosity verbosity)
179{
180 UniValue result = blockheaderToJSON(tip, blockindex);
181
182 result.pushKV("strippedsize", (int)::GetSerializeSize(TX_NO_WITNESS(block)));
183 result.pushKV("size", (int)::GetSerializeSize(TX_WITH_WITNESS(block)));
184 result.pushKV("weight", (int)::GetBlockWeight(block));
186
187 switch (verbosity) {
189 for (const CTransactionRef& tx : block.vtx) {
190 txs.push_back(tx->GetHash().GetHex());
191 }
192 break;
193
196 CBlockUndo blockUndo;
197 const bool is_not_pruned{WITH_LOCK(::cs_main, return !blockman.IsBlockPruned(blockindex))};
198 bool have_undo{is_not_pruned && WITH_LOCK(::cs_main, return blockindex.nStatus & BLOCK_HAVE_UNDO)};
199 if (have_undo && !blockman.UndoReadFromDisk(blockUndo, blockindex)) {
200 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.");
201 }
202 for (size_t i = 0; i < block.vtx.size(); ++i) {
203 const CTransactionRef& tx = block.vtx.at(i);
204 // coinbase transaction (i.e. i == 0) doesn't have undo data
205 const CTxUndo* txundo = (have_undo && i > 0) ? &blockUndo.vtxundo.at(i - 1) : nullptr;
207 TxToUniv(*tx, /*block_hash=*/uint256(), /*entry=*/objTx, /*include_hex=*/true, txundo, verbosity);
208 txs.push_back(std::move(objTx));
209 }
210 break;
211 }
212
213 result.pushKV("tx", std::move(txs));
214
215 return result;
216}
217
219{
220 return RPCHelpMan{"getblockcount",
221 "\nReturns the height of the most-work fully-validated chain.\n"
222 "The genesis block has height 0.\n",
223 {},
224 RPCResult{
225 RPCResult::Type::NUM, "", "The current block count"},
227 HelpExampleCli("getblockcount", "")
228 + HelpExampleRpc("getblockcount", "")
229 },
230 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
231{
232 ChainstateManager& chainman = EnsureAnyChainman(request.context);
233 LOCK(cs_main);
234 return chainman.ActiveChain().Height();
235},
236 };
237}
238
240{
241 return RPCHelpMan{"getbestblockhash",
242 "\nReturns the hash of the best (tip) block in the most-work fully-validated chain.\n",
243 {},
244 RPCResult{
245 RPCResult::Type::STR_HEX, "", "the block hash, hex-encoded"},
247 HelpExampleCli("getbestblockhash", "")
248 + HelpExampleRpc("getbestblockhash", "")
249 },
250 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
251{
252 ChainstateManager& chainman = EnsureAnyChainman(request.context);
253 LOCK(cs_main);
254 return chainman.ActiveChain().Tip()->GetBlockHash().GetHex();
255},
256 };
257}
258
260{
261 return RPCHelpMan{"waitfornewblock",
262 "\nWaits for any new block and returns useful info about it.\n"
263 "\nReturns the current block on timeout or exit.\n"
264 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
265 {
266 {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},
267 },
268 RPCResult{
269 RPCResult::Type::OBJ, "", "",
270 {
271 {RPCResult::Type::STR_HEX, "hash", "The blockhash"},
272 {RPCResult::Type::NUM, "height", "Block height"},
273 }},
275 HelpExampleCli("waitfornewblock", "1000")
276 + HelpExampleRpc("waitfornewblock", "1000")
277 },
278 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
279{
280 int timeout = 0;
281 if (!request.params[0].isNull())
282 timeout = request.params[0].getInt<int>();
283 if (timeout < 0) throw JSONRPCError(RPC_MISC_ERROR, "Negative timeout");
284
285 NodeContext& node = EnsureAnyNodeContext(request.context);
286 Mining& miner = EnsureMining(node);
287
288 auto block{CHECK_NONFATAL(miner.getTip()).value()};
289 if (IsRPCRunning()) {
290 block = timeout ? miner.waitTipChanged(block.hash, std::chrono::milliseconds(timeout)) : miner.waitTipChanged(block.hash);
291 }
292
294 ret.pushKV("hash", block.hash.GetHex());
295 ret.pushKV("height", block.height);
296 return ret;
297},
298 };
299}
300
302{
303 return RPCHelpMan{"waitforblock",
304 "\nWaits for a specific new block and returns useful info about it.\n"
305 "\nReturns the current block on timeout or exit.\n"
306 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
307 {
308 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "Block hash to wait for."},
309 {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},
310 },
311 RPCResult{
312 RPCResult::Type::OBJ, "", "",
313 {
314 {RPCResult::Type::STR_HEX, "hash", "The blockhash"},
315 {RPCResult::Type::NUM, "height", "Block height"},
316 }},
318 HelpExampleCli("waitforblock", "\"0000000000079f8ef3d2c688c244eb7a4570b24c9ed7b4a8c619eb02596f8862\" 1000")
319 + HelpExampleRpc("waitforblock", "\"0000000000079f8ef3d2c688c244eb7a4570b24c9ed7b4a8c619eb02596f8862\", 1000")
320 },
321 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
322{
323 int timeout = 0;
324
325 uint256 hash(ParseHashV(request.params[0], "blockhash"));
326
327 if (!request.params[1].isNull())
328 timeout = request.params[1].getInt<int>();
329 if (timeout < 0) throw JSONRPCError(RPC_MISC_ERROR, "Negative timeout");
330
331 NodeContext& node = EnsureAnyNodeContext(request.context);
332 Mining& miner = EnsureMining(node);
333
334 auto block{CHECK_NONFATAL(miner.getTip()).value()};
335 const auto deadline{std::chrono::steady_clock::now() + 1ms * timeout};
336 while (IsRPCRunning() && block.hash != hash) {
337 if (timeout) {
338 auto now{std::chrono::steady_clock::now()};
339 if (now >= deadline) break;
340 const MillisecondsDouble remaining{deadline - now};
341 block = miner.waitTipChanged(block.hash, remaining);
342 } else {
343 block = miner.waitTipChanged(block.hash);
344 }
345 }
346
348 ret.pushKV("hash", block.hash.GetHex());
349 ret.pushKV("height", block.height);
350 return ret;
351},
352 };
353}
354
356{
357 return RPCHelpMan{"waitforblockheight",
358 "\nWaits for (at least) block height and returns the height and hash\n"
359 "of the current tip.\n"
360 "\nReturns the current block on timeout or exit.\n"
361 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
362 {
363 {"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "Block height to wait for."},
364 {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},
365 },
366 RPCResult{
367 RPCResult::Type::OBJ, "", "",
368 {
369 {RPCResult::Type::STR_HEX, "hash", "The blockhash"},
370 {RPCResult::Type::NUM, "height", "Block height"},
371 }},
373 HelpExampleCli("waitforblockheight", "100 1000")
374 + HelpExampleRpc("waitforblockheight", "100, 1000")
375 },
376 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
377{
378 int timeout = 0;
379
380 int height = request.params[0].getInt<int>();
381
382 if (!request.params[1].isNull())
383 timeout = request.params[1].getInt<int>();
384 if (timeout < 0) throw JSONRPCError(RPC_MISC_ERROR, "Negative timeout");
385
386 NodeContext& node = EnsureAnyNodeContext(request.context);
387 Mining& miner = EnsureMining(node);
388
389 auto block{CHECK_NONFATAL(miner.getTip()).value()};
390 const auto deadline{std::chrono::steady_clock::now() + 1ms * timeout};
391
392 while (IsRPCRunning() && block.height < height) {
393 if (timeout) {
394 auto now{std::chrono::steady_clock::now()};
395 if (now >= deadline) break;
396 const MillisecondsDouble remaining{deadline - now};
397 block = miner.waitTipChanged(block.hash, remaining);
398 } else {
399 block = miner.waitTipChanged(block.hash);
400 }
401 }
402
404 ret.pushKV("hash", block.hash.GetHex());
405 ret.pushKV("height", block.height);
406 return ret;
407},
408 };
409}
410
412{
413 return RPCHelpMan{"syncwithvalidationinterfacequeue",
414 "\nWaits for the validation interface queue to catch up on everything that was there when we entered this function.\n",
415 {},
418 HelpExampleCli("syncwithvalidationinterfacequeue","")
419 + HelpExampleRpc("syncwithvalidationinterfacequeue","")
420 },
421 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
422{
423 NodeContext& node = EnsureAnyNodeContext(request.context);
424 CHECK_NONFATAL(node.validation_signals)->SyncWithValidationInterfaceQueue();
425 return UniValue::VNULL;
426},
427 };
428}
429
431{
432 return RPCHelpMan{"getdifficulty",
433 "\nReturns the proof-of-work difficulty as a multiple of the minimum difficulty.\n",
434 {},
435 RPCResult{
436 RPCResult::Type::NUM, "", "the proof-of-work difficulty as a multiple of the minimum difficulty."},
438 HelpExampleCli("getdifficulty", "")
439 + HelpExampleRpc("getdifficulty", "")
440 },
441 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
442{
443 ChainstateManager& chainman = EnsureAnyChainman(request.context);
444 LOCK(cs_main);
445 return GetDifficulty(*CHECK_NONFATAL(chainman.ActiveChain().Tip()));
446},
447 };
448}
449
451{
452 return RPCHelpMan{
453 "getblockfrompeer",
454 "Attempt to fetch block from a given peer.\n\n"
455 "We must have the header for this block, e.g. using submitheader.\n"
456 "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"
457 "Subsequent calls for the same block may cause the response from the previous peer to be ignored.\n"
458 "Peers generally ignore requests for a stale block that they never fully verified, or one that is more than a month old.\n"
459 "When a peer does not respond with a block, we will disconnect.\n"
460 "Note: The block could be re-pruned as soon as it is received.\n\n"
461 "Returns an empty JSON object if the request was successfully scheduled.",
462 {
463 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The block hash to try to fetch"},
464 {"peer_id", RPCArg::Type::NUM, RPCArg::Optional::NO, "The peer to fetch it from (see getpeerinfo for peer IDs)"},
465 },
466 RPCResult{RPCResult::Type::OBJ, "", /*optional=*/false, "", {}},
468 HelpExampleCli("getblockfrompeer", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" 0")
469 + HelpExampleRpc("getblockfrompeer", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" 0")
470 },
471 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
472{
473 const NodeContext& node = EnsureAnyNodeContext(request.context);
475 PeerManager& peerman = EnsurePeerman(node);
476
477 const uint256& block_hash{ParseHashV(request.params[0], "blockhash")};
478 const NodeId peer_id{request.params[1].getInt<int64_t>()};
479
480 const CBlockIndex* const index = WITH_LOCK(cs_main, return chainman.m_blockman.LookupBlockIndex(block_hash););
481
482 if (!index) {
483 throw JSONRPCError(RPC_MISC_ERROR, "Block header missing");
484 }
485
486 // Fetching blocks before the node has syncing past their height can prevent block files from
487 // being pruned, so we avoid it if the node is in prune mode.
488 if (chainman.m_blockman.IsPruneMode() && index->nHeight > WITH_LOCK(chainman.GetMutex(), return chainman.ActiveTip()->nHeight)) {
489 throw JSONRPCError(RPC_MISC_ERROR, "In prune mode, only blocks that the node has already synced previously can be fetched from a peer");
490 }
491
492 const bool block_has_data = WITH_LOCK(::cs_main, return index->nStatus & BLOCK_HAVE_DATA);
493 if (block_has_data) {
494 throw JSONRPCError(RPC_MISC_ERROR, "Block already downloaded");
495 }
496
497 if (const auto err{peerman.FetchBlock(peer_id, *index)}) {
498 throw JSONRPCError(RPC_MISC_ERROR, err.value());
499 }
500 return UniValue::VOBJ;
501},
502 };
503}
504
506{
507 return RPCHelpMan{"getblockhash",
508 "\nReturns hash of block in best-block-chain at height provided.\n",
509 {
510 {"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "The height index"},
511 },
512 RPCResult{
513 RPCResult::Type::STR_HEX, "", "The block hash"},
515 HelpExampleCli("getblockhash", "1000")
516 + HelpExampleRpc("getblockhash", "1000")
517 },
518 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
519{
520 ChainstateManager& chainman = EnsureAnyChainman(request.context);
521 LOCK(cs_main);
522 const CChain& active_chain = chainman.ActiveChain();
523
524 int nHeight = request.params[0].getInt<int>();
525 if (nHeight < 0 || nHeight > active_chain.Height())
526 throw JSONRPCError(RPC_INVALID_PARAMETER, "Block height out of range");
527
528 const CBlockIndex* pblockindex = active_chain[nHeight];
529 return pblockindex->GetBlockHash().GetHex();
530},
531 };
532}
533
535{
536 return RPCHelpMan{"getblockheader",
537 "\nIf verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'.\n"
538 "If verbose is true, returns an Object with information about blockheader <hash>.\n",
539 {
540 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The block hash"},
541 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{true}, "true for a json object, false for the hex-encoded data"},
542 },
543 {
544 RPCResult{"for verbose = true",
545 RPCResult::Type::OBJ, "", "",
546 {
547 {RPCResult::Type::STR_HEX, "hash", "the block hash (same as provided)"},
548 {RPCResult::Type::NUM, "confirmations", "The number of confirmations, or -1 if the block is not on the main chain"},
549 {RPCResult::Type::NUM, "height", "The block height or index"},
550 {RPCResult::Type::NUM, "version", "The block version"},
551 {RPCResult::Type::STR_HEX, "versionHex", "The block version formatted in hexadecimal"},
552 {RPCResult::Type::STR_HEX, "merkleroot", "The merkle root"},
553 {RPCResult::Type::NUM_TIME, "time", "The block time expressed in " + UNIX_EPOCH_TIME},
554 {RPCResult::Type::NUM_TIME, "mediantime", "The median block time expressed in " + UNIX_EPOCH_TIME},
555 {RPCResult::Type::NUM, "nonce", "The nonce"},
556 {RPCResult::Type::STR_HEX, "bits", "The bits"},
557 {RPCResult::Type::NUM, "difficulty", "The difficulty"},
558 {RPCResult::Type::STR_HEX, "chainwork", "Expected number of hashes required to produce the current chain"},
559 {RPCResult::Type::NUM, "nTx", "The number of transactions in the block"},
560 {RPCResult::Type::STR_HEX, "previousblockhash", /*optional=*/true, "The hash of the previous block (if available)"},
561 {RPCResult::Type::STR_HEX, "nextblockhash", /*optional=*/true, "The hash of the next block (if available)"},
562 }},
563 RPCResult{"for verbose=false",
564 RPCResult::Type::STR_HEX, "", "A string that is serialized, hex-encoded data for block 'hash'"},
565 },
567 HelpExampleCli("getblockheader", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
568 + HelpExampleRpc("getblockheader", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
569 },
570 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
571{
572 uint256 hash(ParseHashV(request.params[0], "hash"));
573
574 bool fVerbose = true;
575 if (!request.params[1].isNull())
576 fVerbose = request.params[1].get_bool();
577
578 const CBlockIndex* pblockindex;
579 const CBlockIndex* tip;
580 {
581 ChainstateManager& chainman = EnsureAnyChainman(request.context);
582 LOCK(cs_main);
583 pblockindex = chainman.m_blockman.LookupBlockIndex(hash);
584 tip = chainman.ActiveChain().Tip();
585 }
586
587 if (!pblockindex) {
588 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
589 }
590
591 if (!fVerbose)
592 {
593 DataStream ssBlock{};
594 ssBlock << pblockindex->GetBlockHeader();
595 std::string strHex = HexStr(ssBlock);
596 return strHex;
597 }
598
599 return blockheaderToJSON(*tip, *pblockindex);
600},
601 };
602}
603
604void CheckBlockDataAvailability(BlockManager& blockman, const CBlockIndex& blockindex, bool check_for_undo)
605{
607 uint32_t flag = check_for_undo ? BLOCK_HAVE_UNDO : BLOCK_HAVE_DATA;
608 if (!(blockindex.nStatus & flag)) {
609 if (blockman.IsBlockPruned(blockindex)) {
610 throw JSONRPCError(RPC_MISC_ERROR, strprintf("%s not available (pruned data)", check_for_undo ? "Undo data" : "Block"));
611 }
612 if (check_for_undo) {
613 throw JSONRPCError(RPC_MISC_ERROR, "Undo data not available");
614 }
615 throw JSONRPCError(RPC_MISC_ERROR, "Block not available (not fully downloaded)");
616 }
617}
618
619static CBlock GetBlockChecked(BlockManager& blockman, const CBlockIndex& blockindex)
620{
621 CBlock block;
622 {
623 LOCK(cs_main);
624 CheckBlockDataAvailability(blockman, blockindex, /*check_for_undo=*/false);
625 }
626
627 if (!blockman.ReadBlockFromDisk(block, blockindex)) {
628 // Block not found on disk. This shouldn't normally happen unless the block was
629 // pruned right after we released the lock above.
630 throw JSONRPCError(RPC_MISC_ERROR, "Block not found on disk");
631 }
632
633 return block;
634}
635
636static std::vector<uint8_t> GetRawBlockChecked(BlockManager& blockman, const CBlockIndex& blockindex)
637{
638 std::vector<uint8_t> data{};
639 FlatFilePos pos{};
640 {
641 LOCK(cs_main);
642 CheckBlockDataAvailability(blockman, blockindex, /*check_for_undo=*/false);
643 pos = blockindex.GetBlockPos();
644 }
645
646 if (!blockman.ReadRawBlockFromDisk(data, pos)) {
647 // Block not found on disk. This shouldn't normally happen unless the block was
648 // pruned right after we released the lock above.
649 throw JSONRPCError(RPC_MISC_ERROR, "Block not found on disk");
650 }
651
652 return data;
653}
654
655static CBlockUndo GetUndoChecked(BlockManager& blockman, const CBlockIndex& blockindex)
656{
657 CBlockUndo blockUndo;
658
659 // The Genesis block does not have undo data
660 if (blockindex.nHeight == 0) return blockUndo;
661
662 {
663 LOCK(cs_main);
664 CheckBlockDataAvailability(blockman, blockindex, /*check_for_undo=*/true);
665 }
666
667 if (!blockman.UndoReadFromDisk(blockUndo, blockindex)) {
668 throw JSONRPCError(RPC_MISC_ERROR, "Can't read undo data from disk");
669 }
670
671 return blockUndo;
672}
673
675 RPCResult::Type::ARR, "vin", "",
676 {
677 {RPCResult::Type::OBJ, "", "",
678 {
679 {RPCResult::Type::ELISION, "", "The same output as verbosity = 2"},
680 {RPCResult::Type::OBJ, "prevout", "(Only if undo information is available)",
681 {
682 {RPCResult::Type::BOOL, "generated", "Coinbase or not"},
683 {RPCResult::Type::NUM, "height", "The height of the prevout"},
684 {RPCResult::Type::STR_AMOUNT, "value", "The value in " + CURRENCY_UNIT},
685 {RPCResult::Type::OBJ, "scriptPubKey", "",
686 {
687 {RPCResult::Type::STR, "asm", "Disassembly of the output script"},
688 {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},
689 {RPCResult::Type::STR_HEX, "hex", "The raw output script bytes, hex-encoded"},
690 {RPCResult::Type::STR, "address", /*optional=*/true, "The Bitcoin address (only if a well-defined address exists)"},
691 {RPCResult::Type::STR, "type", "The type (one of: " + GetAllOutputTypes() + ")"},
692 }},
693 }},
694 }},
695 }
696};
697
699{
700 return RPCHelpMan{"getblock",
701 "\nIf verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.\n"
702 "If verbosity is 1, returns an Object with information about block <hash>.\n"
703 "If verbosity is 2, returns an Object with information about block <hash> and information about each transaction.\n"
704 "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",
705 {
706 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The block hash"},
707 {"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",
709 },
710 {
711 RPCResult{"for verbosity = 0",
712 RPCResult::Type::STR_HEX, "", "A string that is serialized, hex-encoded data for block 'hash'"},
713 RPCResult{"for verbosity = 1",
714 RPCResult::Type::OBJ, "", "",
715 {
716 {RPCResult::Type::STR_HEX, "hash", "the block hash (same as provided)"},
717 {RPCResult::Type::NUM, "confirmations", "The number of confirmations, or -1 if the block is not on the main chain"},
718 {RPCResult::Type::NUM, "size", "The block size"},
719 {RPCResult::Type::NUM, "strippedsize", "The block size excluding witness data"},
720 {RPCResult::Type::NUM, "weight", "The block weight as defined in BIP 141"},
721 {RPCResult::Type::NUM, "height", "The block height or index"},
722 {RPCResult::Type::NUM, "version", "The block version"},
723 {RPCResult::Type::STR_HEX, "versionHex", "The block version formatted in hexadecimal"},
724 {RPCResult::Type::STR_HEX, "merkleroot", "The merkle root"},
725 {RPCResult::Type::ARR, "tx", "The transaction ids",
726 {{RPCResult::Type::STR_HEX, "", "The transaction id"}}},
727 {RPCResult::Type::NUM_TIME, "time", "The block time expressed in " + UNIX_EPOCH_TIME},
728 {RPCResult::Type::NUM_TIME, "mediantime", "The median block time expressed in " + UNIX_EPOCH_TIME},
729 {RPCResult::Type::NUM, "nonce", "The nonce"},
730 {RPCResult::Type::STR_HEX, "bits", "The bits"},
731 {RPCResult::Type::NUM, "difficulty", "The difficulty"},
732 {RPCResult::Type::STR_HEX, "chainwork", "Expected number of hashes required to produce the chain up to this block (in hex)"},
733 {RPCResult::Type::NUM, "nTx", "The number of transactions in the block"},
734 {RPCResult::Type::STR_HEX, "previousblockhash", /*optional=*/true, "The hash of the previous block (if available)"},
735 {RPCResult::Type::STR_HEX, "nextblockhash", /*optional=*/true, "The hash of the next block (if available)"},
736 }},
737 RPCResult{"for verbosity = 2",
738 RPCResult::Type::OBJ, "", "",
739 {
740 {RPCResult::Type::ELISION, "", "Same output as verbosity = 1"},
741 {RPCResult::Type::ARR, "tx", "",
742 {
743 {RPCResult::Type::OBJ, "", "",
744 {
745 {RPCResult::Type::ELISION, "", "The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 \"tx\" result"},
746 {RPCResult::Type::NUM, "fee", "The transaction fee in " + CURRENCY_UNIT + ", omitted if block undo data is not available"},
747 }},
748 }},
749 }},
750 RPCResult{"for verbosity = 3",
751 RPCResult::Type::OBJ, "", "",
752 {
753 {RPCResult::Type::ELISION, "", "Same output as verbosity = 2"},
754 {RPCResult::Type::ARR, "tx", "",
755 {
756 {RPCResult::Type::OBJ, "", "",
757 {
759 }},
760 }},
761 }},
762 },
764 HelpExampleCli("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
765 + HelpExampleRpc("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
766 },
767 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
768{
769 uint256 hash(ParseHashV(request.params[0], "blockhash"));
770
771 int verbosity{ParseVerbosity(request.params[1], /*default_verbosity=*/1, /*allow_bool=*/true)};
772
773 const CBlockIndex* pblockindex;
774 const CBlockIndex* tip;
775 ChainstateManager& chainman = EnsureAnyChainman(request.context);
776 {
777 LOCK(cs_main);
778 pblockindex = chainman.m_blockman.LookupBlockIndex(hash);
779 tip = chainman.ActiveChain().Tip();
780
781 if (!pblockindex) {
782 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
783 }
784 }
785
786 const std::vector<uint8_t> block_data{GetRawBlockChecked(chainman.m_blockman, *pblockindex)};
787
788 if (verbosity <= 0) {
789 return HexStr(block_data);
790 }
791
792 DataStream block_stream{block_data};
793 CBlock block{};
794 block_stream >> TX_WITH_WITNESS(block);
795
796 TxVerbosity tx_verbosity;
797 if (verbosity == 1) {
798 tx_verbosity = TxVerbosity::SHOW_TXID;
799 } else if (verbosity == 2) {
800 tx_verbosity = TxVerbosity::SHOW_DETAILS;
801 } else {
803 }
804
805 return blockToJSON(chainman.m_blockman, block, *tip, *pblockindex, tx_verbosity);
806},
807 };
808}
809
811std::optional<int> GetPruneHeight(const BlockManager& blockman, const CChain& chain) {
813
814 // Search for the last block missing block data or undo data. Don't let the
815 // search consider the genesis block, because the genesis block does not
816 // have undo data, but should not be considered pruned.
817 const CBlockIndex* first_block{chain[1]};
818 const CBlockIndex* chain_tip{chain.Tip()};
819
820 // If there are no blocks after the genesis block, or no blocks at all, nothing is pruned.
821 if (!first_block || !chain_tip) return std::nullopt;
822
823 // If the chain tip is pruned, everything is pruned.
824 if (!((chain_tip->nStatus & BLOCK_HAVE_MASK) == BLOCK_HAVE_MASK)) return chain_tip->nHeight;
825
826 const auto& first_unpruned{*CHECK_NONFATAL(blockman.GetFirstBlock(*chain_tip, /*status_mask=*/BLOCK_HAVE_MASK, first_block))};
827 if (&first_unpruned == first_block) {
828 // All blocks between first_block and chain_tip have data, so nothing is pruned.
829 return std::nullopt;
830 }
831
832 // Block before the first unpruned block is the last pruned block.
833 return CHECK_NONFATAL(first_unpruned.pprev)->nHeight;
834}
835
837{
838 return RPCHelpMan{"pruneblockchain", "",
839 {
840 {"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "The block height to prune up to. May be set to a discrete height, or to a " + UNIX_EPOCH_TIME + "\n"
841 " to prune blocks whose block time is at least 2 hours older than the provided timestamp."},
842 },
843 RPCResult{
844 RPCResult::Type::NUM, "", "Height of the last block pruned"},
846 HelpExampleCli("pruneblockchain", "1000")
847 + HelpExampleRpc("pruneblockchain", "1000")
848 },
849 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
850{
851 ChainstateManager& chainman = EnsureAnyChainman(request.context);
852 if (!chainman.m_blockman.IsPruneMode()) {
853 throw JSONRPCError(RPC_MISC_ERROR, "Cannot prune blocks because node is not in prune mode.");
854 }
855
856 LOCK(cs_main);
857 Chainstate& active_chainstate = chainman.ActiveChainstate();
858 CChain& active_chain = active_chainstate.m_chain;
859
860 int heightParam = request.params[0].getInt<int>();
861 if (heightParam < 0) {
862 throw JSONRPCError(RPC_INVALID_PARAMETER, "Negative block height.");
863 }
864
865 // Height value more than a billion is too high to be a block height, and
866 // too low to be a block time (corresponds to timestamp from Sep 2001).
867 if (heightParam > 1000000000) {
868 // Add a 2 hour buffer to include blocks which might have had old timestamps
869 const CBlockIndex* pindex = active_chain.FindEarliestAtLeast(heightParam - TIMESTAMP_WINDOW, 0);
870 if (!pindex) {
871 throw JSONRPCError(RPC_INVALID_PARAMETER, "Could not find block with at least the specified timestamp.");
872 }
873 heightParam = pindex->nHeight;
874 }
875
876 unsigned int height = (unsigned int) heightParam;
877 unsigned int chainHeight = (unsigned int) active_chain.Height();
878 if (chainHeight < chainman.GetParams().PruneAfterHeight()) {
879 throw JSONRPCError(RPC_MISC_ERROR, "Blockchain is too short for pruning.");
880 } else if (height > chainHeight) {
881 throw JSONRPCError(RPC_INVALID_PARAMETER, "Blockchain is shorter than the attempted prune height.");
882 } else if (height > chainHeight - MIN_BLOCKS_TO_KEEP) {
883 LogDebug(BCLog::RPC, "Attempt to prune blocks close to the tip. Retaining the minimum number of blocks.\n");
884 height = chainHeight - MIN_BLOCKS_TO_KEEP;
885 }
886
887 PruneBlockFilesManual(active_chainstate, height);
888 return GetPruneHeight(chainman.m_blockman, active_chain).value_or(-1);
889},
890 };
891}
892
893CoinStatsHashType ParseHashType(const std::string& hash_type_input)
894{
895 if (hash_type_input == "hash_serialized_3") {
896 return CoinStatsHashType::HASH_SERIALIZED;
897 } else if (hash_type_input == "muhash") {
898 return CoinStatsHashType::MUHASH;
899 } else if (hash_type_input == "none") {
901 } else {
902 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("'%s' is not a valid hash_type", hash_type_input));
903 }
904}
905
911static std::optional<kernel::CCoinsStats> GetUTXOStats(CCoinsView* view, node::BlockManager& blockman,
913 const std::function<void()>& interruption_point = {},
914 const CBlockIndex* pindex = nullptr,
915 bool index_requested = true)
916{
917 // Use CoinStatsIndex if it is requested and available and a hash_type of Muhash or None was requested
918 if ((hash_type == kernel::CoinStatsHashType::MUHASH || hash_type == kernel::CoinStatsHashType::NONE) && g_coin_stats_index && index_requested) {
919 if (pindex) {
920 return g_coin_stats_index->LookUpStats(*pindex);
921 } else {
922 CBlockIndex& block_index = *CHECK_NONFATAL(WITH_LOCK(::cs_main, return blockman.LookupBlockIndex(view->GetBestBlock())));
923 return g_coin_stats_index->LookUpStats(block_index);
924 }
925 }
926
927 // If the coinstats index isn't requested or is otherwise not usable, the
928 // pindex should either be null or equal to the view's best block. This is
929 // because without the coinstats index we can only get coinstats about the
930 // best block.
931 CHECK_NONFATAL(!pindex || pindex->GetBlockHash() == view->GetBestBlock());
932
933 return kernel::ComputeUTXOStats(hash_type, view, blockman, interruption_point);
934}
935
937{
938 return RPCHelpMan{"gettxoutsetinfo",
939 "\nReturns statistics about the unspent transaction output set.\n"
940 "Note this call may take some time if you are not using coinstatsindex.\n",
941 {
942 {"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'."},
943 {"hash_or_height", RPCArg::Type::NUM, RPCArg::DefaultHint{"the current best block"}, "The block hash or height of the target height (only available with coinstatsindex).",
945 .skip_type_check = true,
946 .type_str = {"", "string or numeric"},
947 }},
948 {"use_index", RPCArg::Type::BOOL, RPCArg::Default{true}, "Use coinstatsindex, if available."},
949 },
950 RPCResult{
951 RPCResult::Type::OBJ, "", "",
952 {
953 {RPCResult::Type::NUM, "height", "The block height (index) of the returned statistics"},
954 {RPCResult::Type::STR_HEX, "bestblock", "The hash of the block at which these statistics are calculated"},
955 {RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs"},
956 {RPCResult::Type::NUM, "bogosize", "Database-independent, meaningless metric indicating the UTXO set size"},
957 {RPCResult::Type::STR_HEX, "hash_serialized_3", /*optional=*/true, "The serialized hash (only present if 'hash_serialized_3' hash_type is chosen)"},
958 {RPCResult::Type::STR_HEX, "muhash", /*optional=*/true, "The serialized hash (only present if 'muhash' hash_type is chosen)"},
959 {RPCResult::Type::NUM, "transactions", /*optional=*/true, "The number of transactions with unspent outputs (not available when coinstatsindex is used)"},
960 {RPCResult::Type::NUM, "disk_size", /*optional=*/true, "The estimated size of the chainstate on disk (not available when coinstatsindex is used)"},
961 {RPCResult::Type::STR_AMOUNT, "total_amount", "The total amount of coins in the UTXO set"},
962 {RPCResult::Type::STR_AMOUNT, "total_unspendable_amount", /*optional=*/true, "The total amount of coins permanently excluded from the UTXO set (only available if coinstatsindex is used)"},
963 {RPCResult::Type::OBJ, "block_info", /*optional=*/true, "Info on amounts in the block at this block height (only available if coinstatsindex is used)",
964 {
965 {RPCResult::Type::STR_AMOUNT, "prevout_spent", "Total amount of all prevouts spent in this block"},
966 {RPCResult::Type::STR_AMOUNT, "coinbase", "Coinbase subsidy amount of this block"},
967 {RPCResult::Type::STR_AMOUNT, "new_outputs_ex_coinbase", "Total amount of new outputs created by this block"},
968 {RPCResult::Type::STR_AMOUNT, "unspendable", "Total amount of unspendable outputs created in this block"},
969 {RPCResult::Type::OBJ, "unspendables", "Detailed view of the unspendable categories",
970 {
971 {RPCResult::Type::STR_AMOUNT, "genesis_block", "The unspendable amount of the Genesis block subsidy"},
972 {RPCResult::Type::STR_AMOUNT, "bip30", "Transactions overridden by duplicates (no longer possible with BIP30)"},
973 {RPCResult::Type::STR_AMOUNT, "scripts", "Amounts sent to scripts that are unspendable (for example OP_RETURN outputs)"},
974 {RPCResult::Type::STR_AMOUNT, "unclaimed_rewards", "Fee rewards that miners did not claim in their coinbase transaction"},
975 }}
976 }},
977 }},
979 HelpExampleCli("gettxoutsetinfo", "") +
980 HelpExampleCli("gettxoutsetinfo", R"("none")") +
981 HelpExampleCli("gettxoutsetinfo", R"("none" 1000)") +
982 HelpExampleCli("gettxoutsetinfo", R"("none" '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"')") +
983 HelpExampleCli("-named gettxoutsetinfo", R"(hash_type='muhash' use_index='false')") +
984 HelpExampleRpc("gettxoutsetinfo", "") +
985 HelpExampleRpc("gettxoutsetinfo", R"("none")") +
986 HelpExampleRpc("gettxoutsetinfo", R"("none", 1000)") +
987 HelpExampleRpc("gettxoutsetinfo", R"("none", "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09")")
988 },
989 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
990{
992
993 const CBlockIndex* pindex{nullptr};
994 const CoinStatsHashType hash_type{request.params[0].isNull() ? CoinStatsHashType::HASH_SERIALIZED : ParseHashType(request.params[0].get_str())};
995 bool index_requested = request.params[2].isNull() || request.params[2].get_bool();
996
997 NodeContext& node = EnsureAnyNodeContext(request.context);
999 Chainstate& active_chainstate = chainman.ActiveChainstate();
1000 active_chainstate.ForceFlushStateToDisk();
1001
1002 CCoinsView* coins_view;
1003 BlockManager* blockman;
1004 {
1005 LOCK(::cs_main);
1006 coins_view = &active_chainstate.CoinsDB();
1007 blockman = &active_chainstate.m_blockman;
1008 pindex = blockman->LookupBlockIndex(coins_view->GetBestBlock());
1009 }
1010
1011 if (!request.params[1].isNull()) {
1012 if (!g_coin_stats_index) {
1013 throw JSONRPCError(RPC_INVALID_PARAMETER, "Querying specific block heights requires coinstatsindex");
1014 }
1015
1016 if (hash_type == CoinStatsHashType::HASH_SERIALIZED) {
1017 throw JSONRPCError(RPC_INVALID_PARAMETER, "hash_serialized_3 hash type cannot be queried for a specific block");
1018 }
1019
1020 if (!index_requested) {
1021 throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot set use_index to false when querying for a specific block");
1022 }
1023 pindex = ParseHashOrHeight(request.params[1], chainman);
1024 }
1025
1026 if (index_requested && g_coin_stats_index) {
1027 if (!g_coin_stats_index->BlockUntilSyncedToCurrentChain()) {
1028 const IndexSummary summary{g_coin_stats_index->GetSummary()};
1029
1030 // If a specific block was requested and the index has already synced past that height, we can return the
1031 // data already even though the index is not fully synced yet.
1032 if (pindex->nHeight > summary.best_block_height) {
1033 throw JSONRPCError(RPC_INTERNAL_ERROR, strprintf("Unable to get data because coinstatsindex is still syncing. Current height: %d", summary.best_block_height));
1034 }
1035 }
1036 }
1037
1038 const std::optional<CCoinsStats> maybe_stats = GetUTXOStats(coins_view, *blockman, hash_type, node.rpc_interruption_point, pindex, index_requested);
1039 if (maybe_stats.has_value()) {
1040 const CCoinsStats& stats = maybe_stats.value();
1041 ret.pushKV("height", (int64_t)stats.nHeight);
1042 ret.pushKV("bestblock", stats.hashBlock.GetHex());
1043 ret.pushKV("txouts", (int64_t)stats.nTransactionOutputs);
1044 ret.pushKV("bogosize", (int64_t)stats.nBogoSize);
1045 if (hash_type == CoinStatsHashType::HASH_SERIALIZED) {
1046 ret.pushKV("hash_serialized_3", stats.hashSerialized.GetHex());
1047 }
1048 if (hash_type == CoinStatsHashType::MUHASH) {
1049 ret.pushKV("muhash", stats.hashSerialized.GetHex());
1050 }
1051 CHECK_NONFATAL(stats.total_amount.has_value());
1052 ret.pushKV("total_amount", ValueFromAmount(stats.total_amount.value()));
1053 if (!stats.index_used) {
1054 ret.pushKV("transactions", static_cast<int64_t>(stats.nTransactions));
1055 ret.pushKV("disk_size", stats.nDiskSize);
1056 } else {
1057 ret.pushKV("total_unspendable_amount", ValueFromAmount(stats.total_unspendable_amount));
1058
1059 CCoinsStats prev_stats{};
1060 if (pindex->nHeight > 0) {
1061 const std::optional<CCoinsStats> maybe_prev_stats = GetUTXOStats(coins_view, *blockman, hash_type, node.rpc_interruption_point, pindex->pprev, index_requested);
1062 if (!maybe_prev_stats) {
1063 throw JSONRPCError(RPC_INTERNAL_ERROR, "Unable to read UTXO set");
1064 }
1065 prev_stats = maybe_prev_stats.value();
1066 }
1067
1068 UniValue block_info(UniValue::VOBJ);
1069 block_info.pushKV("prevout_spent", ValueFromAmount(stats.total_prevout_spent_amount - prev_stats.total_prevout_spent_amount));
1070 block_info.pushKV("coinbase", ValueFromAmount(stats.total_coinbase_amount - prev_stats.total_coinbase_amount));
1071 block_info.pushKV("new_outputs_ex_coinbase", ValueFromAmount(stats.total_new_outputs_ex_coinbase_amount - prev_stats.total_new_outputs_ex_coinbase_amount));
1072 block_info.pushKV("unspendable", ValueFromAmount(stats.total_unspendable_amount - prev_stats.total_unspendable_amount));
1073
1074 UniValue unspendables(UniValue::VOBJ);
1075 unspendables.pushKV("genesis_block", ValueFromAmount(stats.total_unspendables_genesis_block - prev_stats.total_unspendables_genesis_block));
1076 unspendables.pushKV("bip30", ValueFromAmount(stats.total_unspendables_bip30 - prev_stats.total_unspendables_bip30));
1077 unspendables.pushKV("scripts", ValueFromAmount(stats.total_unspendables_scripts - prev_stats.total_unspendables_scripts));
1078 unspendables.pushKV("unclaimed_rewards", ValueFromAmount(stats.total_unspendables_unclaimed_rewards - prev_stats.total_unspendables_unclaimed_rewards));
1079 block_info.pushKV("unspendables", std::move(unspendables));
1080
1081 ret.pushKV("block_info", std::move(block_info));
1082 }
1083 } else {
1084 throw JSONRPCError(RPC_INTERNAL_ERROR, "Unable to read UTXO set");
1085 }
1086 return ret;
1087},
1088 };
1089}
1090
1092{
1093 return RPCHelpMan{"gettxout",
1094 "\nReturns details about an unspent transaction output.\n",
1095 {
1096 {"txid", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction id"},
1097 {"n", RPCArg::Type::NUM, RPCArg::Optional::NO, "vout number"},
1098 {"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."},
1099 },
1100 {
1101 RPCResult{"If the UTXO was not found", RPCResult::Type::NONE, "", ""},
1102 RPCResult{"Otherwise", RPCResult::Type::OBJ, "", "", {
1103 {RPCResult::Type::STR_HEX, "bestblock", "The hash of the block at the tip of the chain"},
1104 {RPCResult::Type::NUM, "confirmations", "The number of confirmations"},
1105 {RPCResult::Type::STR_AMOUNT, "value", "The transaction value in " + CURRENCY_UNIT},
1106 {RPCResult::Type::OBJ, "scriptPubKey", "", {
1107 {RPCResult::Type::STR, "asm", "Disassembly of the output script"},
1108 {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},
1109 {RPCResult::Type::STR_HEX, "hex", "The raw output script bytes, hex-encoded"},
1110 {RPCResult::Type::STR, "type", "The type, eg pubkeyhash"},
1111 {RPCResult::Type::STR, "address", /*optional=*/true, "The Bitcoin address (only if a well-defined address exists)"},
1112 }},
1113 {RPCResult::Type::BOOL, "coinbase", "Coinbase or not"},
1114 }},
1115 },
1117 "\nGet unspent transactions\n"
1118 + HelpExampleCli("listunspent", "") +
1119 "\nView the details\n"
1120 + HelpExampleCli("gettxout", "\"txid\" 1") +
1121 "\nAs a JSON-RPC call\n"
1122 + HelpExampleRpc("gettxout", "\"txid\", 1")
1123 },
1124 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1125{
1126 NodeContext& node = EnsureAnyNodeContext(request.context);
1128 LOCK(cs_main);
1129
1131
1132 auto hash{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
1133 COutPoint out{hash, request.params[1].getInt<uint32_t>()};
1134 bool fMempool = true;
1135 if (!request.params[2].isNull())
1136 fMempool = request.params[2].get_bool();
1137
1138 Chainstate& active_chainstate = chainman.ActiveChainstate();
1139 CCoinsViewCache* coins_view = &active_chainstate.CoinsTip();
1140
1141 std::optional<Coin> coin;
1142 if (fMempool) {
1143 const CTxMemPool& mempool = EnsureMemPool(node);
1144 LOCK(mempool.cs);
1145 CCoinsViewMemPool view(coins_view, mempool);
1146 if (!mempool.isSpent(out)) coin = view.GetCoin(out);
1147 } else {
1148 coin = coins_view->GetCoin(out);
1149 }
1150 if (!coin) return UniValue::VNULL;
1151
1152 const CBlockIndex* pindex = active_chainstate.m_blockman.LookupBlockIndex(coins_view->GetBestBlock());
1153 ret.pushKV("bestblock", pindex->GetBlockHash().GetHex());
1154 if (coin->nHeight == MEMPOOL_HEIGHT) {
1155 ret.pushKV("confirmations", 0);
1156 } else {
1157 ret.pushKV("confirmations", (int64_t)(pindex->nHeight - coin->nHeight + 1));
1158 }
1159 ret.pushKV("value", ValueFromAmount(coin->out.nValue));
1161 ScriptToUniv(coin->out.scriptPubKey, /*out=*/o, /*include_hex=*/true, /*include_address=*/true);
1162 ret.pushKV("scriptPubKey", std::move(o));
1163 ret.pushKV("coinbase", (bool)coin->fCoinBase);
1164
1165 return ret;
1166},
1167 };
1168}
1169
1171{
1172 return RPCHelpMan{"verifychain",
1173 "\nVerifies blockchain database.\n",
1174 {
1175 {"checklevel", RPCArg::Type::NUM, RPCArg::DefaultHint{strprintf("%d, range=0-4", DEFAULT_CHECKLEVEL)},
1176 strprintf("How thorough the block verification is:\n%s", MakeUnorderedList(CHECKLEVEL_DOC))},
1177 {"nblocks", RPCArg::Type::NUM, RPCArg::DefaultHint{strprintf("%d, 0=all", DEFAULT_CHECKBLOCKS)}, "The number of blocks to check."},
1178 },
1179 RPCResult{
1180 RPCResult::Type::BOOL, "", "Verification finished successfully. If false, check debug.log for reason."},
1182 HelpExampleCli("verifychain", "")
1183 + HelpExampleRpc("verifychain", "")
1184 },
1185 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1186{
1187 const int check_level{request.params[0].isNull() ? DEFAULT_CHECKLEVEL : request.params[0].getInt<int>()};
1188 const int check_depth{request.params[1].isNull() ? DEFAULT_CHECKBLOCKS : request.params[1].getInt<int>()};
1189
1190 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1191 LOCK(cs_main);
1192
1193 Chainstate& active_chainstate = chainman.ActiveChainstate();
1194 return CVerifyDB(chainman.GetNotifications()).VerifyDB(
1195 active_chainstate, chainman.GetParams().GetConsensus(), active_chainstate.CoinsTip(), check_level, check_depth) == VerifyDBResult::SUCCESS;
1196},
1197 };
1198}
1199
1200static void SoftForkDescPushBack(const CBlockIndex* blockindex, UniValue& softforks, const ChainstateManager& chainman, Consensus::BuriedDeployment dep)
1201{
1202 // For buried deployments.
1203
1204 if (!DeploymentEnabled(chainman, dep)) return;
1205
1207 rv.pushKV("type", "buried");
1208 // getdeploymentinfo reports the softfork as active from when the chain height is
1209 // one below the activation height
1210 rv.pushKV("active", DeploymentActiveAfter(blockindex, chainman, dep));
1211 rv.pushKV("height", chainman.GetConsensus().DeploymentHeight(dep));
1212 softforks.pushKV(DeploymentName(dep), std::move(rv));
1213}
1214
1215static void SoftForkDescPushBack(const CBlockIndex* blockindex, UniValue& softforks, const ChainstateManager& chainman, Consensus::DeploymentPos id)
1216{
1217 // For BIP9 deployments.
1218
1219 if (!DeploymentEnabled(chainman, id)) return;
1220 if (blockindex == nullptr) return;
1221
1222 auto get_state_name = [](const ThresholdState state) -> std::string {
1223 switch (state) {
1224 case ThresholdState::DEFINED: return "defined";
1225 case ThresholdState::STARTED: return "started";
1226 case ThresholdState::LOCKED_IN: return "locked_in";
1227 case ThresholdState::ACTIVE: return "active";
1228 case ThresholdState::FAILED: return "failed";
1229 }
1230 return "invalid";
1231 };
1232
1234
1235 const ThresholdState next_state = chainman.m_versionbitscache.State(blockindex, chainman.GetConsensus(), id);
1236 const ThresholdState current_state = chainman.m_versionbitscache.State(blockindex->pprev, chainman.GetConsensus(), id);
1237
1238 const bool has_signal = (ThresholdState::STARTED == current_state || ThresholdState::LOCKED_IN == current_state);
1239
1240 // BIP9 parameters
1241 if (has_signal) {
1242 bip9.pushKV("bit", chainman.GetConsensus().vDeployments[id].bit);
1243 }
1244 bip9.pushKV("start_time", chainman.GetConsensus().vDeployments[id].nStartTime);
1245 bip9.pushKV("timeout", chainman.GetConsensus().vDeployments[id].nTimeout);
1246 bip9.pushKV("min_activation_height", chainman.GetConsensus().vDeployments[id].min_activation_height);
1247
1248 // BIP9 status
1249 bip9.pushKV("status", get_state_name(current_state));
1250 bip9.pushKV("since", chainman.m_versionbitscache.StateSinceHeight(blockindex->pprev, chainman.GetConsensus(), id));
1251 bip9.pushKV("status_next", get_state_name(next_state));
1252
1253 // BIP9 signalling status, if applicable
1254 if (has_signal) {
1255 UniValue statsUV(UniValue::VOBJ);
1256 std::vector<bool> signals;
1257 BIP9Stats statsStruct = chainman.m_versionbitscache.Statistics(blockindex, chainman.GetConsensus(), id, &signals);
1258 statsUV.pushKV("period", statsStruct.period);
1259 statsUV.pushKV("elapsed", statsStruct.elapsed);
1260 statsUV.pushKV("count", statsStruct.count);
1261 if (ThresholdState::LOCKED_IN != current_state) {
1262 statsUV.pushKV("threshold", statsStruct.threshold);
1263 statsUV.pushKV("possible", statsStruct.possible);
1264 }
1265 bip9.pushKV("statistics", std::move(statsUV));
1266
1267 std::string sig;
1268 sig.reserve(signals.size());
1269 for (const bool s : signals) {
1270 sig.push_back(s ? '#' : '-');
1271 }
1272 bip9.pushKV("signalling", sig);
1273 }
1274
1276 rv.pushKV("type", "bip9");
1277 if (ThresholdState::ACTIVE == next_state) {
1278 rv.pushKV("height", chainman.m_versionbitscache.StateSinceHeight(blockindex, chainman.GetConsensus(), id));
1279 }
1280 rv.pushKV("active", ThresholdState::ACTIVE == next_state);
1281 rv.pushKV("bip9", std::move(bip9));
1282
1283 softforks.pushKV(DeploymentName(id), std::move(rv));
1284}
1285
1286// used by rest.cpp:rest_chaininfo, so cannot be static
1288{
1289 return RPCHelpMan{"getblockchaininfo",
1290 "Returns an object containing various state info regarding blockchain processing.\n",
1291 {},
1292 RPCResult{
1293 RPCResult::Type::OBJ, "", "",
1294 {
1295 {RPCResult::Type::STR, "chain", "current network name (" LIST_CHAIN_NAMES ")"},
1296 {RPCResult::Type::NUM, "blocks", "the height of the most-work fully-validated chain. The genesis block has height 0"},
1297 {RPCResult::Type::NUM, "headers", "the current number of headers we have validated"},
1298 {RPCResult::Type::STR, "bestblockhash", "the hash of the currently best block"},
1299 {RPCResult::Type::NUM, "difficulty", "the current difficulty"},
1300 {RPCResult::Type::NUM_TIME, "time", "The block time expressed in " + UNIX_EPOCH_TIME},
1301 {RPCResult::Type::NUM_TIME, "mediantime", "The median block time expressed in " + UNIX_EPOCH_TIME},
1302 {RPCResult::Type::NUM, "verificationprogress", "estimate of verification progress [0..1]"},
1303 {RPCResult::Type::BOOL, "initialblockdownload", "(debug information) estimate of whether this node is in Initial Block Download mode"},
1304 {RPCResult::Type::STR_HEX, "chainwork", "total amount of work in active chain, in hexadecimal"},
1305 {RPCResult::Type::NUM, "size_on_disk", "the estimated size of the block and undo files on disk"},
1306 {RPCResult::Type::BOOL, "pruned", "if the blocks are subject to pruning"},
1307 {RPCResult::Type::NUM, "pruneheight", /*optional=*/true, "height of the last block pruned, plus one (only present if pruning is enabled)"},
1308 {RPCResult::Type::BOOL, "automatic_pruning", /*optional=*/true, "whether automatic pruning is enabled (only present if pruning is enabled)"},
1309 {RPCResult::Type::NUM, "prune_target_size", /*optional=*/true, "the target size used by pruning (only present if automatic pruning is enabled)"},
1310 (IsDeprecatedRPCEnabled("warnings") ?
1311 RPCResult{RPCResult::Type::STR, "warnings", "any network and blockchain warnings (DEPRECATED)"} :
1312 RPCResult{RPCResult::Type::ARR, "warnings", "any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",
1313 {
1314 {RPCResult::Type::STR, "", "warning"},
1315 }
1316 }
1317 ),
1318 }},
1320 HelpExampleCli("getblockchaininfo", "")
1321 + HelpExampleRpc("getblockchaininfo", "")
1322 },
1323 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1324{
1325 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1326 LOCK(cs_main);
1327 Chainstate& active_chainstate = chainman.ActiveChainstate();
1328
1329 const CBlockIndex& tip{*CHECK_NONFATAL(active_chainstate.m_chain.Tip())};
1330 const int height{tip.nHeight};
1332 obj.pushKV("chain", chainman.GetParams().GetChainTypeString());
1333 obj.pushKV("blocks", height);
1334 obj.pushKV("headers", chainman.m_best_header ? chainman.m_best_header->nHeight : -1);
1335 obj.pushKV("bestblockhash", tip.GetBlockHash().GetHex());
1336 obj.pushKV("difficulty", GetDifficulty(tip));
1337 obj.pushKV("time", tip.GetBlockTime());
1338 obj.pushKV("mediantime", tip.GetMedianTimePast());
1339 obj.pushKV("verificationprogress", chainman.GuessVerificationProgress(&tip));
1340 obj.pushKV("initialblockdownload", chainman.IsInitialBlockDownload());
1341 obj.pushKV("chainwork", tip.nChainWork.GetHex());
1342 obj.pushKV("size_on_disk", chainman.m_blockman.CalculateCurrentUsage());
1343 obj.pushKV("pruned", chainman.m_blockman.IsPruneMode());
1344 if (chainman.m_blockman.IsPruneMode()) {
1345 const auto prune_height{GetPruneHeight(chainman.m_blockman, active_chainstate.m_chain)};
1346 obj.pushKV("pruneheight", prune_height ? prune_height.value() + 1 : 0);
1347
1348 const bool automatic_pruning{chainman.m_blockman.GetPruneTarget() != BlockManager::PRUNE_TARGET_MANUAL};
1349 obj.pushKV("automatic_pruning", automatic_pruning);
1350 if (automatic_pruning) {
1351 obj.pushKV("prune_target_size", chainman.m_blockman.GetPruneTarget());
1352 }
1353 }
1354
1355 NodeContext& node = EnsureAnyNodeContext(request.context);
1356 obj.pushKV("warnings", node::GetWarningsForRpc(*CHECK_NONFATAL(node.warnings), IsDeprecatedRPCEnabled("warnings")));
1357 return obj;
1358},
1359 };
1360}
1361
1362namespace {
1363const std::vector<RPCResult> RPCHelpForDeployment{
1364 {RPCResult::Type::STR, "type", "one of \"buried\", \"bip9\""},
1365 {RPCResult::Type::NUM, "height", /*optional=*/true, "height of the first block which the rules are or will be enforced (only for \"buried\" type, or \"bip9\" type with \"active\" status)"},
1366 {RPCResult::Type::BOOL, "active", "true if the rules are enforced for the mempool and the next block"},
1367 {RPCResult::Type::OBJ, "bip9", /*optional=*/true, "status of bip9 softforks (only for \"bip9\" type)",
1368 {
1369 {RPCResult::Type::NUM, "bit", /*optional=*/true, "the bit (0-28) in the block version field used to signal this softfork (only for \"started\" and \"locked_in\" status)"},
1370 {RPCResult::Type::NUM_TIME, "start_time", "the minimum median time past of a block at which the bit gains its meaning"},
1371 {RPCResult::Type::NUM_TIME, "timeout", "the median time past of a block at which the deployment is considered failed if not yet locked in"},
1372 {RPCResult::Type::NUM, "min_activation_height", "minimum height of blocks for which the rules may be enforced"},
1373 {RPCResult::Type::STR, "status", "status of deployment at specified block (one of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\")"},
1374 {RPCResult::Type::NUM, "since", "height of the first block to which the status applies"},
1375 {RPCResult::Type::STR, "status_next", "status of deployment at the next block"},
1376 {RPCResult::Type::OBJ, "statistics", /*optional=*/true, "numeric statistics about signalling for a softfork (only for \"started\" and \"locked_in\" status)",
1377 {
1378 {RPCResult::Type::NUM, "period", "the length in blocks of the signalling period"},
1379 {RPCResult::Type::NUM, "threshold", /*optional=*/true, "the number of blocks with the version bit set required to activate the feature (only for \"started\" status)"},
1380 {RPCResult::Type::NUM, "elapsed", "the number of blocks elapsed since the beginning of the current period"},
1381 {RPCResult::Type::NUM, "count", "the number of blocks with the version bit set in the current period"},
1382 {RPCResult::Type::BOOL, "possible", /*optional=*/true, "returns false if there are not enough blocks left in this period to pass activation threshold (only for \"started\" status)"},
1383 }},
1384 {RPCResult::Type::STR, "signalling", /*optional=*/true, "indicates blocks that signalled with a # and blocks that did not with a -"},
1385 }},
1386};
1387
1388UniValue DeploymentInfo(const CBlockIndex* blockindex, const ChainstateManager& chainman)
1389{
1390 UniValue softforks(UniValue::VOBJ);
1391 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_HEIGHTINCB);
1392 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_DERSIG);
1393 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_CLTV);
1394 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_CSV);
1395 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_SEGWIT);
1396 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_TESTDUMMY);
1397 SoftForkDescPushBack(blockindex, softforks, chainman, Consensus::DEPLOYMENT_TAPROOT);
1398 return softforks;
1399}
1400} // anon namespace
1401
1403{
1404 return RPCHelpMan{"getdeploymentinfo",
1405 "Returns an object containing various state info regarding deployments of consensus changes.",
1406 {
1407 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Default{"hash of current chain tip"}, "The block hash at which to query deployment state"},
1408 },
1409 RPCResult{
1410 RPCResult::Type::OBJ, "", "", {
1411 {RPCResult::Type::STR, "hash", "requested block hash (or tip)"},
1412 {RPCResult::Type::NUM, "height", "requested block height (or tip)"},
1413 {RPCResult::Type::OBJ_DYN, "deployments", "", {
1414 {RPCResult::Type::OBJ, "xxxx", "name of the deployment", RPCHelpForDeployment}
1415 }},
1416 }
1417 },
1418 RPCExamples{ HelpExampleCli("getdeploymentinfo", "") + HelpExampleRpc("getdeploymentinfo", "") },
1419 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1420 {
1421 const ChainstateManager& chainman = EnsureAnyChainman(request.context);
1422 LOCK(cs_main);
1423 const Chainstate& active_chainstate = chainman.ActiveChainstate();
1424
1425 const CBlockIndex* blockindex;
1426 if (request.params[0].isNull()) {
1427 blockindex = CHECK_NONFATAL(active_chainstate.m_chain.Tip());
1428 } else {
1429 const uint256 hash(ParseHashV(request.params[0], "blockhash"));
1430 blockindex = chainman.m_blockman.LookupBlockIndex(hash);
1431 if (!blockindex) {
1432 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
1433 }
1434 }
1435
1436 UniValue deploymentinfo(UniValue::VOBJ);
1437 deploymentinfo.pushKV("hash", blockindex->GetBlockHash().ToString());
1438 deploymentinfo.pushKV("height", blockindex->nHeight);
1439 deploymentinfo.pushKV("deployments", DeploymentInfo(blockindex, chainman));
1440 return deploymentinfo;
1441 },
1442 };
1443}
1444
1447{
1448 bool operator()(const CBlockIndex* a, const CBlockIndex* b) const
1449 {
1450 /* Make sure that unequal blocks with the same height do not compare
1451 equal. Use the pointers themselves to make a distinction. */
1452
1453 if (a->nHeight != b->nHeight)
1454 return (a->nHeight > b->nHeight);
1455
1456 return a < b;
1457 }
1458};
1459
1461{
1462 return RPCHelpMan{"getchaintips",
1463 "Return information about all known tips in the block tree,"
1464 " including the main chain as well as orphaned branches.\n",
1465 {},
1466 RPCResult{
1467 RPCResult::Type::ARR, "", "",
1468 {{RPCResult::Type::OBJ, "", "",
1469 {
1470 {RPCResult::Type::NUM, "height", "height of the chain tip"},
1471 {RPCResult::Type::STR_HEX, "hash", "block hash of the tip"},
1472 {RPCResult::Type::NUM, "branchlen", "zero for main chain, otherwise length of branch connecting the tip to the main chain"},
1473 {RPCResult::Type::STR, "status", "status of the chain, \"active\" for the main chain\n"
1474 "Possible values for status:\n"
1475 "1. \"invalid\" This branch contains at least one invalid block\n"
1476 "2. \"headers-only\" Not all blocks for this branch are available, but the headers are valid\n"
1477 "3. \"valid-headers\" All blocks are available for this branch, but they were never fully validated\n"
1478 "4. \"valid-fork\" This branch is not part of the active chain, but is fully validated\n"
1479 "5. \"active\" This is the tip of the active main chain, which is certainly valid"},
1480 }}}},
1482 HelpExampleCli("getchaintips", "")
1483 + HelpExampleRpc("getchaintips", "")
1484 },
1485 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1486{
1487 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1488 LOCK(cs_main);
1489 CChain& active_chain = chainman.ActiveChain();
1490
1491 /*
1492 * Idea: The set of chain tips is the active chain tip, plus orphan blocks which do not have another orphan building off of them.
1493 * Algorithm:
1494 * - Make one pass through BlockIndex(), picking out the orphan blocks, and also storing a set of the orphan block's pprev pointers.
1495 * - Iterate through the orphan blocks. If the block isn't pointed to by another orphan, it is a chain tip.
1496 * - Add the active chain tip
1497 */
1498 std::set<const CBlockIndex*, CompareBlocksByHeight> setTips;
1499 std::set<const CBlockIndex*> setOrphans;
1500 std::set<const CBlockIndex*> setPrevs;
1501
1502 for (const auto& [_, block_index] : chainman.BlockIndex()) {
1503 if (!active_chain.Contains(&block_index)) {
1504 setOrphans.insert(&block_index);
1505 setPrevs.insert(block_index.pprev);
1506 }
1507 }
1508
1509 for (std::set<const CBlockIndex*>::iterator it = setOrphans.begin(); it != setOrphans.end(); ++it) {
1510 if (setPrevs.erase(*it) == 0) {
1511 setTips.insert(*it);
1512 }
1513 }
1514
1515 // Always report the currently active tip.
1516 setTips.insert(active_chain.Tip());
1517
1518 /* Construct the output array. */
1520 for (const CBlockIndex* block : setTips) {
1522 obj.pushKV("height", block->nHeight);
1523 obj.pushKV("hash", block->phashBlock->GetHex());
1524
1525 const int branchLen = block->nHeight - active_chain.FindFork(block)->nHeight;
1526 obj.pushKV("branchlen", branchLen);
1527
1528 std::string status;
1529 if (active_chain.Contains(block)) {
1530 // This block is part of the currently active chain.
1531 status = "active";
1532 } else if (block->nStatus & BLOCK_FAILED_MASK) {
1533 // This block or one of its ancestors is invalid.
1534 status = "invalid";
1535 } else if (!block->HaveNumChainTxs()) {
1536 // This block cannot be connected because full block data for it or one of its parents is missing.
1537 status = "headers-only";
1538 } else if (block->IsValid(BLOCK_VALID_SCRIPTS)) {
1539 // This block is fully validated, but no longer part of the active chain. It was probably the active block once, but was reorganized.
1540 status = "valid-fork";
1541 } else if (block->IsValid(BLOCK_VALID_TREE)) {
1542 // The headers for this block are valid, but it has not been validated. It was probably never part of the most-work chain.
1543 status = "valid-headers";
1544 } else {
1545 // No clue.
1546 status = "unknown";
1547 }
1548 obj.pushKV("status", status);
1549
1550 res.push_back(std::move(obj));
1551 }
1552
1553 return res;
1554},
1555 };
1556}
1557
1559{
1560 return RPCHelpMan{"preciousblock",
1561 "\nTreats a block as if it were received before others with the same work.\n"
1562 "\nA later preciousblock call can override the effect of an earlier one.\n"
1563 "\nThe effects of preciousblock are not retained across restarts.\n",
1564 {
1565 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hash of the block to mark as precious"},
1566 },
1569 HelpExampleCli("preciousblock", "\"blockhash\"")
1570 + HelpExampleRpc("preciousblock", "\"blockhash\"")
1571 },
1572 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1573{
1574 uint256 hash(ParseHashV(request.params[0], "blockhash"));
1575 CBlockIndex* pblockindex;
1576
1577 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1578 {
1579 LOCK(cs_main);
1580 pblockindex = chainman.m_blockman.LookupBlockIndex(hash);
1581 if (!pblockindex) {
1582 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
1583 }
1584 }
1585
1587 chainman.ActiveChainstate().PreciousBlock(state, pblockindex);
1588
1589 if (!state.IsValid()) {
1591 }
1592
1593 return UniValue::VNULL;
1594},
1595 };
1596}
1597
1598void InvalidateBlock(ChainstateManager& chainman, const uint256 block_hash) {
1600 CBlockIndex* pblockindex;
1601 {
1602 LOCK(chainman.GetMutex());
1603 pblockindex = chainman.m_blockman.LookupBlockIndex(block_hash);
1604 if (!pblockindex) {
1605 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
1606 }
1607 }
1608 chainman.ActiveChainstate().InvalidateBlock(state, pblockindex);
1609
1610 if (state.IsValid()) {
1611 chainman.ActiveChainstate().ActivateBestChain(state);
1612 }
1613
1614 if (!state.IsValid()) {
1616 }
1617}
1618
1620{
1621 return RPCHelpMan{"invalidateblock",
1622 "\nPermanently marks a block as invalid, as if it violated a consensus rule.\n",
1623 {
1624 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hash of the block to mark as invalid"},
1625 },
1628 HelpExampleCli("invalidateblock", "\"blockhash\"")
1629 + HelpExampleRpc("invalidateblock", "\"blockhash\"")
1630 },
1631 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1632{
1633 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1634 uint256 hash(ParseHashV(request.params[0], "blockhash"));
1635
1636 InvalidateBlock(chainman, hash);
1637
1638 return UniValue::VNULL;
1639},
1640 };
1641}
1642
1643void ReconsiderBlock(ChainstateManager& chainman, uint256 block_hash) {
1644 {
1645 LOCK(chainman.GetMutex());
1646 CBlockIndex* pblockindex = chainman.m_blockman.LookupBlockIndex(block_hash);
1647 if (!pblockindex) {
1648 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
1649 }
1650
1651 chainman.ActiveChainstate().ResetBlockFailureFlags(pblockindex);
1652 chainman.RecalculateBestHeader();
1653 }
1654
1656 chainman.ActiveChainstate().ActivateBestChain(state);
1657
1658 if (!state.IsValid()) {
1660 }
1661}
1662
1664{
1665 return RPCHelpMan{"reconsiderblock",
1666 "\nRemoves invalidity status of a block, its ancestors and its descendants, reconsider them for activation.\n"
1667 "This can be used to undo the effects of invalidateblock.\n",
1668 {
1669 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hash of the block to reconsider"},
1670 },
1673 HelpExampleCli("reconsiderblock", "\"blockhash\"")
1674 + HelpExampleRpc("reconsiderblock", "\"blockhash\"")
1675 },
1676 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1677{
1678 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1679 uint256 hash(ParseHashV(request.params[0], "blockhash"));
1680
1681 ReconsiderBlock(chainman, hash);
1682
1683 return UniValue::VNULL;
1684},
1685 };
1686}
1687
1689{
1690 return RPCHelpMan{"getchaintxstats",
1691 "\nCompute statistics about the total number and rate of transactions in the chain.\n",
1692 {
1693 {"nblocks", RPCArg::Type::NUM, RPCArg::DefaultHint{"one month"}, "Size of the window in number of blocks"},
1694 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::DefaultHint{"chain tip"}, "The hash of the block that ends the window."},
1695 },
1696 RPCResult{
1697 RPCResult::Type::OBJ, "", "",
1698 {
1699 {RPCResult::Type::NUM_TIME, "time", "The timestamp for the final block in the window, expressed in " + UNIX_EPOCH_TIME},
1700 {RPCResult::Type::NUM, "txcount", /*optional=*/true,
1701 "The total number of transactions in the chain up to that point, if known. "
1702 "It may be unknown when using assumeutxo."},
1703 {RPCResult::Type::STR_HEX, "window_final_block_hash", "The hash of the final block in the window"},
1704 {RPCResult::Type::NUM, "window_final_block_height", "The height of the final block in the window."},
1705 {RPCResult::Type::NUM, "window_block_count", "Size of the window in number of blocks"},
1706 {RPCResult::Type::NUM, "window_interval", /*optional=*/true, "The elapsed time in the window in seconds. Only returned if \"window_block_count\" is > 0"},
1707 {RPCResult::Type::NUM, "window_tx_count", /*optional=*/true,
1708 "The number of transactions in the window. "
1709 "Only returned if \"window_block_count\" is > 0 and if txcount exists for the start and end of the window."},
1710 {RPCResult::Type::NUM, "txrate", /*optional=*/true,
1711 "The average rate of transactions per second in the window. "
1712 "Only returned if \"window_interval\" is > 0 and if window_tx_count exists."},
1713 }},
1715 HelpExampleCli("getchaintxstats", "")
1716 + HelpExampleRpc("getchaintxstats", "2016")
1717 },
1718 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1719{
1720 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1721 const CBlockIndex* pindex;
1722 int blockcount = 30 * 24 * 60 * 60 / chainman.GetParams().GetConsensus().nPowTargetSpacing; // By default: 1 month
1723
1724 if (request.params[1].isNull()) {
1725 LOCK(cs_main);
1726 pindex = chainman.ActiveChain().Tip();
1727 } else {
1728 uint256 hash(ParseHashV(request.params[1], "blockhash"));
1729 LOCK(cs_main);
1730 pindex = chainman.m_blockman.LookupBlockIndex(hash);
1731 if (!pindex) {
1732 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
1733 }
1734 if (!chainman.ActiveChain().Contains(pindex)) {
1735 throw JSONRPCError(RPC_INVALID_PARAMETER, "Block is not in main chain");
1736 }
1737 }
1738
1739 CHECK_NONFATAL(pindex != nullptr);
1740
1741 if (request.params[0].isNull()) {
1742 blockcount = std::max(0, std::min(blockcount, pindex->nHeight - 1));
1743 } else {
1744 blockcount = request.params[0].getInt<int>();
1745
1746 if (blockcount < 0 || (blockcount > 0 && blockcount >= pindex->nHeight)) {
1747 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid block count: should be between 0 and the block's height - 1");
1748 }
1749 }
1750
1751 const CBlockIndex& past_block{*CHECK_NONFATAL(pindex->GetAncestor(pindex->nHeight - blockcount))};
1752 const int64_t nTimeDiff{pindex->GetMedianTimePast() - past_block.GetMedianTimePast()};
1753
1755 ret.pushKV("time", (int64_t)pindex->nTime);
1756 if (pindex->m_chain_tx_count) {
1757 ret.pushKV("txcount", pindex->m_chain_tx_count);
1758 }
1759 ret.pushKV("window_final_block_hash", pindex->GetBlockHash().GetHex());
1760 ret.pushKV("window_final_block_height", pindex->nHeight);
1761 ret.pushKV("window_block_count", blockcount);
1762 if (blockcount > 0) {
1763 ret.pushKV("window_interval", nTimeDiff);
1764 if (pindex->m_chain_tx_count != 0 && past_block.m_chain_tx_count != 0) {
1765 const auto window_tx_count = pindex->m_chain_tx_count - past_block.m_chain_tx_count;
1766 ret.pushKV("window_tx_count", window_tx_count);
1767 if (nTimeDiff > 0) {
1768 ret.pushKV("txrate", double(window_tx_count) / nTimeDiff);
1769 }
1770 }
1771 }
1772
1773 return ret;
1774},
1775 };
1776}
1777
1778template<typename T>
1779static T CalculateTruncatedMedian(std::vector<T>& scores)
1780{
1781 size_t size = scores.size();
1782 if (size == 0) {
1783 return 0;
1784 }
1785
1786 std::sort(scores.begin(), scores.end());
1787 if (size % 2 == 0) {
1788 return (scores[size / 2 - 1] + scores[size / 2]) / 2;
1789 } else {
1790 return scores[size / 2];
1791 }
1792}
1793
1794void CalculatePercentilesByWeight(CAmount result[NUM_GETBLOCKSTATS_PERCENTILES], std::vector<std::pair<CAmount, int64_t>>& scores, int64_t total_weight)
1795{
1796 if (scores.empty()) {
1797 return;
1798 }
1799
1800 std::sort(scores.begin(), scores.end());
1801
1802 // 10th, 25th, 50th, 75th, and 90th percentile weight units.
1803 const double weights[NUM_GETBLOCKSTATS_PERCENTILES] = {
1804 total_weight / 10.0, total_weight / 4.0, total_weight / 2.0, (total_weight * 3.0) / 4.0, (total_weight * 9.0) / 10.0
1805 };
1806
1807 int64_t next_percentile_index = 0;
1808 int64_t cumulative_weight = 0;
1809 for (const auto& element : scores) {
1810 cumulative_weight += element.second;
1811 while (next_percentile_index < NUM_GETBLOCKSTATS_PERCENTILES && cumulative_weight >= weights[next_percentile_index]) {
1812 result[next_percentile_index] = element.first;
1813 ++next_percentile_index;
1814 }
1815 }
1816
1817 // Fill any remaining percentiles with the last value.
1818 for (int64_t i = next_percentile_index; i < NUM_GETBLOCKSTATS_PERCENTILES; i++) {
1819 result[i] = scores.back().first;
1820 }
1821}
1822
1823template<typename T>
1824static inline bool SetHasKeys(const std::set<T>& set) {return false;}
1825template<typename T, typename Tk, typename... Args>
1826static inline bool SetHasKeys(const std::set<T>& set, const Tk& key, const Args&... args)
1827{
1828 return (set.count(key) != 0) || SetHasKeys(set, args...);
1829}
1830
1831// outpoint (needed for the utxo index) + nHeight + fCoinBase
1832static constexpr size_t PER_UTXO_OVERHEAD = sizeof(COutPoint) + sizeof(uint32_t) + sizeof(bool);
1833
1835{
1836 return RPCHelpMan{"getblockstats",
1837 "\nCompute per block statistics for a given window. All amounts are in satoshis.\n"
1838 "It won't work for some heights with pruning.\n",
1839 {
1840 {"hash_or_height", RPCArg::Type::NUM, RPCArg::Optional::NO, "The block hash or height of the target block",
1842 .skip_type_check = true,
1843 .type_str = {"", "string or numeric"},
1844 }},
1845 {"stats", RPCArg::Type::ARR, RPCArg::DefaultHint{"all values"}, "Values to plot (see result below)",
1846 {
1847 {"height", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Selected statistic"},
1848 {"time", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Selected statistic"},
1849 },
1851 },
1852 RPCResult{
1853 RPCResult::Type::OBJ, "", "",
1854 {
1855 {RPCResult::Type::NUM, "avgfee", /*optional=*/true, "Average fee in the block"},
1856 {RPCResult::Type::NUM, "avgfeerate", /*optional=*/true, "Average feerate (in satoshis per virtual byte)"},
1857 {RPCResult::Type::NUM, "avgtxsize", /*optional=*/true, "Average transaction size"},
1858 {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "The block hash (to check for potential reorgs)"},
1859 {RPCResult::Type::ARR_FIXED, "feerate_percentiles", /*optional=*/true, "Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)",
1860 {
1861 {RPCResult::Type::NUM, "10th_percentile_feerate", "The 10th percentile feerate"},
1862 {RPCResult::Type::NUM, "25th_percentile_feerate", "The 25th percentile feerate"},
1863 {RPCResult::Type::NUM, "50th_percentile_feerate", "The 50th percentile feerate"},
1864 {RPCResult::Type::NUM, "75th_percentile_feerate", "The 75th percentile feerate"},
1865 {RPCResult::Type::NUM, "90th_percentile_feerate", "The 90th percentile feerate"},
1866 }},
1867 {RPCResult::Type::NUM, "height", /*optional=*/true, "The height of the block"},
1868 {RPCResult::Type::NUM, "ins", /*optional=*/true, "The number of inputs (excluding coinbase)"},
1869 {RPCResult::Type::NUM, "maxfee", /*optional=*/true, "Maximum fee in the block"},
1870 {RPCResult::Type::NUM, "maxfeerate", /*optional=*/true, "Maximum feerate (in satoshis per virtual byte)"},
1871 {RPCResult::Type::NUM, "maxtxsize", /*optional=*/true, "Maximum transaction size"},
1872 {RPCResult::Type::NUM, "medianfee", /*optional=*/true, "Truncated median fee in the block"},
1873 {RPCResult::Type::NUM, "mediantime", /*optional=*/true, "The block median time past"},
1874 {RPCResult::Type::NUM, "mediantxsize", /*optional=*/true, "Truncated median transaction size"},
1875 {RPCResult::Type::NUM, "minfee", /*optional=*/true, "Minimum fee in the block"},
1876 {RPCResult::Type::NUM, "minfeerate", /*optional=*/true, "Minimum feerate (in satoshis per virtual byte)"},
1877 {RPCResult::Type::NUM, "mintxsize", /*optional=*/true, "Minimum transaction size"},
1878 {RPCResult::Type::NUM, "outs", /*optional=*/true, "The number of outputs"},
1879 {RPCResult::Type::NUM, "subsidy", /*optional=*/true, "The block subsidy"},
1880 {RPCResult::Type::NUM, "swtotal_size", /*optional=*/true, "Total size of all segwit transactions"},
1881 {RPCResult::Type::NUM, "swtotal_weight", /*optional=*/true, "Total weight of all segwit transactions"},
1882 {RPCResult::Type::NUM, "swtxs", /*optional=*/true, "The number of segwit transactions"},
1883 {RPCResult::Type::NUM, "time", /*optional=*/true, "The block time"},
1884 {RPCResult::Type::NUM, "total_out", /*optional=*/true, "Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])"},
1885 {RPCResult::Type::NUM, "total_size", /*optional=*/true, "Total size of all non-coinbase transactions"},
1886 {RPCResult::Type::NUM, "total_weight", /*optional=*/true, "Total weight of all non-coinbase transactions"},
1887 {RPCResult::Type::NUM, "totalfee", /*optional=*/true, "The fee total"},
1888 {RPCResult::Type::NUM, "txs", /*optional=*/true, "The number of transactions (including coinbase)"},
1889 {RPCResult::Type::NUM, "utxo_increase", /*optional=*/true, "The increase/decrease in the number of unspent outputs (not discounting op_return and similar)"},
1890 {RPCResult::Type::NUM, "utxo_size_inc", /*optional=*/true, "The increase/decrease in size for the utxo index (not discounting op_return and similar)"},
1891 {RPCResult::Type::NUM, "utxo_increase_actual", /*optional=*/true, "The increase/decrease in the number of unspent outputs, not counting unspendables"},
1892 {RPCResult::Type::NUM, "utxo_size_inc_actual", /*optional=*/true, "The increase/decrease in size for the utxo index, not counting unspendables"},
1893 }},
1895 HelpExampleCli("getblockstats", R"('"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' '["minfeerate","avgfeerate"]')") +
1896 HelpExampleCli("getblockstats", R"(1000 '["minfeerate","avgfeerate"]')") +
1897 HelpExampleRpc("getblockstats", R"("00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", ["minfeerate","avgfeerate"])") +
1898 HelpExampleRpc("getblockstats", R"(1000, ["minfeerate","avgfeerate"])")
1899 },
1900 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1901{
1902 ChainstateManager& chainman = EnsureAnyChainman(request.context);
1903 const CBlockIndex& pindex{*CHECK_NONFATAL(ParseHashOrHeight(request.params[0], chainman))};
1904
1905 std::set<std::string> stats;
1906 if (!request.params[1].isNull()) {
1907 const UniValue stats_univalue = request.params[1].get_array();
1908 for (unsigned int i = 0; i < stats_univalue.size(); i++) {
1909 const std::string stat = stats_univalue[i].get_str();
1910 stats.insert(stat);
1911 }
1912 }
1913
1914 const CBlock& block = GetBlockChecked(chainman.m_blockman, pindex);
1915 const CBlockUndo& blockUndo = GetUndoChecked(chainman.m_blockman, pindex);
1916
1917 const bool do_all = stats.size() == 0; // Calculate everything if nothing selected (default)
1918 const bool do_mediantxsize = do_all || stats.count("mediantxsize") != 0;
1919 const bool do_medianfee = do_all || stats.count("medianfee") != 0;
1920 const bool do_feerate_percentiles = do_all || stats.count("feerate_percentiles") != 0;
1921 const bool loop_inputs = do_all || do_medianfee || do_feerate_percentiles ||
1922 SetHasKeys(stats, "utxo_increase", "utxo_increase_actual", "utxo_size_inc", "utxo_size_inc_actual", "totalfee", "avgfee", "avgfeerate", "minfee", "maxfee", "minfeerate", "maxfeerate");
1923 const bool loop_outputs = do_all || loop_inputs || stats.count("total_out");
1924 const bool do_calculate_size = do_mediantxsize ||
1925 SetHasKeys(stats, "total_size", "avgtxsize", "mintxsize", "maxtxsize", "swtotal_size");
1926 const bool do_calculate_weight = do_all || SetHasKeys(stats, "total_weight", "avgfeerate", "swtotal_weight", "avgfeerate", "feerate_percentiles", "minfeerate", "maxfeerate");
1927 const bool do_calculate_sw = do_all || SetHasKeys(stats, "swtxs", "swtotal_size", "swtotal_weight");
1928
1929 CAmount maxfee = 0;
1930 CAmount maxfeerate = 0;
1931 CAmount minfee = MAX_MONEY;
1932 CAmount minfeerate = MAX_MONEY;
1933 CAmount total_out = 0;
1934 CAmount totalfee = 0;
1935 int64_t inputs = 0;
1936 int64_t maxtxsize = 0;
1937 int64_t mintxsize = MAX_BLOCK_SERIALIZED_SIZE;
1938 int64_t outputs = 0;
1939 int64_t swtotal_size = 0;
1940 int64_t swtotal_weight = 0;
1941 int64_t swtxs = 0;
1942 int64_t total_size = 0;
1943 int64_t total_weight = 0;
1944 int64_t utxos = 0;
1945 int64_t utxo_size_inc = 0;
1946 int64_t utxo_size_inc_actual = 0;
1947 std::vector<CAmount> fee_array;
1948 std::vector<std::pair<CAmount, int64_t>> feerate_array;
1949 std::vector<int64_t> txsize_array;
1950
1951 for (size_t i = 0; i < block.vtx.size(); ++i) {
1952 const auto& tx = block.vtx.at(i);
1953 outputs += tx->vout.size();
1954
1955 CAmount tx_total_out = 0;
1956 if (loop_outputs) {
1957 for (const CTxOut& out : tx->vout) {
1958 tx_total_out += out.nValue;
1959
1960 size_t out_size = GetSerializeSize(out) + PER_UTXO_OVERHEAD;
1961 utxo_size_inc += out_size;
1962
1963 // The Genesis block and the repeated BIP30 block coinbases don't change the UTXO
1964 // set counts, so they have to be excluded from the statistics
1965 if (pindex.nHeight == 0 || (IsBIP30Repeat(pindex) && tx->IsCoinBase())) continue;
1966 // Skip unspendable outputs since they are not included in the UTXO set
1967 if (out.scriptPubKey.IsUnspendable()) continue;
1968
1969 ++utxos;
1970 utxo_size_inc_actual += out_size;
1971 }
1972 }
1973
1974 if (tx->IsCoinBase()) {
1975 continue;
1976 }
1977
1978 inputs += tx->vin.size(); // Don't count coinbase's fake input
1979 total_out += tx_total_out; // Don't count coinbase reward
1980
1981 int64_t tx_size = 0;
1982 if (do_calculate_size) {
1983
1984 tx_size = tx->GetTotalSize();
1985 if (do_mediantxsize) {
1986 txsize_array.push_back(tx_size);
1987 }
1988 maxtxsize = std::max(maxtxsize, tx_size);
1989 mintxsize = std::min(mintxsize, tx_size);
1990 total_size += tx_size;
1991 }
1992
1993 int64_t weight = 0;
1994 if (do_calculate_weight) {
1995 weight = GetTransactionWeight(*tx);
1996 total_weight += weight;
1997 }
1998
1999 if (do_calculate_sw && tx->HasWitness()) {
2000 ++swtxs;
2001 swtotal_size += tx_size;
2002 swtotal_weight += weight;
2003 }
2004
2005 if (loop_inputs) {
2006 CAmount tx_total_in = 0;
2007 const auto& txundo = blockUndo.vtxundo.at(i - 1);
2008 for (const Coin& coin: txundo.vprevout) {
2009 const CTxOut& prevoutput = coin.out;
2010
2011 tx_total_in += prevoutput.nValue;
2012 size_t prevout_size = GetSerializeSize(prevoutput) + PER_UTXO_OVERHEAD;
2013 utxo_size_inc -= prevout_size;
2014 utxo_size_inc_actual -= prevout_size;
2015 }
2016
2017 CAmount txfee = tx_total_in - tx_total_out;
2018 CHECK_NONFATAL(MoneyRange(txfee));
2019 if (do_medianfee) {
2020 fee_array.push_back(txfee);
2021 }
2022 maxfee = std::max(maxfee, txfee);
2023 minfee = std::min(minfee, txfee);
2024 totalfee += txfee;
2025
2026 // New feerate uses satoshis per virtual byte instead of per serialized byte
2027 CAmount feerate = weight ? (txfee * WITNESS_SCALE_FACTOR) / weight : 0;
2028 if (do_feerate_percentiles) {
2029 feerate_array.emplace_back(feerate, weight);
2030 }
2031 maxfeerate = std::max(maxfeerate, feerate);
2032 minfeerate = std::min(minfeerate, feerate);
2033 }
2034 }
2035
2036 CAmount feerate_percentiles[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 };
2037 CalculatePercentilesByWeight(feerate_percentiles, feerate_array, total_weight);
2038
2039 UniValue feerates_res(UniValue::VARR);
2040 for (int64_t i = 0; i < NUM_GETBLOCKSTATS_PERCENTILES; i++) {
2041 feerates_res.push_back(feerate_percentiles[i]);
2042 }
2043
2044 UniValue ret_all(UniValue::VOBJ);
2045 ret_all.pushKV("avgfee", (block.vtx.size() > 1) ? totalfee / (block.vtx.size() - 1) : 0);
2046 ret_all.pushKV("avgfeerate", total_weight ? (totalfee * WITNESS_SCALE_FACTOR) / total_weight : 0); // Unit: sat/vbyte
2047 ret_all.pushKV("avgtxsize", (block.vtx.size() > 1) ? total_size / (block.vtx.size() - 1) : 0);
2048 ret_all.pushKV("blockhash", pindex.GetBlockHash().GetHex());
2049 ret_all.pushKV("feerate_percentiles", std::move(feerates_res));
2050 ret_all.pushKV("height", (int64_t)pindex.nHeight);
2051 ret_all.pushKV("ins", inputs);
2052 ret_all.pushKV("maxfee", maxfee);
2053 ret_all.pushKV("maxfeerate", maxfeerate);
2054 ret_all.pushKV("maxtxsize", maxtxsize);
2055 ret_all.pushKV("medianfee", CalculateTruncatedMedian(fee_array));
2056 ret_all.pushKV("mediantime", pindex.GetMedianTimePast());
2057 ret_all.pushKV("mediantxsize", CalculateTruncatedMedian(txsize_array));
2058 ret_all.pushKV("minfee", (minfee == MAX_MONEY) ? 0 : minfee);
2059 ret_all.pushKV("minfeerate", (minfeerate == MAX_MONEY) ? 0 : minfeerate);
2060 ret_all.pushKV("mintxsize", mintxsize == MAX_BLOCK_SERIALIZED_SIZE ? 0 : mintxsize);
2061 ret_all.pushKV("outs", outputs);
2062 ret_all.pushKV("subsidy", GetBlockSubsidy(pindex.nHeight, chainman.GetParams().GetConsensus()));
2063 ret_all.pushKV("swtotal_size", swtotal_size);
2064 ret_all.pushKV("swtotal_weight", swtotal_weight);
2065 ret_all.pushKV("swtxs", swtxs);
2066 ret_all.pushKV("time", pindex.GetBlockTime());
2067 ret_all.pushKV("total_out", total_out);
2068 ret_all.pushKV("total_size", total_size);
2069 ret_all.pushKV("total_weight", total_weight);
2070 ret_all.pushKV("totalfee", totalfee);
2071 ret_all.pushKV("txs", (int64_t)block.vtx.size());
2072 ret_all.pushKV("utxo_increase", outputs - inputs);
2073 ret_all.pushKV("utxo_size_inc", utxo_size_inc);
2074 ret_all.pushKV("utxo_increase_actual", utxos - inputs);
2075 ret_all.pushKV("utxo_size_inc_actual", utxo_size_inc_actual);
2076
2077 if (do_all) {
2078 return ret_all;
2079 }
2080
2082 for (const std::string& stat : stats) {
2083 const UniValue& value = ret_all[stat];
2084 if (value.isNull()) {
2085 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid selected statistic '%s'", stat));
2086 }
2087 ret.pushKV(stat, value);
2088 }
2089 return ret;
2090},
2091 };
2092}
2093
2094namespace {
2096bool 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)
2097{
2098 scan_progress = 0;
2099 count = 0;
2100 while (cursor->Valid()) {
2101 COutPoint key;
2102 Coin coin;
2103 if (!cursor->GetKey(key) || !cursor->GetValue(coin)) return false;
2104 if (++count % 8192 == 0) {
2105 interruption_point();
2106 if (should_abort) {
2107 // allow to abort the scan via the abort reference
2108 return false;
2109 }
2110 }
2111 if (count % 256 == 0) {
2112 // update progress reference every 256 item
2113 uint32_t high = 0x100 * *UCharCast(key.hash.begin()) + *(UCharCast(key.hash.begin()) + 1);
2114 scan_progress = (int)(high * 100.0 / 65536.0 + 0.5);
2115 }
2116 if (needles.count(coin.out.scriptPubKey)) {
2117 out_results.emplace(key, coin);
2118 }
2119 cursor->Next();
2120 }
2121 scan_progress = 100;
2122 return true;
2123}
2124} // namespace
2125
2127static std::atomic<int> g_scan_progress;
2128static std::atomic<bool> g_scan_in_progress;
2129static std::atomic<bool> g_should_abort_scan;
2131{
2132private:
2133 bool m_could_reserve{false};
2134public:
2135 explicit CoinsViewScanReserver() = default;
2136
2137 bool reserve() {
2139 if (g_scan_in_progress.exchange(true)) {
2140 return false;
2141 }
2143 m_could_reserve = true;
2144 return true;
2145 }
2146
2148 if (m_could_reserve) {
2149 g_scan_in_progress = false;
2150 g_scan_progress = 0;
2151 }
2152 }
2153};
2154
2155static const auto scan_action_arg_desc = RPCArg{
2156 "action", RPCArg::Type::STR, RPCArg::Optional::NO, "The action to execute\n"
2157 "\"start\" for starting a scan\n"
2158 "\"abort\" for aborting the current scan (returns true when abort was successful)\n"
2159 "\"status\" for progress report (in %) of the current scan"
2160};
2161
2162static const auto scan_objects_arg_desc = RPCArg{
2163 "scanobjects", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "Array of scan objects. Required for \"start\" action\n"
2164 "Every scan object is either a string descriptor or an object:",
2165 {
2166 {"descriptor", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "An output descriptor"},
2167 {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "An object with output descriptor and metadata",
2168 {
2169 {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
2170 {"range", RPCArg::Type::RANGE, RPCArg::Default{1000}, "The range of HD chain indexes to explore (either end or [begin,end])"},
2171 }},
2172 },
2173 RPCArgOptions{.oneline_description="[scanobjects,...]"},
2174};
2175
2176static const auto scan_result_abort = RPCResult{
2177 "when action=='abort'", RPCResult::Type::BOOL, "success",
2178 "True if scan will be aborted (not necessarily before this RPC returns), or false if there is no scan to abort"
2179};
2181 "when action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""
2182};
2184 "when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "",
2185 {{RPCResult::Type::NUM, "progress", "Approximate percent complete"},}
2186};
2187
2188
2190{
2191 // raw() descriptor corresponding to mainnet address 12cbQLTFMXRnSzktFkuoG3eHoMeFtpTu3S
2192 const std::string EXAMPLE_DESCRIPTOR_RAW = "raw(76a91411b366edfc0a8b66feebae5c2e25a7b6a5d1cf3188ac)#fm24fxxy";
2193
2194 return RPCHelpMan{"scantxoutset",
2195 "\nScans the unspent transaction output set for entries that match certain output descriptors.\n"
2196 "Examples of output descriptors are:\n"
2197 " addr(<address>) Outputs whose output script corresponds to the specified address (does not include P2PK)\n"
2198 " raw(<hex script>) Outputs whose output script equals the specified hex-encoded bytes\n"
2199 " combo(<pubkey>) P2PK, P2PKH, P2WPKH, and P2SH-P2WPKH outputs for the given pubkey\n"
2200 " pkh(<pubkey>) P2PKH outputs for the given pubkey\n"
2201 " sh(multi(<n>,<pubkey>,<pubkey>,...)) P2SH-multisig outputs for the given threshold and pubkeys\n"
2202 " tr(<pubkey>) P2TR\n"
2203 " tr(<pubkey>,{pk(<pubkey>)}) P2TR with single fallback pubkey in tapscript\n"
2204 " rawtr(<pubkey>) P2TR with the specified key as output key rather than inner\n"
2205 " wsh(and_v(v:pk(<pubkey>),after(2))) P2WSH miniscript with mandatory pubkey and a timelock\n"
2206 "\nIn the above, <pubkey> either refers to a fixed public key in hexadecimal notation, or to an xpub/xprv optionally followed by one\n"
2207 "or more path elements separated by \"/\", and optionally ending in \"/*\" (unhardened), or \"/*'\" or \"/*h\" (hardened) to specify all\n"
2208 "unhardened or hardened child keys.\n"
2209 "In the latter case, a range needs to be specified by below if different from 1000.\n"
2210 "For more information on output descriptors, see the documentation in the doc/descriptors.md file.\n",
2211 {
2214 },
2215 {
2216 RPCResult{"when action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", {
2217 {RPCResult::Type::BOOL, "success", "Whether the scan was completed"},
2218 {RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"},
2219 {RPCResult::Type::NUM, "height", "The block height at which the scan was done"},
2220 {RPCResult::Type::STR_HEX, "bestblock", "The hash of the block at the tip of the chain"},
2221 {RPCResult::Type::ARR, "unspents", "",
2222 {
2223 {RPCResult::Type::OBJ, "", "",
2224 {
2225 {RPCResult::Type::STR_HEX, "txid", "The transaction id"},
2226 {RPCResult::Type::NUM, "vout", "The vout value"},
2227 {RPCResult::Type::STR_HEX, "scriptPubKey", "The output script"},
2228 {RPCResult::Type::STR, "desc", "A specialized descriptor for the matched output script"},
2229 {RPCResult::Type::STR_AMOUNT, "amount", "The total amount in " + CURRENCY_UNIT + " of the unspent output"},
2230 {RPCResult::Type::BOOL, "coinbase", "Whether this is a coinbase output"},
2231 {RPCResult::Type::NUM, "height", "Height of the unspent transaction output"},
2232 {RPCResult::Type::STR_HEX, "blockhash", "Blockhash of the unspent transaction output"},
2233 {RPCResult::Type::NUM, "confirmations", "Number of confirmations of the unspent transaction output when the scan was done"},
2234 }},
2235 }},
2236 {RPCResult::Type::STR_AMOUNT, "total_amount", "The total amount of all found unspent outputs in " + CURRENCY_UNIT},
2237 }},
2241 },
2243 HelpExampleCli("scantxoutset", "start \'[\"" + EXAMPLE_DESCRIPTOR_RAW + "\"]\'") +
2244 HelpExampleCli("scantxoutset", "status") +
2245 HelpExampleCli("scantxoutset", "abort") +
2246 HelpExampleRpc("scantxoutset", "\"start\", [\"" + EXAMPLE_DESCRIPTOR_RAW + "\"]") +
2247 HelpExampleRpc("scantxoutset", "\"status\"") +
2248 HelpExampleRpc("scantxoutset", "\"abort\"")
2249 },
2250 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
2251{
2252 UniValue result(UniValue::VOBJ);
2253 const auto action{self.Arg<std::string>("action")};
2254 if (action == "status") {
2255 CoinsViewScanReserver reserver;
2256 if (reserver.reserve()) {
2257 // no scan in progress
2258 return UniValue::VNULL;
2259 }
2260 result.pushKV("progress", g_scan_progress.load());
2261 return result;
2262 } else if (action == "abort") {
2263 CoinsViewScanReserver reserver;
2264 if (reserver.reserve()) {
2265 // reserve was possible which means no scan was running
2266 return false;
2267 }
2268 // set the abort flag
2269 g_should_abort_scan = true;
2270 return true;
2271 } else if (action == "start") {
2272 CoinsViewScanReserver reserver;
2273 if (!reserver.reserve()) {
2274 throw JSONRPCError(RPC_INVALID_PARAMETER, "Scan already in progress, use action \"abort\" or \"status\"");
2275 }
2276
2277 if (request.params.size() < 2) {
2278 throw JSONRPCError(RPC_MISC_ERROR, "scanobjects argument is required for the start action");
2279 }
2280
2281 std::set<CScript> needles;
2282 std::map<CScript, std::string> descriptors;
2283 CAmount total_in = 0;
2284
2285 // loop through the scan objects
2286 for (const UniValue& scanobject : request.params[1].get_array().getValues()) {
2287 FlatSigningProvider provider;
2288 auto scripts = EvalDescriptorStringOrObject(scanobject, provider);
2289 for (CScript& script : scripts) {
2290 std::string inferred = InferDescriptor(script, provider)->ToString();
2291 needles.emplace(script);
2292 descriptors.emplace(std::move(script), std::move(inferred));
2293 }
2294 }
2295
2296 // Scan the unspent transaction output set for inputs
2297 UniValue unspents(UniValue::VARR);
2298 std::vector<CTxOut> input_txos;
2299 std::map<COutPoint, Coin> coins;
2300 g_should_abort_scan = false;
2301 int64_t count = 0;
2302 std::unique_ptr<CCoinsViewCursor> pcursor;
2303 const CBlockIndex* tip;
2304 NodeContext& node = EnsureAnyNodeContext(request.context);
2305 {
2307 LOCK(cs_main);
2308 Chainstate& active_chainstate = chainman.ActiveChainstate();
2309 active_chainstate.ForceFlushStateToDisk();
2310 pcursor = CHECK_NONFATAL(active_chainstate.CoinsDB().Cursor());
2311 tip = CHECK_NONFATAL(active_chainstate.m_chain.Tip());
2312 }
2313 bool res = FindScriptPubKey(g_scan_progress, g_should_abort_scan, count, pcursor.get(), needles, coins, node.rpc_interruption_point);
2314 result.pushKV("success", res);
2315 result.pushKV("txouts", count);
2316 result.pushKV("height", tip->nHeight);
2317 result.pushKV("bestblock", tip->GetBlockHash().GetHex());
2318
2319 for (const auto& it : coins) {
2320 const COutPoint& outpoint = it.first;
2321 const Coin& coin = it.second;
2322 const CTxOut& txo = coin.out;
2323 const CBlockIndex& coinb_block{*CHECK_NONFATAL(tip->GetAncestor(coin.nHeight))};
2324 input_txos.push_back(txo);
2325 total_in += txo.nValue;
2326
2327 UniValue unspent(UniValue::VOBJ);
2328 unspent.pushKV("txid", outpoint.hash.GetHex());
2329 unspent.pushKV("vout", outpoint.n);
2330 unspent.pushKV("scriptPubKey", HexStr(txo.scriptPubKey));
2331 unspent.pushKV("desc", descriptors[txo.scriptPubKey]);
2332 unspent.pushKV("amount", ValueFromAmount(txo.nValue));
2333 unspent.pushKV("coinbase", coin.IsCoinBase());
2334 unspent.pushKV("height", coin.nHeight);
2335 unspent.pushKV("blockhash", coinb_block.GetBlockHash().GetHex());
2336 unspent.pushKV("confirmations", tip->nHeight - coin.nHeight + 1);
2337
2338 unspents.push_back(std::move(unspent));
2339 }
2340 result.pushKV("unspents", std::move(unspents));
2341 result.pushKV("total_amount", ValueFromAmount(total_in));
2342 } else {
2343 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid action '%s'", action));
2344 }
2345 return result;
2346},
2347 };
2348}
2349
2351static std::atomic<int> g_scanfilter_progress;
2352static std::atomic<int> g_scanfilter_progress_height;
2353static std::atomic<bool> g_scanfilter_in_progress;
2354static std::atomic<bool> g_scanfilter_should_abort_scan;
2356{
2357private:
2358 bool m_could_reserve{false};
2359public:
2360 explicit BlockFiltersScanReserver() = default;
2361
2362 bool reserve() {
2364 if (g_scanfilter_in_progress.exchange(true)) {
2365 return false;
2366 }
2367 m_could_reserve = true;
2368 return true;
2369 }
2370
2372 if (m_could_reserve) {
2374 }
2375 }
2376};
2377
2378static bool CheckBlockFilterMatches(BlockManager& blockman, const CBlockIndex& blockindex, const GCSFilter::ElementSet& needles)
2379{
2380 const CBlock block{GetBlockChecked(blockman, blockindex)};
2381 const CBlockUndo block_undo{GetUndoChecked(blockman, blockindex)};
2382
2383 // Check if any of the outputs match the scriptPubKey
2384 for (const auto& tx : block.vtx) {
2385 if (std::any_of(tx->vout.cbegin(), tx->vout.cend(), [&](const auto& txout) {
2386 return needles.count(std::vector<unsigned char>(txout.scriptPubKey.begin(), txout.scriptPubKey.end())) != 0;
2387 })) {
2388 return true;
2389 }
2390 }
2391 // Check if any of the inputs match the scriptPubKey
2392 for (const auto& txundo : block_undo.vtxundo) {
2393 if (std::any_of(txundo.vprevout.cbegin(), txundo.vprevout.cend(), [&](const auto& coin) {
2394 return needles.count(std::vector<unsigned char>(coin.out.scriptPubKey.begin(), coin.out.scriptPubKey.end())) != 0;
2395 })) {
2396 return true;
2397 }
2398 }
2399
2400 return false;
2401}
2402
2404{
2405 return RPCHelpMan{"scanblocks",
2406 "\nReturn relevant blockhashes for given descriptors (requires blockfilterindex).\n"
2407 "This call may take several minutes. Make sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2408 {
2411 RPCArg{"start_height", RPCArg::Type::NUM, RPCArg::Default{0}, "Height to start to scan from"},
2412 RPCArg{"stop_height", RPCArg::Type::NUM, RPCArg::DefaultHint{"chain tip"}, "Height to stop to scan"},
2413 RPCArg{"filtertype", RPCArg::Type::STR, RPCArg::Default{BlockFilterTypeName(BlockFilterType::BASIC)}, "The type name of the filter"},
2415 {
2416 {"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"},
2417 },
2419 },
2420 {
2422 RPCResult{"When action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", {
2423 {RPCResult::Type::NUM, "from_height", "The height we started the scan from"},
2424 {RPCResult::Type::NUM, "to_height", "The height we ended the scan at"},
2425 {RPCResult::Type::ARR, "relevant_blocks", "Blocks that may have matched a scanobject.", {
2426 {RPCResult::Type::STR_HEX, "blockhash", "A relevant blockhash"},
2427 }},
2428 {RPCResult::Type::BOOL, "completed", "true if the scan process was not aborted"}
2429 }},
2430 RPCResult{"when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "", {
2431 {RPCResult::Type::NUM, "progress", "Approximate percent complete"},
2432 {RPCResult::Type::NUM, "current_height", "Height of the block currently being scanned"},
2433 },
2434 },
2436 },
2438 HelpExampleCli("scanblocks", "start '[\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"]' 300000") +
2439 HelpExampleCli("scanblocks", "start '[\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"]' 100 150 basic") +
2440 HelpExampleCli("scanblocks", "status") +
2441 HelpExampleRpc("scanblocks", "\"start\", [\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"], 300000") +
2442 HelpExampleRpc("scanblocks", "\"start\", [\"addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)\"], 100, 150, \"basic\"") +
2443 HelpExampleRpc("scanblocks", "\"status\"")
2444 },
2445 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
2446{
2448 if (request.params[0].get_str() == "status") {
2449 BlockFiltersScanReserver reserver;
2450 if (reserver.reserve()) {
2451 // no scan in progress
2452 return NullUniValue;
2453 }
2454 ret.pushKV("progress", g_scanfilter_progress.load());
2455 ret.pushKV("current_height", g_scanfilter_progress_height.load());
2456 return ret;
2457 } else if (request.params[0].get_str() == "abort") {
2458 BlockFiltersScanReserver reserver;
2459 if (reserver.reserve()) {
2460 // reserve was possible which means no scan was running
2461 return false;
2462 }
2463 // set the abort flag
2465 return true;
2466 } else if (request.params[0].get_str() == "start") {
2467 BlockFiltersScanReserver reserver;
2468 if (!reserver.reserve()) {
2469 throw JSONRPCError(RPC_INVALID_PARAMETER, "Scan already in progress, use action \"abort\" or \"status\"");
2470 }
2471 const std::string filtertype_name{request.params[4].isNull() ? "basic" : request.params[4].get_str()};
2472
2473 BlockFilterType filtertype;
2474 if (!BlockFilterTypeByName(filtertype_name, filtertype)) {
2475 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Unknown filtertype");
2476 }
2477
2478 UniValue options{request.params[5].isNull() ? UniValue::VOBJ : request.params[5]};
2479 bool filter_false_positives{options.exists("filter_false_positives") ? options["filter_false_positives"].get_bool() : false};
2480
2481 BlockFilterIndex* index = GetBlockFilterIndex(filtertype);
2482 if (!index) {
2483 throw JSONRPCError(RPC_MISC_ERROR, "Index is not enabled for filtertype " + filtertype_name);
2484 }
2485
2486 NodeContext& node = EnsureAnyNodeContext(request.context);
2488
2489 // set the start-height
2490 const CBlockIndex* start_index = nullptr;
2491 const CBlockIndex* stop_block = nullptr;
2492 {
2493 LOCK(cs_main);
2494 CChain& active_chain = chainman.ActiveChain();
2495 start_index = active_chain.Genesis();
2496 stop_block = active_chain.Tip(); // If no stop block is provided, stop at the chain tip.
2497 if (!request.params[2].isNull()) {
2498 start_index = active_chain[request.params[2].getInt<int>()];
2499 if (!start_index) {
2500 throw JSONRPCError(RPC_MISC_ERROR, "Invalid start_height");
2501 }
2502 }
2503 if (!request.params[3].isNull()) {
2504 stop_block = active_chain[request.params[3].getInt<int>()];
2505 if (!stop_block || stop_block->nHeight < start_index->nHeight) {
2506 throw JSONRPCError(RPC_MISC_ERROR, "Invalid stop_height");
2507 }
2508 }
2509 }
2510 CHECK_NONFATAL(start_index);
2511 CHECK_NONFATAL(stop_block);
2512
2513 // loop through the scan objects, add scripts to the needle_set
2514 GCSFilter::ElementSet needle_set;
2515 for (const UniValue& scanobject : request.params[1].get_array().getValues()) {
2516 FlatSigningProvider provider;
2517 std::vector<CScript> scripts = EvalDescriptorStringOrObject(scanobject, provider);
2518 for (const CScript& script : scripts) {
2519 needle_set.emplace(script.begin(), script.end());
2520 }
2521 }
2522 UniValue blocks(UniValue::VARR);
2523 const int amount_per_chunk = 10000;
2524 std::vector<BlockFilter> filters;
2525 int start_block_height = start_index->nHeight; // for progress reporting
2526 const int total_blocks_to_process = stop_block->nHeight - start_block_height;
2527
2530 g_scanfilter_progress_height = start_block_height;
2531 bool completed = true;
2532
2533 const CBlockIndex* end_range = nullptr;
2534 do {
2535 node.rpc_interruption_point(); // allow a clean shutdown
2537 completed = false;
2538 break;
2539 }
2540
2541 // split the lookup range in chunks if we are deeper than 'amount_per_chunk' blocks from the stopping block
2542 int start_block = !end_range ? start_index->nHeight : start_index->nHeight + 1; // to not include the previous round 'end_range' block
2543 end_range = (start_block + amount_per_chunk < stop_block->nHeight) ?
2544 WITH_LOCK(::cs_main, return chainman.ActiveChain()[start_block + amount_per_chunk]) :
2545 stop_block;
2546
2547 if (index->LookupFilterRange(start_block, end_range, filters)) {
2548 for (const BlockFilter& filter : filters) {
2549 // compare the elements-set with each filter
2550 if (filter.GetFilter().MatchAny(needle_set)) {
2551 if (filter_false_positives) {
2552 // Double check the filter matches by scanning the block
2553 const CBlockIndex& blockindex = *CHECK_NONFATAL(WITH_LOCK(cs_main, return chainman.m_blockman.LookupBlockIndex(filter.GetBlockHash())));
2554
2555 if (!CheckBlockFilterMatches(chainman.m_blockman, blockindex, needle_set)) {
2556 continue;
2557 }
2558 }
2559
2560 blocks.push_back(filter.GetBlockHash().GetHex());
2561 }
2562 }
2563 }
2564 start_index = end_range;
2565
2566 // update progress
2567 int blocks_processed = end_range->nHeight - start_block_height;
2568 if (total_blocks_to_process > 0) { // avoid division by zero
2569 g_scanfilter_progress = (int)(100.0 / total_blocks_to_process * blocks_processed);
2570 } else {
2572 }
2574
2575 // Finish if we reached the stop block
2576 } while (start_index != stop_block);
2577
2578 ret.pushKV("from_height", start_block_height);
2579 ret.pushKV("to_height", start_index->nHeight); // start_index is always the last scanned block here
2580 ret.pushKV("relevant_blocks", std::move(blocks));
2581 ret.pushKV("completed", completed);
2582 }
2583 else {
2584 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid action '%s'", request.params[0].get_str()));
2585 }
2586 return ret;
2587},
2588 };
2589}
2590
2592{
2593 return RPCHelpMan{"getdescriptoractivity",
2594 "\nGet spend and receive activity associated with a set of descriptors for a set of blocks. "
2595 "This command pairs well with the `relevant_blocks` output of `scanblocks()`.\n"
2596 "This call may take several minutes. If you encounter timeouts, try specifying no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2597 {
2598 RPCArg{"blockhashes", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "The list of blockhashes to examine for activity. Order doesn't matter. Must be along main chain or an error is thrown.\n", {
2599 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "A valid blockhash"},
2600 }},
2602 {"include_mempool", RPCArg::Type::BOOL, RPCArg::Default{true}, "Whether to include unconfirmed activity"},
2603 },
2604 RPCResult{
2605 RPCResult::Type::OBJ, "", "", {
2606 {RPCResult::Type::ARR, "activity", "events", {
2607 {RPCResult::Type::OBJ, "", "", {
2608 {RPCResult::Type::STR, "type", "always 'spend'"},
2609 {RPCResult::Type::STR_AMOUNT, "amount", "The total amount in " + CURRENCY_UNIT + " of the spent output"},
2610 {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "The blockhash this spend appears in (omitted if unconfirmed)"},
2611 {RPCResult::Type::NUM, "height", /*optional=*/true, "Height of the spend (omitted if unconfirmed)"},
2612 {RPCResult::Type::STR_HEX, "spend_txid", "The txid of the spending transaction"},
2613 {RPCResult::Type::NUM, "spend_vout", "The vout of the spend"},
2614 {RPCResult::Type::STR_HEX, "prevout_txid", "The txid of the prevout"},
2615 {RPCResult::Type::NUM, "prevout_vout", "The vout of the prevout"},
2616 {RPCResult::Type::OBJ, "prevout_spk", "", ScriptPubKeyDoc()},
2617 }},
2618 {RPCResult::Type::OBJ, "", "", {
2619 {RPCResult::Type::STR, "type", "always 'receive'"},
2620 {RPCResult::Type::STR_AMOUNT, "amount", "The total amount in " + CURRENCY_UNIT + " of the new output"},
2621 {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "The block that this receive is in (omitted if unconfirmed)"},
2622 {RPCResult::Type::NUM, "height", /*optional=*/true, "The height of the receive (omitted if unconfirmed)"},
2623 {RPCResult::Type::STR_HEX, "txid", "The txid of the receiving transaction"},
2624 {RPCResult::Type::NUM, "vout", "The vout of the receiving output"},
2625 {RPCResult::Type::OBJ, "output_spk", "", ScriptPubKeyDoc()},
2626 }},
2627 // TODO is the skip_type_check avoidable with a heterogeneous ARR?
2628 }, /*skip_type_check=*/true},
2629 },
2630 },
2632 HelpExampleCli("getdescriptoractivity", "'[\"000000000000000000001347062c12fded7c528943c8ce133987e2e2f5a840ee\"]' '[\"addr(bc1qzl6nsgqzu89a66l50cvwapnkw5shh23zarqkw9)\"]'")
2633 },
2634 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
2635{
2637 UniValue activity(UniValue::VARR);
2638 NodeContext& node = EnsureAnyNodeContext(request.context);
2640
2641 struct CompareByHeightAscending {
2642 bool operator()(const CBlockIndex* a, const CBlockIndex* b) const {
2643 return a->nHeight < b->nHeight;
2644 }
2645 };
2646
2647 std::set<const CBlockIndex*, CompareByHeightAscending> blockindexes_sorted;
2648
2649 {
2650 // Validate all given blockhashes, and ensure blocks are along a single chain.
2651 LOCK(::cs_main);
2652 for (const UniValue& blockhash : request.params[0].get_array().getValues()) {
2653 uint256 bhash = ParseHashV(blockhash, "blockhash");
2654 CBlockIndex* pindex = chainman.m_blockman.LookupBlockIndex(bhash);
2655 if (!pindex) {
2656 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
2657 }
2658 if (!chainman.ActiveChain().Contains(pindex)) {
2659 throw JSONRPCError(RPC_INVALID_PARAMETER, "Block is not in main chain");
2660 }
2661 blockindexes_sorted.insert(pindex);
2662 }
2663 }
2664
2665 std::set<CScript> scripts_to_watch;
2666
2667 // Determine scripts to watch.
2668 for (const UniValue& scanobject : request.params[1].get_array().getValues()) {
2669 FlatSigningProvider provider;
2670 std::vector<CScript> scripts = EvalDescriptorStringOrObject(scanobject, provider);
2671
2672 for (const CScript& script : scripts) {
2673 scripts_to_watch.insert(script);
2674 }
2675 }
2676
2677 const auto AddSpend = [&](
2678 const CScript& spk,
2679 const CAmount val,
2680 const CTransactionRef& tx,
2681 int vin,
2682 const CTxIn& txin,
2683 const CBlockIndex* index
2684 ) {
2685 UniValue event(UniValue::VOBJ);
2686 UniValue spkUv(UniValue::VOBJ);
2687 ScriptToUniv(spk, /*out=*/spkUv, /*include_hex=*/true, /*include_address=*/true);
2688
2689 event.pushKV("type", "spend");
2690 event.pushKV("amount", ValueFromAmount(val));
2691 if (index) {
2692 event.pushKV("blockhash", index->GetBlockHash().ToString());
2693 event.pushKV("height", index->nHeight);
2694 }
2695 event.pushKV("spend_txid", tx->GetHash().ToString());
2696 event.pushKV("spend_vin", vin);
2697 event.pushKV("prevout_txid", txin.prevout.hash.ToString());
2698 event.pushKV("prevout_vout", txin.prevout.n);
2699 event.pushKV("prevout_spk", spkUv);
2700
2701 return event;
2702 };
2703
2704 const auto AddReceive = [&](const CTxOut& txout, const CBlockIndex* index, int vout, const CTransactionRef& tx) {
2705 UniValue event(UniValue::VOBJ);
2706 UniValue spkUv(UniValue::VOBJ);
2707 ScriptToUniv(txout.scriptPubKey, /*out=*/spkUv, /*include_hex=*/true, /*include_address=*/true);
2708
2709 event.pushKV("type", "receive");
2710 event.pushKV("amount", ValueFromAmount(txout.nValue));
2711 if (index) {
2712 event.pushKV("blockhash", index->GetBlockHash().ToString());
2713 event.pushKV("height", index->nHeight);
2714 }
2715 event.pushKV("txid", tx->GetHash().ToString());
2716 event.pushKV("vout", vout);
2717 event.pushKV("output_spk", spkUv);
2718
2719 return event;
2720 };
2721
2722 BlockManager* blockman;
2723 Chainstate& active_chainstate = chainman.ActiveChainstate();
2724 {
2725 LOCK(::cs_main);
2726 blockman = CHECK_NONFATAL(&active_chainstate.m_blockman);
2727 }
2728
2729 for (const CBlockIndex* blockindex : blockindexes_sorted) {
2730 const CBlock block{GetBlockChecked(chainman.m_blockman, *blockindex)};
2731 const CBlockUndo block_undo{GetUndoChecked(*blockman, *blockindex)};
2732
2733 for (size_t i = 0; i < block.vtx.size(); ++i) {
2734 const auto& tx = block.vtx.at(i);
2735
2736 if (!tx->IsCoinBase()) {
2737 // skip coinbase; spends can't happen there.
2738 const auto& txundo = block_undo.vtxundo.at(i - 1);
2739
2740 for (size_t vin_idx = 0; vin_idx < tx->vin.size(); ++vin_idx) {
2741 const auto& coin = txundo.vprevout.at(vin_idx);
2742 const auto& txin = tx->vin.at(vin_idx);
2743 if (scripts_to_watch.contains(coin.out.scriptPubKey)) {
2744 activity.push_back(AddSpend(
2745 coin.out.scriptPubKey, coin.out.nValue, tx, vin_idx, txin, blockindex));
2746 }
2747 }
2748 }
2749
2750 for (size_t vout_idx = 0; vout_idx < tx->vout.size(); ++vout_idx) {
2751 const auto& vout = tx->vout.at(vout_idx);
2752 if (scripts_to_watch.contains(vout.scriptPubKey)) {
2753 activity.push_back(AddReceive(vout, blockindex, vout_idx, tx));
2754 }
2755 }
2756 }
2757 }
2758
2759 bool search_mempool = true;
2760 if (!request.params[2].isNull()) {
2761 search_mempool = request.params[2].get_bool();
2762 }
2763
2764 if (search_mempool) {
2765 const CTxMemPool& mempool = EnsureMemPool(node);
2766 LOCK(::cs_main);
2767 LOCK(mempool.cs);
2768 const CCoinsViewCache& coins_view = &active_chainstate.CoinsTip();
2769
2770 for (const CTxMemPoolEntry& e : mempool.entryAll()) {
2771 const auto& tx = e.GetSharedTx();
2772
2773 for (size_t vin_idx = 0; vin_idx < tx->vin.size(); ++vin_idx) {
2774 CScript scriptPubKey;
2775 CAmount value;
2776 const auto& txin = tx->vin.at(vin_idx);
2777 std::optional<Coin> coin = coins_view.GetCoin(txin.prevout);
2778
2779 // Check if the previous output is in the chain
2780 if (!coin) {
2781 // If not found in the chain, check the mempool. Likely, this is a
2782 // child transaction of another transaction in the mempool.
2783 CTransactionRef prev_tx = CHECK_NONFATAL(mempool.get(txin.prevout.hash));
2784
2785 if (txin.prevout.n >= prev_tx->vout.size()) {
2786 throw std::runtime_error("Invalid output index");
2787 }
2788 const CTxOut& out = prev_tx->vout[txin.prevout.n];
2789 scriptPubKey = out.scriptPubKey;
2790 value = out.nValue;
2791 } else {
2792 // Coin found in the chain
2793 const CTxOut& out = coin->out;
2794 scriptPubKey = out.scriptPubKey;
2795 value = out.nValue;
2796 }
2797
2798 if (scripts_to_watch.contains(scriptPubKey)) {
2799 UniValue event(UniValue::VOBJ);
2800 activity.push_back(AddSpend(
2801 scriptPubKey, value, tx, vin_idx, txin, nullptr));
2802 }
2803 }
2804
2805 for (size_t vout_idx = 0; vout_idx < tx->vout.size(); ++vout_idx) {
2806 const auto& vout = tx->vout.at(vout_idx);
2807 if (scripts_to_watch.contains(vout.scriptPubKey)) {
2808 activity.push_back(AddReceive(vout, nullptr, vout_idx, tx));
2809 }
2810 }
2811 }
2812 }
2813
2814 ret.pushKV("activity", activity);
2815 return ret;
2816},
2817 };
2818}
2819
2821{
2822 return RPCHelpMan{"getblockfilter",
2823 "\nRetrieve a BIP 157 content filter for a particular block.\n",
2824 {
2825 {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hash of the block"},
2826 {"filtertype", RPCArg::Type::STR, RPCArg::Default{BlockFilterTypeName(BlockFilterType::BASIC)}, "The type name of the filter"},
2827 },
2828 RPCResult{
2829 RPCResult::Type::OBJ, "", "",
2830 {
2831 {RPCResult::Type::STR_HEX, "filter", "the hex-encoded filter data"},
2832 {RPCResult::Type::STR_HEX, "header", "the hex-encoded filter header"},
2833 }},
2835 HelpExampleCli("getblockfilter", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" \"basic\"") +
2836 HelpExampleRpc("getblockfilter", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\", \"basic\"")
2837 },
2838 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
2839{
2840 uint256 block_hash = ParseHashV(request.params[0], "blockhash");
2841 std::string filtertype_name = BlockFilterTypeName(BlockFilterType::BASIC);
2842 if (!request.params[1].isNull()) {
2843 filtertype_name = request.params[1].get_str();
2844 }
2845
2846 BlockFilterType filtertype;
2847 if (!BlockFilterTypeByName(filtertype_name, filtertype)) {
2848 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Unknown filtertype");
2849 }
2850
2851 BlockFilterIndex* index = GetBlockFilterIndex(filtertype);
2852 if (!index) {
2853 throw JSONRPCError(RPC_MISC_ERROR, "Index is not enabled for filtertype " + filtertype_name);
2854 }
2855
2856 const CBlockIndex* block_index;
2857 bool block_was_connected;
2858 {
2859 ChainstateManager& chainman = EnsureAnyChainman(request.context);
2860 LOCK(cs_main);
2861 block_index = chainman.m_blockman.LookupBlockIndex(block_hash);
2862 if (!block_index) {
2863 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
2864 }
2865 block_was_connected = block_index->IsValid(BLOCK_VALID_SCRIPTS);
2866 }
2867
2868 bool index_ready = index->BlockUntilSyncedToCurrentChain();
2869
2870 BlockFilter filter;
2871 uint256 filter_header;
2872 if (!index->LookupFilter(block_index, filter) ||
2873 !index->LookupFilterHeader(block_index, filter_header)) {
2874 int err_code;
2875 std::string errmsg = "Filter not found.";
2876
2877 if (!block_was_connected) {
2878 err_code = RPC_INVALID_ADDRESS_OR_KEY;
2879 errmsg += " Block was not connected to active chain.";
2880 } else if (!index_ready) {
2881 err_code = RPC_MISC_ERROR;
2882 errmsg += " Block filters are still in the process of being indexed.";
2883 } else {
2884 err_code = RPC_INTERNAL_ERROR;
2885 errmsg += " This error is unexpected and indicates index corruption.";
2886 }
2887
2888 throw JSONRPCError(err_code, errmsg);
2889 }
2890
2892 ret.pushKV("filter", HexStr(filter.GetEncodedFilter()));
2893 ret.pushKV("header", filter_header.GetHex());
2894 return ret;
2895},
2896 };
2897}
2898
2904{
2906public:
2907 NetworkDisable(CConnman& connman) : m_connman(connman) {
2910 throw JSONRPCError(RPC_MISC_ERROR, "Network activity could not be suspended.");
2911 }
2912 };
2915 };
2916};
2917
2923{
2926public:
2927 TemporaryRollback(ChainstateManager& chainman, const CBlockIndex& index) : m_chainman(chainman), m_invalidate_index(index) {
2929 };
2932 };
2933};
2934
2941{
2942 return RPCHelpMan{
2943 "dumptxoutset",
2944 "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"
2945 "Unless the \"latest\" type is requested, the node will roll back to the requested height and network activity will be suspended during this process. "
2946 "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"
2947 "This call may take several minutes. Make sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
2948 {
2949 {"path", RPCArg::Type::STR, RPCArg::Optional::NO, "Path to the output file. If relative, will be prefixed by datadir."},
2950 {"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."},
2952 {
2954 "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.",
2955 RPCArgOptions{.skip_type_check = true, .type_str = {"", "string or numeric"}}},
2956 },
2957 },
2958 },
2959 RPCResult{
2960 RPCResult::Type::OBJ, "", "",
2961 {
2962 {RPCResult::Type::NUM, "coins_written", "the number of coins written in the snapshot"},
2963 {RPCResult::Type::STR_HEX, "base_hash", "the hash of the base of the snapshot"},
2964 {RPCResult::Type::NUM, "base_height", "the height of the base of the snapshot"},
2965 {RPCResult::Type::STR, "path", "the absolute path that the snapshot was written to"},
2966 {RPCResult::Type::STR_HEX, "txoutset_hash", "the hash of the UTXO set contents"},
2967 {RPCResult::Type::NUM, "nchaintx", "the number of transactions in the chain up to and including the base block"},
2968 }
2969 },
2971 HelpExampleCli("-rpcclienttimeout=0 dumptxoutset", "utxo.dat latest") +
2972 HelpExampleCli("-rpcclienttimeout=0 dumptxoutset", "utxo.dat rollback") +
2973 HelpExampleCli("-rpcclienttimeout=0 -named dumptxoutset", R"(utxo.dat rollback=853456)")
2974 },
2975 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
2976{
2977 NodeContext& node = EnsureAnyNodeContext(request.context);
2978 const CBlockIndex* tip{WITH_LOCK(::cs_main, return node.chainman->ActiveChain().Tip())};
2979 const CBlockIndex* target_index{nullptr};
2980 const std::string snapshot_type{self.Arg<std::string>("type")};
2981 const UniValue options{request.params[2].isNull() ? UniValue::VOBJ : request.params[2]};
2982 if (options.exists("rollback")) {
2983 if (!snapshot_type.empty() && snapshot_type != "rollback") {
2984 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid snapshot type \"%s\" specified with rollback option", snapshot_type));
2985 }
2986 target_index = ParseHashOrHeight(options["rollback"], *node.chainman);
2987 } else if (snapshot_type == "rollback") {
2988 auto snapshot_heights = node.chainman->GetParams().GetAvailableSnapshotHeights();
2989 CHECK_NONFATAL(snapshot_heights.size() > 0);
2990 auto max_height = std::max_element(snapshot_heights.begin(), snapshot_heights.end());
2991 target_index = ParseHashOrHeight(*max_height, *node.chainman);
2992 } else if (snapshot_type == "latest") {
2993 target_index = tip;
2994 } else {
2995 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid snapshot type \"%s\" specified. Please specify \"rollback\" or \"latest\"", snapshot_type));
2996 }
2997
2998 const ArgsManager& args{EnsureAnyArgsman(request.context)};
2999 const fs::path path = fsbridge::AbsPathJoin(args.GetDataDirNet(), fs::u8path(request.params[0].get_str()));
3000 // Write to a temporary path and then move into `path` on completion
3001 // to avoid confusion due to an interruption.
3002 const fs::path temppath = fsbridge::AbsPathJoin(args.GetDataDirNet(), fs::u8path(request.params[0].get_str() + ".incomplete"));
3003
3004 if (fs::exists(path)) {
3005 throw JSONRPCError(
3007 path.utf8string() + " already exists. If you are sure this is what you want, "
3008 "move it out of the way first");
3009 }
3010
3011 FILE* file{fsbridge::fopen(temppath, "wb")};
3012 AutoFile afile{file};
3013 if (afile.IsNull()) {
3014 throw JSONRPCError(
3016 "Couldn't open file " + temppath.utf8string() + " for writing.");
3017 }
3018
3019 CConnman& connman = EnsureConnman(node);
3020 const CBlockIndex* invalidate_index{nullptr};
3021 std::optional<NetworkDisable> disable_network;
3022 std::optional<TemporaryRollback> temporary_rollback;
3023
3024 // If the user wants to dump the txoutset of the current tip, we don't have
3025 // to roll back at all
3026 if (target_index != tip) {
3027 // If the node is running in pruned mode we ensure all necessary block
3028 // data is available before starting to roll back.
3029 if (node.chainman->m_blockman.IsPruneMode()) {
3030 LOCK(node.chainman->GetMutex());
3031 const CBlockIndex* current_tip{node.chainman->ActiveChain().Tip()};
3032 const CBlockIndex* first_block{node.chainman->m_blockman.GetFirstBlock(*current_tip, /*status_mask=*/BLOCK_HAVE_MASK)};
3033 if (first_block->nHeight > target_index->nHeight) {
3034 throw JSONRPCError(RPC_MISC_ERROR, "Could not roll back to requested height since necessary block data is already pruned.");
3035 }
3036 }
3037
3038 // Suspend network activity for the duration of the process when we are
3039 // rolling back the chain to get a utxo set from a past height. We do
3040 // this so we don't punish peers that send us that send us data that
3041 // seems wrong in this temporary state. For example a normal new block
3042 // would be classified as a block connecting an invalid block.
3043 // Skip if the network is already disabled because this
3044 // automatically re-enables the network activity at the end of the
3045 // process which may not be what the user wants.
3046 if (connman.GetNetworkActive()) {
3047 disable_network.emplace(connman);
3048 }
3049
3050 invalidate_index = WITH_LOCK(::cs_main, return node.chainman->ActiveChain().Next(target_index));
3051 temporary_rollback.emplace(*node.chainman, *invalidate_index);
3052 }
3053
3054 Chainstate* chainstate;
3055 std::unique_ptr<CCoinsViewCursor> cursor;
3056 CCoinsStats stats;
3057 {
3058 // Lock the chainstate before calling PrepareUtxoSnapshot, to be able
3059 // to get a UTXO database cursor while the chain is pointing at the
3060 // target block. After that, release the lock while calling
3061 // WriteUTXOSnapshot. The cursor will remain valid and be used by
3062 // WriteUTXOSnapshot to write a consistent snapshot even if the
3063 // chainstate changes.
3064 LOCK(node.chainman->GetMutex());
3065 chainstate = &node.chainman->ActiveChainstate();
3066 // In case there is any issue with a block being read from disk we need
3067 // to stop here, otherwise the dump could still be created for the wrong
3068 // height.
3069 // The new tip could also not be the target block if we have a stale
3070 // sister block of invalidate_index. This block (or a descendant) would
3071 // be activated as the new tip and we would not get to new_tip_index.
3072 if (target_index != chainstate->m_chain.Tip()) {
3073 LogWarning("dumptxoutset failed to roll back to requested height, reverting to tip.\n");
3074 throw JSONRPCError(RPC_MISC_ERROR, "Could not roll back to requested height.");
3075 } else {
3076 std::tie(cursor, stats, tip) = PrepareUTXOSnapshot(*chainstate, node.rpc_interruption_point);
3077 }
3078 }
3079
3080 UniValue result = WriteUTXOSnapshot(*chainstate, cursor.get(), &stats, tip, afile, path, temppath, node.rpc_interruption_point);
3081 fs::rename(temppath, path);
3082
3083 result.pushKV("path", path.utf8string());
3084 return result;
3085},
3086 };
3087}
3088
3089std::tuple<std::unique_ptr<CCoinsViewCursor>, CCoinsStats, const CBlockIndex*>
3091 Chainstate& chainstate,
3092 const std::function<void()>& interruption_point)
3093{
3094 std::unique_ptr<CCoinsViewCursor> pcursor;
3095 std::optional<CCoinsStats> maybe_stats;
3096 const CBlockIndex* tip;
3097
3098 {
3099 // We need to lock cs_main to ensure that the coinsdb isn't written to
3100 // between (i) flushing coins cache to disk (coinsdb), (ii) getting stats
3101 // based upon the coinsdb, and (iii) constructing a cursor to the
3102 // coinsdb for use in WriteUTXOSnapshot.
3103 //
3104 // Cursors returned by leveldb iterate over snapshots, so the contents
3105 // of the pcursor will not be affected by simultaneous writes during
3106 // use below this block.
3107 //
3108 // See discussion here:
3109 // https://github.com/bitcoin/bitcoin/pull/15606#discussion_r274479369
3110 //
3112
3113 chainstate.ForceFlushStateToDisk();
3114
3115 maybe_stats = GetUTXOStats(&chainstate.CoinsDB(), chainstate.m_blockman, CoinStatsHashType::HASH_SERIALIZED, interruption_point);
3116 if (!maybe_stats) {
3117 throw JSONRPCError(RPC_INTERNAL_ERROR, "Unable to read UTXO set");
3118 }
3119
3120 pcursor = chainstate.CoinsDB().Cursor();
3121 tip = CHECK_NONFATAL(chainstate.m_blockman.LookupBlockIndex(maybe_stats->hashBlock));
3122 }
3123
3124 return {std::move(pcursor), *CHECK_NONFATAL(maybe_stats), tip};
3125}
3126
3128 Chainstate& chainstate,
3129 CCoinsViewCursor* pcursor,
3130 CCoinsStats* maybe_stats,
3131 const CBlockIndex* tip,
3132 AutoFile& afile,
3133 const fs::path& path,
3134 const fs::path& temppath,
3135 const std::function<void()>& interruption_point)
3136{
3137 LOG_TIME_SECONDS(strprintf("writing UTXO snapshot at height %s (%s) to file %s (via %s)",
3138 tip->nHeight, tip->GetBlockHash().ToString(),
3139 fs::PathToString(path), fs::PathToString(temppath)));
3140
3141 SnapshotMetadata metadata{chainstate.m_chainman.GetParams().MessageStart(), tip->GetBlockHash(), maybe_stats->coins_count};
3142
3143 afile << metadata;
3144
3145 COutPoint key;
3146 Txid last_hash;
3147 Coin coin;
3148 unsigned int iter{0};
3149 size_t written_coins_count{0};
3150 std::vector<std::pair<uint32_t, Coin>> coins;
3151
3152 // To reduce space the serialization format of the snapshot avoids
3153 // duplication of tx hashes. The code takes advantage of the guarantee by
3154 // leveldb that keys are lexicographically sorted.
3155 // In the coins vector we collect all coins that belong to a certain tx hash
3156 // (key.hash) and when we have them all (key.hash != last_hash) we write
3157 // them to file using the below lambda function.
3158 // See also https://github.com/bitcoin/bitcoin/issues/25675
3159 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) {
3160 afile << last_hash;
3161 WriteCompactSize(afile, coins.size());
3162 for (const auto& [n, coin] : coins) {
3163 WriteCompactSize(afile, n);
3164 afile << coin;
3165 ++written_coins_count;
3166 }
3167 };
3168
3169 pcursor->GetKey(key);
3170 last_hash = key.hash;
3171 while (pcursor->Valid()) {
3172 if (iter % 5000 == 0) interruption_point();
3173 ++iter;
3174 if (pcursor->GetKey(key) && pcursor->GetValue(coin)) {
3175 if (key.hash != last_hash) {
3176 write_coins_to_file(afile, last_hash, coins, written_coins_count);
3177 last_hash = key.hash;
3178 coins.clear();
3179 }
3180 coins.emplace_back(key.n, coin);
3181 }
3182 pcursor->Next();
3183 }
3184
3185 if (!coins.empty()) {
3186 write_coins_to_file(afile, last_hash, coins, written_coins_count);
3187 }
3188
3189 CHECK_NONFATAL(written_coins_count == maybe_stats->coins_count);
3190
3191 afile.fclose();
3192
3193 UniValue result(UniValue::VOBJ);
3194 result.pushKV("coins_written", written_coins_count);
3195 result.pushKV("base_hash", tip->GetBlockHash().ToString());
3196 result.pushKV("base_height", tip->nHeight);
3197 result.pushKV("path", path.utf8string());
3198 result.pushKV("txoutset_hash", maybe_stats->hashSerialized.ToString());
3199 result.pushKV("nchaintx", tip->m_chain_tx_count);
3200 return result;
3201}
3202
3205 Chainstate& chainstate,
3206 AutoFile& afile,
3207 const fs::path& path,
3208 const fs::path& tmppath)
3209{
3210 auto [cursor, stats, tip]{WITH_LOCK(::cs_main, return PrepareUTXOSnapshot(chainstate, node.rpc_interruption_point))};
3211 return WriteUTXOSnapshot(chainstate, cursor.get(), &stats, tip, afile, path, tmppath, node.rpc_interruption_point);
3212}
3213
3215{
3216 return RPCHelpMan{
3217 "loadtxoutset",
3218 "Load the serialized UTXO set from a file.\n"
3219 "Once this snapshot is loaded, its contents will be "
3220 "deserialized into a second chainstate data structure, which is then used to sync to "
3221 "the network's tip. "
3222 "Meanwhile, the original chainstate will complete the initial block download process in "
3223 "the background, eventually validating up to the block that the snapshot is based upon.\n\n"
3224
3225 "The result is a usable bitcoind instance that is current with the network tip in a "
3226 "matter of minutes rather than hours. UTXO snapshot are typically obtained from "
3227 "third-party sources (HTTP, torrent, etc.) which is reasonable since their "
3228 "contents are always checked by hash.\n\n"
3229
3230 "You can find more information on this process in the `assumeutxo` design "
3231 "document (<https://github.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo.md>).",
3232 {
3233 {"path",
3236 "path to the snapshot file. If relative, will be prefixed by datadir."},
3237 },
3238 RPCResult{
3239 RPCResult::Type::OBJ, "", "",
3240 {
3241 {RPCResult::Type::NUM, "coins_loaded", "the number of coins loaded from the snapshot"},
3242 {RPCResult::Type::STR_HEX, "tip_hash", "the hash of the base of the snapshot"},
3243 {RPCResult::Type::NUM, "base_height", "the height of the base of the snapshot"},
3244 {RPCResult::Type::STR, "path", "the absolute path that the snapshot was loaded from"},
3245 }
3246 },
3248 HelpExampleCli("-rpcclienttimeout=0 loadtxoutset", "utxo.dat")
3249 },
3250 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
3251{
3252 NodeContext& node = EnsureAnyNodeContext(request.context);
3254 const fs::path path{AbsPathForConfigVal(EnsureArgsman(node), fs::u8path(self.Arg<std::string>("path")))};
3255
3256 FILE* file{fsbridge::fopen(path, "rb")};
3257 AutoFile afile{file};
3258 if (afile.IsNull()) {
3259 throw JSONRPCError(
3261 "Couldn't open file " + path.utf8string() + " for reading.");
3262 }
3263
3264 SnapshotMetadata metadata{chainman.GetParams().MessageStart()};
3265 try {
3266 afile >> metadata;
3267 } catch (const std::ios_base::failure& e) {
3268 throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("Unable to parse metadata: %s", e.what()));
3269 }
3270
3271 auto activation_result{chainman.ActivateSnapshot(afile, metadata, false)};
3272 if (!activation_result) {
3273 throw JSONRPCError(RPC_INTERNAL_ERROR, strprintf("Unable to load UTXO snapshot: %s. (%s)", util::ErrorString(activation_result).original, path.utf8string()));
3274 }
3275
3276 // Because we can't provide historical blocks during tip or background sync.
3277 // Update local services to reflect we are a limited peer until we are fully sync.
3278 node.connman->RemoveLocalServices(NODE_NETWORK);
3279 // Setting the limited state is usually redundant because the node can always
3280 // provide the last 288 blocks, but it doesn't hurt to set it.
3281 node.connman->AddLocalServices(NODE_NETWORK_LIMITED);
3282
3283 CBlockIndex& snapshot_index{*CHECK_NONFATAL(*activation_result)};
3284
3285 UniValue result(UniValue::VOBJ);
3286 result.pushKV("coins_loaded", metadata.m_coins_count);
3287 result.pushKV("tip_hash", snapshot_index.GetBlockHash().ToString());
3288 result.pushKV("base_height", snapshot_index.nHeight);
3289 result.pushKV("path", fs::PathToString(path));
3290 return result;
3291},
3292 };
3293}
3294
3295const std::vector<RPCResult> RPCHelpForChainstate{
3296 {RPCResult::Type::NUM, "blocks", "number of blocks in this chainstate"},
3297 {RPCResult::Type::STR_HEX, "bestblockhash", "blockhash of the tip"},
3298 {RPCResult::Type::NUM, "difficulty", "difficulty of the tip"},
3299 {RPCResult::Type::NUM, "verificationprogress", "progress towards the network tip"},
3300 {RPCResult::Type::STR_HEX, "snapshot_blockhash", /*optional=*/true, "the base block of the snapshot this chainstate is based on, if any"},
3301 {RPCResult::Type::NUM, "coins_db_cache_bytes", "size of the coinsdb cache"},
3302 {RPCResult::Type::NUM, "coins_tip_cache_bytes", "size of the coinstip cache"},
3303 {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."},
3304};
3305
3307{
3308return RPCHelpMan{
3309 "getchainstates",
3310 "\nReturn information about chainstates.\n",
3311 {},
3312 RPCResult{
3313 RPCResult::Type::OBJ, "", "", {
3314 {RPCResult::Type::NUM, "headers", "the number of headers seen so far"},
3315 {RPCResult::Type::ARR, "chainstates", "list of the chainstates ordered by work, with the most-work (active) chainstate last", {{RPCResult::Type::OBJ, "", "", RPCHelpForChainstate},}},
3316 }
3317 },
3319 HelpExampleCli("getchainstates", "")
3320 + HelpExampleRpc("getchainstates", "")
3321 },
3322 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
3323{
3324 LOCK(cs_main);
3326
3327 ChainstateManager& chainman = EnsureAnyChainman(request.context);
3328
3329 auto make_chain_data = [&](const Chainstate& cs, bool validated) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
3332 if (!cs.m_chain.Tip()) {
3333 return data;
3334 }
3335 const CChain& chain = cs.m_chain;
3336 const CBlockIndex* tip = chain.Tip();
3337
3338 data.pushKV("blocks", (int)chain.Height());
3339 data.pushKV("bestblockhash", tip->GetBlockHash().GetHex());
3340 data.pushKV("difficulty", GetDifficulty(*tip));
3341 data.pushKV("verificationprogress", chainman.GuessVerificationProgress(tip));
3342 data.pushKV("coins_db_cache_bytes", cs.m_coinsdb_cache_size_bytes);
3343 data.pushKV("coins_tip_cache_bytes", cs.m_coinstip_cache_size_bytes);
3344 if (cs.m_from_snapshot_blockhash) {
3345 data.pushKV("snapshot_blockhash", cs.m_from_snapshot_blockhash->ToString());
3346 }
3347 data.pushKV("validated", validated);
3348 return data;
3349 };
3350
3351 obj.pushKV("headers", chainman.m_best_header ? chainman.m_best_header->nHeight : -1);
3352
3353 const auto& chainstates = chainman.GetAll();
3354 UniValue obj_chainstates{UniValue::VARR};
3355 for (Chainstate* cs : chainstates) {
3356 obj_chainstates.push_back(make_chain_data(*cs, !cs->m_from_snapshot_blockhash || chainstates.size() == 1));
3357 }
3358 obj.pushKV("chainstates", std::move(obj_chainstates));
3359 return obj;
3360}
3361 };
3362}
3363
3364
3366{
3367 static const CRPCCommand commands[]{
3368 {"blockchain", &getblockchaininfo},
3369 {"blockchain", &getchaintxstats},
3370 {"blockchain", &getblockstats},
3371 {"blockchain", &getbestblockhash},
3372 {"blockchain", &getblockcount},
3373 {"blockchain", &getblock},
3374 {"blockchain", &getblockfrompeer},
3375 {"blockchain", &getblockhash},
3376 {"blockchain", &getblockheader},
3377 {"blockchain", &getchaintips},
3378 {"blockchain", &getdifficulty},
3379 {"blockchain", &getdeploymentinfo},
3380 {"blockchain", &gettxout},
3381 {"blockchain", &gettxoutsetinfo},
3382 {"blockchain", &pruneblockchain},
3383 {"blockchain", &verifychain},
3384 {"blockchain", &preciousblock},
3385 {"blockchain", &scantxoutset},
3386 {"blockchain", &scanblocks},
3387 {"blockchain", &getdescriptoractivity},
3388 {"blockchain", &getblockfilter},
3389 {"blockchain", &dumptxoutset},
3390 {"blockchain", &loadtxoutset},
3391 {"blockchain", &getchainstates},
3392 {"hidden", &invalidateblock},
3393 {"hidden", &reconsiderblock},
3394 {"hidden", &waitfornewblock},
3395 {"hidden", &waitforblock},
3396 {"hidden", &waitforblockheight},
3398 };
3399 for (const auto& c : commands) {
3400 t.appendCommand(c.name, &c);
3401 }
3402}
static constexpr CAmount MAX_MONEY
No amount larger than this (in satoshi) is valid.
Definition: amount.h:26
bool MoneyRange(const CAmount &nValue)
Definition: amount.h:27
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
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...
Definition: config.cpp:226
int ret
ArgsManager & args
Definition: bitcoind.cpp:277
static RPCHelpMan getblock()
Definition: blockchain.cpp:698
static RPCHelpMan getdifficulty()
Definition: blockchain.cpp:430
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)
Definition: blockchain.cpp:111
const RPCResult getblock_vin
Definition: blockchain.cpp:674
static RPCHelpMan syncwithvalidationinterfacequeue()
Definition: blockchain.cpp:411
static CBlockUndo GetUndoChecked(BlockManager &blockman, const CBlockIndex &blockindex)
Definition: blockchain.cpp:655
static RPCHelpMan getchaintips()
static RPCHelpMan loadtxoutset()
static RPCHelpMan gettxoutsetinfo()
Definition: blockchain.cpp:936
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)
Definition: blockchain.cpp:604
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.
Definition: blockchain.cpp:91
static const auto scan_objects_arg_desc
static RPCHelpMan scantxoutset()
CoinStatsHashType ParseHashType(const std::string &hash_type_input)
Definition: blockchain.cpp:893
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)
Definition: blockchain.cpp:619
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.
Definition: blockchain.cpp:811
RPCHelpMan getdeploymentinfo()
static RPCHelpMan getblockfilter()
static RPCHelpMan getbestblockhash()
Definition: blockchain.cpp:239
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()
Definition: blockchain.cpp:301
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={})
static RPCHelpMan getblockfrompeer()
Definition: blockchain.cpp:450
static const auto scan_result_status_some
static RPCHelpMan getblockhash()
Definition: blockchain.cpp:505
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.
Definition: blockchain.cpp:911
static RPCHelpMan gettxout()
static RPCHelpMan verifychain()
static std::atomic< bool > g_should_abort_scan
const std::vector< RPCResult > RPCHelpForChainstate
UniValue blockheaderToJSON(const CBlockIndex &tip, const CBlockIndex &blockindex)
Block header to JSON.
Definition: blockchain.cpp:149
static const auto scan_action_arg_desc
static RPCHelpMan waitforblockheight()
Definition: blockchain.cpp:355
static const CBlockIndex * ParseHashOrHeight(const UniValue &param, ChainstateManager &chainman)
Definition: blockchain.cpp:121
UniValue blockToJSON(BlockManager &blockman, const CBlock &block, const CBlockIndex &tip, const CBlockIndex &blockindex, TxVerbosity verbosity)
Block description to JSON.
Definition: blockchain.cpp:178
static RPCHelpMan pruneblockchain()
Definition: blockchain.cpp:836
static RPCHelpMan getblockheader()
Definition: blockchain.cpp:534
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)
Definition: blockchain.cpp:636
static RPCHelpMan getblockcount()
Definition: blockchain.cpp:218
static RPCHelpMan waitfornewblock()
Definition: blockchain.cpp:259
static const auto scan_result_status_none
static constexpr int NUM_GETBLOCKSTATS_PERCENTILES
Definition: blockchain.h:28
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.
BlockFilterType
Definition: blockfilter.h:93
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
@ BLOCK_VALID_SCRIPTS
Scripts & signatures ok.
Definition: chain.h:115
@ BLOCK_VALID_TREE
All parent headers found, difficulty matches, timestamp >= median previous, checkpoint.
Definition: chain.h:97
@ BLOCK_HAVE_UNDO
undo data available in rev*.dat
Definition: chain.h:122
@ BLOCK_HAVE_DATA
full block available in blk*.dat
Definition: chain.h:121
@ BLOCK_FAILED_MASK
Definition: chain.h:127
@ BLOCK_HAVE_MASK
Definition: chain.h:123
static constexpr int64_t TIMESTAMP_WINDOW
Timestamp window used as a grace period by code that compares external timestamps (such as timestamps...
Definition: chain.h:37
#define LIST_CHAIN_NAMES
List of possible chain / network names
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:81
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:234
Non-refcounted RAII wrapper for FILE*.
Definition: streams.h:392
bool IsNull() const
Return true if the wrapped FILE* is nullptr, false otherwise.
Definition: streams.h:428
int fclose()
Definition: streams.h:409
Complete block filter struct as defined in BIP 157.
Definition: blockfilter.h:115
const std::vector< unsigned char > & GetEncodedFilter() const LIFETIMEBOUND
Definition: blockfilter.h:138
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
Definition: block.h:69
std::vector< CTransactionRef > vtx
Definition: block.h:72
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:141
uint256 hashMerkleRoot
Definition: chain.h:188
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: chain.h:147
uint64_t m_chain_tx_count
(memory only) Number of transactions in the chain up to and including this block.
Definition: chain.h:176
CBlockHeader GetBlockHeader() const
Definition: chain.h:230
arith_uint256 nChainWork
(memory only) Total amount of work (expected number of hashes) in the chain up to and including this ...
Definition: chain.h:165
uint32_t nTime
Definition: chain.h:189
uint32_t nNonce
Definition: chain.h:191
uint256 GetBlockHash() const
Definition: chain.h:243
int64_t GetBlockTime() const
Definition: chain.h:266
int64_t GetMedianTimePast() const
Definition: chain.h:278
uint32_t nBits
Definition: chain.h:190
unsigned int nTx
Number of transactions in this block.
Definition: chain.h:170
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.
Definition: chain.h:295
int32_t nVersion
block header
Definition: chain.h:187
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: chain.cpp:120
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:153
FlatFilePos GetBlockPos() const EXCLUSIVE_LOCKS_REQUIRED(
Definition: chain.h:208
Undo information for a CBlock.
Definition: undo.h:63
std::vector< CTxUndo > vtxundo
Definition: undo.h:65
An in-memory indexed chain of blocks.
Definition: chain.h:417
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:433
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
Definition: chain.h:427
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...
Definition: chain.cpp:71
int Height() const
Return the maximal height in the chain.
Definition: chain.h:462
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
Definition: chain.cpp:60
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
Definition: chain.h:447
std::string GetChainTypeString() const
Return the chain type string.
Definition: chainparams.h:113
const MessageStartChars & MessageStart() const
Definition: chainparams.h:94
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:93
uint64_t PruneAfterHeight() const
Definition: chainparams.h:105
CCoinsView that adds a memory cache for transactions to another CCoinsView.
Definition: coins.h:363
uint256 GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Definition: coins.cpp:173
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
Retrieve the Coin (unspent transaction output) for a given outpoint.
Definition: coins.cpp:66
Cursor for iterating over CoinsView state.
Definition: coins.h:235
virtual void Next()=0
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.
Definition: txdb.cpp:182
Abstract view on the open txout dataset.
Definition: coins.h:310
virtual uint256 GetBestBlock() const
Retrieve the block hash whose state this CCoinsView currently represents.
Definition: coins.cpp:17
CCoinsView that brings transactions from a mempool into view.
Definition: txmempool.h:925
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
GetCoin, returning whether it exists and is not spent.
Definition: txmempool.cpp:1027
Definition: net.h:1036
bool GetNetworkActive() const
Definition: net.h:1120
void SetNetworkActive(bool active)
Definition: net.cpp:3132
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
uint32_t n
Definition: transaction.h:32
Txid hash
Definition: transaction.h:31
RPC command dispatcher.
Definition: server.h:127
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:415
An input of a transaction.
Definition: transaction.h:67
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
Definition: mempool_entry.h:66
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:304
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
Definition: txmempool.h:390
CTransactionRef get(const uint256 &hash) const
Definition: txmempool.cpp:884
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:851
bool isSpent(const COutPoint &outpoint) const
Definition: txmempool.cpp:419
An output of a transaction.
Definition: transaction.h:150
CScript scriptPubKey
Definition: transaction.h:153
CAmount nValue
Definition: transaction.h:152
Undo information for a CTransaction.
Definition: undo.h:53
RAII wrapper for VerifyDB: Verify consistency of the block and coin databases.
Definition: validation.h:414
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.
Definition: validation.h:505
CChain m_chain
The current chain of blockheaders we consult and build on.
Definition: validation.h:585
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:611
void ForceFlushStateToDisk()
Unconditionally flush all changes to disk.
CCoinsViewDB & CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:619
ChainstateManager & m_chainman
The chainstate manager that owns this chainstate.
Definition: validation.h:545
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances.
Definition: validation.h:540
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:866
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:1125
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...
Definition: validation.h:1110
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
Definition: validation.h:981
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.
Definition: validation.h:1001
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1113
VersionBitsCache m_versionbitscache
Track versionbit status.
Definition: validation.h:1134
const CChainParams & GetParams() const
Definition: validation.h:976
const Consensus::Params & GetConsensus() const
Definition: validation.h:977
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())
Definition: validation.h:1111
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Definition: validation.h:1080
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1007
A UTXO entry.
Definition: coins.h:33
bool IsCoinBase() const
Definition: coins.h:57
CTxOut out
unspent transaction output
Definition: coins.h:36
uint32_t nHeight
at which height this containing transaction was included in the active block chain
Definition: coins.h:42
CoinsViewScanReserver()=default
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:147
std::unordered_set< Element, ByteVectorHash > ElementSet
Definition: blockfilter.h:32
RAII class that disables the network in its constructor and enables it in its destructor.
NetworkDisable(CConnman &connman)
CConnman & m_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.
Definition: util.h:441
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)
Definition: univalue.cpp:104
const std::string & get_str() const
@ VNULL
Definition: univalue.h:24
@ VOBJ
Definition: univalue.h:24
@ VARR
Definition: univalue.h:24
bool isNull() const
Definition: univalue.h:79
size_t size() const
Definition: univalue.h:71
const std::vector< UniValue > & getValues() const
Int getInt() const
Definition: univalue.h:138
const UniValue & get_array() const
bool isNum() const
Definition: univalue.h:84
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
bool IsValid() const
Definition: validation.h:106
std::string ToString() const
Definition: validation.h:112
int StateSinceHeight(const CBlockIndex *pindexPrev, const Consensus::Params &params, 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 &params, 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 &params, 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
Definition: uint256.cpp:47
std::string GetHex() const
Definition: uint256.cpp:11
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:...
Definition: fs.h:33
std::string utf8string() const
Return a UTF-8 representation of the path as a std::string, for compatibility with code using std::st...
Definition: fs.h:63
Interface giving clients (RPC, Stratum v2 Template Provider in the future) ability to create block te...
Definition: mining.h:64
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...
Definition: blockstorage.h:136
bool ReadBlockFromDisk(CBlock &block, const FlatFilePos &pos) const
Functions for disk access for blocks.
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ReadRawBlockFromDisk(std::vector< uint8_t > &block, const FlatFilePos &pos) const
bool UndoReadFromDisk(CBlockUndo &blockundo, const CBlockIndex &index) const
uint64_t GetPruneTarget() const
Attempt to stay below this number of bytes of block files.
Definition: blockstorage.h:359
uint64_t CalculateCurrentUsage()
Calculate the amount of disk space the block & undo files currently use.
bool IsPruneMode() const
Whether running in -prune mode.
Definition: blockstorage.h:356
Metadata describing a serialized version of a UTXO set from which an assumeutxo Chainstate can be con...
Definition: utxo_snapshot.h:34
constexpr const std::byte * begin() const
std::string GetHex() const
static transaction_identifier FromUint256(const uint256 &id)
256-bit opaque blob.
Definition: uint256.h:190
std::unique_ptr< CoinStatsIndex > g_coin_stats_index
The global UTXO set hash object.
static int64_t GetBlockWeight(const CBlock &block)
Definition: validation.h:137
static int32_t GetTransactionWeight(const CTransaction &tx)
Definition: validation.h:133
static const unsigned int MAX_BLOCK_SERIALIZED_SIZE
The maximum allowed size for a serialized block, in bytes (only for buffer size limits)
Definition: consensus.h:13
static const int WITNESS_SCALE_FACTOR
Definition: consensus.h:21
void TxToUniv(const CTransaction &tx, const uint256 &block_hash, UniValue &entry, bool include_hex=true, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS)
Definition: core_write.cpp:171
TxVerbosity
Verbose level for block's transaction.
Definition: core_io.h:28
@ 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)
Definition: core_write.cpp:150
UniValue ValueFromAmount(const CAmount amount)
Definition: core_write.cpp:26
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
std::string DeploymentName(Consensus::BuriedDeployment dep)
bool DeploymentActiveAfter(const CBlockIndex *pindexPrev, const Consensus::Params &params, Consensus::BuriedDeployment dep, VersionBitsCache &versionbitscache)
Determine if a deployment is active for the next block.
bool DeploymentEnabled(const Consensus::Params &params, Consensus::BuriedDeployment dep)
Determine if a deployment is enabled (can ever be active)
const std::string CURRENCY_UNIT
Definition: feerate.h:17
#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.
Definition: hex_base.cpp:29
#define LogWarning(...)
Definition: logging.h:262
#define LogDebug(category,...)
Definition: logging.h:280
unsigned int nHeight
static void pool cs
@ RPC
Definition: logging.h:50
@ NONE
Definition: logging.h:42
DeploymentPos
Definition: params.h:32
@ DEPLOYMENT_TAPROOT
Definition: params.h:34
@ DEPLOYMENT_TESTDUMMY
Definition: params.h:33
BuriedDeployment
A buried deployment is one where the height of the activation has been hardcoded into the client impl...
Definition: params.h:22
@ DEPLOYMENT_DERSIG
Definition: params.h:26
@ DEPLOYMENT_CSV
Definition: params.h:27
@ DEPLOYMENT_SEGWIT
Definition: params.h:28
@ DEPLOYMENT_HEIGHTINCB
Definition: params.h:24
@ DEPLOYMENT_CLTV
Definition: params.h:25
static path u8path(const std::string &utf8_str)
Definition: fs.h:75
static bool exists(const path &p)
Definition: fs.h:89
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:151
FILE * fopen(const fs::path &p, const char *mode)
Definition: fs.cpp:26
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
Definition: fs.cpp:36
static bool ComputeUTXOStats(CCoinsView *view, CCoinsStats &stats, T hash_obj, const std::function< void()> &interruption_point)
Calculate statistics about the unspent transaction output set.
Definition: coinstats.cpp:116
CoinStatsHashType
Definition: coinstats.h:26
Definition: messages.h:20
UniValue GetWarningsForRpc(const Warnings &warnings, bool use_deprecated)
RPC helper function that wraps warnings.GetMessages().
Definition: warnings.cpp:54
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
std::string MakeUnorderedList(const std::vector< std::string > &items)
Create an unordered multi-line list of items.
Definition: string.h:213
int64_t NodeId
Definition: net.h:97
static constexpr TransactionSerParams TX_NO_WITNESS
Definition: transaction.h:196
static constexpr TransactionSerParams TX_WITH_WITNESS
Definition: transaction.h:195
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
@ NODE_NETWORK_LIMITED
Definition: protocol.h:327
@ NODE_NETWORK
Definition: protocol.h:315
UniValue JSONRPCError(int code, const std::string &message)
Definition: request.cpp:70
@ RPC_MISC_ERROR
General application defined errors.
Definition: protocol.h:40
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
Definition: protocol.h:44
@ RPC_INTERNAL_ERROR
Definition: protocol.h:36
@ RPC_DATABASE_ERROR
Database error.
Definition: protocol.h:45
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
Definition: protocol.h:46
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
Definition: protocol.h:42
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 ...
Definition: util.cpp:1345
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
Definition: util.cpp:184
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
Definition: util.cpp:202
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency.
Definition: util.cpp:44
std::string GetAllOutputTypes()
Gets all existing output types formatted for RPC help sections.
Definition: util.cpp:47
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
Definition: util.cpp:84
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
Definition: util.cpp:118
std::vector< RPCResult > ScriptPubKeyDoc()
Definition: util.cpp:1411
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)
Definition: serialize.h:1101
void WriteCompactSize(SizeComputer &os, uint64_t nSize)
Definition: serialize.h:1095
bool IsDeprecatedRPCEnabled(const std::string &method)
Definition: server.cpp:341
bool IsRPCRunning()
Query whether RPC is running.
Definition: server.cpp:310
ChainstateManager & EnsureAnyChainman(const std::any &context)
Definition: server_util.cpp:78
NodeContext & EnsureAnyNodeContext(const std::any &context)
Definition: server_util.cpp:21
CTxMemPool & EnsureMemPool(const NodeContext &node)
Definition: server_util.cpp:30
PeerManager & EnsurePeerman(const NodeContext &node)
ChainstateManager & EnsureChainman(const NodeContext &node)
Definition: server_util.cpp:70
ArgsManager & EnsureArgsman(const NodeContext &node)
Definition: server_util.cpp:57
interfaces::Mining & EnsureMining(const NodeContext &node)
CConnman & EnsureConnman(const NodeContext &node)
Definition: server_util.cpp:96
ArgsManager & EnsureAnyArgsman(const std::any &context)
Definition: server_util.cpp:65
unsigned char * UCharCast(char *c)
Definition: span.h:281
Display status of an in-progress BIP9 softfork.
Definition: versionbits.h:41
int count
Number of blocks with the version bit set since the beginning of the current period.
Definition: versionbits.h:49
int elapsed
Number of blocks elapsed since the beginning of the current period.
Definition: versionbits.h:47
int threshold
Number of blocks with the version bit set required to activate the softfork.
Definition: versionbits.h:45
bool possible
False if there are not enough blocks left in this period to pass activation threshold.
Definition: versionbits.h:51
int period
Length of blocks of the BIP9 signalling period.
Definition: versionbits.h:43
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.
Definition: params.h:54
int bit
Bit position to select the particular bit in nVersion.
Definition: params.h:45
int64_t nTimeout
Timeout/expiry MedianTime for the deployment attempt.
Definition: params.h:49
int64_t nStartTime
Start MedianTime for version bits miner confirmation.
Definition: params.h:47
BIP9Deployment vDeployments[MAX_VERSION_BITS_DEPLOYMENTS]
Definition: params.h:107
int DeploymentHeight(BuriedDeployment dep) const
Definition: params.h:136
int64_t nPowTargetSpacing
Definition: params.h:117
Definition: util.h:183
@ 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.
Definition: util.h:217
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
@ NO
Required arg.
UniValue Default
Default constant value.
Definition: util.h:219
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
Definition: util.h:168
bool skip_type_check
Definition: util.h:167
@ 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.
Definition: coinstats.h:41
uint64_t nDiskSize
Definition: coinstats.h:39
CAmount total_unspendable_amount
Total cumulative amount of unspendable coins up to and including this block.
Definition: coinstats.h:54
CAmount total_unspendables_scripts
Total cumulative amount of outputs sent to unspendable scripts (OP_RETURN for example) up to and incl...
Definition: coinstats.h:66
uint64_t coins_count
The number of coins contained.
Definition: coinstats.h:44
CAmount total_new_outputs_ex_coinbase_amount
Total cumulative amount of outputs created up to and including this block.
Definition: coinstats.h:58
uint64_t nTransactions
Definition: coinstats.h:35
uint64_t nTransactionOutputs
Definition: coinstats.h:36
CAmount total_coinbase_amount
Total cumulative amount of coinbase outputs up to and including this block.
Definition: coinstats.h:60
uint64_t nBogoSize
Definition: coinstats.h:37
bool index_used
Signals if the coinstatsindex was used to retrieve the statistics.
Definition: coinstats.h:47
CAmount total_unspendables_bip30
The two unspendable coinbase outputs total amount caused by BIP30.
Definition: coinstats.h:64
CAmount total_unspendables_genesis_block
The unspendable coinbase amount from the genesis block.
Definition: coinstats.h:62
CAmount total_prevout_spent_amount
Total cumulative amount of prevouts spent up to and including this block.
Definition: coinstats.h:56
uint256 hashSerialized
Definition: coinstats.h:38
CAmount total_unspendables_unclaimed_rewards
Total cumulative amount of coins lost due to unclaimed miner rewards up to and including this block.
Definition: coinstats.h:68
NodeContext struct containing references to chain state and connection state.
Definition: context.h:56
#define AssertLockNotHeld(cs)
Definition: sync.h:147
#define LOCK(cs)
Definition: sync.h:257
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:301
static int count
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
Definition: time.h:62
#define LOG_TIME_SECONDS(end_msg)
Definition: timer.h:107
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1165
bilingual_str _(ConstevalStringLiteral str)
Translation function.
Definition: translation.h:80
static const uint32_t MEMPOOL_HEIGHT
Fake height value used in Coin to signify they are only in the memory pool (since 0....
Definition: txmempool.h:49
const UniValue NullUniValue
Definition: univalue.cpp:16
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
Definition: validation.cpp:97
void PruneBlockFilesManual(Chainstate &active_chainstate, int nManualPruneHeight)
Prune block files up to a given height.
AssertLockHeld(pool.cs)
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
Definition: validation.h:70
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...
Definition: validation.h:68
static const signed int DEFAULT_CHECKBLOCKS
Definition: validation.h:69
ThresholdState
BIP 9 defines a finite-state-machine to deploy a softfork in multiple stages.
Definition: versionbits.h:27