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.

5,178 bytes · SHA-256 ae1393a242d6544d… · 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 ping message
6"""
7
8import time
9
10from test_framework.messages import (
11    msg_pong,
12    msg_generic,
13)
14from test_framework.p2p import P2PInterface
15from test_framework.test_framework import BitcoinTestFramework
16from test_framework.util import (
17    assert_equal,
18    assert_not_equal,
19)
20
21
22PING_INTERVAL = 2 * 60
23TIMEOUT_INTERVAL = 20 * 60
24
25
26class NodeNoPong(P2PInterface):
27    def on_ping(self, message):
28        pass
29
30
31class PingPongTest(BitcoinTestFramework):
32    def set_test_params(self):
33        self.setup_clean_chain = True
34        self.num_nodes = 1
35        # Set the peer connection timeout low. It does not matter for this
36        # test, as long as it is less than TIMEOUT_INTERVAL.
37        self.extra_args = [['-peertimeout=1']]
38
39    def check_peer_info(self, *, pingtime, minping, pingwait):
40        stats = self.nodes[0].getpeerinfo()[0]
41        assert_equal(stats.pop('pingtime', None), pingtime)
42        assert_equal(stats.pop('minping', None), minping)
43        assert_equal(stats.pop('pingwait', None), pingwait)
44
45    def mock_forward(self, delta):
46        self.mock_time += delta
47        self.nodes[0].setmocktime(self.mock_time)
48
49    def run_test(self):
50        self.mock_time = int(time.time())
51        self.mock_forward(0)
52
53        self.log.info('Check that ping is sent after connection is established')
54        no_pong_node = self.nodes[0].add_p2p_connection(NodeNoPong())
55        self.mock_forward(3)
56        assert_not_equal(no_pong_node.last_message.pop('ping').nonce, 0)
57        self.check_peer_info(pingtime=None, minping=None, pingwait=3)
58
59        self.log.info('Reply without nonce cancels ping')
60        with self.nodes[0].assert_debug_log(['pong peer=0: Short payload']):
61            no_pong_node.send_and_ping(msg_generic(b"pong", b""))
62        self.check_peer_info(pingtime=None, minping=None, pingwait=None)
63
64        self.log.info('Reply without ping')
65        with self.nodes[0].assert_debug_log([
66                'pong peer=0: Unsolicited pong without ping, 0 expected, 0 received, 8 bytes',
67        ]):
68            no_pong_node.send_and_ping(msg_pong())
69        self.check_peer_info(pingtime=None, minping=None, pingwait=None)
70
71        self.log.info('Reply with wrong nonce does not cancel ping')
72        assert 'ping' not in no_pong_node.last_message
73        with self.nodes[0].assert_debug_log(['pong peer=0: Nonce mismatch']):
74            # mock time PING_INTERVAL ahead to trigger node into sending a ping
75            self.mock_forward(PING_INTERVAL + 1)
76            no_pong_node.wait_until(lambda: 'ping' in no_pong_node.last_message)
77            self.mock_forward(9)
78            # Send the wrong pong
79            no_pong_node.send_and_ping(msg_pong(no_pong_node.last_message.pop('ping').nonce - 1))
80        self.check_peer_info(pingtime=None, minping=None, pingwait=9)
81
82        self.log.info('Reply with zero nonce does cancel ping')
83        with self.nodes[0].assert_debug_log(['pong peer=0: Nonce zero']):
84            no_pong_node.send_and_ping(msg_pong(0))
85        self.check_peer_info(pingtime=None, minping=None, pingwait=None)
86
87        self.log.info('Check that ping is properly reported on RPC')
88        assert 'ping' not in no_pong_node.last_message
89        # mock time PING_INTERVAL ahead to trigger node into sending a ping
90        self.mock_forward(PING_INTERVAL + 1)
91        no_pong_node.wait_until(lambda: 'ping' in no_pong_node.last_message)
92        ping_delay = 29
93        self.mock_forward(ping_delay)
94        no_pong_node.wait_until(lambda: 'ping' in no_pong_node.last_message)
95        no_pong_node.send_and_ping(msg_pong(no_pong_node.last_message.pop('ping').nonce))
96        self.check_peer_info(pingtime=ping_delay, minping=ping_delay, pingwait=None)
97
98        self.log.info('Check that minping is decreased after a fast roundtrip')
99        # mock time PING_INTERVAL ahead to trigger node into sending a ping
100        self.mock_forward(PING_INTERVAL + 1)
101        no_pong_node.wait_until(lambda: 'ping' in no_pong_node.last_message)
102        ping_delay = 9
103        self.mock_forward(ping_delay)
104        no_pong_node.wait_until(lambda: 'ping' in no_pong_node.last_message)
105        no_pong_node.send_and_ping(msg_pong(no_pong_node.last_message.pop('ping').nonce))
106        self.check_peer_info(pingtime=ping_delay, minping=ping_delay, pingwait=None)
107
108        self.log.info('Check that peer is disconnected after ping timeout')
109        assert 'ping' not in no_pong_node.last_message
110        self.nodes[0].ping()
111        no_pong_node.wait_until(lambda: 'ping' in no_pong_node.last_message)
112        with self.nodes[0].assert_debug_log(['ping timeout: 1201.000000s']):
113            self.mock_forward(TIMEOUT_INTERVAL // 2)
114            # Check that sending a ping does not prevent the disconnect
115            no_pong_node.sync_with_ping()
116            self.mock_forward(TIMEOUT_INTERVAL // 2 + 1)
117            no_pong_node.wait_for_disconnect()
118
119
120if __name__ == '__main__':
121    PingPongTest(__file__).main()
122

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.