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 server440 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.

11,634 bytes · SHA-256 5c8c29d224117df7… · View upstream ↗

1// Copyright (c) 2020-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_TEST_UTIL_NET_H
6#define BITCOIN_TEST_UTIL_NET_H
7
8#include <attributes.h>
9#include <compat/compat.h>
10#include <netmessagemaker.h>
11#include <net.h>
12#include <net_permissions.h>
13#include <net_processing.h>
14#include <netaddress.h>
15#include <node/connection_types.h>
16#include <node/eviction.h>
17#include <span.h>
18#include <sync.h>
19#include <util/sock.h>
20
21#include <algorithm>
22#include <array>
23#include <cassert>
24#include <chrono>
25#include <condition_variable>
26#include <cstdint>
27#include <cstring>
28#include <memory>
29#include <optional>
30#include <string>
31#include <unordered_map>
32#include <vector>
33
34class FastRandomContext;
35
36struct ConnmanTestMsg : public CConnman {
37    using CConnman::CConnman;
38
39    void SetMsgProc(NetEventsInterface* msgproc)
40    {
41        m_msgproc = msgproc;
42    }
43
44    void SetAddrman(AddrMan& in) { addrman = in; }
45
46    void SetPeerConnectTimeout(std::chrono::seconds timeout)
47    {
48        m_peer_connect_timeout = timeout;
49    }
50
51    void ResetAddrCache();
52    void ResetMaxOutboundCycle();
53    /// Reset the internal state.
54    void Reset();
55
56    std::vector<CNode*> TestNodes()
57    {
58        LOCK(m_nodes_mutex);
59        return m_nodes;
60    }
61
62    void AddTestNode(CNode& node)
63    {
64        LOCK(m_nodes_mutex);
65        m_nodes.push_back(&node);
66
67        if (node.IsManualOrFullOutboundConn()) ++m_network_conn_counts[node.addr.GetNetwork()];
68    }
69
70    void ClearTestNodes()
71    {
72        LOCK(m_nodes_mutex);
73        for (CNode* node : m_nodes) {
74            delete node;
75        }
76        m_nodes.clear();
77    }
78
79    void CreateNodeFromAcceptedSocketPublic(std::unique_ptr<Sock> sock,
80                                            NetPermissionFlags permissions,
81                                            const CAddress& addr_bind,
82                                            const CAddress& addr_peer)
83    {
84        CreateNodeFromAcceptedSocket(std::move(sock), permissions, addr_bind, addr_peer);
85    }
86
87    bool InitBindsPublic(const CConnman::Options& options)
88    {
89        return InitBinds(options);
90    }
91
92    void SocketHandlerPublic()
93    {
94        SocketHandler();
95    }
96
97    void Handshake(CNode& node,
98                   bool successfully_connected,
99                   ServiceFlags remote_services,
100                   ServiceFlags local_services,
101                   int32_t version,
102                   bool relay_txs)
103        EXCLUSIVE_LOCKS_REQUIRED(NetEventsInterface::g_msgproc_mutex);
104
105    bool ProcessMessagesOnce(CNode& node) EXCLUSIVE_LOCKS_REQUIRED(NetEventsInterface::g_msgproc_mutex)
106    {
107        return m_msgproc->ProcessMessages(node, flagInterruptMsgProc);
108    }
109
110    void NodeReceiveMsgBytes(CNode& node, std::span<const uint8_t> msg_bytes, bool& complete) const;
111
112    bool ReceiveMsgFrom(CNode& node, CSerializedNetMsg&& ser_msg) const;
113    void FlushSendBuffer(CNode& node) const;
114
115    bool AlreadyConnectedToAddressPublic(const CNetAddr& addr) { return AlreadyConnectedToAddress(addr); };
116
117    CNode* ConnectNodePublic(PeerManager& peerman, const char* pszDest, ConnectionType conn_type)
118        EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
119};
120
121inline constexpr ServiceFlags ALL_SERVICE_FLAGS[]{
122    NODE_NONE,
123    NODE_NETWORK,
124    NODE_BLOOM,
125    NODE_WITNESS,
126    NODE_COMPACT_FILTERS,
127    NODE_NETWORK_LIMITED,
128    NODE_P2P_V2,
129};
130
131inline constexpr NetPermissionFlags ALL_NET_PERMISSION_FLAGS[]{
132    NetPermissionFlags::None,
133    NetPermissionFlags::BloomFilter,
134    NetPermissionFlags::Relay,
135    NetPermissionFlags::ForceRelay,
136    NetPermissionFlags::NoBan,
137    NetPermissionFlags::Mempool,
138    NetPermissionFlags::Addr,
139    NetPermissionFlags::Download,
140    NetPermissionFlags::Implicit,
141    NetPermissionFlags::All,
142};
143
144inline constexpr ConnectionType ALL_CONNECTION_TYPES[]{
145    ConnectionType::INBOUND,
146    ConnectionType::OUTBOUND_FULL_RELAY,
147    ConnectionType::MANUAL,
148    ConnectionType::FEELER,
149    ConnectionType::BLOCK_RELAY,
150    ConnectionType::ADDR_FETCH,
151    ConnectionType::PRIVATE_BROADCAST,
152};
153
154inline constexpr auto ALL_NETWORKS = std::array{
155    Network::NET_UNROUTABLE,
156    Network::NET_IPV4,
157    Network::NET_IPV6,
158    Network::NET_ONION,
159    Network::NET_I2P,
160    Network::NET_CJDNS,
161    Network::NET_INTERNAL,
162};
163
164/**
165 * A mocked Sock alternative that succeeds on all operations.
166 * Returns infinite amount of 0x0 bytes on reads.
167 */
168class ZeroSock : public Sock
169{
170public:
171    ZeroSock();
172
173    ~ZeroSock() override;
174
175    ssize_t Send(const void*, size_t len, int) const override;
176
177    ssize_t Recv(void* buf, size_t len, int flags) const override;
178
179    int Connect(const sockaddr*, socklen_t) const override;
180
181    int Bind(const sockaddr*, socklen_t) const override;
182
183    int Listen(int) const override;
184
185    std::unique_ptr<Sock> Accept(sockaddr* addr, socklen_t* addr_len) const override;
186
187    int GetSockOpt(int level, int opt_name, void* opt_val, socklen_t* opt_len) const override;
188
189    int SetSockOpt(int, int, const void*, socklen_t) const override;
190
191    int GetSockName(sockaddr* name, socklen_t* name_len) const override;
192
193    bool SetNonBlocking() const override;
194
195    bool IsSelectable() const override;
196
197    bool Wait(std::chrono::milliseconds timeout,
198              Event requested,
199              Event* occurred = nullptr) const override;
200
201    bool WaitMany(std::chrono::milliseconds timeout, EventsPerSock& events_per_sock) const override;
202
203private:
204    ZeroSock& operator=(Sock&& other) override;
205};
206
207/**
208 * A mocked Sock alternative that returns a statically contained data upon read and succeeds
209 * and ignores all writes. The data to be returned is given to the constructor and when it is
210 * exhausted an EOF is returned by further reads.
211 */
212class StaticContentsSock : public ZeroSock
213{
214public:
215    explicit StaticContentsSock(const std::string& contents);
216
217    /**
218     * Return parts of the contents that was provided at construction until it is exhausted
219     * and then return 0 (EOF).
220     */
221    ssize_t Recv(void* buf, size_t len, int flags) const override;
222
223    bool IsConnected(std::string&) const override
224    {
225        return true;
226    }
227
228private:
229    StaticContentsSock& operator=(Sock&& other) override;
230
231    const std::string m_contents;
232    mutable size_t m_consumed{0};
233};
234
235/**
236 * A mocked Sock alternative that allows providing the data to be returned by Recv()
237 * and inspecting the data that has been supplied to Send().
238 */
239class DynSock : public ZeroSock
240{
241public:
242    /**
243     * Unidirectional bytes or CNetMessage queue (FIFO).
244     */
245    class Pipe
246    {
247    public:
248        /**
249         * Get bytes and remove them from the pipe.
250         * @param[in] buf Destination to write bytes to.

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

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.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.