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.

19,382 bytes · SHA-256 442827aa548a0b02… · 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"""Tests related to node initialization."""
6from concurrent.futures import ThreadPoolExecutor
7from pathlib import Path
8import os
9import platform
10import re
11import shutil
12import signal
13import subprocess
14
15from test_framework.test_framework import BitcoinTestFramework
16from test_framework.test_node import (
17    BITCOIN_PID_FILENAME_DEFAULT,
18    ErrorMatch,
19)
20from test_framework.util import assert_equal
21
22ALL_INDEX_ARGS = [
23    '-txindex=1',
24    '-blockfilterindex=1',
25    '-coinstatsindex=1',
26    '-txospenderindex=1',
27]
28
29
30def get_process_group_kwargs():
31    # CTRL_BREAK_EVENT must target a separate process group to avoid
32    # terminating the Python test runner.
33    return {"creationflags": subprocess.CREATE_NEW_PROCESS_GROUP} if platform.system() == 'Windows' else {}
34
35
36def sigterm_node(node):
37    if platform.system() == 'Windows':
38        # Don't call Python's terminate() since it calls
39        # TerminateProcess(), which unlike SIGTERM doesn't allow
40        # bitcoind to perform any shutdown logic.
41        os.kill(node.process.pid, signal.CTRL_BREAK_EVENT)
42    else:
43        node.process.terminate()
44    node.wait_until_stopped()
45
46
47class InitTest(BitcoinTestFramework):
48    """
49    Ensure that initialization can be interrupted at a number of points and not impair
50    subsequent starts.
51    """
52
53    def set_test_params(self):
54        self.setup_clean_chain = True
55        self.num_nodes = 2
56        self.uses_wallet = None
57
58    def check_clean_start(self, node, extra_args):
59        """Ensure that node restarts successfully after various interrupts."""
60        node.start(extra_args)
61        node.wait_for_rpc_connection()
62        height = node.getblockcount()
63        assert_equal(200, height)
64        self.wait_until(lambda: all(i["synced"] and i["best_block_height"] == height for i in node.getindexinfo().values()))
65
66    def init_stress_test_interrupt(self):
67        """
68        - test terminating initialization after seeing a certain log line.
69        """
70        self.start_node(0)
71        node = self.nodes[0]
72        self.generate(node, 200, sync_fun=self.no_op)
73        self.stop_node(0)
74
75        reindex_log_line = b'Reindexing block file blk00000.dat'
76        lines_to_terminate_after = [
77            b'Validating signatures for all blocks',
78            b'scheduler thread start',
79            b'Starting HTTP server',
80            b'Loading P2P addresses',
81            b'Loading banlist',
82            b'Loading block index',
83            b'Checking all blk files are present',
84            b'Loaded best chain:',
85            b'init message: Verifying blocks',
86            b'init message: Starting network threads',
87            b'net thread start',
88            b'addcon thread start',
89            b'initload thread start',
90            b'txidx thread start',
91            b'blkfltbscidx thread start',
92            b'coinstatsidx thread start',
93            b'txospenderidx thread start',
94            b'msghand thread start',
95            b'net thread start',
96            b'addcon thread start',
97        ]
98        if self.is_wallet_compiled():
99            lines_to_terminate_after.append(b'Verifying wallet')
100        lines_to_terminate_after.append(reindex_log_line)
101
102        for terminate_line in lines_to_terminate_after:
103            self.log.info(f"Starting node and will terminate after line {terminate_line}")
104            with node.busy_wait_for_debug_log([terminate_line]):
105                extra_args = [*ALL_INDEX_ARGS]
106                if terminate_line == reindex_log_line:
107                    extra_args += ['-reindex']
108                node.start(extra_args=extra_args, **get_process_group_kwargs())
109            self.log.debug("Terminating node after terminate line was found")
110            sigterm_node(node)
111
112        # Prior to deleting/perturbing index files, start node with all indexes enabled.
113        # 'check_clean_start' will ensure indexes are synchronized (i.e., data exists to modify)
114        self.check_clean_start(node, ALL_INDEX_ARGS)
115        self.stop_node(0)
116
117    def init_stress_test_removals(self):
118        """
119        - test removing certain essential files to test startup error paths.
120        """
121        self.log.info("Test startup errors after removing certain essential files")
122        node = self.nodes[0]
123
124        def start_expecting_error(err_fragment, args):
125            node.assert_start_raises_init_error(
126                extra_args=args,
127                expected_msg=err_fragment,
128                match=ErrorMatch.PARTIAL_REGEX,
129            )
130
131        deletion_rounds = [
132            {
133                'filepath_glob': 'blocks/index/*.ldb',
134                'error_message': 'Error opening block database.',
135                'startup_args': [],
136            },
137            {
138                'filepath_glob': 'chainstate/*.ldb',
139                'error_message': 'Error opening coins database.',
140                'startup_args': ['-checklevel=4'],
141            },
142            {
143                'filepath_glob': 'blocks/blk*.dat',
144                'error_message': 'Error loading block database.',
145                'startup_args': ['-checkblocks=200', '-checklevel=4'],
146            },
147            {
148                'filepath_glob': 'indexes/txindex/MANIFEST*',
149                'error_message': 'LevelDB error: Corruption: CURRENT points to a non-existent file',
150                'startup_args': ['-txindex=1'],
151            },
152            {
153                'filepath_glob': 'indexes/txospenderindex/db/MANIFEST*',
154                'error_message': 'LevelDB error: Corruption: CURRENT points to a non-existent file',
155                'startup_args': ['-txospenderindex=1'],
156            },
157            # Removing these files does not result in a startup error:
158            # 'indexes/blockfilter/basic/*.dat', 'indexes/blockfilter/basic/db/*.*', 'indexes/coinstatsindex/db/*.*',
159            # 'indexes/txindex/*.log', 'indexes/txindex/CURRENT', 'indexes/txindex/LOCK'
160        ]
161
162        perturbation_rounds = [
163            {
164                'filepath_glob': 'blocks/index/*.ldb',
165                'error_message': 'Error loading block database.',
166                'startup_args': [],
167            },
168            {
169                'filepath_glob': 'chainstate/*.ldb',
170                'error_message': 'Error opening coins database.',
171                'startup_args': [],
172            },
173            {
174                'filepath_glob': 'blocks/blk*.dat',
175                'error_message': 'Corrupted block database detected.',
176                'startup_args': ['-checkblocks=200', '-checklevel=4'],
177            },
178            {
179                'filepath_glob': 'indexes/blockfilter/basic/db/*.*',
180                'error_message': 'LevelDB error: Corruption',
181                'startup_args': ['-blockfilterindex=1'],
182            },
183            {
184                'filepath_glob': 'indexes/coinstatsindex/db/*.*',
185                'error_message': 'LevelDB error: Corruption',
186                'startup_args': ['-coinstatsindex=1'],
187            },
188            {
189                'filepath_glob': 'indexes/txindex/*.log',
190                'error_message': 'LevelDB error: Corruption',
191                'startup_args': ['-txindex=1'],
192            },
193            {
194                'filepath_glob': 'indexes/txindex/CURRENT',
195                'error_message': 'LevelDB error: Corruption',
196                'startup_args': ['-txindex=1'],
197            },
198            {
199                'filepath_glob': 'indexes/txospenderindex/db/*',
200                'error_message': 'LevelDB error: Corruption',
201                'startup_args': ['-txospenderindex=1'],
202            },
203            # Perturbing these files does not result in a startup error:
204            # 'indexes/blockfilter/basic/*.dat', 'indexes/txindex/MANIFEST*', 'indexes/txindex/LOCK'
205        ]
206
207        for round_info in deletion_rounds:
208            file_patt = round_info['filepath_glob']
209            err_fragment = round_info['error_message']
210            startup_args = round_info['startup_args']
211            target_files = list(node.chain_path.glob(file_patt))
212            assert target_files, f"Failed to find expected files: {file_patt}"
213
214            for target_file in target_files:
215                self.log.info(f"Deleting file to ensure failure {target_file}")
216                bak_path = str(target_file) + ".bak"
217                target_file.rename(bak_path)
218
219            start_expecting_error(err_fragment, startup_args)
220
221            for target_file in target_files:
222                bak_path = str(target_file) + ".bak"
223                self.log.debug(f"Restoring file from {bak_path} and restarting")
224                Path(bak_path).rename(target_file)
225
226            self.check_clean_start(node, ALL_INDEX_ARGS)
227            self.stop_node(0)
228
229        self.log.info("Test startup errors after perturbing certain essential files")
230        dirs = ["blocks", "chainstate", "indexes"]
231        for round_info in perturbation_rounds:
232            file_patt = round_info['filepath_glob']
233            err_fragment = round_info['error_message']
234            startup_args = round_info['startup_args']
235
236            for dir in dirs:
237                shutil.copytree(node.chain_path / dir, node.chain_path / f"{dir}_bak")
238            target_files = list(node.chain_path.glob(file_patt))
239            assert target_files, f"Failed to find expected files: {file_patt}"
240
241            for target_file in target_files:
242                self.log.info(f"Perturbing file to ensure failure {target_file}")
243                with open(target_file, "r+b") as tf:
244                    # Since the genesis block is not checked by -checkblocks, the
245                    # perturbation window must be chosen such that a higher block
246                    # in blk*.dat is affected.
247                    tf.seek(150)
248                    tf.write(b"1" * 200)
249
250            start_expecting_error(err_fragment, startup_args)

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.