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,117 bytes · SHA-256 298d6cc93f1c6dd0… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2015-present 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"""Test behavior of -maxuploadtarget.
6
7* Verify that getdata requests for old blocks (>1week) are dropped
8if uploadtarget has been reached.
9* Verify that getdata requests for recent blocks are respected even
10if uploadtarget has been reached.
11* Verify that mempool requests lead to a disconnect if uploadtarget has been reached.
12* Verify that the upload counters are reset after 24 hours.
13"""
14from collections import defaultdict
15import time
16
17from test_framework.messages import (
18    CInv,
19    MSG_BLOCK,
20    msg_getdata,
21    msg_mempool,
22)
23from test_framework.p2p import P2PInterface
24from test_framework.test_framework import BitcoinTestFramework
25from test_framework.util import (
26    assert_equal,
27    mine_large_block,
28)
29from test_framework.wallet import MiniWallet
30
31
32UPLOAD_TARGET_MB = 800
33
34
35class TestP2PConn(P2PInterface):
36    def __init__(self):
37        super().__init__()
38        self.block_receive_map = defaultdict(int)
39
40    def on_inv(self, message):
41        pass
42
43    def on_block(self, message):
44        self.block_receive_map[message.block.hash_int] += 1
45
46class MaxUploadTest(BitcoinTestFramework):
47
48    def set_test_params(self):
49        self.setup_clean_chain = True
50        self.num_nodes = 1
51        self.extra_args = [[
52            f"-maxuploadtarget={UPLOAD_TARGET_MB}M",
53        ]]
54
55    def assert_uploadtarget_state(self, *, target_reached, serve_historical_blocks):
56        """Verify the node's current upload target state via the `getnettotals` RPC call."""
57        uploadtarget = self.nodes[0].getnettotals()["uploadtarget"]
58        assert_equal(uploadtarget["target_reached"], target_reached)
59        assert_equal(uploadtarget["serve_historical_blocks"], serve_historical_blocks)
60
61    def run_test(self):
62        # Initially, neither historical blocks serving limit nor total limit are reached
63        self.assert_uploadtarget_state(target_reached=False, serve_historical_blocks=True)
64
65        # Before we connect anything, we first set the time on the node
66        # to be in the past, otherwise things break because the CNode
67        # time counters can't be reset backward after initialization
68        old_time = int(time.time() - 2*60*60*24*7)
69        self.nodes[0].setmocktime(old_time)
70
71        # Generate some old blocks
72        self.wallet = MiniWallet(self.nodes[0])
73        self.generate(self.wallet, 130)
74
75        # p2p_conns[0] will only request old blocks
76        # p2p_conns[1] will only request new blocks
77        # p2p_conns[2] will test resetting the counters
78        p2p_conns = []
79
80        for _ in range(3):
81            # Don't use v2transport in this test (too slow with the unoptimized python ChaCha20 implementation)
82            p2p_conns.append(self.nodes[0].add_p2p_connection(TestP2PConn(), supports_v2_p2p=False))
83
84        # Now mine a big block
85        mine_large_block(self, self.wallet, self.nodes[0])
86
87        # Store the hash; we'll request this later
88        big_old_block = self.nodes[0].getbestblockhash()
89        old_block_size = self.nodes[0].getblock(big_old_block, True)['size']
90        big_old_block = int(big_old_block, 16)
91
92        # Advance to two days ago
93        self.nodes[0].setmocktime(int(time.time()) - 2*60*60*24)
94
95        # Mine one more block, so that the prior block looks old
96        mine_large_block(self, self.wallet, self.nodes[0])
97
98        # We'll be requesting this new block too
99        big_new_block = self.nodes[0].getbestblockhash()
100        big_new_block = int(big_new_block, 16)
101
102        # p2p_conns[0] will test what happens if we just keep requesting the
103        # the same big old block too many times (expect: disconnect)
104
105        getdata_request = msg_getdata()
106        getdata_request.inv.append(CInv(MSG_BLOCK, big_old_block))
107
108        max_bytes_per_day = UPLOAD_TARGET_MB * 1024 *1024
109        daily_buffer = 144 * 4000000
110        max_bytes_available = max_bytes_per_day - daily_buffer
111        success_count = max_bytes_available // old_block_size
112
113        # 576MB will be reserved for relaying new blocks, so expect this to
114        # succeed for ~235 tries.
115        for i in range(success_count):
116            p2p_conns[0].send_and_ping(getdata_request)
117            assert_equal(p2p_conns[0].block_receive_map[big_old_block], i+1)
118
119        assert_equal(len(self.nodes[0].getpeerinfo()), 3)
120        # At most a couple more tries should succeed (depending on how long
121        # the test has been running so far).
122        with self.nodes[0].assert_debug_log(expected_msgs=["historical block serving limit reached, disconnecting peer=0"]):
123            for _ in range(3):
124                p2p_conns[0].send_without_ping(getdata_request)
125            p2p_conns[0].wait_for_disconnect()
126        assert_equal(len(self.nodes[0].getpeerinfo()), 2)
127        self.log.info("Peer 0 disconnected after downloading old block too many times")
128
129        # Historical blocks serving limit is reached by now, but total limit still isn't
130        self.assert_uploadtarget_state(target_reached=False, serve_historical_blocks=False)
131
132        # Requesting the current block on p2p_conns[1] should succeed indefinitely,
133        # even when over the max upload target.
134        # We'll try 800 times
135        getdata_request.inv = [CInv(MSG_BLOCK, big_new_block)]
136        for i in range(800):
137            p2p_conns[1].send_and_ping(getdata_request)
138            assert_equal(p2p_conns[1].block_receive_map[big_new_block], i+1)
139
140        # Both historical blocks serving limit and total limit are reached
141        self.assert_uploadtarget_state(target_reached=True, serve_historical_blocks=False)
142
143        self.log.info("Peer 1 able to repeatedly download new block")
144
145        # But if p2p_conns[1] tries for an old block, it gets disconnected too.
146        getdata_request.inv = [CInv(MSG_BLOCK, big_old_block)]
147        with self.nodes[0].assert_debug_log(expected_msgs=["historical block serving limit reached, disconnecting peer=1"]):
148            p2p_conns[1].send_without_ping(getdata_request)
149            p2p_conns[1].wait_for_disconnect()
150        assert_equal(len(self.nodes[0].getpeerinfo()), 1)
151
152        self.log.info("Peer 1 disconnected after trying to download old block")
153
154        self.log.info("Advancing system time on node to clear counters...")
155
156        # If we advance the time by 24 hours, then the counters should reset,
157        # and p2p_conns[2] should be able to retrieve the old block.
158        self.nodes[0].setmocktime(int(time.time()))
159        p2p_conns[2].sync_with_ping()
160        p2p_conns[2].send_and_ping(getdata_request)
161        assert_equal(p2p_conns[2].block_receive_map[big_old_block], 1)
162        self.assert_uploadtarget_state(target_reached=False, serve_historical_blocks=True)
163
164        self.log.info("Peer 2 able to download old block")
165
166        self.nodes[0].disconnect_p2ps()
167
168        self.log.info("Restarting node 0 with download permission, bloom filter support and 1MB maxuploadtarget")
169        self.restart_node(0, ["[email protected]", "-peerbloomfilters", "-maxuploadtarget=1"])
170        # Total limit isn't reached after restart, but 1 MB is too small to serve historical blocks
171        self.assert_uploadtarget_state(target_reached=False, serve_historical_blocks=False)
172
173        # Reconnect to self.nodes[0]
174        peer = self.nodes[0].add_p2p_connection(TestP2PConn(), supports_v2_p2p=False)
175
176        # Sending mempool message shouldn't disconnect peer, as total limit isn't reached yet
177        peer.send_and_ping(msg_mempool())
178
179        #retrieve 20 blocks which should be enough to break the 1MB limit
180        getdata_request.inv = [CInv(MSG_BLOCK, big_new_block)]
181        for i in range(20):
182            peer.send_and_ping(getdata_request)
183            assert_equal(peer.block_receive_map[big_new_block], i+1)
184
185        # Total limit is exceeded
186        self.assert_uploadtarget_state(target_reached=True, serve_historical_blocks=False)
187
188        getdata_request.inv = [CInv(MSG_BLOCK, big_old_block)]
189        peer.send_and_ping(getdata_request)
190
191        self.log.info("Peer still connected after trying to download old block (download permission)")
192        peer_info = self.nodes[0].getpeerinfo()
193        assert_equal(len(peer_info), 1)  # node is still connected
194        assert_equal(peer_info[0]['permissions'], ['download'])
195
196        self.log.info("Peer gets disconnected for a mempool request after limit is reached")
197        with self.nodes[0].assert_debug_log(expected_msgs=["mempool request with bandwidth limit reached, disconnecting peer=0"]):
198            peer.send_without_ping(msg_mempool())
199            peer.wait_for_disconnect()
200
201        self.log.info("Test passing an unparsable value to -maxuploadtarget throws an error")
202        self.stop_node(0)
203        self.nodes[0].assert_start_raises_init_error(extra_args=["-maxuploadtarget=abc"], expected_msg="Error: Unable to parse -maxuploadtarget: 'abc'")
204
205if __name__ == '__main__':
206    MaxUploadTest(__file__).main()
207

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.