#include <rpc/blockchain.h>
#include <rpc/register.h>
#include <arith_uint256.h>
#include <blockfilter.h>
#include <chain.h>
#include <chainparams.h>
#include <chainparamsbase.h>
#include <coins.h>
#include <common/args.h>
#include <consensus/amount.h>
#include <consensus/consensus.h>
#include <consensus/params.h>
#include <consensus/validation.h>
#include <core_io.h>
#include <crypto/hex_base.h>
#include <dbwrapper.h>
#include <deploymentinfo.h>
#include <flatfile.h>
#include <index/base.h>
#include <index/blockfilterindex.h>
#include <index/coinstatsindex.h>
#include <interfaces/mining.h>
#include <interfaces/types.h>
#include <kernel/coinstats.h>
#include <logging/timer.h>
#include <net.h>
#include <net_processing.h>
#include <node/blockstorage.h>
#include <node/context.h>
#include <node/utxo_snapshot.h>
#include <node/warnings.h>
#include <policy/feerate.h>
#include <prevector.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
#include <protocol.h>
#include <rpc/rawtransaction_util.h>
#include <rpc/request.h>
#include <rpc/server.h>
#include <rpc/server_util.h>
#include <rpc/util.h>
#include <script/descriptor.h>
#include <script/interpreter.h>
#include <script/script.h>
#include <script/signingprovider.h>
#include <serialize.h>
#include <span.h>
#include <streams.h>
#include <sync.h>
#include <tinyformat.h>
#include <txdb.h>
#include <txmempool.h>
#include <uint256.h>
#include <undo.h>
#include <univalue.h>
#include <util/chaintype.h>
#include <util/check.h>
#include <util/expected.h>
#include <util/fs.h>
#include <util/log.h>
#include <util/result.h>
#include <util/string.h>
#include <util/syserror.h>
#include <util/time.h>
#include <util/translation.h>
#include <validation.h>
#include <validationinterface.h>
#include <versionbits.h>
#include <algorithm>
#include <array>
#include <atomic>
#include <cerrno>
#include <compare>
#include <cstddef>
#include <cstdint>
#include <cstdio>
#include <functional>
#include <ios>
#include <map>
#include <memory>
#include <optional>
#include <ratio>
#include <set>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <tuple>
#include <vector>

Classes
struct	CompareBlocksByHeight
	Comparison function for sorting the getchaintips heads. More...
class	CoinsViewScanReserver
class	BlockFiltersScanReserver
class	TemporaryPruneLock
	RAII class that registers a prune lock in its constructor to prevent block data from being pruned, and removes it in its destructor. More...
class	TemporaryUTXODatabase
	RAII class that creates a temporary database directory in its constructor and removes it in its destructor. More...
class	SnapshotMetadata

Enumerations
enum class	CoinStatsHashType

