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.

6,940 bytes · SHA-256 60b6c5d6180b85d4… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2021-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 addrman functionality"""
6
7import os
8import re
9
10from test_framework.messages import ser_uint256, hash256, MAGIC_BYTES
11from test_framework.netutil import ADDRMAN_NEW_BUCKET_COUNT, ADDRMAN_TRIED_BUCKET_COUNT, ADDRMAN_BUCKET_SIZE
12from test_framework.test_framework import BitcoinTestFramework
13from test_framework.test_node import ErrorMatch
14from test_framework.util import assert_equal
15
16def serialize_addrman(
17    *,
18    format=1,
19    lowest_compatible=4,
20    net_magic="regtest",
21    bucket_key=1,
22    len_new=None,
23    len_tried=None,
24    mock_checksum=None,
25):
26    new = []
27    tried = []
28    INCOMPATIBILITY_BASE = 32
29    r = MAGIC_BYTES[net_magic]
30    r += format.to_bytes(1, "little")
31    r += (INCOMPATIBILITY_BASE + lowest_compatible).to_bytes(1, "little")
32    r += ser_uint256(bucket_key)
33    r += (len_new or len(new)).to_bytes(4, "little", signed=True)
34    r += (len_tried or len(tried)).to_bytes(4, "little", signed=True)
35    ADDRMAN_NEW_BUCKET_COUNT = 1 << 10
36    r += (ADDRMAN_NEW_BUCKET_COUNT ^ (1 << 30)).to_bytes(4, "little", signed=True)
37    for _ in range(ADDRMAN_NEW_BUCKET_COUNT):
38        r += (0).to_bytes(4, "little", signed=True)
39    checksum = hash256(r)
40    r += mock_checksum or checksum
41    return r
42
43
44def write_addrman(peers_dat, **kwargs):
45    with open(peers_dat, "wb") as f:
46        f.write(serialize_addrman(**kwargs))
47
48
49class AddrmanTest(BitcoinTestFramework):
50    def set_test_params(self):
51        self.num_nodes = 1
52
53    def run_test(self):
54        peers_dat = os.path.join(self.nodes[0].chain_path, "peers.dat")
55        def init_error(reason):
56            return (
57                f"Error: Invalid or corrupt peers.dat \\({reason}\\). If you believe this "
58                f"is a bug, please report it to {self.config['environment']['CLIENT_BUGREPORT']}. "
59                f'As a workaround, you can move the file \\("{re.escape(peers_dat)}"\\) out of the way \\(rename, '
60                "move, or delete\\) to have a new one created on the next start."
61            )
62
63        self.log.info("Check that mocked addrman is valid")
64        self.stop_node(0)
65        write_addrman(peers_dat)
66        with self.nodes[0].assert_debug_log(["Loaded 0 addresses from peers.dat"]):
67            self.start_node(0, extra_args=["-checkaddrman=1"])
68        assert_equal(self.nodes[0].getnodeaddresses(), [])
69
70        self.log.info("Check that addrman with negative lowest_compatible cannot be read")
71        self.stop_node(0)
72        write_addrman(peers_dat, lowest_compatible=-32)
73        self.nodes[0].assert_start_raises_init_error(
74            expected_msg=init_error(
75                "Corrupted addrman database: The compat value \\(0\\) is lower "
76                "than the expected minimum value 32.: (.+)"
77            ),
78            match=ErrorMatch.FULL_REGEX,
79        )
80
81        self.log.info("Check that addrman from future is overwritten with new addrman")
82        self.stop_node(0)
83        write_addrman(peers_dat, lowest_compatible=111)
84        assert_equal(os.path.exists(peers_dat + ".bak"), False)
85        with self.nodes[0].assert_debug_log([
86                f'Creating new peers.dat because the file version was not compatible ("{peers_dat}"). Original backed up to peers.dat.bak',
87        ]):
88            self.start_node(0)
89        assert_equal(self.nodes[0].getnodeaddresses(), [])
90        assert_equal(os.path.exists(peers_dat + ".bak"), True)
91
92        self.log.info("Check that corrupt addrman cannot be read (EOF)")
93        self.stop_node(0)
94        with open(peers_dat, "wb") as f:
95            f.write(serialize_addrman()[:-1])
96        self.nodes[0].assert_start_raises_init_error(
97            expected_msg=init_error("AutoFile::read: end of file.*"),
98            match=ErrorMatch.FULL_REGEX,
99        )
100
101        self.log.info("Check that corrupt addrman cannot be read (magic)")
102        self.stop_node(0)
103        write_addrman(peers_dat, net_magic="signet")
104        self.nodes[0].assert_start_raises_init_error(
105            expected_msg=init_error("Invalid network magic number"),
106            match=ErrorMatch.FULL_REGEX,
107        )
108
109        self.log.info("Check that corrupt addrman cannot be read (checksum)")
110        self.stop_node(0)
111        write_addrman(peers_dat, mock_checksum=b"ab" * 32)
112        self.nodes[0].assert_start_raises_init_error(
113            expected_msg=init_error("Checksum mismatch, data corrupted"),
114            match=ErrorMatch.FULL_REGEX,
115        )
116
117        self.log.info("Check that corrupt addrman cannot be read (len_tried)")
118        self.stop_node(0)
119        max_len_tried = ADDRMAN_TRIED_BUCKET_COUNT * ADDRMAN_BUCKET_SIZE
120        write_addrman(peers_dat, len_tried=-1)
121        self.nodes[0].assert_start_raises_init_error(
122            expected_msg=init_error(f"Corrupt AddrMan serialization: nTried=-1, should be in \\[0, {max_len_tried}\\]:.*"),
123            match=ErrorMatch.FULL_REGEX,
124        )
125
126        self.log.info("Check that corrupt addrman cannot be read (large len_tried)")
127        write_addrman(peers_dat, len_tried=max_len_tried + 1)
128        self.nodes[0].assert_start_raises_init_error(
129            expected_msg=init_error(f"Corrupt AddrMan serialization: nTried={max_len_tried + 1}, should be in \\[0, {max_len_tried}\\]:.*"),
130            match=ErrorMatch.FULL_REGEX,
131        )
132
133        self.log.info("Check that corrupt addrman cannot be read (len_new)")
134        self.stop_node(0)
135        max_len_new = ADDRMAN_NEW_BUCKET_COUNT * ADDRMAN_BUCKET_SIZE
136        write_addrman(peers_dat, len_new=-1)
137        self.nodes[0].assert_start_raises_init_error(
138            expected_msg=init_error(f"Corrupt AddrMan serialization: nNew=-1, should be in \\[0, {max_len_new}\\]:.*"),
139            match=ErrorMatch.FULL_REGEX,
140        )
141
142        self.log.info("Check that corrupt addrman cannot be read (large len_new)")
143        self.stop_node(0)
144        write_addrman(peers_dat, len_new=max_len_new + 1)
145        self.nodes[0].assert_start_raises_init_error(
146            expected_msg=init_error(f"Corrupt AddrMan serialization: nNew={max_len_new + 1}, should be in \\[0, {max_len_new}\\]:.*"),
147            match=ErrorMatch.FULL_REGEX,
148        )
149
150        self.log.info("Check that corrupt addrman cannot be read (failed check)")
151        self.stop_node(0)
152        write_addrman(peers_dat, bucket_key=0)
153        self.nodes[0].assert_start_raises_init_error(
154            expected_msg=init_error("Corrupt data. Consistency check failed with code -16: .*"),
155            match=ErrorMatch.FULL_REGEX,
156        )
157
158        self.log.info("Check that missing addrman is recreated")
159        self.restart_node(0, clear_addrman=True)
160        assert_equal(self.nodes[0].getnodeaddresses(), [])
161
162
163if __name__ == "__main__":
164    AddrmanTest(__file__).main()
165

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.