interfaces::Node Class Reference

Top-level interface for a bitcoin node (bitcoind process). More...

#include <node.h>

Public Types
using	NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>
	Get stats for connected nodes.
using	InitMessageFn = std::function<void(const std::string& message)>
	Register handler for init messages.
using	MessageBoxFn = std::function<void(const bilingual_str& message, unsigned int style)>
	Register handler for message box messages.
using	QuestionFn
	Register handler for question messages.
using	ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>
	Register handler for progress messages.
using	InitWalletFn = std::function<void()>
	Register handler for wallet loader constructed messages.
using	NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>
	Register handler for number of connections changed messages.
using	NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>
	Register handler for network active messages.
using	NotifyAlertChangedFn = std::function<void()>
	Register handler for notify alert messages.
using	BannedListChangedFn = std::function<void()>
	Register handler for ban list messages.
using	NotifyBlockTipFn
	Register handler for block tip messages.
using	NotifyHeaderTipFn
	Register handler for header tip messages.

Public Member Functions
virtual	~Node ()=default
virtual void	initLogging ()=0
	Init logging.
virtual void	initParameterInteraction ()=0
	Init parameter interaction.
virtual bilingual_str	getWarnings ()=0
	Get warnings.
virtual int	getExitStatus ()=0
	Get exit status.
virtual BCLog::CategoryMask	getLogCategories ()=0
virtual bool	baseInitialize ()=0
	Initialize app dependencies.
virtual bool	appInitMain (interfaces::BlockAndHeaderTipInfo *tip_info=nullptr)=0
	Start node.
virtual void	appShutdown ()=0
	Stop node.
virtual void	startShutdown ()=0
	Start shutdown.
virtual bool	shutdownRequested ()=0
	Return whether shutdown was requested.
virtual bool	isSettingIgnored (const std::string &name)=0
virtual common::SettingsValue	getPersistentSetting (const std::string &name)=0
	Return setting value from <datadir>/settings.json or bitcoin.conf.
virtual void	updateRwSetting (const std::string &name, const common::SettingsValue &value)=0
	Update a setting in <datadir>/settings.json.
virtual void	forceSetting (const std::string &name, const common::SettingsValue &value)=0
virtual void	resetSettings ()=0
virtual void	mapPort (bool enable)=0
	Map port.
virtual std::optional< Proxy >	getProxy (Network net)=0
	Get proxy.
virtual size_t	getNodeCount (ConnectionDirection flags)=0
	Get number of connections.
virtual bool	getNodesStats (NodesStats &stats)=0
virtual bool	getBanned (banmap_t &banmap)=0
	Get ban map entries.
virtual bool	ban (const CNetAddr &net_addr, int64_t ban_time_offset)=0
	Ban node.
virtual bool	unban (const CSubNet &ip)=0
	Unban node.
virtual bool	disconnectByAddress (const CNetAddr &net_addr)=0
	Disconnect node by address.
virtual bool	disconnectById (NodeId id)=0
	Disconnect node by id.
virtual std::vector< std::unique_ptr< ExternalSigner > >	listExternalSigners ()=0
	Return list of external signers (attached devices which can sign transactions).
virtual int64_t	getTotalBytesRecv ()=0
	Get total bytes recv.
virtual int64_t	getTotalBytesSent ()=0
	Get total bytes sent.
virtual size_t	getMempoolSize ()=0
	Get mempool size.
virtual size_t	getMempoolDynamicUsage ()=0
	Get mempool dynamic usage.
virtual size_t	getMempoolMaxUsage ()=0
	Get mempool maximum memory usage.
virtual bool	getHeaderTip (int &height, int64_t &block_time)=0
	Get header tip height and time.
virtual int	getNumBlocks ()=0
	Get num blocks.
virtual std::map< CNetAddr, LocalServiceInfo >	getNetLocalAddresses ()=0
	Get network local addresses.
virtual uint256	getBestBlockHash ()=0
	Get best block hash.
virtual int64_t	getLastBlockTime ()=0
	Get last block time.
virtual double	getVerificationProgress ()=0
	Get verification progress.
virtual bool	isInitialBlockDownload ()=0
	Is initial block download.
virtual bool	isLoadingBlocks ()=0
	Is loading blocks.
virtual void	setNetworkActive (bool active)=0
	Set network active.
virtual bool	getNetworkActive ()=0
	Get network active.
virtual CFeeRate	getDustRelayFee ()=0
	Get dust relay fee.
virtual UniValue	executeRpc (const std::string &command, const UniValue &params, const std::string &uri)=0
	Execute rpc command.
virtual std::vector< std::string >	listRpcCommands ()=0
	List rpc commands.
