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.

9,508 bytes · SHA-256 74048dd64cf25f14… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6"""Test BIP434 feature negotiation."""
7
8from test_framework.messages import (
9    msg_version,
10    ser_compact_size,
11)
12from test_framework.p2p import (
13    P2PInterface,
14    P2P_SERVICES,
15    P2P_SUBVERSION,
16    P2P_VERSION_RELAY,
17)
18from test_framework.test_framework import BitcoinTestFramework
19from test_framework.util import assert_equal
20
21# Pre-BIP434 protocol version
22PRE_FEATURE_VERSION = 70016
23# Protocol version which enables BIP434 FEATURE negotiation
24FEATURE_VERSION = 70017
25# BIP434 wire-format limits
26MIN_FEATUREID_LENGTH = 4
27MAX_FEATUREID_LENGTH = 80
28MAX_FEATUREDATA_LENGTH = 512
29
30
31class RawFeature:
32    """A FEATURE message with a hand-crafted payload."""
33    msgtype = b"feature"
34
35    def __init__(self, payload):
36        self.payload = payload
37
38    def serialize(self):
39        return self.payload
40
41    def __repr__(self):
42        return f"RawFeature(payload_len={len(self.payload)})"
43
44
45def feature_wire(feature_id, feature_data, *, trailing=b""):
46    """Build a FEATURE payload plus optional trailing bytes."""
47    if isinstance(feature_id, str):
48        feature_id = feature_id.encode()
49    return (ser_compact_size(len(feature_id)) + feature_id
50            + ser_compact_size(len(feature_data)) + feature_data
51            + trailing)
52
53
54def _version_msg(nversion):
55    v = msg_version()
56    v.nVersion = nversion
57    v.strSubVer = P2P_SUBVERSION
58    v.nServices = P2P_SERVICES
59    v.relay = P2P_VERSION_RELAY
60    return v
61
62
63class FeaturePeer(P2PInterface):
64    """P2PInterface that counts FEATURE messages received."""
65
66    def __init__(self):
67        super().__init__()
68        self.got_feature_count = 0
69        self.last_feature = None
70
71    def on_feature(self, message):
72        self.got_feature_count += 1
73        self.last_feature = message
74
75
76class FeaturePeerNoVerack(FeaturePeer):
77    """Peer that records but does not auto-reply to the node's VERSION, so the
78    node stays in the post-VERSION / pre-VERACK window where FEATURE messages
79    are valid to send."""
80
81    def on_version(self, message):
82        self.nServices = message.nServices
83        self.relay = message.relay
84
85
86class P2PBIP434FeatureTest(BitcoinTestFramework):
87    def set_test_params(self):
88        self.num_nodes = 1
89        # peertimeout=999 prevents the node from kicking the peer for being idle
90        self.extra_args = [["-debug=net", "-peertimeout=999"]]
91
92    def run_test(self):
93        self.test_advertised_version()
94        self.test_no_feature_to_pre_70017_peer()
95        self.test_features_announced_to_modern_peer()
96        self.test_feature_after_verack_disconnects()
97        self.test_feature_before_version_ignored()
98        self.test_feature_id_length_boundaries()
99        self.test_feature_data_length_boundaries()
100        self.test_trailing_bytes_disconnect()
101        self.test_truncated_feature_id_disconnect()
102        self.test_truncated_feature_data_disconnect()
103        self.test_non_ascii_feature_id_accepted()
104        self.test_many_features_in_handshake()
105        self.test_recv_feature_from_pre_70017_peer()
106
107    def _silent_peer(self, *, nversion=FEATURE_VERSION):
108        peer = self.nodes[0].add_p2p_connection(
109            FeaturePeerNoVerack(),
110            send_version=False, wait_for_verack=False,
111        )
112        peer.send_without_ping(_version_msg(nversion))
113        peer.wait_for_verack()
114        return peer
115
116    def _expect_accept(self, payload, *, log_substring="unknown feature advertised",
117                      nversion=FEATURE_VERSION):
118        peer = self._silent_peer(nversion=nversion)
119        with self.nodes[0].assert_debug_log([log_substring], timeout=2):
120            peer.send_without_ping(RawFeature(payload))
121        assert peer.is_connected, "peer disconnected after a well-formed FEATURE"
122        self.nodes[0].disconnect_p2ps()
123
124    def _expect_disconnect(self, payload, *, log_substring="invalid feature payload",
125                          nversion=FEATURE_VERSION):
126        peer = self._silent_peer(nversion=nversion)
127        with self.nodes[0].assert_debug_log([log_substring], timeout=2):
128            peer.send_without_ping(RawFeature(payload))
129            peer.wait_for_disconnect()
130
131    def test_advertised_version(self):
132        self.log.info("Test that node advertises FEATURE to peer with protocol version 70017")
133        peer = self.nodes[0].add_p2p_connection(FeaturePeer())
134        assert_equal(peer.last_message["version"].nVersion, FEATURE_VERSION)
135        self.nodes[0].disconnect_p2ps()
136
137    def test_no_feature_to_pre_70017_peer(self):
138        self.log.info("Test that node doesn't send FEATURE to a peer with protocol version <70017")
139        peer = self.nodes[0].add_p2p_connection(
140            FeaturePeer(), send_version=False, wait_for_verack=False,
141        )
142        peer.send_without_ping(_version_msg(PRE_FEATURE_VERSION))
143        peer.wait_for_verack()
144        # The node's full handshake has now been delivered to us; if any
145        # FEATURE would have been sent it would be in last_message by now.
146        assert_equal(peer.got_feature_count, 0)
147        self.nodes[0].disconnect_p2ps()
148
149    def test_features_announced_to_modern_peer(self):
150        self.log.info("Test that node announces correct number of features to a 70017 peer")
151        peer = self.nodes[0].add_p2p_connection(FeaturePeer())
152        assert_equal(peer.got_feature_count, 0)
153        self.nodes[0].disconnect_p2ps()
154
155    def test_feature_after_verack_disconnects(self):
156        self.log.info("Test that FEATURE after VERACK triggers disconnect")
157        peer = self.nodes[0].add_p2p_connection(FeaturePeer())
158        peer.sync_with_ping()  # ensure node has set fSuccessfullyConnected
159        with self.nodes[0].assert_debug_log(["feature received after verack"], timeout=2):
160            peer.send_without_ping(RawFeature(feature_wire(b"abcd", b"")))
161            peer.wait_for_disconnect()
162
163    def test_feature_before_version_ignored(self):
164        self.log.info("Test that FEATURE before any VERSION is silently ignored")
165        peer = self.nodes[0].add_p2p_connection(
166            FeaturePeer(), send_version=False, wait_for_verack=False,
167        )
168        with self.nodes[0].assert_debug_log(
169            ["non-version message before version handshake"], timeout=2,
170        ):
171            peer.send_without_ping(RawFeature(feature_wire(b"abcd", b"")))
172        assert peer.is_connected
173        self.nodes[0].disconnect_p2ps()
174
175    def test_feature_id_length_boundaries(self):
176        self.log.info("Test feature_id length boundaries")
177        for length, accept in [(0, False),
178                               (3, False),
179                               (MIN_FEATUREID_LENGTH, True),
180                               (MAX_FEATUREID_LENGTH, True),
181                               (MAX_FEATUREID_LENGTH + 1, False)]:
182            payload = feature_wire(b"a" * length, b"")
183            if accept:
184                self._expect_accept(payload)
185            else:
186                self._expect_disconnect(payload)
187
188    def test_feature_data_length_boundaries(self):
189        self.log.info("Test feature_data length boundaries")
190        for length, accept in [(0, True),
191                               (MAX_FEATUREDATA_LENGTH, True),
192                               (MAX_FEATUREDATA_LENGTH + 1, False)]:
193            payload = feature_wire(b"abcd", b"\x00" * length)
194            if accept:
195                self._expect_accept(payload)
196            else:
197                self._expect_disconnect(payload)
198
199    def test_trailing_bytes_disconnect(self):
200        self.log.info("Test that trailing bytes after data triggers disconnect")
201        self._expect_disconnect(
202            feature_wire(b"abcd", b"", trailing=b"\x00"),
203        )
204
205    def test_truncated_feature_id_disconnect(self):
206        self.log.info("Test that truncated feature_id triggers disconnect")
207        payload = ser_compact_size(10) + b"abcde"
208        self._expect_disconnect(payload)
209
210    def test_truncated_feature_data_disconnect(self):
211        self.log.info("Test that truncated feature_data triggers disconnect")
212        payload = (ser_compact_size(MIN_FEATUREID_LENGTH) + b"abcd"
213                   + ser_compact_size(10) + b"xx")
214        self._expect_disconnect(payload)
215
216    def test_non_ascii_feature_id_accepted(self):
217        self.log.info("Test that feature_id with non-ASCII bytes is still accepted")
218        # BIP says SHOULD, not MUST, on this
219        self._expect_accept(feature_wire(b"\x00\xff\x01\x7f", b""))
220
221    def test_many_features_in_handshake(self):
222        self.log.info("Test multiple FEATURE advertisements")
223        peer = self._silent_peer()
224        with self.nodes[0].assert_debug_log(["unknown feature advertised"], timeout=2):
225            for i in range(16):
226                peer.send_without_ping(
227                    RawFeature(feature_wire(f"feat{i:04d}".encode(), b""))
228                )
229        assert peer.is_connected
230        self.nodes[0].disconnect_p2ps()
231
232    def test_recv_feature_from_pre_70017_peer(self):
233        self.log.info("Test that FEATURE from <70017 peer triggers disconnect")
234        self._expect_disconnect(
235            feature_wire(b"abcd", b""),
236            log_substring="feature received with incompatible version",
237            nversion=PRE_FEATURE_VERSION,
238        )
239
240
241if __name__ == "__main__":
242    P2PBIP434FeatureTest(__file__).main()
243

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.