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.

13,450 bytes · SHA-256 cef54a9946427756… · View upstream ↗

1// Copyright (c) 2009-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_NETBASE_H
6#define BITCOIN_NETBASE_H
7
8#include <compat/compat.h>
9#include <netaddress.h>
10#include <serialize.h>
11#include <util/sock.h>
12#include <util/threadinterrupt.h>
13
14#include <chrono>
15#include <cstdint>
16#include <functional>
17#include <memory>
18#include <optional>
19#include <string>
20#include <type_traits>
21#include <unordered_set>
22#include <vector>
23
24extern int nConnectTimeout;
25extern bool fNameLookup;
26
27//! -timeout default
28inline constexpr int DEFAULT_CONNECT_TIMEOUT = 5000;
29//! -dns default
30inline constexpr int DEFAULT_NAME_LOOKUP = true;
31
32/** Prefix for unix domain socket addresses (which are local filesystem paths) */
33inline const std::string ADDR_PREFIX_UNIX = "unix:";
34
35enum class ConnectionDirection {
36    None = 0,
37    In = (1U << 0),
38    Out = (1U << 1),
39    Both = (In | Out),
40};
41static inline ConnectionDirection& operator|=(ConnectionDirection& a, ConnectionDirection b) {
42    using underlying = std::underlying_type_t<ConnectionDirection>;
43    a = ConnectionDirection(underlying(a) | underlying(b));
44    return a;
45}
46static inline bool operator&(ConnectionDirection a, ConnectionDirection b) {
47    using underlying = std::underlying_type_t<ConnectionDirection>;
48    return (underlying(a) & underlying(b));
49}
50
51/**
52 * Check if a string is a valid UNIX domain socket path
53 *
54 * @param      name     The string provided by the user representing a local path
55 *
56 * @returns Whether the string has proper format, length, and points to an existing file path
57 */
58bool IsUnixSocketPath(const std::string& name);
59
60class Proxy
61{
62public:
63    Proxy() : m_is_unix_socket(false), m_tor_stream_isolation(false) {}
64    explicit Proxy(const CService& _proxy, bool tor_stream_isolation = false) : proxy(_proxy), m_is_unix_socket(false), m_tor_stream_isolation(tor_stream_isolation) {}
65    explicit Proxy(std::string path, bool tor_stream_isolation = false)
66        : m_unix_socket_path(std::move(path)), m_is_unix_socket(true), m_tor_stream_isolation(tor_stream_isolation) {}
67
68    CService proxy;
69    std::string m_unix_socket_path;
70    bool m_is_unix_socket;
71    bool m_tor_stream_isolation;
72
73    bool IsValid() const
74    {
75        if (m_is_unix_socket) return IsUnixSocketPath(m_unix_socket_path);
76        return proxy.IsValid();
77    }
78
79    sa_family_t GetFamily() const
80    {
81        if (m_is_unix_socket) return AF_UNIX;
82        return proxy.GetSAFamily();
83    }
84
85    std::string ToString() const
86    {
87        if (m_is_unix_socket) return m_unix_socket_path;
88        return proxy.ToStringAddrPort();
89    }
90
91    std::unique_ptr<Sock> Connect() const;
92};
93
94/** Credentials for proxy authentication */
95struct ProxyCredentials
96{
97    std::string username;
98    std::string password;
99};
100
101/**
102 * List of reachable networks. Everything is reachable by default.
103 */
104class ReachableNets {
105public:
106    void Add(Network net) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
107    {
108        AssertLockNotHeld(m_mutex);
109        LOCK(m_mutex);
110        m_reachable.insert(net);
111    }
112
113    void Remove(Network net) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
114    {
115        AssertLockNotHeld(m_mutex);
116        LOCK(m_mutex);
117        m_reachable.erase(net);
118    }
119
120    void RemoveAll() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
121    {
122        AssertLockNotHeld(m_mutex);
123        LOCK(m_mutex);
124        m_reachable.clear();
125    }
126
127    void Reset() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
128    {
129        AssertLockNotHeld(m_mutex);
130        LOCK(m_mutex);
131        m_reachable = DefaultNets();
132    }
133
134    [[nodiscard]] bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
135    {
136        AssertLockNotHeld(m_mutex);
137        LOCK(m_mutex);
138        return m_reachable.contains(net);
139    }
140
141    [[nodiscard]] bool Contains(const CNetAddr& addr) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
142    {
143        AssertLockNotHeld(m_mutex);
144        return Contains(addr.GetNetwork());
145    }
146
147    [[nodiscard]] std::unordered_set<Network> All() const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
148    {
149        AssertLockNotHeld(m_mutex);
150        LOCK(m_mutex);
151        return m_reachable;
152    }
153
154private:
155    static std::unordered_set<Network> DefaultNets()
156    {
157        return {
158            NET_UNROUTABLE,
159            NET_IPV4,
160            NET_IPV6,
161            NET_ONION,
162            NET_I2P,
163            NET_CJDNS,
164            NET_INTERNAL
165        };
166    };
167
168    mutable Mutex m_mutex;
169    std::unordered_set<Network> m_reachable GUARDED_BY(m_mutex){DefaultNets()};
170};
171
172extern ReachableNets g_reachable_nets;
173
174/**
175 * Wrapper for getaddrinfo(3). Do not use directly: call Lookup/LookupHost/LookupNumeric/LookupSubNet.
176 */
177std::vector<CNetAddr> WrappedGetAddrInfo(const std::string& name, bool allow_lookup);
178
179enum Network ParseNetwork(const std::string& net);
180std::string GetNetworkName(enum Network net);
181/** Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE. */
182std::vector<std::string> GetNetworkNames(bool append_unroutable = false);
183bool SetProxy(enum Network net, const Proxy &addrProxy);
184std::optional<Proxy> GetProxy(enum Network net);
185bool IsProxy(const CNetAddr &addr);
186/**
187 * Set the name proxy to use for all connections to nodes specified by a
188 * hostname. After setting this proxy, connecting to a node specified by a
189 * hostname won't result in a local lookup of said hostname, rather, connect to
190 * the node by asking the name proxy for a proxy connection to the hostname,
191 * effectively delegating the hostname lookup to the specified proxy.
192 *
193 * This delegation increases privacy for those who set the name proxy as they no
194 * longer leak their external hostname queries to their DNS servers.
195 *
196 * @returns Whether or not the operation succeeded.
197 *
198 * @note SOCKS5's support for UDP-over-SOCKS5 has been considered, but no SOCK5
199 *       server in common use (most notably Tor) actually implements UDP
200 *       support, and a DNS resolver is beyond the scope of this project.
201 */
202bool SetNameProxy(const Proxy &addrProxy);
203bool HaveNameProxy();
204std::optional<Proxy> GetNameProxy();
205
206using DNSLookupFn = std::function<std::vector<CNetAddr>(const std::string&, bool)>;
207extern DNSLookupFn g_dns_lookup;
208
209/**
210 * Resolve a host string to its corresponding network addresses.
211 *
212 * @param name    The string representing a host. Could be a name or a numerical
213 *                IP address (IPv6 addresses in their bracketed form are
214 *                allowed).
215 *
216 * @returns The resulting network addresses to which the specified host
217 *          string resolved.
218 *
219 * @see Lookup(const std::string&, uint16_t, bool, unsigned int, DNSLookupFn)
220 *      for additional parameter descriptions.
221 */
222std::vector<CNetAddr> LookupHost(const std::string& name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function = g_dns_lookup);
223
224/**
225 * Resolve a host string to its first corresponding network address.
226 *
227 * @returns The resulting network address to which the specified host
228 *          string resolved or std::nullopt if host does not resolve to an address.
229 *
230 * @see LookupHost(const std::string&, unsigned int, bool, DNSLookupFn)
231 *      for additional parameter descriptions.
232 */
233std::optional<CNetAddr> LookupHost(const std::string& name, bool fAllowLookup, DNSLookupFn dns_lookup_function = g_dns_lookup);
234
235/**
236 * Resolve a service string to its corresponding service.
237 *
238 * @param name    The string representing a service. Could be a name or a
239 *                numerical IP address (IPv6 addresses should be in their
240 *                disambiguated bracketed form), optionally followed by a uint16_t port
241 *                number. (e.g. example.com:8333 or
242 *                [2001:db8:85a3:8d3:1319:8a2e:370:7348]:420)
243 * @param portDefault The default port for resulting services if not specified
244 *                    by the service string.
245 * @param fAllowLookup Whether or not hostname lookups are permitted. If yes,
246 *                     external queries may be performed.
247 * @param nMaxSolutions The maximum number of results we want, specifying 0
248 *                      means "as many solutions as we get."
249 *
250 * @returns The resulting services to which the specified service string

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.