Bitcoin
Public Types | Public Member Functions | List of all members
interfaces::Node Class Referenceabstract

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

#include <node.h>

Inheritance diagram for interfaces::Node:
interfaces::anonymous_namespace{node.cpp}::NodeImpl

Public Types

using NodesStats = std::vector< std::tuple< CNodeStats, bool, CNodeStateStats > >
 Get stats for connected nodes. More...
 
using InitMessageFn = std::function< void(const std::string &message)>
 Register handler for init messages. More...
 
using MessageBoxFn = std::function< bool(const std::string &message, const std::string &caption, unsigned int style)>
 Register handler for message box messages. More...
 
using QuestionFn = std::function< bool(const std::string &message, const std::string &non_interactive_message, const std::string &caption, unsigned int style)>
 Register handler for question messages. More...
 
using ShowProgressFn = std::function< void(const std::string &title, int progress, bool resume_possible)>
 Register handler for progress messages. More...
 
using LoadWalletFn = std::function< void(std::unique_ptr< Wallet > wallet)>
 Register handler for load wallet messages. More...
 
using NotifyNumConnectionsChangedFn = std::function< void(int new_num_connections)>
 Register handler for number of connections changed messages. More...
 
using NotifyNetworkActiveChangedFn = std::function< void(bool network_active)>
 Register handler for network active messages. More...
 
using NotifyAlertChangedFn = std::function< void()>
 Register handler for notify alert messages. More...
 
using BannedListChangedFn = std::function< void()>
 Register handler for ban list messages. More...
 
using NotifyBlockTipFn = std::function< void(bool initial_download, int height, int64_t block_time, double verification_progress)>
 Register handler for block tip messages. More...
 
using NotifyHeaderTipFn = std::function< void(bool initial_download, int height, int64_t block_time, double verification_progress)>
 Register handler for header tip messages. More...
 

Public Member Functions

virtual ~Node ()
 
virtual bool parseParameters (int argc, const char *const argv[], std::string &error)=0
 Set command line arguments. More...
 
virtual bool softSetArg (const std::string &arg, const std::string &value)=0
 Set a command line argument if it doesn't already have a value. More...
 
virtual bool softSetBoolArg (const std::string &arg, bool value)=0
 Set a command line boolean argument if it doesn't already have a value. More...
 
virtual bool readConfigFiles (std::string &error)=0
 Load settings from configuration file. More...
 
virtual void selectParams (const std::string &network)=0
 Choose network parameters. More...
 
virtual uint64_t getAssumedBlockchainSize ()=0
 Get the (assumed) blockchain size. More...
 
virtual uint64_t getAssumedChainStateSize ()=0
 Get the (assumed) chain state size. More...
 
virtual std::string getNetwork ()=0
 Get network name. More...
 
virtual void initLogging ()=0
 Init logging. More...
 
virtual void initParameterInteraction ()=0
 Init parameter interaction. More...
 
virtual std::string getWarnings (const std::string &type)=0
 Get warnings. More...
 
virtual uint32_t getLogCategories ()=0
 
virtual bool baseInitialize ()=0
 Initialize app dependencies. More...
 
virtual bool appInitMain ()=0
 Start node. More...
 
virtual void appShutdown ()=0
 Stop node. More...
 
virtual void startShutdown ()=0
 Start shutdown. More...
 
virtual bool shutdownRequested ()=0
 Return whether shutdown was requested. More...
 
virtual void setupServerArgs ()=0
 Setup arguments. More...
 
virtual void mapPort (bool use_upnp)=0
 Map port. More...
 
virtual bool getProxy (Network net, proxyType &proxy_info)=0
 Get proxy. More...
 
virtual size_t getNodeCount (CConnman::NumConnections flags)=0
 Get number of connections. More...
 
virtual bool getNodesStats (NodesStats &stats)=0
 
virtual bool getBanned (banmap_t &banmap)=0
 Get ban map entries. More...
 
