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.

47,454 bytes · SHA-256 528980fd43b5731d… · View upstream ↗

1// Copyright (c) 2011-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 <sync.h>
7#include <test/util/logging.h>
8#include <test/util/setup_common.h>
9#include <test/util/str.h>
10#include <univalue.h>
11#include <util/chaintype.h>
12#include <util/fs.h>
13#include <util/strencodings.h>
14
15#include <array>
16#include <optional>
17#include <cstdint>
18#include <cstring>
19#include <vector>
20
21#include <boost/test/unit_test.hpp>
22
23using util::ToString;
24
25BOOST_FIXTURE_TEST_SUITE(argsman_tests, BasicTestingSetup)
26
27BOOST_AUTO_TEST_CASE(util_datadir)
28{
29    // Use local args variable instead of m_args to avoid making assumptions about test setup
30    ArgsManager args;
31    args.ForceSetArg("-datadir", fs::PathToString(m_path_root));
32
33    const fs::path dd_norm = args.GetDataDirBase();
34
35    args.ForceSetArg("-datadir", fs::PathToString(dd_norm) + "/");
36    args.ClearPathCache();
37    BOOST_CHECK_EQUAL(dd_norm, args.GetDataDirBase());
38
39    args.ForceSetArg("-datadir", fs::PathToString(dd_norm) + "/.");
40    args.ClearPathCache();
41    BOOST_CHECK_EQUAL(dd_norm, args.GetDataDirBase());
42
43    args.ForceSetArg("-datadir", fs::PathToString(dd_norm) + "/./");
44    args.ClearPathCache();
45    BOOST_CHECK_EQUAL(dd_norm, args.GetDataDirBase());
46
47    args.ForceSetArg("-datadir", fs::PathToString(dd_norm) + "/.//");
48    args.ClearPathCache();
49    BOOST_CHECK_EQUAL(dd_norm, args.GetDataDirBase());
50}
51
52struct TestArgsManager : public ArgsManager
53{
54    void ReadConfigString(const std::string& str_config)
55    {
56        BOOST_REQUIRE(ArgsManager::ReadConfigString(str_config));
57    }
58    void SetupArgs(const std::vector<std::pair<std::string, unsigned int>>& args)
59    {
60        for (const auto& arg : args) {
61            AddArg(arg.first, "", arg.second, OptionsCategory::OPTIONS);
62        }
63    }
64
65    // make protected methods available for testing
66    using ArgsManager::ReadConfigStream;
67};
68
69//! Test GetSetting and GetArg type coercion, negation, and default value handling.
70class CheckValueTest : public TestChain100Setup
71{
72public:
73    struct Expect {
74        common::SettingsValue setting;
75        bool default_string = false;
76        bool default_int = false;
77        bool default_bool = false;
78        const char* string_value = nullptr;
79        std::optional<int64_t> int_value;
80        std::optional<bool> bool_value;
81        std::optional<std::vector<std::string>> list_value;
82        const char* error = nullptr;
83
84        explicit Expect(common::SettingsValue s) : setting(std::move(s)) {}
85        Expect& DefaultString() { default_string = true; return *this; }
86        Expect& DefaultInt() { default_int = true; return *this; }
87        Expect& DefaultBool() { default_bool = true; return *this; }
88        Expect& String(const char* s) { string_value = s; return *this; }
89        Expect& Int(int64_t i) { int_value = i; return *this; }
90        Expect& Bool(bool b) { bool_value = b; return *this; }
91        Expect& List(std::vector<std::string> m) { list_value = std::move(m); return *this; }
92        Expect& Error(const char* e) { error = e; return *this; }
93    };
94
95    void CheckValue(unsigned int flags, const char* arg, const Expect& expect)
96    {
97        TestArgsManager test;
98        test.SetupArgs({{"-value", flags}});
99        const char* argv[] = {"ignored", arg};
100        std::string error;
101        bool success = test.ParseParameters(arg ? 2 : 1, argv, error);
102
103        BOOST_CHECK_EQUAL(test.GetSetting("-value").write(), expect.setting.write());
104        auto settings_list = test.GetSettingsList("-value");
105        if (expect.setting.isNull() || expect.setting.isFalse()) {
106            BOOST_CHECK_EQUAL(settings_list.size(), 0U);
107        } else {
108            BOOST_CHECK_EQUAL(settings_list.size(), 1U);
109            BOOST_CHECK_EQUAL(settings_list[0].write(), expect.setting.write());
110        }
111
112        if (expect.error) {
113            BOOST_CHECK(!success);
114            BOOST_CHECK_NE(error.find(expect.error), std::string::npos);
115        } else {
116            BOOST_CHECK(success);
117            BOOST_CHECK_EQUAL(error, "");
118        }
119
120        if (expect.default_string) {
121            BOOST_CHECK_EQUAL(test.GetArg("-value", "zzzzz"), "zzzzz");
122        } else if (expect.string_value) {
123            BOOST_CHECK_EQUAL(test.GetArg("-value", "zzzzz"), expect.string_value);
124        } else {
125            BOOST_CHECK(!success);
126        }
127
128        if (expect.default_int) {
129            BOOST_CHECK_EQUAL(test.GetIntArg("-value", 99999), 99999);
130        } else if (expect.int_value) {
131            BOOST_CHECK_EQUAL(test.GetIntArg("-value", 99999), *expect.int_value);
132        } else {
133            BOOST_CHECK(!success);
134        }
135
136        if (expect.default_bool) {
137            BOOST_CHECK_EQUAL(test.GetBoolArg("-value", false), false);
138            BOOST_CHECK_EQUAL(test.GetBoolArg("-value", true), true);
139        } else if (expect.bool_value) {
140            BOOST_CHECK_EQUAL(test.GetBoolArg("-value", false), *expect.bool_value);
141            BOOST_CHECK_EQUAL(test.GetBoolArg("-value", true), *expect.bool_value);
142        } else {
143            BOOST_CHECK(!success);
144        }
145
146        if (expect.list_value) {
147            auto l = test.GetArgs("-value");
148            BOOST_CHECK_EQUAL_COLLECTIONS(l.begin(), l.end(), expect.list_value->begin(), expect.list_value->end());
149        } else {
150            BOOST_CHECK(!success);
151        }
152    }
153};
154
155BOOST_FIXTURE_TEST_CASE(util_CheckValue, CheckValueTest)
156{
157    using M = ArgsManager;
158
159    CheckValue(M::ALLOW_ANY, nullptr, Expect{{}}.DefaultString().DefaultInt().DefaultBool().List({}));
160    CheckValue(M::ALLOW_ANY, "-novalue", Expect{false}.String("0").Int(0).Bool(false).List({}));
161    CheckValue(M::ALLOW_ANY, "-novalue=", Expect{false}.String("0").Int(0).Bool(false).List({}));
162    CheckValue(M::ALLOW_ANY, "-novalue=0", Expect{true}.String("1").Int(1).Bool(true).List({"1"}));
163    CheckValue(M::ALLOW_ANY, "-novalue=1", Expect{false}.String("0").Int(0).Bool(false).List({}));
164    CheckValue(M::ALLOW_ANY, "-novalue=2", Expect{false}.String("0").Int(0).Bool(false).List({}));
165    CheckValue(M::ALLOW_ANY, "-novalue=abc", Expect{true}.String("1").Int(1).Bool(true).List({"1"}));
166    CheckValue(M::ALLOW_ANY, "-value", Expect{""}.String("").Int(0).Bool(true).List({""}));
167    CheckValue(M::ALLOW_ANY, "-value=", Expect{""}.String("").Int(0).Bool(true).List({""}));
168    CheckValue(M::ALLOW_ANY, "-value=0", Expect{"0"}.String("0").Int(0).Bool(false).List({"0"}));
169    CheckValue(M::ALLOW_ANY, "-value=1", Expect{"1"}.String("1").Int(1).Bool(true).List({"1"}));
170    CheckValue(M::ALLOW_ANY, "-value=2", Expect{"2"}.String("2").Int(2).Bool(true).List({"2"}));
171    CheckValue(M::ALLOW_ANY, "-value=abc", Expect{"abc"}.String("abc").Int(0).Bool(false).List({"abc"}));
172}
173
174struct NoIncludeConfTest {
175    std::string Parse(const char* arg)
176    {
177        TestArgsManager test;
178        test.SetupArgs({{"-includeconf", ArgsManager::ALLOW_ANY}});
179        std::array argv{"ignored", arg};
180        std::string error;
181        (void)test.ParseParameters(argv.size(), argv.data(), error);
182        return error;
183    }
184};
185
186BOOST_FIXTURE_TEST_CASE(util_NoIncludeConf, NoIncludeConfTest)
187{
188    BOOST_CHECK_EQUAL(Parse("-noincludeconf"), "");
189    BOOST_CHECK_EQUAL(Parse("-includeconf"), "-includeconf cannot be used from commandline; -includeconf=\"\"");
190    BOOST_CHECK_EQUAL(Parse("-includeconf=file"), "-includeconf cannot be used from commandline; -includeconf=\"file\"");
191}
192
193BOOST_AUTO_TEST_CASE(util_ParseParameters)
194{
195    TestArgsManager testArgs;
196    const auto a = std::make_pair("-a", ArgsManager::ALLOW_ANY);
197    const auto b = std::make_pair("-b", ArgsManager::ALLOW_ANY);
198    const auto ccc = std::make_pair("-ccc", ArgsManager::ALLOW_ANY);
199    const auto d = std::make_pair("-d", ArgsManager::ALLOW_ANY);
200
201    const char *argv_test[] = {"-ignored", "-a", "-b", "-ccc=argument", "-ccc=multiple", "f", "-d=e"};
202
203    std::string error;
204    testArgs.SetupArgs({a, b, ccc, d});
205    BOOST_CHECK(testArgs.ParseParameters(0, argv_test, error));
206    testArgs.LockSettings([&](const common::Settings& s) {
207        BOOST_CHECK(s.command_line_options.empty());
208        BOOST_CHECK(s.ro_config.empty());
209    });
210
211    BOOST_CHECK(testArgs.ParseParameters(1, argv_test, error));
212    testArgs.LockSettings([&](const common::Settings& s) {
213        BOOST_CHECK(s.command_line_options.empty());
214        BOOST_CHECK(s.ro_config.empty());
215    });
216
217    BOOST_CHECK(testArgs.ParseParameters(7, argv_test, error));
218    // expectation: -ignored is ignored (program name argument),
219    // -a, -b and -ccc end up in map, -d ignored because it is after
220    // a non-option argument (non-GNU option parsing)
221    BOOST_CHECK(testArgs.IsArgSet("-a"));
222    BOOST_CHECK(testArgs.IsArgSet("-b"));
223    BOOST_CHECK(testArgs.IsArgSet("-ccc"));
224    BOOST_CHECK(!testArgs.IsArgSet("f"));
225    BOOST_CHECK(!testArgs.IsArgSet("-d"));
226    testArgs.LockSettings([&](const common::Settings& s) {
227        BOOST_CHECK(s.command_line_options.size() == 3);
228        BOOST_CHECK(s.ro_config.empty());
229        BOOST_CHECK(s.command_line_options.contains("a"));
230        BOOST_CHECK(s.command_line_options.contains("b"));
231        BOOST_CHECK(s.command_line_options.contains("ccc"));
232        BOOST_CHECK(!s.command_line_options.contains("f"));
233        BOOST_CHECK(!s.command_line_options.contains("d"));
234
235        BOOST_CHECK(s.command_line_options.at("a").size() == 1);
236        BOOST_CHECK(s.command_line_options.at("a").front().get_str() == "");
237        BOOST_CHECK(s.command_line_options.at("ccc").size() == 2);
238        BOOST_CHECK(s.command_line_options.at("ccc").front().get_str() == "argument");
239        BOOST_CHECK(s.command_line_options.at("ccc").back().get_str() == "multiple");
240    });
241    BOOST_CHECK(testArgs.GetArgs("-ccc").size() == 2);
242}
243
244BOOST_AUTO_TEST_CASE(util_ParseInvalidParameters)
245{
246    TestArgsManager test;
247    test.SetupArgs({{"-registered", ArgsManager::ALLOW_ANY}});
248
249    const char* argv[] = {"ignored", "-registered"};
250    std::string error;

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.