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.

8,290 bytes · SHA-256 8d998ebebd52ba55… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2020-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 asmap config argument for ASN-based IP bucketing.
6
7Verify node behaviour and debug log when launching bitcoind with different
8`-asmap` and `-noasmap` arg values, including absolute and relative paths, and
9with missing and unparseable files.
10
11The tests are order-independent.
12
13"""
14import hashlib
15import os
16import shutil
17
18from test_framework.test_framework import BitcoinTestFramework
19from test_framework.util import (
20    assert_equal,
21    assert_raises_rpc_error,
22)
23
24ASMAP = 'src/test/data/asmap.raw' # path to unit test skeleton asmap
25VERSION = '55dcec00c72b8a33a271dad20271e14cfbe5526aa1dc12e2559f30c376d85a35'
26EMBEDDED_VERSION = '03580ade8ec0036ad3d6a5a91602b995c89387f722d3fee58127219de6aafc12' # SHA256 of src/node/data/ip_asn.dat
27
28def expected_messages(filename):
29    return [f'Opened asmap file "{filename}" (59 bytes) from disk',
30            f'Using asmap version {VERSION} for IP bucketing']
31
32class AsmapTest(BitcoinTestFramework):
33    def set_test_params(self):
34        self.num_nodes = 1
35        # Do addrman checks on all operations and use deterministic addrman
36        self.extra_args = [["-checkaddrman=1", "-test=addrman"]]
37
38    def fill_addrman(self, node_id):
39        """Add 2 tried addresses to the addrman, followed by 2 new addresses."""
40        for addr, tried in [[0, True], [1, True], [2, False], [3, False]]:
41            self.nodes[node_id].addpeeraddress(address=f"101.{addr}.0.0", tried=tried, port=8333)
42
43    def test_without_asmap_arg(self):
44        self.log.info('Test bitcoind with no -asmap arg passed')
45        self.stop_node(0)
46        with self.node.assert_debug_log(['Using /16 prefix for IP bucketing']):
47            self.start_node(0)
48        assert "asmap_version" not in self.node.getnetworkinfo()
49
50    def test_noasmap_arg(self):
51        self.log.info('Test bitcoind with -noasmap arg passed')
52        self.stop_node(0)
53        with self.node.assert_debug_log(['Using /16 prefix for IP bucketing']):
54            self.start_node(0, ["-noasmap"])
55
56    def test_asmap_with_absolute_path(self):
57        self.log.info('Test bitcoind -asmap=<absolute path>')
58        self.stop_node(0)
59        filename = os.path.join(self.datadir, 'my-map-file.map')
60        shutil.copyfile(self.asmap_raw, filename)
61        with self.node.assert_debug_log(expected_messages(filename)):
62            self.start_node(0, [f'-asmap={filename}'])
63        assert_equal(self.node.getnetworkinfo()["asmap_version"], VERSION)
64        os.remove(filename)
65
66    def test_asmap_with_relative_path(self):
67        self.log.info('Test bitcoind -asmap=<relative path>')
68        self.stop_node(0)
69        name = 'ASN_map'
70        filename = os.path.join(self.datadir, name)
71        shutil.copyfile(self.asmap_raw, filename)
72        with self.node.assert_debug_log(expected_messages(filename)):
73            self.start_node(0, [f'-asmap={name}'])
74        os.remove(filename)
75
76    def test_embedded_asmap(self):
77        if self.is_embedded_asmap_compiled():
78            self.log.info('Test bitcoind -asmap (using embedded map data)')
79            for arg in ['-asmap', '-asmap=1']:
80                self.stop_node(0)
81                with self.node.assert_debug_log(["Opened asmap data", "from embedded byte array",
82                                                 f"Using asmap version {EMBEDDED_VERSION} for IP bucketing"]):
83                    self.start_node(0, [arg])
84                assert_equal(self.node.getnetworkinfo()["asmap_version"], EMBEDDED_VERSION)
85        else:
86            self.log.info('Test bitcoind -asmap (compiled without embedded map data)')
87            for arg in ['-asmap', '-asmap=1']:
88                self.stop_node(0)
89                msg = "Error: Embedded asmap data not available"
90                self.node.assert_start_raises_init_error(extra_args=[arg], expected_msg=msg)
91
92    def test_asmap_interaction_with_addrman_containing_entries(self):
93        self.log.info("Test bitcoind -asmap restart with addrman containing new and tried entries")
94        self.stop_node(0)
95        self.start_node(0, [f"-asmap={self.asmap_raw}", "-checkaddrman=1", "-test=addrman"])
96        self.fill_addrman(node_id=0)
97        rebucket_msg = "Bucketing method was updated, re-bucketing addrman entries from disk"
98        with self.node.assert_debug_log(expected_msgs=[], unexpected_msgs=[rebucket_msg]):
99            self.restart_node(0, [f"-asmap={self.asmap_raw}", "-checkaddrman=1", "-test=addrman"])
100        with self.node.assert_debug_log(
101            expected_msgs=[
102                "CheckAddrman: new 2, tried 2, total 4 started",
103                "CheckAddrman: completed",
104            ]
105        ):
106            self.node.getnodeaddresses()  # getnodeaddresses re-runs the addrman checks
107
108        self.log.info("Test bitcoind restart without -asmap re-buckets the addrman entries")
109        with self.node.assert_debug_log(expected_msgs=[rebucket_msg]):
110            self.restart_node(0, ["-checkaddrman=1", "-test=addrman"])
111
112    def test_asmap_with_missing_file(self):
113        self.log.info('Test bitcoind -asmap with missing map file')
114        self.stop_node(0)
115        msg = f"Error: Could not find asmap file \"{self.datadir}{os.sep}missing\""
116        self.node.assert_start_raises_init_error(extra_args=['-asmap=missing'], expected_msg=msg)
117
118    def test_empty_asmap(self):
119        self.log.info('Test bitcoind -asmap with empty map file')
120        self.stop_node(0)
121        empty_asmap = os.path.join(self.datadir, "ip_asn.map")
122        with open(empty_asmap, "w") as f:
123            f.write("")
124        msg = f"Error: Could not parse asmap file \"{empty_asmap}\""
125        self.node.assert_start_raises_init_error(extra_args=[f'-asmap={empty_asmap}'], expected_msg=msg)
126        os.remove(empty_asmap)
127
128    def test_asmap_health_check(self):
129        self.log.info('Test bitcoind -asmap logs ASMap Health Check with basic stats')
130        msg = "ASMap Health Check: 4 clearnet peers are mapped to 3 ASNs with 0 peers being unmapped"
131        with self.node.assert_debug_log(expected_msgs=[msg]):
132            self.start_node(0, extra_args=[f'-asmap={self.asmap_raw}'])
133        raw_addrman = self.node.getrawaddrman()
134        asns = []
135        for _, entries in raw_addrman.items():
136            for _, entry in entries.items():
137                asn = entry['mapped_as']
138                if asn not in asns:
139                    asns.append(asn)
140        assert_equal(len(asns), 3)
141
142    def test_export_embedded_asmap(self):
143        self.log.info('Test exportasmap RPC')
144        export_path = os.path.join(self.datadir, "asmap.dat")
145
146        if not self.is_embedded_asmap_compiled():
147            assert_raises_rpc_error(-1, "No embedded ASMap data available", self.node.exportasmap, export_path)
148            return
149
150        # Relative paths are resolved against the datadir.
151        result = self.node.exportasmap("asmap.dat")
152        assert_equal(result["path"], export_path)
153
154        with open(export_path, 'rb') as f:
155            data = f.read()
156        assert_equal(result["bytes_written"], len(data))
157
158        assert_equal(hashlib.sha256(data).hexdigest(), EMBEDDED_VERSION)
159        assert_equal(result["file_hash"], EMBEDDED_VERSION)
160
161        os.remove(export_path)
162
163    def run_test(self):
164        self.node = self.nodes[0]
165        self.datadir = self.node.chain_path
166        base_dir = self.config["environment"]["SRCDIR"]
167        self.asmap_raw = os.path.join(base_dir, ASMAP)
168        # The asmap version from the logs is the plain SHA256 of the file
169        with open(self.asmap_raw, 'rb') as f:
170            assert_equal(hashlib.sha256(f.read()).hexdigest(), VERSION)
171
172        self.test_without_asmap_arg()
173        self.test_noasmap_arg()
174        self.test_asmap_with_absolute_path()
175        self.test_asmap_with_relative_path()
176        self.test_embedded_asmap()
177        self.test_asmap_interaction_with_addrman_containing_entries()
178        self.test_asmap_with_missing_file()
179        self.test_empty_asmap()
180        self.test_asmap_health_check()
181        self.test_export_embedded_asmap()
182
183
184if __name__ == '__main__':
185    AsmapTest(__file__).main()
186

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.