Bitcoin Core 29.99.0
P2P Digital Currency
node.h
Go to the documentation of this file.
1// Copyright (c) 2018-present 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 <common/settings.h>
9#include <consensus/amount.h>
10#include <logging.h>
11#include <net.h>
12#include <net_types.h>
13#include <netaddress.h>
14#include <netbase.h>
16#include <util/translation.h>
17
18#include <cstddef>
19#include <cstdint>
20#include <functional>
21#include <memory>
22#include <string>
23#include <tuple>
24#include <vector>
25
26class BanMan;
27class CFeeRate;
28class CNodeStats;
29class Coin;
30class UniValue;
31class Proxy;
32enum class SynchronizationState;
33struct CNodeStateStats;
34struct bilingual_str;
35namespace node {
36enum class TransactionError;
37struct NodeContext;
38} // namespace node
39namespace wallet {
40class CCoinControl;
41} // namespace wallet
42
43namespace interfaces {
44class Handler;
45class WalletLoader;
46struct BlockTip;
47
50{
52 int64_t block_time;
54 int64_t header_time;
56};
57
60{
61public:
62 virtual ~ExternalSigner() = default;
63
65 virtual std::string getName() = 0;
66};
67
69class Node
70{
71public:
72 virtual ~Node() = default;
73
75 virtual void initLogging() = 0;
76
78 virtual void initParameterInteraction() = 0;
79
82
84 virtual int getExitStatus() = 0;
85
86 // Get log flags.
88
90 virtual bool baseInitialize() = 0;
91
93 virtual bool appInitMain(interfaces::BlockAndHeaderTipInfo* tip_info = nullptr) = 0;
94
96 virtual void appShutdown() = 0;
97
99 virtual void startShutdown() = 0;
100
102 virtual bool shutdownRequested() = 0;
103
106 virtual bool isSettingIgnored(const std::string& name) = 0;
107
109 virtual common::SettingsValue getPersistentSetting(const std::string& name) = 0;
110
112 virtual void updateRwSetting(const std::string& name, const common::SettingsValue& value) = 0;
113
116 virtual void forceSetting(const std::string& name, const common::SettingsValue& value) = 0;
117
120 virtual void resetSettings() = 0;
121
123 virtual void mapPort(bool enable) = 0;
124
126 virtual bool getProxy(Network net, Proxy& proxy_info) = 0;
127
130
132 using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;
133 virtual bool getNodesStats(NodesStats& stats) = 0;
134
136 virtual bool getBanned(banmap_t& banmap) = 0;
137
139 virtual bool ban(const CNetAddr& net_addr, int64_t ban_time_offset) = 0;
140
142 virtual bool unban(const CSubNet& ip) = 0;
143
145 virtual bool disconnectByAddress(const CNetAddr& net_addr) = 0;
146
148 virtual bool disconnectById(NodeId id) = 0;
149
151 virtual std::vector<std::unique_ptr<ExternalSigner>> listExternalSigners() = 0;
152
154 virtual int64_t getTotalBytesRecv() = 0;
155
157 virtual int64_t getTotalBytesSent() = 0;
158
160 virtual size_t getMempoolSize() = 0;
161
163 virtual size_t getMempoolDynamicUsage() = 0;
164
166 virtual size_t getMempoolMaxUsage() = 0;
167
169 virtual bool getHeaderTip(int& height, int64_t& block_time) = 0;
170
172 virtual int getNumBlocks() = 0;
173
175 virtual std::map<CNetAddr, LocalServiceInfo> getNetLocalAddresses() = 0;
176
179
181 virtual int64_t getLastBlockTime() = 0;
182
184 virtual double getVerificationProgress() = 0;
185
187 virtual bool isInitialBlockDownload() = 0;
188
190 virtual bool isLoadingBlocks() = 0;
191
193 virtual void setNetworkActive(bool active) = 0;
194
196 virtual bool getNetworkActive() = 0;
197
200
202 virtual UniValue executeRpc(const std::string& command, const UniValue& params, const std::string& uri) = 0;
203
205 virtual std::vector<std::string> listRpcCommands() = 0;
206
208 virtual std::optional<Coin> getUnspentOutput(const COutPoint& output) = 0;
209
211 virtual node::TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string& err_string) = 0;
212
215
217 using InitMessageFn = std::function<void(const std::string& message)>;
218 virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;
219
222 std::function<bool(const bilingual_str& message, const std::string& caption, unsigned int style)>;
223 virtual std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) = 0;
224
226 using QuestionFn = std::function<bool(const bilingual_str& message,
227 const std::string& non_interactive_message,
228 const std::string& caption,
229 unsigned int style)>;
230 virtual std::unique_ptr<Handler> handleQuestion(QuestionFn fn) = 0;
231
233 using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>;
234 virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;
235
237 using InitWalletFn = std::function<void()>;
238 virtual std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) = 0;
239
241 using NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>;
242 virtual std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0;
243
245 using NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>;
246 virtual std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0;
247
249 using NotifyAlertChangedFn = std::function<void()>;
250 virtual std::unique_ptr<Handler> handleNotifyAlertChanged(NotifyAlertChangedFn fn) = 0;
251
253 using BannedListChangedFn = std::function<void()>;
254 virtual std::unique_ptr<Handler> handleBannedListChanged(BannedListChangedFn fn) = 0;
255
258 std::function<void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)>;
259 virtual std::unique_ptr<Handler> handleNotifyBlockTip(NotifyBlockTipFn fn) = 0;
260
263 std::function<void(SynchronizationState, interfaces::BlockTip tip, bool presync)>;
264 virtual std::unique_ptr<Handler> handleNotifyHeaderTip(NotifyHeaderTipFn fn) = 0;
265
268 virtual node::NodeContext* context() { return nullptr; }
270};
271
273std::unique_ptr<Node> MakeNode(node::NodeContext& context);
274
276struct BlockTip {
278 int64_t block_time;
280};
281
282} // namespace interfaces
283
284#endif // BITCOIN_INTERFACES_NODE_H
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
int flags
Definition: bitcoin-tx.cpp:529
const auto command
Definition: banman.h:64
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:35
Network address.
Definition: netaddress.h:112
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
A UTXO entry.
Definition: coins.h:33
Definition: netbase.h:59
External signer interface used by the GUI.
Definition: node.h:60
virtual std::string getName()=0
Get signer display name.
virtual ~ExternalSigner()=default
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:70
std::function< void()> BannedListChangedFn
Register handler for ban list messages.
Definition: node.h:253
virtual void mapPort(bool enable)=0
Map port.
virtual void updateRwSetting(const std::string &name, const common::SettingsValue &value)=0
Update a setting in <datadir>/settings.json.
virtual std::map< CNetAddr, LocalServiceInfo > getNetLocalAddresses()=0
Get network local addresses.
virtual std::optional< Coin > getUnspentOutput(const COutPoint &output)=0
Get unspent output associated with a transaction.
virtual common::SettingsValue getPersistentSetting(const std::string &name)=0
Return setting value from <datadir>/settings.json or bitcoin.conf.
virtual bool disconnectById(NodeId id)=0
Disconnect node by id.
virtual bool baseInitialize()=0
Initialize app dependencies.
std::function< void(SynchronizationState, interfaces::BlockTip tip, bool presync)> NotifyHeaderTipFn
Register handler for header tip messages.
Definition: node.h:263
virtual std::unique_ptr< Handler > handleInitMessage(InitMessageFn fn)=0
virtual bool ban(const CNetAddr &net_addr, int64_t ban_time_offset)=0
Ban node.
std::function< void(bool network_active)> NotifyNetworkActiveChangedFn
Register handler for network active messages.
Definition: node.h:245
virtual std::unique_ptr< Handler > handleShowProgress(ShowProgressFn fn)=0
virtual void setNetworkActive(bool active)=0
Set network active.
virtual bilingual_str getWarnings()=0
Get warnings.
virtual size_t getMempoolMaxUsage()=0
Get mempool maximum memory usage.
virtual std::vector< std::string > listRpcCommands()=0
List rpc commands.
virtual void appShutdown()=0
Stop node.
virtual node::TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string &err_string)=0
Broadcast transaction.
std::function< void(const std::string &message)> InitMessageFn
Register handler for init messages.
Definition: node.h:217
std::function< bool(const bilingual_str &message, const std::string &non_interactive_message, const std::string &caption, unsigned int style)> QuestionFn
Register handler for question messages.
Definition: node.h:229
std::function< bool(const bilingual_str &message, const std::string &caption, unsigned int style)> MessageBoxFn
Register handler for message box messages.
Definition: node.h:222
virtual std::unique_ptr< Handler > handleNotifyBlockTip(NotifyBlockTipFn fn)=0
virtual void resetSettings()=0
Clear all settings in <datadir>/settings.json and store a backup of previous settings in <datadir>/se...
std::function< void()> InitWalletFn
Register handler for wallet loader constructed messages.
Definition: node.h:237
virtual std::unique_ptr< Handler > handleNotifyAlertChanged(NotifyAlertChangedFn fn)=0
virtual std::unique_ptr< Handler > handleNotifyHeaderTip(NotifyHeaderTipFn fn)=0
virtual std::unique_ptr< Handler > handleMessageBox(MessageBoxFn fn)=0
std::vector< std::tuple< CNodeStats, bool, CNodeStateStats > > NodesStats
Get stats for connected nodes.
Definition: node.h:132
virtual UniValue executeRpc(const std::string &command, const UniValue &params, const std::string &uri)=0
Execute rpc command.
virtual bool isSettingIgnored(const std::string &name)=0
Return whether a particular setting in <datadir>/settings.json is or would be ignored because it is a...
virtual void initParameterInteraction()=0
Init parameter interaction.
virtual void startShutdown()=0
Start shutdown.
std::function< void()> NotifyAlertChangedFn
Register handler for notify alert messages.
Definition: node.h:249
virtual int64_t getLastBlockTime()=0
Get last block time.
virtual bool getBanned(banmap_t &banmap)=0
Get ban map entries.
virtual std::unique_ptr< Handler > handleInitWallet(InitWalletFn fn)=0
virtual BCLog::CategoryMask getLogCategories()=0
virtual size_t getMempoolSize()=0
Get mempool size.
virtual bool getNetworkActive()=0
Get network active.
virtual bool unban(const CSubNet &ip)=0
Unban node.
virtual bool isLoadingBlocks()=0
Is loading blocks.
virtual bool appInitMain(interfaces::BlockAndHeaderTipInfo *tip_info=nullptr)=0
Start node.
virtual std::unique_ptr< Handler > handleQuestion(QuestionFn fn)=0
virtual size_t getNodeCount(ConnectionDirection flags)=0
Get number of connections.
virtual void forceSetting(const std::string &name, const common::SettingsValue &value)=0
Force a setting value to be applied, overriding any other configuration source, but not being persist...
virtual double getVerificationProgress()=0
Get verification progress.
virtual bool getHeaderTip(int &height, int64_t &block_time)=0
Get header tip height and time.
virtual uint256 getBestBlockHash()=0
Get best block hash.
virtual bool disconnectByAddress(const CNetAddr &net_addr)=0
Disconnect node by address.
virtual int64_t getTotalBytesRecv()=0
Get total bytes recv.
virtual std::unique_ptr< Handler > handleBannedListChanged(BannedListChangedFn fn)=0
std::function< void(const std::string &title, int progress, bool resume_possible)> ShowProgressFn
Register handler for progress messages.
Definition: node.h:233
virtual WalletLoader & walletLoader()=0
Get wallet loader.
virtual void initLogging()=0
Init logging.
virtual std::unique_ptr< Handler > handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn)=0
virtual int64_t getTotalBytesSent()=0
Get total bytes sent.
virtual ~Node()=default
virtual node::NodeContext * context()
Get and set internal node context.
Definition: node.h:268
virtual size_t getMempoolDynamicUsage()=0
Get mempool dynamic usage.
virtual bool getProxy(Network net, Proxy &proxy_info)=0
Get proxy.
virtual int getNumBlocks()=0
Get num blocks.
virtual bool shutdownRequested()=0
Return whether shutdown was requested.
virtual bool getNodesStats(NodesStats &stats)=0
virtual bool isInitialBlockDownload()=0
Is initial block download.
std::function< void(int new_num_connections)> NotifyNumConnectionsChangedFn
Register handler for number of connections changed messages.
Definition: node.h:241
virtual std::unique_ptr< Handler > handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn)=0
virtual int getExitStatus()=0
Get exit status.
virtual CFeeRate getDustRelayFee()=0
Get dust relay fee.
virtual void setContext(node::NodeContext *context)
Definition: node.h:269
std::function< void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)> NotifyBlockTipFn
Register handler for block tip messages.
Definition: node.h:258
virtual std::vector< std::unique_ptr< ExternalSigner > > listExternalSigners()=0
Return list of external signers (attached devices which can sign transactions).
Wallet chain client that in addition to having chain client methods for starting up,...
Definition: wallet.h:316
256-bit opaque blob.
Definition: uint256.h:196
static CService ip(uint32_t i)
uint64_t CategoryMask
Definition: logging.h:63
std::unique_ptr< Node > MakeNode(node::NodeContext &context)
Return implementation of Node interface.
Definition: interfaces.cpp:988
Definition: messages.h:20
TransactionError
Definition: types.h:24
int64_t NodeId
Definition: net.h:98
std::map< CSubNet, CBanEntry > banmap_t
Definition: net_types.h:41
Network
A network type.
Definition: netaddress.h:32
ConnectionDirection
Definition: netbase.h:33
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
const char * name
Definition: rest.cpp:50
Bilingual messages:
Definition: translation.h:24
Block and header tip information.
Definition: node.h:50
Block tip (could be a header or not, depends on the subscribed signal).
Definition: node.h:276
uint256 block_hash
Definition: node.h:279
int64_t block_time
Definition: node.h:278
NodeContext struct containing references to chain state and connection state.
Definition: context.h:56
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:88