virtual std::optional< Coin >	getUnspentOutput (const COutPoint &output)=0
	Get unspent output associated with a transaction.
virtual node::TransactionError	broadcastTransaction (CTransactionRef tx, CAmount max_tx_fee, std::string &err_string)=0
	Broadcast transaction.
virtual WalletLoader &	walletLoader ()=0
	Get wallet loader.
virtual std::unique_ptr< Handler >	handleInitMessage (InitMessageFn fn)=0
virtual std::unique_ptr< Handler >	handleMessageBox (MessageBoxFn fn)=0
virtual std::unique_ptr< Handler >	handleQuestion (QuestionFn fn)=0
virtual std::unique_ptr< Handler >	handleShowProgress (ShowProgressFn fn)=0
virtual std::unique_ptr< Handler >	handleInitWallet (InitWalletFn fn)=0
virtual std::unique_ptr< Handler >	handleNotifyNumConnectionsChanged (NotifyNumConnectionsChangedFn fn)=0
virtual std::unique_ptr< Handler >	handleNotifyNetworkActiveChanged (NotifyNetworkActiveChangedFn fn)=0
virtual std::unique_ptr< Handler >	handleNotifyAlertChanged (NotifyAlertChangedFn fn)=0
virtual std::unique_ptr< Handler >	handleBannedListChanged (BannedListChangedFn fn)=0
virtual std::unique_ptr< Handler >	handleNotifyBlockTip (NotifyBlockTipFn fn)=0
virtual std::unique_ptr< Handler >	handleNotifyHeaderTip (NotifyHeaderTipFn fn)=0
virtual node::NodeContext *	context ()
virtual void	setContext (node::NodeContext *context)

Detailed Description

Top-level interface for a bitcoin node (bitcoind process).

Definition at line 65 of file node.h.

Member Typedef Documentation

BannedListChangedFn

using interfaces::Node::BannedListChangedFn = std::function<void()>

Register handler for ban list messages.

Definition at line 247 of file node.h.

InitMessageFn

using interfaces::Node::InitMessageFn = std::function<void(const std::string& message)>

Register handler for init messages.

Definition at line 213 of file node.h.

InitWalletFn

using interfaces::Node::InitWalletFn = std::function<void()>

Register handler for wallet loader constructed messages.

Definition at line 231 of file node.h.

MessageBoxFn

using interfaces::Node::MessageBoxFn = std::function<void(const bilingual_str& message, unsigned int style)>

Register handler for message box messages.

Definition at line 217 of file node.h.

NodesStats

using interfaces::Node::NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>

Get stats for connected nodes.

Definition at line 128 of file node.h.

NotifyAlertChangedFn

using interfaces::Node::NotifyAlertChangedFn = std::function<void()>

Register handler for notify alert messages.

Definition at line 243 of file node.h.

NotifyBlockTipFn

using interfaces::Node::NotifyBlockTipFn

Initial value:

 
std::function<void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)>

Register handler for block tip messages.

Definition at line 251 of file node.h.

NotifyHeaderTipFn

using interfaces::Node::NotifyHeaderTipFn

Initial value:

 
std::function<void(SynchronizationState, interfaces::BlockTip tip, bool presync)>

Register handler for header tip messages.

Definition at line 256 of file node.h.

NotifyNetworkActiveChangedFn

using interfaces::Node::NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>

Register handler for network active messages.

Definition at line 239 of file node.h.

NotifyNumConnectionsChangedFn

using interfaces::Node::NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>

Register handler for number of connections changed messages.

Definition at line 235 of file node.h.

QuestionFn

using interfaces::Node::QuestionFn

Initial value:

std::function<bool(const bilingual_str& message,
       const std::string& non_interactive_message,
       unsigned int style)>

Register handler for question messages.

Definition at line 221 of file node.h.

ShowProgressFn

using interfaces::Node::ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>

Register handler for progress messages.

Definition at line 227 of file node.h.

Constructor & Destructor Documentation

~Node()

virtual interfaces::Node::~Node ( )

virtualdefault

Member Function Documentation

appInitMain()

virtual bool interfaces::Node::appInitMain ( interfaces::BlockAndHeaderTipInfo * tip_info = nullptr )

pure virtual

Start node.

Here is the caller graph for this function:

appShutdown()

virtual void interfaces::Node::appShutdown ( )

pure virtual

Stop node.

Here is the caller graph for this function:

ban()

virtual bool interfaces::Node::ban ( const CNetAddr & net_addr, int64_t ban_time_offset )

pure virtual

Ban node.

Here is the caller graph for this function:

baseInitialize()

virtual bool interfaces::Node::baseInitialize ( )

pure virtual

Initialize app dependencies.

broadcastTransaction()

