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.

7,828 bytes · SHA-256 1b6121f90a876400… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2025-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"""
6Test that a node sends a self-announcement with its external IP to
7in- and outbound peers after connection open and again sometime later.
8
9Additionally, this checks that the first self-announcement arrives
10in its own message and that this message is the first we receive.
11"""
12
13import time
14
15from test_framework.messages import (
16    CAddress,
17    from_hex,
18    msg_headers,
19    CBlockHeader,
20)
21from test_framework.p2p import P2PInterface
22from test_framework.test_framework import BitcoinTestFramework
23from test_framework.util import assert_equal, assert_greater_than
24
25IP_TO_ANNOUNCE = "42.42.42.42"
26ONION_ADDR = "pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion"
27ONE_DAY = 60 * 60 * 24
28
29
30class SelfAnnouncementReceiver(P2PInterface):
31    self_announcements_received = 0
32    addresses_received = 0
33    addr_messages_received = 0
34
35    expected = None
36    addrv2_test = False
37
38    def __init__(self, *, expected, addrv2):
39        super().__init__(support_addrv2=addrv2)
40        self.expected = expected
41        self.addrv2_test = addrv2
42
43    def handle_addr_message(self, message):
44        self.addr_messages_received += 1
45        for addr in message.addrs:
46            self.addresses_received += 1
47            if addr == self.expected:
48                self.self_announcements_received += 1
49                if self.self_announcements_received == 1:
50                    # If it's the first self-announcement, check that it is
51                    # in the first addr message we receive, and that this message
52                    # only contains one address. This also implies that it is
53                    # the first address we receive.
54                    assert_equal(self.addr_messages_received, 1)
55                    assert_equal(len(message.addrs), 1)
56
57    def on_addrv2(self, message):
58        assert (self.addrv2_test)
59        self.handle_addr_message(message)
60
61    def on_addr(self, message):
62        assert (not self.addrv2_test)
63        self.handle_addr_message(message)
64
65
66class AddrSelfAnnouncementTest(BitcoinTestFramework):
67    def set_test_params(self):
68        self.num_nodes = 1
69        self.extra_args = [[f"-externalip={IP_TO_ANNOUNCE}"]]
70
71    def run_test(self):
72        # populate addrman to have some addresses for a GETADDR response
73        for i in range(50):
74            a = f"{1 + i}.{i}.1.1"
75            self.nodes[0].addpeeraddress(a, 8333)
76
77        self.self_announcement_test(outbound=False, addrv2=False)
78        self.self_announcement_test(outbound=False, addrv2=True)
79        self.self_announcement_test(outbound=True, addrv2=False)
80        self.self_announcement_test(outbound=True, addrv2=True)
81        self.test_externalip_bypasses_onlynet()
82
83    @staticmethod
84    def inbound_connection_open_assertions(addr_receiver):
85        # In response to a GETADDR, we expect a message with the self-announcement
86        # and an addr message containing the GETADDR response.
87        assert_equal(addr_receiver.self_announcements_received, 1)
88        assert_equal(addr_receiver.addr_messages_received, 2)
89        assert_greater_than(addr_receiver.addresses_received, 1)
90
91    @staticmethod
92    def outbound_connection_open_assertions(addr_receiver):
93        # We expect only the self-announcement.
94        assert_equal(addr_receiver.self_announcements_received, 1)
95        assert_equal(addr_receiver.addr_messages_received, 1)
96        assert_equal(addr_receiver.addresses_received, 1)
97
98    def self_announcement_test(self, *, outbound, addrv2):
99        connection_type = "outbound" if outbound else "inbound"
100        addr_version = "addrv2" if addrv2 else "addrv1"
101        self.log.info(f"Test that the node does an address self-announcement to {connection_type} connections ({addr_version})")
102
103        # We only self-announce after initial block download is done
104        assert (not self.nodes[0].getblockchaininfo()["initialblockdownload"])
105
106        netinfo = self.nodes[0].getnetworkinfo()
107        port = netinfo["localaddresses"][0]["port"]
108        self.nodes[0].setmocktime(int(time.time()))
109
110        expected = CAddress()
111        expected.nServices = int(netinfo["localservices"], 16)
112        expected.ip = IP_TO_ANNOUNCE
113        expected.port = port
114        expected.time = self.nodes[0].mocktime
115
116        with self.nodes[0].assert_debug_log([f'Advertising address {IP_TO_ANNOUNCE}:{port}']):
117            if outbound:
118                self.log.info(f"Check that we get an initial self-announcement on an outbound connection from the node ({connection_type}, {addr_version})")
119                addr_receiver = self.nodes[0].add_outbound_p2p_connection(SelfAnnouncementReceiver(expected=expected, addrv2=addrv2), p2p_idx=0, connection_type="outbound-full-relay")
120            else:
121                self.log.info(f"Check that we get an initial self-announcement when connecting to a node and sending a GETADDR ({connection_type}, {addr_version})")
122                addr_receiver = self.nodes[0].add_p2p_connection(SelfAnnouncementReceiver(expected=expected, addrv2=addrv2))
123            addr_receiver.sync_with_ping()
124
125        if outbound:
126            self.outbound_connection_open_assertions(addr_receiver)
127        else:
128            self.inbound_connection_open_assertions(addr_receiver)
129
130        if outbound:
131            # to avoid the node evicting the outbound peer, protect it by announcing the most recent header to it
132            tip_header = from_hex(CBlockHeader(), self.nodes[0].getblockheader(self.nodes[0].getbestblockhash(), False))
133            addr_receiver.send_and_ping(msg_headers([tip_header]))
134
135        self.log.info(f"Check that we get more self-announcements sometime later ({connection_type}, {addr_version})")
136        for _ in range(5):
137            last_self_announcements_received = addr_receiver.self_announcements_received
138            last_addr_messages_received = addr_receiver.addr_messages_received
139            last_addresses_received = addr_receiver.addresses_received
140            with self.nodes[0].assert_debug_log([f'Advertising address {IP_TO_ANNOUNCE}:{port}']):
141                # m_next_local_addr_send and AVG_LOCAL_ADDRESS_BROADCAST_INTERVAL:
142                # self-announcements are sent on an exponential distribution with mean interval of 24h.
143                # Setting the mocktime 20d forward gives a probability of (1 - e^-(480/24)) that
144                # the event will occur (i.e. this fails once in ~500 million repeats).
145                addr_receiver.expected.time = self.nodes[0].mocktime + 20 * ONE_DAY
146                self.nodes[0].bumpmocktime(20 * ONE_DAY)
147                addr_receiver.sync_with_ping()
148
149            assert_equal(addr_receiver.self_announcements_received, last_self_announcements_received + 1)
150            assert_equal(addr_receiver.addr_messages_received, last_addr_messages_received + 1)
151            assert_equal(addr_receiver.addresses_received, last_addresses_received + 1)
152
153        self.nodes[0].disconnect_p2ps()
154
155    def test_externalip_bypasses_onlynet(self):
156        self.log.info("Test that -externalip onion is advertised despite -onlynet=ipv4")
157        self.restart_node(0, extra_args=["-onlynet=ipv4", f"-externalip={ONION_ADDR}"])
158
159        netinfo = self.nodes[0].getnetworkinfo()
160
161        onion_net = next(n for n in netinfo["networks"] if n["name"] == "onion")
162        assert not onion_net["reachable"], "onion should not be reachable under -onlynet=ipv4"
163
164        addrs = [a["address"] for a in netinfo["localaddresses"]]
165        assert ONION_ADDR in addrs, f"onion address missing from localaddresses: {addrs}"
166
167if __name__ == '__main__':
168    AddrSelfAnnouncementTest(__file__).main()
169

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.