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.

31,549 bytes · SHA-256 f21562db1a46416b… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2017-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 various command line arguments and configuration file parameters."""
6
7import os
8from pathlib import Path
9import platform
10import re
11import tempfile
12import time
13
14from test_framework.netutil import UNREACHABLE_PROXY_ARG
15from test_framework.test_framework import BitcoinTestFramework
16from test_framework.test_node import ErrorMatch
17from test_framework import util
18
19
20class ConfArgsTest(BitcoinTestFramework):
21    def set_test_params(self):
22        self.setup_clean_chain = True
23        self.num_nodes = 1
24        # Prune to prevent disk space warning on CI systems with limited space,
25        # when using networks other than regtest.
26        self.extra_args = [["-prune=550"]]
27        self.supports_cli = False
28        self.wallet_names = []
29        self.disable_autoconnect = False
30        self.uses_wallet = None
31
32    # Overridden to avoid attempt to sync not yet started nodes.
33    def setup_network(self):
34        self.setup_nodes()
35
36    # Overridden to not start nodes automatically - doing so is the
37    # responsibility of each test function.
38    def setup_nodes(self):
39        self.add_nodes(self.num_nodes, self.extra_args)
40        # Ensure a log file exists as TestNode.assert_debug_log() expects it.
41        self.nodes[0].debug_log_path.parent.mkdir()
42        self.nodes[0].debug_log_path.touch()
43
44    def test_dir_config(self):
45        self.log.info('Error should be emitted if config file is a directory')
46        conf_path = self.nodes[0].datadir_path / 'bitcoin.conf'
47        os.rename(conf_path, conf_path.with_suffix('.confbkp'))
48        conf_path.mkdir()
49        self.stop_node(0)
50        self.nodes[0].assert_start_raises_init_error(
51            extra_args=['-regtest'],
52            expected_msg=f'Error: Error reading configuration file: Config file "{conf_path}" is a directory.',
53        )
54        conf_path.rmdir()
55        os.rename(conf_path.with_suffix('.confbkp'), conf_path)
56
57        self.log.debug('Verifying includeconf directive pointing to directory is caught')
58        with open(conf_path, 'a') as conf:
59            conf.write(f'includeconf={self.nodes[0].datadir_path}\n')
60        self.nodes[0].assert_start_raises_init_error(
61            extra_args=['-regtest'],
62            expected_msg=f'Error: Error reading configuration file: Included config file "{self.nodes[0].datadir_path}" is a directory.',
63        )
64
65        self.nodes[0].replace_in_config([(f'includeconf={self.nodes[0].datadir_path}', '')])
66
67    def test_negated_config(self):
68        self.log.info('Disabling configuration via -noconf')
69
70        conf_path = self.nodes[0].datadir_path / 'bitcoin.conf'
71        with open(conf_path) as conf:
72            settings = [f'-{line.rstrip()}' for line in conf if len(line) > 1 and line[0] != '[']
73        os.rename(conf_path, conf_path.with_suffix('.confbkp'))
74
75        self.log.debug('Verifying garbage in config can be detected')
76        with open(conf_path, 'a') as conf:
77            conf.write('garbage\n')
78        self.nodes[0].assert_start_raises_init_error(
79            extra_args=['-regtest'],
80            expected_msg='Error: Error reading configuration file: parse error on line 1: garbage',
81        )
82
83        self.log.debug('Verifying that disabling of the config file means garbage inside of it does ' \
84            'not prevent the node from starting, and message about existing config file is logged')
85        ignored_file_message = [f'Data directory "{self.nodes[0].datadir_path}" contains a "bitcoin.conf" file which is explicitly ignored using -noconf.']
86        with self.nodes[0].assert_debug_log(expected_msgs=ignored_file_message):
87            self.start_node(0, extra_args=settings + ['-noconf'])
88        self.stop_node(0)
89
90        self.log.debug('Verifying no message appears when removing config file')
91        os.remove(conf_path)
92        with self.nodes[0].assert_debug_log(expected_msgs=[], unexpected_msgs=ignored_file_message):
93            self.start_node(0, extra_args=settings + ['-noconf'])
94        self.stop_node(0)
95
96        os.rename(conf_path.with_suffix('.confbkp'), conf_path)
97
98    def test_config_file_parser(self):
99        self.log.info('Test config file parser')
100
101        # Check that startup fails if conf= is set in bitcoin.conf or in an included conf file
102        bad_conf_file_path = self.nodes[0].datadir_path / "bitcoin_bad.conf"
103        util.write_config(bad_conf_file_path, n=0, chain='', extra_config='conf=some.conf\n')
104        conf_in_config_file_err = 'Error: Error reading configuration file: conf cannot be set in the configuration file; use includeconf= if you want to include additional config files'
105        self.nodes[0].assert_start_raises_init_error(
106            extra_args=[f'-conf={bad_conf_file_path}'],
107            expected_msg=conf_in_config_file_err,
108        )
109        inc_conf_file_path = self.nodes[0].datadir_path / 'include.conf'
110        with open(self.nodes[0].datadir_path / 'bitcoin.conf', 'a') as conf:
111            conf.write(f'includeconf={inc_conf_file_path}\n')
112        with open(inc_conf_file_path, 'w') as conf:
113            conf.write('conf=some.conf\n')
114        self.nodes[0].assert_start_raises_init_error(
115            expected_msg=conf_in_config_file_err,
116        )
117
118        self.nodes[0].assert_start_raises_init_error(
119            expected_msg='Error: Error parsing command line arguments: Invalid parameter -dash_cli=1',
120            extra_args=['-dash_cli=1'],
121        )
122        with open(inc_conf_file_path, 'w') as conf:
123            conf.write('dash_conf=1\n')
124
125        with self.nodes[0].assert_debug_log(expected_msgs=['Ignoring unknown configuration value dash_conf']):
126            self.start_node(0)
127        self.stop_node(0)
128
129        with open(inc_conf_file_path, 'w') as conf:
130            conf.write('reindex=1\n')
131
132        with self.nodes[0].assert_debug_log(expected_msgs=["[warning] reindex=1 is set in the configuration file, which will significantly slow down startup. Consider removing or commenting out this option for better performance, unless there is currently a condition which makes rebuilding the indexes necessary"]):
133            self.start_node(0)
134        self.stop_node(0)
135
136        with open(inc_conf_file_path, 'w') as conf:
137            conf.write('-dash=1\n')
138        self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Error reading configuration file: parse error on line 1: -dash=1, options in configuration file must be specified without leading -')
139
140        if self.is_wallet_compiled():
141            with open(inc_conf_file_path, 'w') as conf:
142                conf.write("wallet=foo\n")
143            self.nodes[0].assert_start_raises_init_error(expected_msg=f'Error: Config setting for -wallet only applied on {self.chain} network when in [{self.chain}] section.')
144
145        main_conf_file_path = self.nodes[0].datadir_path / "bitcoin_main.conf"
146        util.write_config(main_conf_file_path, n=0, chain='', extra_config=f'includeconf={inc_conf_file_path}\n')
147        with open(inc_conf_file_path, 'w') as conf:
148            conf.write('acceptnonstdtxn=1\n')
149        self.nodes[0].assert_start_raises_init_error(extra_args=[f"-conf={main_conf_file_path}", "-allowignoredconf"], expected_msg='Error: acceptnonstdtxn is not currently supported for main chain')
150
151        with open(inc_conf_file_path, 'w') as conf:
152            conf.write('nono\n')
153        self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Error reading configuration file: parse error on line 1: nono, if you intended to specify a negated option, use nono=1 instead')
154
155        with open(inc_conf_file_path, 'w') as conf:
156            conf.write('server=1\nrpcuser=someuser\nrpcpassword=some#pass')
157        self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Error reading configuration file: parse error on line 3, using # in rpcpassword can be ambiguous and should be avoided')
158
159        with open(inc_conf_file_path, 'w') as conf:
160            conf.write('server=1\nrpcuser=someuser\nmain.rpcpassword=some#pass')
161        self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Error reading configuration file: parse error on line 3, using # in rpcpassword can be ambiguous and should be avoided')
162
163        with open(inc_conf_file_path, 'w') as conf:
164            conf.write('server=1\nrpcuser=someuser\n[main]\nrpcpassword=some#pass')
165        self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Error reading configuration file: parse error on line 4, using # in rpcpassword can be ambiguous and should be avoided')
166
167        inc_conf_file2_path = self.nodes[0].datadir_path / 'include2.conf'
168        with open(self.nodes[0].datadir_path / 'bitcoin.conf', 'a') as conf:
169            conf.write(f'includeconf={inc_conf_file2_path}\n')
170
171        with open(inc_conf_file_path, 'w') as conf:
172            conf.write('testnot.datadir=1\n')
173        with open(inc_conf_file2_path, 'w') as conf:
174            conf.write('[testnet]\n')
175        self.restart_node(0)
176        self.nodes[0].stop_node(expected_stderr=f'Warning: {inc_conf_file_path}:1 Section [testnot] is not recognized.{os.linesep}{inc_conf_file2_path}:1 Section [testnet] is not recognized.')
177
178        with open(inc_conf_file_path, 'w') as conf:
179            conf.write('')  # clear
180        with open(inc_conf_file2_path, 'w') as conf:
181            conf.write('')  # clear
182
183    def test_config_file_log(self):
184        # Disable this test for windows currently because trying to override
185        # the default datadir through the environment does not seem to work.
186        if platform.system() == "Windows":
187            return
188
189        self.log.info('Test that correct configuration path is changed when configuration file changes the datadir')
190
191        # Create a temporary directory that will be treated as the default data
192        # directory by bitcoind.
193        env, default_datadir = util.get_temp_default_datadir(Path(self.options.tmpdir, "test_config_file_log"))
194        default_datadir.mkdir(parents=True)
195
196        # Write a bitcoin.conf file in the default data directory containing a
197        # datadir= line pointing at the node datadir.
198        node = self.nodes[0]
199        conf_text = node.bitcoinconf.read_text()
200        conf_path = default_datadir / "bitcoin.conf"
201        conf_path.write_text(f"datadir={node.datadir_path}\n{conf_text}")
202
203        # Drop the node -datadir= argument during this test, because if it is
204        # specified it would take precedence over the datadir setting in the
205        # config file.
206        node_args = node.args
207        node.args = [arg for arg in node.args if not arg.startswith("-datadir=")]
208
209        # Check that correct configuration file path is actually logged
210        # (conf_path, not node.bitcoinconf)
211        with self.nodes[0].assert_debug_log(expected_msgs=[f"Config file: {conf_path}"]):
212            self.start_node(0, ["-allowignoredconf"], env=env)
213            self.stop_node(0)
214
215        # Restore node arguments after the test
216        node.args = node_args
217
218    def test_invalid_command_line_options(self):
219        self.nodes[0].assert_start_raises_init_error(
220            expected_msg='Error: Error parsing command line arguments: Can not set -proxy with no value. Please specify value with -proxy=value.',
221            extra_args=['-proxy'],
222        )
223        # Provide a value different from 1 to the -wallet negated option
224        if self.is_wallet_compiled():
225            for value in [0, 'not_a_boolean']:
226                self.nodes[0].assert_start_raises_init_error(
227                    expected_msg="Error: Invalid value detected for '-wallet' or '-nowallet'. '-wallet' requires a string value, while '-nowallet' accepts only '1' to disable all wallets",
228                    extra_args=[f'-nowallet={value}'],
229                )
230
231    def test_log_buffer(self):
232        with self.nodes[0].assert_debug_log(expected_msgs=["[warning] Parsed potentially confusing double-negative -listen=0\n"]):
233            self.start_node(0, extra_args=['-nolisten=0'])
234        self.stop_node(0)
235
236    def test_args_log(self):
237        self.log.info('Test config args logging')
238        with self.nodes[0].assert_debug_log(
239                expected_msgs=[
240                    'Command-line arg: addnode="some.node"',
241                    'Command-line arg: rpcauth=****',
242                    'Command-line arg: rpcpassword=****',
243                    'Command-line arg: rpcuser=****',
244                    'Command-line arg: torpassword=****',
245                    f'Config file arg: {self.chain}="1"',
246                    f'Config file arg: [{self.chain}] server="1"',
247                ],
248                unexpected_msgs=[
249                    'alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc0',
250                    'secret-rpcuser',

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.