Bitcoin Core  0.18.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 
13 #include <functional>
14 #include <memory>
15 #include <stddef.h>
16 #include <stdint.h>
17 #include <string>
18 #include <tuple>
19 #include <vector>
20 
21 class BanMan;
22 class CCoinControl;
23 class CFeeRate;
24 class CNodeStats;
25 class Coin;
26 class RPCTimerInterface;
27 class UniValue;
28 class proxyType;
29 struct CNodeStateStats;
30 
31 namespace interfaces {
32 class Handler;
33 class Wallet;
34 
36 class Node
37 {
38 public:
39  virtual ~Node() {}
40 
42  virtual bool parseParameters(int argc, const char* const argv[], std::string& error) = 0;
43 
45  virtual bool softSetArg(const std::string& arg, const std::string& value) = 0;
46 
48  virtual bool softSetBoolArg(const std::string& arg, bool value) = 0;
49 
51  virtual bool readConfigFiles(std::string& error) = 0;
52 
54  virtual void selectParams(const std::string& network) = 0;
55 
57  virtual uint64_t getAssumedBlockchainSize() = 0;
58 
60  virtual uint64_t getAssumedChainStateSize() = 0;
61 
63  virtual std::string getNetwork() = 0;
64 
66  virtual void initLogging() = 0;
67 
69  virtual void initParameterInteraction() = 0;
70 
72  virtual std::string getWarnings(const std::string& type) = 0;
73 
74  // Get log flags.
75  virtual uint32_t getLogCategories() = 0;
76 
78  virtual bool baseInitialize() = 0;
79 
81  virtual bool appInitMain() = 0;
82 
84  virtual void appShutdown() = 0;
85 
87  virtual void startShutdown() = 0;
88 
90  virtual bool shutdownRequested() = 0;
91 
93  virtual void setupServerArgs() = 0;
94 
96  virtual void mapPort(bool use_upnp) = 0;
97 
99  virtual bool getProxy(Network net, proxyType& proxy_info) = 0;
100 
102  virtual size_t getNodeCount(CConnman::NumConnections flags) = 0;
103 
105  using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;
106  virtual bool getNodesStats(NodesStats& stats) = 0;
107 
109  virtual bool getBanned(banmap_t& banmap) = 0;
110 
112  virtual bool ban(const CNetAddr& net_addr, BanReason reason, int64_t ban_time_offset) = 0;
113 
115  virtual bool unban(const CSubNet& ip) = 0;
116 
118  virtual bool disconnect(const CNetAddr& net_addr) = 0;
119 
121  virtual bool disconnect(NodeId id) = 0;
122 
124  virtual int64_t getTotalBytesRecv() = 0;
125 
127  virtual int64_t getTotalBytesSent() = 0;
128 
130  virtual size_t getMempoolSize() = 0;
131 
133  virtual size_t getMempoolDynamicUsage() = 0;
134 
136  virtual bool getHeaderTip(int& height, int64_t& block_time) = 0;
137 
139  virtual int getNumBlocks() = 0;
140 
142  virtual int64_t getLastBlockTime() = 0;
143 
145  virtual double getVerificationProgress() = 0;
146 
148  virtual bool isInitialBlockDownload() = 0;
149 
151  virtual bool getReindex() = 0;
152 
154  virtual bool getImporting() = 0;
155 
157  virtual void setNetworkActive(bool active) = 0;
158 
160  virtual bool getNetworkActive() = 0;
161 
163  virtual CFeeRate estimateSmartFee(int num_blocks, bool conservative, int* returned_target = nullptr) = 0;
164 
166  virtual CFeeRate getDustRelayFee() = 0;
167 
169  virtual UniValue executeRpc(const std::string& command, const UniValue& params, const std::string& uri) = 0;
170 
172  virtual std::vector<std::string> listRpcCommands() = 0;
173 
175  virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface* iface) = 0;
176 
178  virtual void rpcUnsetTimerInterface(RPCTimerInterface* iface) = 0;
179 
181  virtual bool getUnspentOutput(const COutPoint& output, Coin& coin) = 0;
182 
184  virtual std::string getWalletDir() = 0;
185 
187  virtual std::vector<std::string> listWalletDir() = 0;
188 
190  virtual std::vector<std::unique_ptr<Wallet>> getWallets() = 0;
191 
195  virtual std::unique_ptr<Wallet> loadWallet(const std::string& name, std::string& error, std::string& warning) = 0;
196 
198  using InitMessageFn = std::function<void(const std::string& message)>;
199  virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;
200 
202  using MessageBoxFn =
203  std::function<bool(const std::string& message, const std::string& caption, unsigned int style)>;
204  virtual std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) = 0;
205 
207  using QuestionFn = std::function<bool(const std::string& message,
208  const std::string& non_interactive_message,
209  const std::string& caption,
210  unsigned int style)>;
211  virtual std::unique_ptr<Handler> handleQuestion(QuestionFn fn) = 0;
212 
214  using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>;
215  virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;
216 
218  using LoadWalletFn = std::function<void(std::unique_ptr<Wallet> wallet)>;
219  virtual std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) = 0;
220 
222  using NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>;
223  virtual std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0;
224 
226  using NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>;
227  virtual std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0;
228 
230  using NotifyAlertChangedFn = std::function<void()>;
231  virtual std::unique_ptr<Handler> handleNotifyAlertChanged(NotifyAlertChangedFn fn) = 0;
232 
234  using BannedListChangedFn = std::function<void()>;
235  virtual std::unique_ptr<Handler> handleBannedListChanged(BannedListChangedFn fn) = 0;
236 
238  using NotifyBlockTipFn =
239  std::function<void(bool initial_download, int height, int64_t block_time, double verification_progress)>;
240  virtual std::unique_ptr<Handler> handleNotifyBlockTip(NotifyBlockTipFn fn) = 0;
241 
243  using NotifyHeaderTipFn =
244  std::function<void(bool initial_download, int height, int64_t block_time, double verification_progress)>;
245  virtual std::unique_ptr<Handler> handleNotifyHeaderTip(NotifyHeaderTipFn fn) = 0;
246 };
247 
249 std::unique_ptr<Node> MakeNode();
250 
251 } // namespace interfaces
252 
253 #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:105
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:210
virtual std::string getWarnings(const std::string &type)=0
Get warnings.
RPC timer "driver".
Definition: server.h:72
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:29
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:226
virtual size_t getMempoolSize()=0
Get mempool size.
virtual uint32_t getLogCategories()=0
virtual std::vector< std::unique_ptr< Wallet > > getWallets()=0
Return interfaces for accessing wallets (if any).
virtual std::unique_ptr< Handler > handleNotifyBlockTip(NotifyBlockTipFn fn)=0
virtual CFeeRate getDustRelayFee()=0
Get dust relay fee.
Coin Control Features.
Definition: coincontrol.h:16
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:244
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:239
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:230
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:38
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:39
Network
Definition: netaddress.h:20
int64_t NodeId
Definition: net.h:85
NumConnections
Definition: net.h:117
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:218
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:18
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:198
std::function< void()> BannedListChangedFn
Register handler for ban list messages.
Definition: node.h:234
int flags
Definition: bitcoin-tx.cpp:507
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:222
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:316
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:203
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:214
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:36
bool error(const char *fmt, const Args &... args)
Definition: system.h:61
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.