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.

42,670 bytes · SHA-256 8f5da7b6d11a5fea… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2010 ArtForz -- public domain half-a-node
3# Copyright (c) 2012 Jeff Garzik
4# Copyright (c) 2010-present The Bitcoin Core developers
5# Distributed under the MIT software license, see the accompanying
6# file COPYING or http://www.opensource.org/licenses/mit-license.php.
7"""Test objects for interacting with a bitcoind node over the p2p protocol.
8
9The P2PInterface objects interact with the bitcoind nodes under test using the
10node's p2p interface. They can be used to send messages to the node, and
11callbacks can be registered that execute when messages are received from the
12node. Messages are sent to/received from the node on an asyncio event loop.
13State held inside the objects must be guarded by the p2p_lock to avoid data
14races between the main testing thread and the event loop.
15
16P2PConnection: A low-level connection object to a node's P2P interface
17P2PInterface: A high-level interface object for communicating to a node over P2P
18P2PDataStore: A p2p interface class that keeps a store of transactions and blocks
19              and can respond correctly to getdata and getheaders messages
20P2PTxInvStore: A p2p interface class that inherits from P2PDataStore, and keeps
21              a count of how many times each txid has been announced."""
22
23import asyncio
24from collections import defaultdict
25import ipaddress
26from io import BytesIO
27import logging
28import platform
29import socket
30import struct
31import sys
32import threading
33
34from test_framework.messages import (
35    CBlockHeader,
36    MAX_HEADERS_RESULTS,
37    msg_addr,
38    msg_addrv2,
39    msg_block,
40    MSG_BLOCK,
41    msg_blocktxn,
42    msg_cfcheckpt,
43    msg_cfheaders,
44    msg_cfilter,
45    msg_cmpctblock,
46    msg_feature,
47    msg_feefilter,
48    msg_filteradd,
49    msg_filterclear,
50    msg_filterload,
51    msg_getaddr,
52    msg_getblocks,
53    msg_getblocktxn,
54    msg_getcfcheckpt,
55    msg_getcfheaders,
56    msg_getcfilters,
57    msg_getdata,
58    msg_getheaders,
59    msg_headers,
60    msg_inv,
61    msg_mempool,
62    msg_merkleblock,
63    msg_notfound,
64    msg_ping,
65    msg_pong,
66    msg_sendaddrv2,
67    msg_sendcmpct,
68    msg_sendheaders,
69    msg_sendtxrcncl,
70    msg_tx,
71    MSG_TX,
72    MSG_TYPE_MASK,
73    msg_verack,
74    msg_version,
75    MSG_WTX,
76    msg_wtxidrelay,
77    NODE_NETWORK,
78    NODE_WITNESS,
79    MAGIC_BYTES,
80    sha256,
81)
82from test_framework.netutil import (
83    set_ephemeral_port_range,
84)
85from test_framework.util import (
86    assert_not_equal,
87    MAX_NODES,
88    p2p_port,
89    wait_until_helper_internal,
90)
91from test_framework.v2_p2p import (
92    EncryptedP2PState,
93    MSGTYPE_TO_SHORTID,
94    SHORTID,
95)
96
97logger = logging.getLogger("TestFramework.p2p")
98
99# The minimum P2P version that this test framework supports
100MIN_P2P_VERSION_SUPPORTED = 60001
101# The P2P version that this test framework implements and sends in its `version` message
102# Version 70016 supports wtxid relay
103# Version 70017 supports feature
104P2P_VERSION = 70017
105# The services that this test framework offers in its `version` message
106P2P_SERVICES = NODE_NETWORK | NODE_WITNESS
107# The P2P user agent string that this test framework sends in its `version` message
108P2P_SUBVERSION = "/python-p2p-tester:0.0.3/"
109# Value for relay that this test framework sends in its `version` message
110P2P_VERSION_RELAY = 1
111# Delay after receiving a tx inv before requesting transactions from non-preferred peers, in seconds
112NONPREF_PEER_TX_DELAY = 2
113# Delay for requesting transactions via txids if we have wtxid-relaying peers, in seconds
114TXID_RELAY_DELAY = 2
115# Delay for requesting transactions if the peer has MAX_PEER_TX_REQUEST_IN_FLIGHT or more requests
116OVERLOADED_PEER_TX_DELAY = 2
117# How long to wait before downloading a transaction from an additional peer
118GETDATA_TX_INTERVAL = 60
119
120MESSAGEMAP = {
121    b"addr": msg_addr,
122    b"addrv2": msg_addrv2,
123    b"block": msg_block,
124    b"blocktxn": msg_blocktxn,
125    b"cfcheckpt": msg_cfcheckpt,
126    b"cfheaders": msg_cfheaders,
127    b"cfilter": msg_cfilter,
128    b"cmpctblock": msg_cmpctblock,
129    b"feature": msg_feature,
130    b"feefilter": msg_feefilter,
131    b"filteradd": msg_filteradd,
132    b"filterclear": msg_filterclear,
133    b"filterload": msg_filterload,
134    b"getaddr": msg_getaddr,
135    b"getblocks": msg_getblocks,
136    b"getblocktxn": msg_getblocktxn,
137    b"getcfcheckpt": msg_getcfcheckpt,
138    b"getcfheaders": msg_getcfheaders,
139    b"getcfilters": msg_getcfilters,
140    b"getdata": msg_getdata,
141    b"getheaders": msg_getheaders,
142    b"headers": msg_headers,
143    b"inv": msg_inv,
144    b"mempool": msg_mempool,
145    b"merkleblock": msg_merkleblock,
146    b"notfound": msg_notfound,
147    b"ping": msg_ping,
148    b"pong": msg_pong,
149    b"sendaddrv2": msg_sendaddrv2,
150    b"sendcmpct": msg_sendcmpct,
151    b"sendheaders": msg_sendheaders,
152    b"sendtxrcncl": msg_sendtxrcncl,
153    b"tx": msg_tx,
154    b"verack": msg_verack,
155    b"version": msg_version,
156    b"wtxidrelay": msg_wtxidrelay,
157}
158
159
160class P2PConnection(asyncio.Protocol):
161    """A low-level connection object to a node's P2P interface.
162
163    This class is responsible for:
164
165    - opening and closing the TCP connection to the node
166    - reading bytes from and writing bytes to the socket
167    - deserializing and serializing the P2P message header
168    - logging messages as they are sent and received
169
170    This class contains no logic for handing the P2P message payloads. It must be
171    sub-classed and the on_message() callback overridden."""
172
173    def __init__(self):
174        # The underlying transport of the connection.
175        # Should only call methods on this from the NetworkThread, c.f. call_soon_threadsafe
176        self._transport = None
177        # This lock is acquired before sending messages over the socket. There's an implied lock order and
178        # p2p_lock must not be acquired after _send_lock as it could result in deadlocks.
179        self._send_lock = threading.Lock()
180        self.v2_state = None  # EncryptedP2PState object needed for v2 p2p connections
181        self.reconnect = False  # set if reconnection needs to happen
182
183    @property
184    def is_connected(self):
185        return self._transport is not None
186
187    @property
188    def supports_v2_p2p(self):
189        return self.v2_state is not None
190
191    def peer_connect_helper(self, dstaddr, dstport, net, timeout_factor):
192        assert not self.is_connected
193        self.timeout_factor = timeout_factor
194        self.dstaddr = dstaddr
195        self.dstport = dstport
196        # The initial message to send after the connection was made:
197        self.on_connection_send_msg = None
198        self.recvbuf = b""
199        self.magic_bytes = MAGIC_BYTES[net]
200        self.p2p_connected_to_node = dstport != 0
201
202    def peer_connect(self, dstaddr, dstport, *, net, timeout_factor, supports_v2_p2p):
203        self.peer_connect_helper(dstaddr, dstport, net, timeout_factor)
204        if supports_v2_p2p:
205            self.v2_state = EncryptedP2PState(initiating=True, net=net)
206
207        loop = NetworkThread.network_event_loop
208        logger.debug('Connecting to Bitcoin Node: %s:%d' % (self.dstaddr, self.dstport))
209        coroutine = loop.create_connection(lambda: self, host=self.dstaddr, port=self.dstport)
210        return lambda: loop.call_soon_threadsafe(loop.create_task, coroutine)
211
212    def peer_accept_connection(self, connect_id, connect_cb=lambda: None, *, net, timeout_factor, supports_v2_p2p, reconnect):
213        self.peer_connect_helper('0', 0, net, timeout_factor)
214        self.reconnect = reconnect
215        if supports_v2_p2p:
216            self.v2_state = EncryptedP2PState(initiating=False, net=net)
217
218        logger.debug('Listening for Bitcoin Node with id: {}'.format(connect_id))
219        return lambda: NetworkThread.listen(self, connect_cb, idx=connect_id)
220
221    def peer_disconnect(self):
222        # Connection could have already been closed by other end.
223        NetworkThread.network_event_loop.call_soon_threadsafe(lambda: self._transport and self._transport.abort())
224
225    # Connection and disconnection methods
226
227    def connection_made(self, transport):
228        """asyncio callback when a connection is opened."""
229        assert not self._transport
230        info = transport.get_extra_info("socket")
231        us = info.getsockname()
232        them = info.getpeername()
233        logger.debug(f"Connected: us={us[0]}:{us[1]}, them={them[0]}:{them[1]}")
234        self.dstaddr = them[0]
235        self.dstport = them[1]
236        self._transport = transport
237        # in an inbound connection to the TestNode with P2PConnection as the initiator, [TestNode <---- P2PConnection]
238        # send the initial handshake immediately
239        if self.supports_v2_p2p and self.v2_state.initiating and not self.v2_state.tried_v2_handshake:
240            send_handshake_bytes = self.v2_state.initiate_v2_handshake()
241            logger.debug(f"sending {len(self.v2_state.sent_garbage)} bytes of garbage data")
242            self.send_raw_message(send_handshake_bytes)
243        # for v1 outbound connections, send version message immediately after opening
244        # (for v2 outbound connections, send it after the initial v2 handshake)
245        if self.p2p_connected_to_node and not self.supports_v2_p2p:
246            self.send_version()
247        self.on_open()
248
249    def connection_lost(self, exc):
250        """asyncio callback when a connection is closed."""

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.