Functions
std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot(Chainstate &chainstate, const std::function< void()> &interruption_point={}) EXCLUSIVE_LOCKS_REQUIRED(UniValue	WriteUTXOSnapshot (Chainstate &chainstate, CCoinsViewCursor pcursor, CCoinsStats maybe_stats, const CBlockIndex *tip, AutoFile &&afile, const fs::path &path, const fs::path &temppath, const std::function< void()> &interruption_point={})
UniValue	CreateRolledBackUTXOSnapshot (NodeContext &node, Chainstate &chainstate, const CBlockIndex *target, AutoFile &&afile, const fs::path &path, const fs::path &tmppath, bool in_memory)
double	GetDifficulty (const CBlockIndex &blockindex)
	Get the difficulty of the net wrt to the given block index.
static int	ComputeNextBlockAndDepth (const CBlockIndex &tip, const CBlockIndex &blockindex, const CBlockIndex *&next)
static const CBlockIndex *	ParseHashOrHeight (const UniValue &param, ChainstateManager &chainman)
UniValue	blockheaderToJSON (const CBlockIndex &tip, const CBlockIndex &blockindex, const uint256 pow_limit)
	Block header to JSON.
UniValue	coinbaseTxToJSON (const CTransaction &coinbase_tx)
	Serialize coinbase transaction metadata.
UniValue	blockToJSON (BlockManager &blockman, const CBlock &block, const CBlockIndex &tip, const CBlockIndex &blockindex, TxVerbosity verbosity, const uint256 pow_limit)
	Block description to JSON.
static RPCMethod	getblockcount ()
static RPCMethod	getbestblockhash ()
static RPCMethod	waitfornewblock ()
static RPCMethod	waitforblock ()
static RPCMethod	waitforblockheight ()
static RPCMethod	syncwithvalidationinterfacequeue ()
static RPCMethod	getdifficulty ()
static RPCMethod	getblockfrompeer ()
static RPCMethod	getblockhash ()
static RPCMethod	getblockheader ()
void	CheckBlockDataAvailability (BlockManager &blockman, const CBlockIndex &blockindex, bool check_for_undo)
static CBlock	GetBlockChecked (BlockManager &blockman, const CBlockIndex &blockindex)
static std::vector< std::byte >	GetRawBlockChecked (BlockManager &blockman, const CBlockIndex &blockindex)
static CBlockUndo	GetUndoChecked (BlockManager &blockman, const CBlockIndex &blockindex)
static std::vector< RPCResult >	GetBlockFields (RPCResult tx_result, std::optional< std::string > elision_msg=std::nullopt)
static RPCMethod	getblock ()
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.
static RPCMethod	pruneblockchain ()
CoinStatsHashType	ParseHashType (std::string_view hash_type_input)
static std::optional< kernel::CCoinsStats >	GetUTXOStats (const CCoinsViewDB &view, node::BlockManager &blockman, kernel::CoinStatsHashType hash_type, const std::function< void()> &interruption_point={}, const CBlockIndex *pindex=nullptr, bool index_requested=true)
	Calculate statistics about the unspent transaction output set.
static RPCMethod	gettxoutsetinfo ()
static RPCMethod	gettxout ()
static RPCMethod	verifychain ()
static void	SoftForkDescPushBack (const CBlockIndex *blockindex, UniValue &softforks, const ChainstateManager &chainman, Consensus::BuriedDeployment dep)
static void	SoftForkDescPushBack (const CBlockIndex *blockindex, UniValue &softforks, const ChainstateManager &chainman, Consensus::DeploymentPos id)
RPCMethod	getblockchaininfo ()
RPCMethod	getdeploymentinfo ()
static RPCMethod	getchaintips ()
static RPCMethod	preciousblock ()
void	InvalidateBlock (ChainstateManager &chainman, const uint256 block_hash)
static RPCMethod	invalidateblock ()
void	ReconsiderBlock (ChainstateManager &chainman, uint256 block_hash)
static RPCMethod	reconsiderblock ()
static RPCMethod	getchaintxstats ()
template<typename T>
static T	CalculateTruncatedMedian (std::vector< T > &scores)
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.
template<typename T>
static bool	SetHasKeys (const std::set< T > &set)
template<typename T, typename Tk, typename... Args>
static bool	SetHasKeys (const std::set< T > &set, const Tk &key, const Args &... args)
static RPCMethod	getblockstats ()
static RPCMethod	scantxoutset ()
static bool	CheckBlockFilterMatches (BlockManager &blockman, const CBlockIndex &blockindex, const GCSFilter::ElementSet &needles)
static RPCMethod	scanblocks ()
static RPCMethod	getdescriptoractivity ()
static RPCMethod	getblockfilter ()
static RPCMethod	dumptxoutset ()
	Serialize the UTXO set to a file for loading elsewhere.
std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * >	PrepareUTXOSnapshot (Chainstate &chainstate, const std::function< void()> &interruption_point)
UniValue	CreateUTXOSnapshot (node::NodeContext &node, Chainstate &chainstate, AutoFile &&afile, const fs::path &path, const fs::path &tmppath)
	Helper to create UTXO snapshots given a chainstate and a file handle.
static RPCMethod	loadtxoutset ()
static RPCMethod	getchainstates ()
void	RegisterBlockchainRPCCommands (CRPCTable &t)
std::string	MakeUnorderedList (const std::vector< std::string > &items)
	Create an unordered multi-line list of items.

Variables
static constexpr size_t	PER_UTXO_OVERHEAD = sizeof(COutPoint) + sizeof(uint32_t)
static std::atomic< int >	g_scan_progress
	RAII object to prevent concurrency issue when scanning the txout set.
static std::atomic< bool >	g_scan_in_progress
static std::atomic< bool >	g_should_abort_scan
static const auto	scan_action_arg_desc
static const auto	output_descriptor_obj
static const auto	scan_objects_arg_desc
static const auto	scan_result_abort
static const auto	scan_result_status_none
static const auto	scan_result_status_some
static std::atomic< int >	g_scanfilter_progress
	RAII object to prevent concurrency issue when scanning blockfilters.
static std::atomic< int >	g_scanfilter_progress_height
static std::atomic< bool >	g_scanfilter_in_progress
static std::atomic< bool >	g_scanfilter_should_abort_scan
const std::vector< RPCResult >	RPCHelpForChainstate

Enumeration Type Documentation

◆ CoinStatsHashType

enum class kernel::CoinStatsHashType

strong

Definition at line 26 of file coinstats.h.

Function Documentation

◆ blockheaderToJSON()

UniValue blockheaderToJSON	(	const CBlockIndex &	tip,
		const CBlockIndex &	blockindex,
		const uint256	pow_limit )

Block header to JSON.

Definition at line 194 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ blockToJSON()

UniValue blockToJSON	(	BlockManager &	blockman,
		const CBlock &	block,
		const CBlockIndex &	tip,
		const CBlockIndex &	blockindex,
		TxVerbosity	verbosity,
		const uint256	pow_limit )

Block description to JSON.

Definition at line 242 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculatePercentilesByWeight()

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.

Definition at line 1952 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateTruncatedMedian()

template<typename T>

T CalculateTruncatedMedian ( std::vector< T > & scores )

static

Definition at line 1937 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckBlockDataAvailability()

void CheckBlockDataAvailability	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex,
		bool	check_for_undo )