virtual bool ban (const CNetAddr &net_addr, BanReason reason, int64_t ban_time_offset)=0
 Ban node. More...
 
virtual bool unban (const CSubNet &ip)=0
 Unban node. More...
 
virtual bool disconnect (const CNetAddr &net_addr)=0
 Disconnect node by address. More...
 
virtual bool disconnect (NodeId id)=0
 Disconnect node by id. More...
 
virtual int64_t getTotalBytesRecv ()=0
 Get total bytes recv. More...
 
virtual int64_t getTotalBytesSent ()=0
 Get total bytes sent. More...
 
virtual size_t getMempoolSize ()=0
 Get mempool size. More...
 
virtual size_t getMempoolDynamicUsage ()=0
 Get mempool dynamic usage. More...
 
virtual bool getHeaderTip (int &height, int64_t &block_time)=0
 Get header tip height and time. More...
 
virtual int getNumBlocks ()=0
 Get num blocks. More...
 
virtual int64_t getLastBlockTime ()=0
 Get last block time. More...
 
virtual double getVerificationProgress ()=0
 Get verification progress. More...
 
virtual bool isInitialBlockDownload ()=0
 Is initial block download. More...
 
virtual bool getReindex ()=0
 Get reindex. More...
 
virtual bool getImporting ()=0
 Get importing. More...
 
virtual void setNetworkActive (bool active)=0
 Set network active. More...
 
virtual bool getNetworkActive ()=0
 Get network active. More...
 
virtual CFeeRate estimateSmartFee (int num_blocks, bool conservative, int *returned_target=nullptr)=0
 Estimate smart fee. More...
 
virtual CFeeRate getDustRelayFee ()=0
 Get dust relay fee. More...
 
virtual UniValue executeRpc (const std::string &command, const UniValue &params, const std::string &uri)=0
 Execute rpc command. More...
 
virtual std::vector< std::string > listRpcCommands ()=0
 List rpc commands. More...
 
virtual void rpcSetTimerInterfaceIfUnset (RPCTimerInterface *iface)=0
 Set RPC timer interface if unset. More...
 
virtual void rpcUnsetTimerInterface (RPCTimerInterface *iface)=0
 Unset RPC timer interface. More...
 
virtual bool getUnspentOutput (const COutPoint &output, Coin &coin)=0
 Get unspent outputs associated with a transaction. More...
 
virtual std::string getWalletDir ()=0
 Return default wallet directory. More...
 
virtual std::vector< std::string > listWalletDir ()=0
 Return available wallets in wallet directory. More...
 
virtual std::vector< std::unique_ptr< Wallet > > getWallets ()=0
 Return interfaces for accessing wallets (if any). More...
 
