Bitcoin Core  0.19.99
P2P Digital Currency
node.h
Go to the documentation of this file.
1 // Copyright (c) 2018 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_INTERFACES_NODE_H
6 #define BITCOIN_INTERFACES_NODE_H
7 
8 #include <addrdb.h> // For banmap_t
9 #include <amount.h> // For CAmount
10 #include <net.h> // For CConnman::NumConnections
11 #include <netaddress.h> // For Network
12 #include <support/allocators/secure.h> // For SecureString
13 
14 #include <functional>
15 #include <memory>
16 #include <stddef.h>
17 #include <stdint.h>
18 #include <string>
19 #include <tuple>
20 #include <vector>
21 
22 class BanMan;
23 class CCoinControl;
24 class CFeeRate;
25 class CNodeStats;
26 class Coin;
27 class RPCTimerInterface;
28 class UniValue;
29 class proxyType;
30 struct CNodeStateStats;
31 enum class WalletCreationStatus;
32 
33 namespace interfaces {
34 class Handler;
35 class Wallet;
36 
38 class Node
39 {
40 public:
41  virtual ~Node() {}
42 
44  virtual void initError(const std::string& message) = 0;
45 
47  virtual bool parseParameters(int argc, const char* const argv[], std::string& error) = 0;
48 
50  virtual void forceSetArg(const std::string& arg, const std::string& value) = 0;
51 
53  virtual bool softSetArg(const std::string& arg, const std::string& value) = 0;
54 
56  virtual bool softSetBoolArg(const std::string& arg, bool value) = 0;
57 
59  virtual bool readConfigFiles(std::string& error) = 0;
60 
62  virtual void selectParams(const std::string& network) = 0;
63 
65  virtual uint64_t getAssumedBlockchainSize() = 0;
66 
68  virtual uint64_t getAssumedChainStateSize() = 0;
69 
71  virtual std::string getNetwork() = 0;
72 
74  virtual void initLogging() = 0;
75 
77  virtual void initParameterInteraction() = 0;
78 
80  virtual std::string getWarnings(const std::string& type) = 0;
81 
82  // Get log flags.
83  virtual uint32_t getLogCategories() = 0;
84 
86  virtual bool baseInitialize() = 0;
87 
89  virtual bool appInitMain() = 0;
90 
92  virtual void appShutdown() = 0;
93 
95  virtual void startShutdown() = 0;
96 
98  virtual bool shutdownRequested() = 0;
99 
101  virtual void setupServerArgs() = 0;
102 
104  virtual void mapPort(bool use_upnp) = 0;
105 
107  virtual bool getProxy(Network net, proxyType& proxy_info) = 0;
108 
110  virtual size_t getNodeCount(CConnman::NumConnections flags) = 0;
111 
113  using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;
114  virtual bool getNodesStats(NodesStats& stats) = 0;
115 
117  virtual bool getBanned(banmap_t& banmap) = 0;
118 
120  virtual bool ban(const CNetAddr& net_addr, BanReason reason, int64_t ban_time_offset) = 0;
121 
123  virtual bool unban(const CSubNet& ip) = 0;
124 
126  virtual bool disconnect(const CNetAddr& net_addr) = 0;
127 
129  virtual bool disconnect(NodeId id) = 0;
130 
132  virtual int64_t getTotalBytesRecv() = 0;
133 
135  virtual int64_t getTotalBytesSent() = 0;
136 
138  virtual size_t getMempoolSize() = 0;
139 
141  virtual size_t getMempoolDynamicUsage() = 0;
142 
144  virtual bool getHeaderTip(int& height, int64_t& block_time) = 0;
145 
147  virtual int getNumBlocks() = 0;
148 
150  virtual int64_t getLastBlockTime() = 0;
151 
153  virtual double getVerificationProgress() = 0;
154 
156  virtual bool isInitialBlockDownload() = 0;
157 
159  virtual bool getReindex() = 0;
160 
162  virtual bool getImporting() = 0;
163 
165  virtual void setNetworkActive(bool active) = 0;
166 
168  virtual bool getNetworkActive() = 0;
169 
171  virtual CFeeRate estimateSmartFee(int num_blocks, bool conservative, int* returned_target = nullptr) = 0;
172 
174  virtual CFeeRate getDustRelayFee() = 0;
175 
177  virtual UniValue executeRpc(const std::string& command, const UniValue& params, const std::string& uri) = 0;
178 
180  virtual std::vector<std::string> listRpcCommands() = 0;
181 
183  virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface* iface) = 0;
184 
186  virtual void rpcUnsetTimerInterface(RPCTimerInterface* iface) = 0;
187 
189  virtual bool getUnspentOutput(const COutPoint& output, Coin& coin) = 0;
190 
192  virtual std::string getWalletDir() = 0;
193 
195  virtual std::vector<std::string> listWalletDir() = 0;
196 
198  virtual std::vector<std::unique_ptr<Wallet>> getWallets() = 0;
199 
203  virtual std::unique_ptr<Wallet> loadWallet(const std::string& name, std::string& error, std::string& warning) = 0;
204 
206  virtual WalletCreationStatus createWallet(const SecureString& passphrase, uint64_t wallet_creation_flags, const std::string& name, std::string& error, std::string& warning, std::unique_ptr<Wallet>& result) = 0;
207 
209  using InitMessageFn = std::function<void(const std::string& message)>;
210  virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;
211 
213  using MessageBoxFn =
214  std::function<bool(const std::string& message, const std::string& caption, unsigned int style)>;
215  virtual std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) = 0;
216 
218  using QuestionFn = std::function<bool(const std::string& message,
219  const std::string& non_interactive_message,
220  const std::string& caption,
221  unsigned int style)>;
222  virtual std::unique_ptr<Handler> handleQuestion(QuestionFn fn) = 0;
223 
225  using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>;
226  virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;
227 
229  using LoadWalletFn = std::function<void(std::unique_ptr<Wallet> wallet)>;
230  virtual std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) = 0;
231 
233  using NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>;
234  virtual std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0;
235 
237  using NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>;
238  virtual std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0;
239 
241  using NotifyAlertChangedFn = std::function<void()>;
242  virtual std::unique_ptr<Handler> handleNotifyAlertChanged(NotifyAlertChangedFn fn) = 0;
243 
245  using BannedListChangedFn = std::function<void()>;
246  virtual std::unique_ptr<Handler> handleBannedListChanged(BannedListChangedFn fn) = 0;
247 
249  using NotifyBlockTipFn =
250  std::function<void(bool initial_download, int height, int64_t block_time, double verification_progress)>;
251  virtual std::unique_ptr<Handler> handleNotifyBlockTip(NotifyBlockTipFn fn) = 0;
252 
254  using NotifyHeaderTipFn =
255  std::function<void(bool initial_download, int height, int64_t block_time, double verification_progress)>;
256  virtual std::unique_ptr<Handler> handleNotifyHeaderTip(NotifyHeaderTipFn fn) = 0;
257 };
258 
260 std::unique_ptr<Node> MakeNode();
261 
262 } // namespace interfaces
263 
264 #endif // BITCOIN_INTERFACES_NODE_H
virtual std::unique_ptr< Handler > handleNotifyHeaderTip(NotifyHeaderTipFn fn)=0
std::vector< std::tuple< CNodeStats, bool, CNodeStateStats > > NodesStats
Get stats for connected nodes.
Definition: node.h:113
virtual bool appInitMain()=0
Start node.
std::function< bool(const std::string &message, const std::string &non_interactive_message, const std::string &caption, unsigned int style)> QuestionFn
Register handler for question messages.
Definition: node.h:221
virtual std::string getWarnings(const std::string &type)=0
Get warnings.
virtual void initError(const std::string &message)=0
Send init error.
RPC timer "driver".
Definition: server.h:58
virtual bool isInitialBlockDownload()=0
Is initial block download.
Definition: banman.h:37
virtual bool getNetworkActive()=0
Get network active.
BanReason
Definition: addrdb.h:19
virtual std::string getNetwork()=0
Get network name.
virtual void initLogging()=0
Init logging.
virtual void selectParams(const std::string &network)=0
Choose network parameters.
A UTXO entry.
Definition: coins.h:30
virtual double getVerificationProgress()=0
Get verification progress.
virtual size_t getMempoolDynamicUsage()=0
Get mempool dynamic usage.
virtual bool baseInitialize()=0
Initialize app dependencies.
virtual bool parseParameters(int argc, const char *const argv[], std::string &error)=0
Set command line arguments.
virtual bool getProxy(Network net, proxyType &proxy_info)=0
Get proxy.
virtual bool unban(const CSubNet &ip)=0
Unban node.
virtual void startShutdown()=0
Start shutdown.
virtual UniValue executeRpc(const std::string &command, const UniValue &params, const std::string &uri)=0
Execute rpc command.
virtual void rpcUnsetTimerInterface(RPCTimerInterface *iface)=0
Unset RPC timer interface.
virtual std::vector< std::string > listWalletDir()=0
Return available wallets in wallet directory.
virtual int64_t getTotalBytesRecv()=0
Get total bytes recv.
virtual bool getImporting()=0
Get importing.
std::function< void(bool network_active)> NotifyNetworkActiveChangedFn
Register handler for network active messages.
Definition: node.h:237
virtual size_t getMempoolSize()=0
Get mempool size.
virtual uint32_t getLogCategories()=0
std::basic_string< char, std::char_traits< char >, secure_allocator< char > > SecureString
Definition: secure.h:60
virtual std::vector< std::unique_ptr< Wallet > > getWallets()=0
Return interfaces for accessing wallets (if any).
WalletCreationStatus
Definition: wallet.h:53
virtual std::unique_ptr< Handler > handleNotifyBlockTip(NotifyBlockTipFn fn)=0
virtual CFeeRate getDustRelayFee()=0
Get dust relay fee.
Coin Control Features.
Definition: coincontrol.h:19
std::function< void(bool initial_download, int height, int64_t block_time, double verification_progress)> NotifyHeaderTipFn
Register handler for header tip messages.
Definition: node.h:255
virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface *iface)=0
Set RPC timer interface if unset.
virtual std::unique_ptr< Handler > handleMessageBox(MessageBoxFn fn)=0
std::function< void(bool initial_download, int height, int64_t block_time, double verification_progress)> NotifyBlockTipFn
Register handler for block tip messages.
Definition: node.h:250
virtual std::unique_ptr< Handler > handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn)=0
virtual uint64_t getAssumedBlockchainSize()=0
Get the (assumed) blockchain size.
std::map< CSubNet, CBanEntry > banmap_t
Definition: addrdb.h:82
std::function< void()> NotifyAlertChangedFn
Register handler for notify alert messages.
Definition: node.h:241
virtual uint64_t getAssumedChainStateSize()=0
Get the (assumed) chain state size.
virtual std::string getWalletDir()=0
Return default wallet directory.
const char * name
Definition: rest.cpp:39
virtual std::unique_ptr< Handler > handleShowProgress(ShowProgressFn fn)=0
virtual CFeeRate estimateSmartFee(int num_blocks, bool conservative, int *returned_target=nullptr)=0
Estimate smart fee.
virtual ~Node()
Definition: node.h:41
Network
Definition: netaddress.h:20
int64_t NodeId
Definition: net.h:93
NumConnections
Definition: net.h:125
virtual std::unique_ptr< Handler > handleBannedListChanged(BannedListChangedFn fn)=0
std::function< void(std::unique_ptr< Wallet > wallet)> LoadWalletFn
Register handler for load wallet messages.
Definition: node.h:229
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:18
virtual WalletCreationStatus createWallet(const SecureString &passphrase, uint64_t wallet_creation_flags, const std::string &name, std::string &error, std::string &warning, std::unique_ptr< Wallet > &result)=0
Create a wallet from file.
virtual bool shutdownRequested()=0
Return whether shutdown was requested.
std::function< void(const std::string &message)> InitMessageFn
Register handler for init messages.
Definition: node.h:209
std::function< void()> BannedListChangedFn
Register handler for ban list messages.
Definition: node.h:245
int flags
Definition: bitcoin-tx.cpp:509
virtual void initParameterInteraction()=0
Init parameter interaction.
virtual std::unique_ptr< Handler > handleLoadWallet(LoadWalletFn fn)=0
virtual bool ban(const CNetAddr &net_addr, BanReason reason, int64_t ban_time_offset)=0
Ban node.
std::function< void(int new_num_connections)> NotifyNumConnectionsChangedFn
Register handler for number of connections changed messages.
Definition: node.h:233
virtual bool readConfigFiles(std::string &error)=0
Load settings from configuration file.
IP address (IPv6, or IPv4 using mapped IPv6 range (::FFFF:0:0/96))
Definition: netaddress.h:32
virtual bool getReindex()=0
Get reindex.
virtual void setupServerArgs()=0
Setup arguments.
virtual int64_t getLastBlockTime()=0
Get last block time.
virtual void appShutdown()=0
Stop node.
virtual std::unique_ptr< Handler > handleQuestion(QuestionFn fn)=0
virtual void mapPort(bool use_upnp)=0
Map port.
std::unique_ptr< Node > MakeNode()
Return implementation of Node interface.
Definition: node.cpp:326
virtual void forceSetArg(const std::string &arg, const std::string &value)=0
Set a command line argument.
virtual std::vector< std::string > listRpcCommands()=0
List rpc commands.
std::function< bool(const std::string &message, const std::string &caption, unsigned int style)> MessageBoxFn
Register handler for message box messages.
Definition: node.h:214
virtual bool getHeaderTip(int &height, int64_t &block_time)=0
Get header tip height and time.
virtual bool getNodesStats(NodesStats &stats)=0
Fee rate in satoshis per kilobyte: CAmount / kB.
Definition: feerate.h:19
virtual bool getBanned(banmap_t &banmap)=0
Get ban map entries.
std::function< void(const std::string &title, int progress, bool resume_possible)> ShowProgressFn
Register handler for progress messages.
Definition: node.h:225
virtual int getNumBlocks()=0
Get num blocks.
virtual std::unique_ptr< Handler > handleNotifyAlertChanged(NotifyAlertChangedFn fn)=0
virtual bool disconnect(const CNetAddr &net_addr)=0
Disconnect node by address.
virtual std::unique_ptr< Wallet > loadWallet(const std::string &name, std::string &error, std::string &warning)=0
Attempts to load a wallet from file or directory.
virtual bool softSetArg(const std::string &arg, const std::string &value)=0
Set a command line argument if it doesn&#39;t already have a value.
virtual std::unique_ptr< Handler > handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn)=0
virtual int64_t getTotalBytesSent()=0
Get total bytes sent.
virtual void setNetworkActive(bool active)=0
Set network active.
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:38
bool error(const char *fmt, const Args &... args)
Definition: system.h:47
virtual size_t getNodeCount(CConnman::NumConnections flags)=0
Get number of connections.
virtual bool getUnspentOutput(const COutPoint &output, Coin &coin)=0
Get unspent outputs associated with a transaction.
virtual std::unique_ptr< Handler > handleInitMessage(InitMessageFn fn)=0
virtual bool softSetBoolArg(const std::string &arg, bool value)=0
Set a command line boolean argument if it doesn&#39;t already have a value.