Definition at line 711 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckBlockFilterMatches()

bool CheckBlockFilterMatches	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex,
		const GCSFilter::ElementSet &	needles )

static

Definition at line 2543 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coinbaseTxToJSON()

UniValue coinbaseTxToJSON ( const CTransaction & coinbase_tx )

Serialize coinbase transaction metadata.

Definition at line 225 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeNextBlockAndDepth()

int ComputeNextBlockAndDepth	(	const CBlockIndex &	tip,
		const CBlockIndex &	blockindex,
		const CBlockIndex *&	next )

static

Definition at line 156 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateRolledBackUTXOSnapshot()

UniValue CreateRolledBackUTXOSnapshot	(	NodeContext &	node,
		Chainstate &	chainstate,
		const CBlockIndex *	target,
		AutoFile &&	afile,
		const fs::path &	path,
		const fs::path &	tmppath,
		bool	in_memory )

Definition at line 3240 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateUTXOSnapshot()

UniValue CreateUTXOSnapshot	(	node::NodeContext &	node,
		Chainstate &	chainstate,
		AutoFile &&	afile,
		const fs::path &	path,
		const fs::path &	tmppath )

Helper to create UTXO snapshots given a chainstate and a file handle.

Returns: a UniValue map containing metadata about the snapshot.

Definition at line 3495 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dumptxoutset()

RPCMethod dumptxoutset ( )

static

Serialize the UTXO set to a file for loading elsewhere.

See also: SnapshotMetadata

Definition at line 3102 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getbestblockhash()

RPCMethod getbestblockhash ( )

static

Definition at line 309 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblock()

RPCMethod getblock ( )

static

Definition at line 835 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockchaininfo()

RPCMethod getblockchaininfo ( )

Definition at line 1399 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockChecked()

CBlock GetBlockChecked	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex )

static

Definition at line 726 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockcount()

RPCMethod getblockcount ( )

static

Definition at line 287 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockFields()

std::vector< RPCResult > GetBlockFields	(	RPCResult	tx_result,
		std::optional< std::string >	elision_msg = std::nullopt )

static

Definition at line 777 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockfilter()

RPCMethod getblockfilter ( )

static

Definition at line 2997 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockfrompeer()

