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,591 bytes · SHA-256 dd76b98f8761ae2a… · View upstream ↗

1// Copyright (c) 2012-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <common/args.h>
6#include <common/settings.h>
7#include <logging.h>
8#include <test/util/common.h>
9#include <test/util/setup_common.h>
10#include <univalue.h>
11#include <util/strencodings.h>
12
13#include <limits>
14#include <string>
15#include <utility>
16#include <vector>
17
18#include <boost/test/unit_test.hpp>
19
20using util::SplitString;
21
22BOOST_FIXTURE_TEST_SUITE(getarg_tests, BasicTestingSetup)
23
24void ResetArgs(ArgsManager& local_args, const std::string& strArg)
25{
26    std::vector<std::string> vecArg;
27    if (strArg.size()) {
28        vecArg = SplitString(strArg, ' ');
29    }
30
31    // Insert dummy executable name:
32    vecArg.insert(vecArg.begin(), "testbitcoin");
33
34    // Convert to char*:
35    std::vector<const char*> vecChar;
36    vecChar.reserve(vecArg.size());
37    for (const std::string& s : vecArg)
38        vecChar.push_back(s.c_str());
39
40    std::string error;
41    BOOST_CHECK(local_args.ParseParameters(vecChar.size(), vecChar.data(), error));
42}
43
44void SetupArgs(ArgsManager& local_args, const std::vector<std::pair<std::string, unsigned int>>& args)
45{
46    for (const auto& arg : args) {
47        local_args.AddArg(arg.first, "", arg.second, OptionsCategory::OPTIONS);
48    }
49}
50
51// Test behavior of GetArg functions when string, integer, and boolean types
52// are specified in the settings.json file. GetArg functions are convenience
53// functions. The GetSetting method can always be used instead of GetArg
54// methods to retrieve original values, and there's not always an objective
55// answer to what GetArg behavior is best in every case. This test makes sure
56// there's test coverage for whatever the current behavior is, so it's not
57// broken or changed unintentionally.
58BOOST_AUTO_TEST_CASE(setting_args)
59{
60    ArgsManager args;
61    SetupArgs(args, {{"-foo", ArgsManager::ALLOW_ANY}});
62
63    auto set_foo = [&](const common::SettingsValue& value) {
64      args.LockSettings([&](common::Settings& settings) {
65        settings.rw_settings["foo"] = value;
66      });
67    };
68
69    set_foo("str");
70    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"str\"");
71    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "str");
72    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
73    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
74    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
75
76    set_foo("99");
77    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"99\"");
78    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "99");
79    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 99);
80    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
81    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
82
83    set_foo("3.25");
84    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"3.25\"");
85    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "3.25");
86    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 3);
87    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
88    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
89
90    set_foo("0");
91    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"0\"");
92    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
93    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
94    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
95    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
96
97    set_foo("");
98    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"\"");
99    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "");
100    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
101    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
102    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
103
104    set_foo(99);
105    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "99");
106    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "99");
107    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 99);
108    BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
109    BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
110
111    set_foo(3.25);
112    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "3.25");
113    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "3.25");
114    BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
115    BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
116    BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
117
118    set_foo(0);
119    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "0");
120    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
121    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
122    BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
123    BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
124
125    set_foo(true);
126    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "true");
127    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "1");
128    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 1);
129    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
130    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
131
132    set_foo(false);
133    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "false");
134    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
135    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
136    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
137    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
138
139    set_foo(UniValue::VOBJ);
140    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "{}");
141    BOOST_CHECK_THROW(args.GetArg("foo", "default"), std::runtime_error);
142    BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
143    BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
144    BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
145
146    set_foo(UniValue::VARR);
147    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "[]");
148    BOOST_CHECK_THROW(args.GetArg("foo", "default"), std::runtime_error);
149    BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
150    BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
151    BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
152
153    set_foo(UniValue::VNULL);
154    BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "null");
155    BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "default");
156    BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 100);
157    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
158    BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
159}
160
161BOOST_AUTO_TEST_CASE(boolarg)
162{
163    ArgsManager local_args;
164
165    const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
166    SetupArgs(local_args, {foo});
167    ResetArgs(local_args, "-foo");
168    BOOST_CHECK(local_args.GetBoolArg("-foo", false));
169    BOOST_CHECK(local_args.GetBoolArg("-foo", true));
170
171    BOOST_CHECK(!local_args.GetBoolArg("-fo", false));
172    BOOST_CHECK(local_args.GetBoolArg("-fo", true));
173
174    BOOST_CHECK(!local_args.GetBoolArg("-fooo", false));
175    BOOST_CHECK(local_args.GetBoolArg("-fooo", true));
176
177    ResetArgs(local_args, "-foo=0");
178    BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
179    BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
180
181    ResetArgs(local_args, "-foo=1");
182    BOOST_CHECK(local_args.GetBoolArg("-foo", false));
183    BOOST_CHECK(local_args.GetBoolArg("-foo", true));
184
185    // New 0.6 feature: auto-map -nosomething to !-something:
186    ResetArgs(local_args, "-nofoo");
187    BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
188    BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
189
190    ResetArgs(local_args, "-nofoo=1");
191    BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
192    BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
193
194    ResetArgs(local_args, "-foo -nofoo"); // -nofoo should win
195    BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
196    BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
197
198    ResetArgs(local_args, "-foo=1 -nofoo=1"); // -nofoo should win
199    BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
200    BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
201
202    ResetArgs(local_args, "-foo=0 -nofoo=0"); // -nofoo=0 should win
203    BOOST_CHECK(local_args.GetBoolArg("-foo", false));
204    BOOST_CHECK(local_args.GetBoolArg("-foo", true));
205
206    // New 0.6 feature: treat -- same as -:
207    ResetArgs(local_args, "--foo=1");
208    BOOST_CHECK(local_args.GetBoolArg("-foo", false));
209    BOOST_CHECK(local_args.GetBoolArg("-foo", true));
210
211    ResetArgs(local_args, "--nofoo=1");
212    BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
213    BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
214}
215
216BOOST_AUTO_TEST_CASE(stringarg)
217{
218    ArgsManager local_args;
219
220    const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
221    const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
222    SetupArgs(local_args, {foo, bar});
223    ResetArgs(local_args, "");
224    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
225    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "eleven");
226
227    ResetArgs(local_args, "-foo -bar");
228    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
229    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "");
230
231    ResetArgs(local_args, "-foo=");
232    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
233    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "");
234
235    ResetArgs(local_args, "-foo=11");
236    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "11");
237    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "11");
238
239    ResetArgs(local_args, "-foo=eleven");
240    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "eleven");
241    BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "eleven");
242}
243
244BOOST_AUTO_TEST_CASE(intarg)
245{
246    ArgsManager local_args;
247
248    const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
249    const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
250    SetupArgs(local_args, {foo, bar});

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.