virtual node::TransactionError interfaces::Node::broadcastTransaction ( CTransactionRef tx, CAmount max_tx_fee, std::string & err_string )

pure virtual

Broadcast transaction.

Here is the caller graph for this function:

context()

virtual node::NodeContext * interfaces::Node::context ( )

inlinevirtual

Get and set internal node context. Useful for testing, but not accessible across processes.

Definition at line 262 of file node.h.

Here is the caller graph for this function:

disconnectByAddress()

virtual bool interfaces::Node::disconnectByAddress ( const CNetAddr & net_addr )

pure virtual

Disconnect node by address.

Here is the caller graph for this function:

disconnectById()

virtual bool interfaces::Node::disconnectById ( NodeId id )

pure virtual

Disconnect node by id.

Here is the caller graph for this function:

executeRpc()

virtual UniValue interfaces::Node::executeRpc ( const std::string & command, const UniValue & params, const std::string & uri )

pure virtual

Execute rpc command.

forceSetting()

virtual void interfaces::Node::forceSetting ( const std::string & name, const common::SettingsValue & value )

pure virtual

Force a setting value to be applied, overriding any other configuration source, but not being persisted.

getBanned()

virtual bool interfaces::Node::getBanned ( banmap_t & banmap )

pure virtual

Get ban map entries.

getBestBlockHash()

virtual uint256 interfaces::Node::getBestBlockHash ( )

pure virtual

Get best block hash.

Here is the caller graph for this function:

getDustRelayFee()

virtual CFeeRate interfaces::Node::getDustRelayFee ( )

pure virtual

Get dust relay fee.

Here is the caller graph for this function:

getExitStatus()

virtual int interfaces::Node::getExitStatus ( )

pure virtual

Get exit status.

Here is the caller graph for this function:

getHeaderTip()

virtual bool interfaces::Node::getHeaderTip ( int & height, int64_t & block_time )

pure virtual

Get header tip height and time.

Here is the caller graph for this function:

getLastBlockTime()

virtual int64_t interfaces::Node::getLastBlockTime ( )

pure virtual

Get last block time.

getLogCategories()

virtual BCLog::CategoryMask interfaces::Node::getLogCategories ( )

pure virtual

getMempoolDynamicUsage()

virtual size_t interfaces::Node::getMempoolDynamicUsage ( )

pure virtual

Get mempool dynamic usage.

Here is the caller graph for this function:

getMempoolMaxUsage()

virtual size_t interfaces::Node::getMempoolMaxUsage ( )

pure virtual

Get mempool maximum memory usage.

Here is the caller graph for this function:

getMempoolSize()

virtual size_t interfaces::Node::getMempoolSize ( )

pure virtual

Get mempool size.

Here is the caller graph for this function:

getNetLocalAddresses()

virtual std::map< CNetAddr, LocalServiceInfo > interfaces::Node::getNetLocalAddresses ( )

pure virtual

Get network local addresses.

Here is the caller graph for this function:

getNetworkActive()

virtual bool interfaces::Node::getNetworkActive ( )

pure virtual

Get network active.

Here is the caller graph for this function:

getNodeCount()

virtual size_t interfaces::Node::getNodeCount ( ConnectionDirection flags )

pure virtual

Get number of connections.

Here is the caller graph for this function:

getNodesStats()

virtual bool interfaces::Node::getNodesStats ( NodesStats & stats )

pure virtual

Here is the caller graph for this function:

getNumBlocks()

virtual int interfaces::Node::getNumBlocks ( )

pure virtual

Get num blocks.

Here is the caller graph for this function:

getPersistentSetting()

virtual common::SettingsValue interfaces::Node::getPersistentSetting ( const std::string & name )

pure virtual

Return setting value from <datadir>/settings.json or bitcoin.conf.

getProxy()

virtual std::optional< Proxy > interfaces::Node::getProxy ( Network net )

pure virtual

Get proxy.

Here is the caller graph for this function:

getTotalBytesRecv()

virtual int64_t interfaces::Node::getTotalBytesRecv ( )

pure virtual

Get total bytes recv.

Here is the caller graph for this function:

getTotalBytesSent()

virtual int64_t interfaces::Node::getTotalBytesSent ( )

pure virtual

Get total bytes sent.

Here is the caller graph for this function:

getUnspentOutput()

virtual std::optional< Coin > interfaces::Node::getUnspentOutput ( const COutPoint & output )

pure virtual

Get unspent output associated with a transaction.

getVerificationProgress()

virtual double interfaces::Node::getVerificationProgress ( )

pure virtual

Get verification progress.

getWarnings()

virtual bilingual_str interfaces::Node::getWarnings ( )

pure virtual

Get warnings.

Here is the caller graph for this function:

handleBannedListChanged()