RPCMethod getblockfrompeer ( )

static

Definition at line 554 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockhash()

RPCMethod getblockhash ( )

static

Definition at line 609 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockheader()

RPCMethod getblockheader ( )

static

Definition at line 639 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockstats()

RPCMethod getblockstats ( )

static

Definition at line 1992 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getchainstates()

RPCMethod getchainstates ( )

static

Definition at line 3607 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getchaintips()

RPCMethod getchaintips ( )

static

Definition at line 1613 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getchaintxstats()

RPCMethod getchaintxstats ( )

static

Definition at line 1845 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdeploymentinfo()

RPCMethod getdeploymentinfo ( )

Definition at line 1545 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdescriptoractivity()

RPCMethod getdescriptoractivity ( )

static

Definition at line 2761 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDifficulty()

double GetDifficulty ( const CBlockIndex & blockindex )

Get the difficulty of the net wrt to the given block index.

Returns: A floating point number that is a multiple of the main net minimum difficulty (4295032833 hashes).

Definition at line 136 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdifficulty()

RPCMethod getdifficulty ( )

static

Definition at line 533 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPruneHeight()

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 at line 923 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRawBlockChecked()

std::vector< std::byte > GetRawBlockChecked	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex )

static

Definition at line 743 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gettxout()

RPCMethod gettxout ( )

static

Definition at line 1217 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gettxoutsetinfo()

RPCMethod gettxoutsetinfo ( )

static

Definition at line 1050 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUndoChecked()

CBlockUndo GetUndoChecked	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex )

static

Definition at line 758 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUTXOStats()

std::optional< kernel::CCoinsStats > GetUTXOStats	(	const CCoinsViewDB &	view,
		node::BlockManager &	blockman,
		kernel::CoinStatsHashType	hash_type,
		const std::function< void()> &	interruption_point = {},
		const CBlockIndex *	pindex = nullptr,
		bool	index_requested = true )

static

Calculate statistics about the unspent transaction output set.

Parameters

[in] index_requested Signals if the coinstatsindex should be used (when available).

Definition at line 1025 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InvalidateBlock()

void InvalidateBlock	(	ChainstateManager &	chainman,
		const uint256	block_hash )

Definition at line 1753 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ invalidateblock()

RPCMethod invalidateblock ( )

static

Definition at line 1774 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadtxoutset()

RPCMethod loadtxoutset ( )

static

Definition at line 3513 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeUnorderedList()

std::string util::MakeUnorderedList ( const std::vector< std::string > & items )

inline

Create an unordered multi-line list of items.

Definition at line 230 of file string.h.

◆ ParseHashOrHeight()

const CBlockIndex * ParseHashOrHeight	(	const UniValue &	param,
		ChainstateManager &	chainman )

static

Definition at line 166 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHashType()

CoinStatsHashType ParseHashType ( std::string_view hash_type_input )

Definition at line 1007 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preciousblock()

RPCMethod preciousblock ( )

static

Definition at line 1712 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrepareUTXOSnapshot()

std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot	(	Chainstate &	chainstate,
		const std::function< void()> &	interruption_point )

Definition at line 3379 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pruneblockchain()

RPCMethod pruneblockchain ( )

static

Definition at line 948 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReconsiderBlock()

void ReconsiderBlock	(	ChainstateManager &	chainman,
		uint256	block_hash )

Definition at line 1799 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reconsiderblock()

RPCMethod reconsiderblock ( )

static

Definition at line 1819 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterBlockchainRPCCommands()

void RegisterBlockchainRPCCommands ( CRPCTable & t )

Definition at line 3667 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scanblocks()

RPCMethod scanblocks ( )

static

Definition at line 2568 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scantxoutset()

RPCMethod scantxoutset ( )

static

Definition at line 2352 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHasKeys() [1/2]

template<typename T>

bool SetHasKeys ( const std::set< T > & set )

inlinestatic

Definition at line 1982 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHasKeys() [2/2]

template<typename T, typename Tk, typename... Args>

bool SetHasKeys	(	const std::set< T > &	set,
		const Tk &	key,
		const Args &...	args )

inlinestatic

Definition at line 1984 of file blockchain.cpp.

