READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server340 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

9,180 bytes · SHA-256 67433df37315c13d… · View upstream ↗

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 <net.h>
11#include <net_types.h>
12#include <netaddress.h>
13#include <netbase.h>
14#include <primitives/transaction.h>
15#include <uint256.h>
16#include <util/log.h>
17#include <util/translation.h>
18
19#include <cstddef>
20#include <cstdint>
21#include <functional>
22#include <map>
23#include <memory>
24#include <optional>
25#include <string>
26#include <tuple>
27#include <vector>
28
29class CFeeRate;
30class Coin;
31class UniValue;
32enum class SynchronizationState;
33struct CNodeStateStats;
34namespace node {
35enum class TransactionError;
36struct NodeContext;
37} // namespace node
38
39namespace interfaces {
40class Handler;
41class WalletLoader;
42struct BlockTip;
43
44//! Block and header tip information
45struct BlockAndHeaderTipInfo
46{
47    int block_height;
48    int64_t block_time;
49    int header_height;
50    int64_t header_time;
51    double verification_progress;
52};
53
54//! External signer interface used by the GUI.
55class ExternalSigner
56{
57public:
58    virtual ~ExternalSigner() = default;
59
60    //! Get signer display name
61    virtual std::string getName() = 0;
62};
63
64//! Top-level interface for a bitcoin node (bitcoind process).
65class Node
66{
67public:
68    virtual ~Node() = default;
69
70    //! Init logging.
71    virtual void initLogging() = 0;
72
73    //! Init parameter interaction.
74    virtual void initParameterInteraction() = 0;
75
76    //! Get warnings.
77    virtual bilingual_str getWarnings() = 0;
78
79    //! Get exit status.
80    virtual int getExitStatus() = 0;
81
82    // Get log flags.
83    virtual BCLog::CategoryMask getLogCategories() = 0;
84
85    //! Initialize app dependencies.
86    virtual bool baseInitialize() = 0;
87
88    //! Start node.
89    virtual bool appInitMain(interfaces::BlockAndHeaderTipInfo* tip_info = nullptr) = 0;
90
91    //! Stop node.
92    virtual void appShutdown() = 0;
93
94    //! Start shutdown.
95    virtual void startShutdown() = 0;
96
97    //! Return whether shutdown was requested.
98    virtual bool shutdownRequested() = 0;
99
100    //! Return whether a particular setting in <datadir>/settings.json is or
101    //! would be ignored because it is also specified in the command line.
102    virtual bool isSettingIgnored(const std::string& name) = 0;
103
104    //! Return setting value from <datadir>/settings.json or bitcoin.conf.
105    virtual common::SettingsValue getPersistentSetting(const std::string& name) = 0;
106
107    //! Update a setting in <datadir>/settings.json.
108    virtual void updateRwSetting(const std::string& name, const common::SettingsValue& value) = 0;
109
110    //! Force a setting value to be applied, overriding any other configuration
111    //! source, but not being persisted.
112    virtual void forceSetting(const std::string& name, const common::SettingsValue& value) = 0;
113
114    //! Clear all settings in <datadir>/settings.json and store a backup of
115    //! previous settings in <datadir>/settings.json.bak.
116    virtual void resetSettings() = 0;
117
118    //! Map port.
119    virtual void mapPort(bool enable) = 0;
120
121    //! Get proxy.
122    virtual std::optional<Proxy> getProxy(Network net) = 0;
123
124    //! Get number of connections.
125    virtual size_t getNodeCount(ConnectionDirection flags) = 0;
126
127    //! Get stats for connected nodes.
128    using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;
129    virtual bool getNodesStats(NodesStats& stats) = 0;
130
131    //! Get ban map entries.
132    virtual bool getBanned(banmap_t& banmap) = 0;
133
134    //! Ban node.
135    virtual bool ban(const CNetAddr& net_addr, int64_t ban_time_offset) = 0;
136
137    //! Unban node.
138    virtual bool unban(const CSubNet& ip) = 0;
139
140    //! Disconnect node by address.
141    virtual bool disconnectByAddress(const CNetAddr& net_addr) = 0;
142
143    //! Disconnect node by id.
144    virtual bool disconnectById(NodeId id) = 0;
145
146    //! Return list of external signers (attached devices which can sign transactions).
147    virtual std::vector<std::unique_ptr<ExternalSigner>> listExternalSigners() = 0;
148
149    //! Get total bytes recv.
150    virtual int64_t getTotalBytesRecv() = 0;
151
152    //! Get total bytes sent.
153    virtual int64_t getTotalBytesSent() = 0;
154
155    //! Get mempool size.
156    virtual size_t getMempoolSize() = 0;
157
158    //! Get mempool dynamic usage.
159    virtual size_t getMempoolDynamicUsage() = 0;
160
161    //! Get mempool maximum memory usage.
162    virtual size_t getMempoolMaxUsage() = 0;
163
164    //! Get header tip height and time.
165    virtual bool getHeaderTip(int& height, int64_t& block_time) = 0;
166
167    //! Get num blocks.
168    virtual int getNumBlocks() = 0;
169
170    //! Get network local addresses.
171    virtual std::map<CNetAddr, LocalServiceInfo> getNetLocalAddresses() = 0;
172
173    //! Get best block hash.
174    virtual uint256 getBestBlockHash() = 0;
175
176    //! Get last block time.
177    virtual int64_t getLastBlockTime() = 0;
178
179    //! Get verification progress.
180    virtual double getVerificationProgress() = 0;
181
182    //! Is initial block download.
183    virtual bool isInitialBlockDownload() = 0;
184
185    //! Is loading blocks.
186    virtual bool isLoadingBlocks() = 0;
187
188    //! Set network active.
189    virtual void setNetworkActive(bool active) = 0;
190
191    //! Get network active.
192    virtual bool getNetworkActive() = 0;
193
194    //! Get dust relay fee.
195    virtual CFeeRate getDustRelayFee() = 0;
196
197    //! Execute rpc command.
198    virtual UniValue executeRpc(const std::string& command, const UniValue& params, const std::string& uri) = 0;
199
200    //! List rpc commands.
201    virtual std::vector<std::string> listRpcCommands() = 0;
202
203    //! Get unspent output associated with a transaction.
204    virtual std::optional<Coin> getUnspentOutput(const COutPoint& output) = 0;
205
206    //! Broadcast transaction.
207    virtual node::TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string& err_string) = 0;
208
209    //! Get wallet loader.
210    virtual WalletLoader& walletLoader() = 0;
211
212    //! Register handler for init messages.
213    using InitMessageFn = std::function<void(const std::string& message)>;
214    virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;
215
216    //! Register handler for message box messages.
217    using MessageBoxFn = std::function<void(const bilingual_str& message, unsigned int style)>;
218    virtual std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) = 0;
219
220    //! Register handler for question messages.
221    using QuestionFn = std::function<bool(const bilingual_str& message,
222        const std::string& non_interactive_message,
223        unsigned int style)>;
224    virtual std::unique_ptr<Handler> handleQuestion(QuestionFn fn) = 0;
225
226    //! Register handler for progress messages.
227    using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>;
228    virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;
229
230    //! Register handler for wallet loader constructed messages.
231    using InitWalletFn = std::function<void()>;
232    virtual std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) = 0;
233
234    //! Register handler for number of connections changed messages.
235    using NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>;
236    virtual std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0;
237
238    //! Register handler for network active messages.
239    using NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>;
240    virtual std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0;
241
242    //! Register handler for notify alert messages.
243    using NotifyAlertChangedFn = std::function<void()>;
244    virtual std::unique_ptr<Handler> handleNotifyAlertChanged(NotifyAlertChangedFn fn) = 0;
245
246    //! Register handler for ban list messages.
247    using BannedListChangedFn = std::function<void()>;
248    virtual std::unique_ptr<Handler> handleBannedListChanged(BannedListChangedFn fn) = 0;
249
250    //! Register handler for block tip messages.

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.