virtual std::unique_ptr< Handler > interfaces::Node::handleBannedListChanged ( BannedListChangedFn fn )

pure virtual

Here is the caller graph for this function:

handleInitMessage()

virtual std::unique_ptr< Handler > interfaces::Node::handleInitMessage ( InitMessageFn fn )

pure virtual

Here is the caller graph for this function:

handleInitWallet()

virtual std::unique_ptr< Handler > interfaces::Node::handleInitWallet ( InitWalletFn fn )

pure virtual

Here is the caller graph for this function:

handleMessageBox()

virtual std::unique_ptr< Handler > interfaces::Node::handleMessageBox ( MessageBoxFn fn )

pure virtual

Here is the caller graph for this function:

handleNotifyAlertChanged()

virtual std::unique_ptr< Handler > interfaces::Node::handleNotifyAlertChanged ( NotifyAlertChangedFn fn )

pure virtual

Here is the caller graph for this function:

handleNotifyBlockTip()

virtual std::unique_ptr< Handler > interfaces::Node::handleNotifyBlockTip ( NotifyBlockTipFn fn )

pure virtual

handleNotifyHeaderTip()

virtual std::unique_ptr< Handler > interfaces::Node::handleNotifyHeaderTip ( NotifyHeaderTipFn fn )

pure virtual

handleNotifyNetworkActiveChanged()

virtual std::unique_ptr< Handler > interfaces::Node::handleNotifyNetworkActiveChanged ( NotifyNetworkActiveChangedFn fn )

pure virtual

Here is the caller graph for this function:

handleNotifyNumConnectionsChanged()

virtual std::unique_ptr< Handler > interfaces::Node::handleNotifyNumConnectionsChanged ( NotifyNumConnectionsChangedFn fn )

pure virtual

Here is the caller graph for this function:

handleQuestion()

virtual std::unique_ptr< Handler > interfaces::Node::handleQuestion ( QuestionFn fn )

pure virtual

Here is the caller graph for this function:

handleShowProgress()

virtual std::unique_ptr< Handler > interfaces::Node::handleShowProgress ( ShowProgressFn fn )

pure virtual

Here is the caller graph for this function:

initLogging()

virtual void interfaces::Node::initLogging ( )

pure virtual

Init logging.

initParameterInteraction()

virtual void interfaces::Node::initParameterInteraction ( )

pure virtual

Init parameter interaction.

isInitialBlockDownload()

virtual bool interfaces::Node::isInitialBlockDownload ( )

pure virtual

Is initial block download.

Here is the caller graph for this function:

isLoadingBlocks()

virtual bool interfaces::Node::isLoadingBlocks ( )

pure virtual

Is loading blocks.

Here is the caller graph for this function:

isSettingIgnored()

virtual bool interfaces::Node::isSettingIgnored ( const std::string & name )

pure virtual

Return whether a particular setting in <datadir>/settings.json is or would be ignored because it is also specified in the command line.

listExternalSigners()

virtual std::vector< std::unique_ptr< ExternalSigner > > interfaces::Node::listExternalSigners ( )

pure virtual

Return list of external signers (attached devices which can sign transactions).

listRpcCommands()

virtual std::vector< std::string > interfaces::Node::listRpcCommands ( )

pure virtual

List rpc commands.

Here is the caller graph for this function:

mapPort()

virtual void interfaces::Node::mapPort ( bool enable )

pure virtual

Map port.

resetSettings()

virtual void interfaces::Node::resetSettings ( )

pure virtual

Clear all settings in <datadir>/settings.json and store a backup of previous settings in <datadir>/settings.json.bak.

setContext()

virtual void interfaces::Node::setContext ( node::NodeContext * context )

inlinevirtual

Definition at line 263 of file node.h.

Here is the call graph for this function:

Here is the caller graph for this function:

setNetworkActive()

virtual void interfaces::Node::setNetworkActive ( bool active )

pure virtual

Set network active.

Here is the caller graph for this function:

shutdownRequested()

virtual bool interfaces::Node::shutdownRequested ( )

pure virtual

Return whether shutdown was requested.

Here is the caller graph for this function:

startShutdown()

virtual void interfaces::Node::startShutdown ( )

pure virtual

Start shutdown.

Here is the caller graph for this function:

unban()

virtual bool interfaces::Node::unban ( const CSubNet & ip )

pure virtual

Unban node.

Here is the caller graph for this function:

updateRwSetting()

virtual void interfaces::Node::updateRwSetting ( const std::string & name, const common::SettingsValue & value )

pure virtual

Update a setting in <datadir>/settings.json.

walletLoader()

virtual WalletLoader & interfaces::Node::walletLoader ( )

pure virtual

Get wallet loader.

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• src/interfaces/node.h