Here is the call graph for this function:

◆ SoftForkDescPushBack() [1/2]

void SoftForkDescPushBack	(	const CBlockIndex *	blockindex,
		UniValue &	softforks,
		const ChainstateManager &	chainman,
		Consensus::BuriedDeployment	dep )

static

Definition at line 1328 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SoftForkDescPushBack() [2/2]

void SoftForkDescPushBack	(	const CBlockIndex *	blockindex,
		UniValue &	softforks,
		const ChainstateManager &	chainman,
		Consensus::DeploymentPos	id )

static

Definition at line 1343 of file blockchain.cpp.

Here is the call graph for this function:

◆ syncwithvalidationinterfacequeue()

RPCMethod syncwithvalidationinterfacequeue ( )

static

Definition at line 513 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ verifychain()

RPCMethod verifychain ( )

static

Definition at line 1297 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitforblock()

RPCMethod waitforblock ( )

static

Definition at line 389 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitforblockheight()

RPCMethod waitforblockheight ( )

static

Definition at line 450 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitfornewblock()

RPCMethod waitfornewblock ( )

static

Definition at line 330 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteUTXOSnapshot()

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 = {} )

Definition at line 3416 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ g_scan_in_progress

std::atomic<bool> g_scan_in_progress

static

Definition at line 2287 of file blockchain.cpp.

◆ g_scan_progress

std::atomic<int> g_scan_progress

static

RAII object to prevent concurrency issue when scanning the txout set.

Definition at line 2286 of file blockchain.cpp.

◆ g_scanfilter_in_progress

std::atomic<bool> g_scanfilter_in_progress

static

Definition at line 2518 of file blockchain.cpp.

◆ g_scanfilter_progress

std::atomic<int> g_scanfilter_progress

static

RAII object to prevent concurrency issue when scanning blockfilters.

Definition at line 2516 of file blockchain.cpp.

◆ g_scanfilter_progress_height

std::atomic<int> g_scanfilter_progress_height

static

Definition at line 2517 of file blockchain.cpp.

◆ g_scanfilter_should_abort_scan

std::atomic<bool> g_scanfilter_should_abort_scan

static

Definition at line 2519 of file blockchain.cpp.

◆ g_should_abort_scan

std::atomic<bool> g_should_abort_scan

static

Definition at line 2288 of file blockchain.cpp.

◆ output_descriptor_obj

const auto output_descriptor_obj

static