virtual std::unique_ptr< Wallet > loadWallet (const std::string &name, std::string &error, std::string &warning)=0
 
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 > handleLoadWallet (LoadWalletFn 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
 

Detailed Description

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

Member Typedef Documentation

◆ BannedListChangedFn

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

Register handler for ban list messages.

◆ InitMessageFn

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

Register handler for init messages.

◆ LoadWalletFn

using interfaces::Node::LoadWalletFn = std::function<void(std::unique_ptr<Wallet> wallet)>

Register handler for load wallet messages.

◆ MessageBoxFn

using interfaces::Node::MessageBoxFn = std::function<bool(const std::string& message, const std::string& caption, unsigned int style)>

Register handler for message box messages.

◆ NodesStats

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

Get stats for connected nodes.

◆ NotifyAlertChangedFn

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

Register handler for notify alert messages.

◆ NotifyBlockTipFn

using interfaces::Node::NotifyBlockTipFn = std::function<void(bool initial_download, int height, int64_t block_time, double verification_progress)>

Register handler for block tip messages.

◆ NotifyHeaderTipFn

using interfaces::Node::NotifyHeaderTipFn = std::function<void(bool initial_download, int height, int64_t block_time, double verification_progress)>

Register handler for header tip messages.

◆ NotifyNetworkActiveChangedFn

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

Register handler for network active messages.

◆ NotifyNumConnectionsChangedFn

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

Register handler for number of connections changed messages.

◆ QuestionFn

using interfaces::Node::QuestionFn = std::function<bool(const std::string& message, const std::string& non_interactive_message, const std::string& caption, unsigned int style)>

Register handler for question messages.

◆ ShowProgressFn

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

Register handler for progress messages.

Constructor & Destructor Documentation

◆ ~Node()

virtual interfaces::Node::~Node ( )
inlinevirtual

Member Function Documentation

◆ appInitMain()

virtual bool interfaces::Node::appInitMain ( )
pure virtual

Start node.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ appShutdown()

virtual void interfaces::Node::appShutdown ( )
pure virtual

Stop node.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ ban()

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

Ban node.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ baseInitialize()

virtual bool interfaces::Node::baseInitialize ( )
pure virtual

Initialize app dependencies.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ disconnect() [1/2]

virtual bool interfaces::Node::disconnect ( const CNetAddr &  net_addr)
pure virtual

Disconnect node by address.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ disconnect() [2/2]

virtual bool interfaces::Node::disconnect ( NodeId  id)
pure virtual

Disconnect node by id.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ estimateSmartFee()

virtual CFeeRate interfaces::Node::estimateSmartFee ( int  num_blocks,
bool  conservative,
int *  returned_target = nullptr 
)
pure virtual

Estimate smart fee.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ executeRpc()

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

Execute rpc command.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getAssumedBlockchainSize()

virtual uint64_t interfaces::Node::getAssumedBlockchainSize ( )
pure virtual

Get the (assumed) blockchain size.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getAssumedChainStateSize()

virtual uint64_t interfaces::Node::getAssumedChainStateSize ( )
pure virtual

Get the (assumed) chain state size.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getBanned()

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

Get ban map entries.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getDustRelayFee()

virtual CFeeRate interfaces::Node::getDustRelayFee ( )
pure virtual

Get dust relay fee.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getHeaderTip()

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

Get header tip height and time.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getImporting()

virtual bool interfaces::Node::getImporting ( )
pure virtual

Get importing.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getLastBlockTime()

virtual int64_t interfaces::Node::getLastBlockTime ( )
pure virtual

Get last block time.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getLogCategories()

virtual uint32_t interfaces::Node::getLogCategories ( )
pure virtual

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getMempoolDynamicUsage()

virtual size_t interfaces::Node::getMempoolDynamicUsage ( )
pure virtual

Get mempool dynamic usage.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getMempoolSize()

virtual size_t interfaces::Node::getMempoolSize ( )
pure virtual

Get mempool size.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getNetwork()

virtual std::string interfaces::Node::getNetwork ( )
pure virtual

Get network name.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getNetworkActive()

virtual bool interfaces::Node::getNetworkActive ( )
pure virtual

Get network active.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getNodeCount()

virtual size_t interfaces::Node::getNodeCount ( CConnman::NumConnections  flags)
pure virtual

Get number of connections.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getNodesStats()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getNumBlocks()

virtual int interfaces::Node::getNumBlocks ( )
pure virtual

Get num blocks.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getProxy()

virtual bool interfaces::Node::getProxy ( Network  net,
proxyType &  proxy_info 
)
pure virtual

Get proxy.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getReindex()

virtual bool interfaces::Node::getReindex ( )
pure virtual

Get reindex.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getTotalBytesRecv()

virtual int64_t interfaces::Node::getTotalBytesRecv ( )
pure virtual

Get total bytes recv.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getTotalBytesSent()

virtual int64_t interfaces::Node::getTotalBytesSent ( )
pure virtual

Get total bytes sent.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getUnspentOutput()

virtual bool interfaces::Node::getUnspentOutput ( const COutPoint &  output,
Coin &  coin 
)
pure virtual

Get unspent outputs associated with a transaction.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getVerificationProgress()

virtual double interfaces::Node::getVerificationProgress ( )
pure virtual

Get verification progress.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getWalletDir()

virtual std::string interfaces::Node::getWalletDir ( )
pure virtual

Return default wallet directory.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getWallets()

virtual std::vector<std::unique_ptr<Wallet> > interfaces::Node::getWallets ( )
pure virtual

Return interfaces for accessing wallets (if any).

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ getWarnings()

virtual std::string interfaces::Node::getWarnings ( const std::string &  type)
pure virtual

Get warnings.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleBannedListChanged()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleInitMessage()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleLoadWallet()

virtual std::unique_ptr<Handler> interfaces::Node::handleLoadWallet ( LoadWalletFn  fn)
pure virtual

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleMessageBox()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleNotifyAlertChanged()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleNotifyBlockTip()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleNotifyHeaderTip()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleNotifyNetworkActiveChanged()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleNotifyNumConnectionsChanged()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleQuestion()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ handleShowProgress()

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

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ initLogging()

virtual void interfaces::Node::initLogging ( )
pure virtual

Init logging.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ initParameterInteraction()

virtual void interfaces::Node::initParameterInteraction ( )
pure virtual

Init parameter interaction.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ isInitialBlockDownload()

virtual bool interfaces::Node::isInitialBlockDownload ( )
pure virtual

Is initial block download.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ listRpcCommands()

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

List rpc commands.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ listWalletDir()

virtual std::vector<std::string> interfaces::Node::listWalletDir ( )
pure virtual

Return available wallets in wallet directory.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ loadWallet()

virtual std::unique_ptr<Wallet> interfaces::Node::loadWallet ( const std::string &  name,
std::string &  error,
std::string &  warning 
)
pure virtual

Attempts to load a wallet from file or directory. The loaded wallet is also notified to handlers previously registered with handleLoadWallet.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ mapPort()

virtual void interfaces::Node::mapPort ( bool  use_upnp)
pure virtual

Map port.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ parseParameters()

virtual bool interfaces::Node::parseParameters ( int  argc,
const char *const  argv[],
std::string &  error 
)
pure virtual

Set command line arguments.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ readConfigFiles()

virtual bool interfaces::Node::readConfigFiles ( std::string &  error)
pure virtual

Load settings from configuration file.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ rpcSetTimerInterfaceIfUnset()

virtual void interfaces::Node::rpcSetTimerInterfaceIfUnset ( RPCTimerInterface *  iface)
pure virtual

Set RPC timer interface if unset.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ rpcUnsetTimerInterface()

virtual void interfaces::Node::rpcUnsetTimerInterface ( RPCTimerInterface *  iface)
pure virtual

Unset RPC timer interface.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ selectParams()

virtual void interfaces::Node::selectParams ( const std::string &  network)
pure virtual

Choose network parameters.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ setNetworkActive()

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

Set network active.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ setupServerArgs()

virtual void interfaces::Node::setupServerArgs ( )
pure virtual

Setup arguments.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ shutdownRequested()

virtual bool interfaces::Node::shutdownRequested ( )
pure virtual

Return whether shutdown was requested.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ softSetArg()

virtual bool interfaces::Node::softSetArg ( const std::string &  arg,
const std::string &  value 
)
pure virtual

Set a command line argument if it doesn't already have a value.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ softSetBoolArg()

virtual bool interfaces::Node::softSetBoolArg ( const std::string &  arg,
bool  value 
)
pure virtual

Set a command line boolean argument if it doesn't already have a value.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ startShutdown()

virtual void interfaces::Node::startShutdown ( )
pure virtual

Start shutdown.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

◆ unban()

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

Unban node.

Implemented in interfaces::anonymous_namespace{node.cpp}::NodeImpl.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.15