Initial value:

                                        = RPCArg{
    "", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "An object with output descriptor and metadata",
    {
        {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
        {"range", RPCArg::Type::RANGE, RPCArg::Default{1000}, "The range of HD chain indexes to explore (either end or [begin,end])"},
    }
}

Definition at line 2321 of file blockchain.cpp.

◆ PER_UTXO_OVERHEAD

size_t PER_UTXO_OVERHEAD = sizeof(COutPoint) + sizeof(uint32_t)

staticconstexpr

Definition at line 1990 of file blockchain.cpp.

◆ RPCHelpForChainstate

const std::vector<RPCResult> RPCHelpForChainstate

Initial value:

{
    {RPCResult::Type::NUM, "blocks", "number of blocks in this chainstate"},
    {RPCResult::Type::STR_HEX, "bestblockhash", "blockhash of the tip"},
    {RPCResult::Type::STR_HEX, "bits", "nBits: compact representation of the block difficulty target"},
    {RPCResult::Type::STR_HEX, "target", "The difficulty target"},
    {RPCResult::Type::NUM, "difficulty", "difficulty of the tip"},
    {RPCResult::Type::NUM, "verificationprogress", "progress towards the network tip"},
    {RPCResult::Type::STR_HEX, "snapshot_blockhash", true, "the base block of the snapshot this chainstate is based on, if any"},
    {RPCResult::Type::NUM, "coins_db_cache_bytes", "size of the coinsdb cache"},
    {RPCResult::Type::NUM, "coins_tip_cache_bytes", "size of the coinstip cache"},
    {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."},
}

Definition at line 3594 of file blockchain.cpp.

◆ scan_action_arg_desc

const auto scan_action_arg_desc

static

Initial value:

                                       = RPCArg{
    "action", RPCArg::Type::STR, RPCArg::Optional::NO, "The action to execute\n"
        "\"start\" for starting a scan\n"
        "\"abort\" for aborting the current scan (returns true when abort was successful)\n"
        "\"status\" for progress report (in %) of the current scan"
}

Definition at line 2314 of file blockchain.cpp.

◆ scan_objects_arg_desc

const auto scan_objects_arg_desc

static

Initial value:

                                        = RPCArg{
    "scanobjects", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "Array of scan objects. Required for \"start\" action\n"
        "Every scan object is either a string descriptor or an object:",
    {
        {"descriptor", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "An output descriptor"},
        output_descriptor_obj,
    },
    RPCArgOptions{.oneline_description="[scanobjects,...]"},
}

Definition at line 2329 of file blockchain.cpp.

◆ scan_result_abort

const auto scan_result_abort

static

Initial value:

                                    = RPCResult{
    "when action=='abort'", RPCResult::Type::BOOL, "success",
    "True if scan will be aborted (not necessarily before this RPC returns), or false if there is no scan to abort"
}

Definition at line 2339 of file blockchain.cpp.

◆ scan_result_status_none

const auto scan_result_status_none

static

Initial value:

                                          = RPCResult{
    "when action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""
}

Definition at line 2343 of file blockchain.cpp.

◆ scan_result_status_some

const auto scan_result_status_some

static

Initial value:

                                          = RPCResult{
    "when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "",
    {{RPCResult::Type::NUM, "progress", "Approximate percent complete"},}
}

Definition at line 2346 of file blockchain.cpp.

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ CoinStatsHashType

Function Documentation

◆ blockheaderToJSON()

◆ blockToJSON()

◆ CalculatePercentilesByWeight()

◆ CalculateTruncatedMedian()

◆ CheckBlockDataAvailability()

◆ CheckBlockFilterMatches()

◆ coinbaseTxToJSON()

◆ ComputeNextBlockAndDepth()

◆ CreateRolledBackUTXOSnapshot()

◆ CreateUTXOSnapshot()

◆ dumptxoutset()

◆ getbestblockhash()

◆ getblock()

◆ getblockchaininfo()

◆ GetBlockChecked()

◆ getblockcount()

◆ GetBlockFields()

◆ getblockfilter()

◆ getblockfrompeer()

◆ getblockhash()

◆ getblockheader()

◆ getblockstats()

◆ getchainstates()

◆ getchaintips()

◆ getchaintxstats()

◆ getdeploymentinfo()

◆ getdescriptoractivity()

◆ GetDifficulty()

◆ getdifficulty()

◆ GetPruneHeight()

◆ GetRawBlockChecked()

◆ gettxout()

◆ gettxoutsetinfo()

◆ GetUndoChecked()

◆ GetUTXOStats()

◆ InvalidateBlock()

◆ invalidateblock()

◆ loadtxoutset()

◆ MakeUnorderedList()

◆ ParseHashOrHeight()

◆ ParseHashType()

◆ preciousblock()

◆ PrepareUTXOSnapshot()

◆ pruneblockchain()

◆ ReconsiderBlock()

◆ reconsiderblock()

◆ RegisterBlockchainRPCCommands()

◆ scanblocks()

◆ scantxoutset()

◆ SetHasKeys() [1/2]

◆ SetHasKeys() [2/2]

◆ SoftForkDescPushBack() [1/2]

◆ SoftForkDescPushBack() [2/2]

◆ syncwithvalidationinterfacequeue()

◆ verifychain()

◆ waitforblock()

◆ waitforblockheight()

◆ waitfornewblock()

◆ WriteUTXOSnapshot()

Variable Documentation

◆ g_scan_in_progress

◆ g_scan_progress

◆ g_scanfilter_in_progress

◆ g_scanfilter_progress

◆ g_scanfilter_progress_height

◆ g_scanfilter_should_abort_scan

◆ g_should_abort_scan

◆ output_descriptor_obj

◆ PER_UTXO_OVERHEAD

◆ RPCHelpForChainstate

◆ scan_action_arg_desc

◆ scan_objects_arg_desc

◆ scan_result_abort