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.

84,636 bytes · SHA-256 6ed9c8e5344c3b13… · 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 <clientversion.h>
6#include <common/signmessage.h>
7#include <compat/compat.h>
8#include <hash.h>
9#include <key.h>
10#include <script/parsing.h>
11#include <span.h>
12#include <sync.h>
13#include <test/util/common.h>
14#include <test/util/random.h>
15#include <test/util/setup_common.h>
16#include <test/util/time.h>
17#include <uint256.h>
18#include <univalue.h>
19#include <util/bitdeque.h>
20#include <util/byte_units.h>
21#include <util/fs.h>
22#include <util/fs_helpers.h>
23#include <util/moneystr.h>
24#include <util/overflow.h>
25#include <util/readwritefile.h>
26#include <util/strencodings.h>
27#include <util/string.h>
28#include <util/time.h>
29#include <util/tokenbucket.h>
30#include <util/vector.h>
31
32#include <array>
33#include <cmath>
34#include <cstdint>
35#include <cstring>
36#include <fstream>
37#include <limits>
38#include <map>
39#include <optional>
40#include <string>
41#include <thread>
42#include <type_traits>
43#include <utility>
44#include <vector>
45
46#include <sys/types.h>
47
48#ifndef WIN32
49#include <sys/wait.h>
50#endif
51
52#include <boost/test/unit_test.hpp>
53
54using namespace std::literals;
55using namespace util::hex_literals;
56using util::ConstevalHexDigit;
57using util::Join;
58using util::RemovePrefix;
59using util::RemovePrefixView;
60using util::ReplaceAll;
61using util::Split;
62using util::SplitString;
63using util::TrimString;
64using util::TrimStringView;
65
66static const std::string STRING_WITH_EMBEDDED_NULL_CHAR{"1"s "\0" "1"s};
67
68/* defined in logging.cpp */
69namespace BCLog {
70    std::string LogEscapeMessage(std::string_view str);
71}
72
73BOOST_FIXTURE_TEST_SUITE(util_tests, BasicTestingSetup)
74
75namespace {
76class NoCopyOrMove
77{
78public:
79    int i;
80    explicit NoCopyOrMove(int i) : i{i} { }
81
82    NoCopyOrMove() = delete;
83    NoCopyOrMove(const NoCopyOrMove&) = delete;
84    NoCopyOrMove(NoCopyOrMove&&) = delete;
85    NoCopyOrMove& operator=(const NoCopyOrMove&) = delete;
86    NoCopyOrMove& operator=(NoCopyOrMove&&) = delete;
87
88    operator bool() const { return i != 0; }
89
90    int get_ip1() { return i + 1; }
91    bool test()
92    {
93        // Check that Assume can be used within a lambda and still call methods
94        [&]() { Assume(get_ip1()); }();
95        return Assume(get_ip1() != 5);
96    }
97};
98} // namespace
99
100BOOST_AUTO_TEST_CASE(util_check)
101{
102    // Check that Assert can forward
103    const std::unique_ptr<int> p_two = Assert(std::make_unique<int>(2));
104    // Check that Assert works on lvalues and rvalues
105    const int two = *Assert(p_two);
106    Assert(two == 2);
107    Assert(true);
108    // Check that Assume can be used as unary expression
109    const bool result{Assume(two == 2)};
110    Assert(result);
111
112    // Check that Assert doesn't require copy/move
113    NoCopyOrMove x{9};
114    Assert(x).i += 3;
115    Assert(x).test();
116
117    // Check nested Asserts
118    BOOST_CHECK_EQUAL(Assert((Assert(x).test() ? 3 : 0)), 3);
119
120    // Check -Wdangling-gsl does not trigger when copying the int. (It would
121    // trigger on "const int&")
122    const int nine{*Assert(std::optional<int>{9})};
123    BOOST_CHECK_EQUAL(9, nine);
124}
125
126BOOST_AUTO_TEST_CASE(util_criticalsection)
127{
128    RecursiveMutex cs;
129
130    do {
131        LOCK(cs);
132        break;
133
134        BOOST_ERROR("break was swallowed!");
135    } while(0);
136
137    do {
138        TRY_LOCK(cs, lockTest);
139        if (lockTest) {
140            BOOST_CHECK(true); // Needed to suppress "Test case [...] did not check any assertions"
141            break;
142        }
143
144        BOOST_ERROR("break was swallowed!");
145    } while(0);
146}
147
148constexpr char HEX_PARSE_INPUT[] = "04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5f";
149constexpr uint8_t HEX_PARSE_OUTPUT[] = {
150    0x04, 0x67, 0x8a, 0xfd, 0xb0, 0xfe, 0x55, 0x48, 0x27, 0x19, 0x67, 0xf1, 0xa6, 0x71, 0x30, 0xb7,
151    0x10, 0x5c, 0xd6, 0xa8, 0x28, 0xe0, 0x39, 0x09, 0xa6, 0x79, 0x62, 0xe0, 0xea, 0x1f, 0x61, 0xde,
152    0xb6, 0x49, 0xf6, 0xbc, 0x3f, 0x4c, 0xef, 0x38, 0xc4, 0xf3, 0x55, 0x04, 0xe5, 0x1e, 0xc1, 0x12,
153    0xde, 0x5c, 0x38, 0x4d, 0xf7, 0xba, 0x0b, 0x8d, 0x57, 0x8a, 0x4c, 0x70, 0x2b, 0x6b, 0xf1, 0x1d,
154    0x5f
155};
156static_assert((sizeof(HEX_PARSE_INPUT) - 1) == 2 * sizeof(HEX_PARSE_OUTPUT));
157BOOST_AUTO_TEST_CASE(parse_hex)
158{
159    std::vector<unsigned char> result;
160
161    // Basic test vector
162    std::vector<unsigned char> expected(std::begin(HEX_PARSE_OUTPUT), std::end(HEX_PARSE_OUTPUT));
163    constexpr std::array<std::byte, 65> hex_literal_array{operator""_hex<util::detail::Hex(HEX_PARSE_INPUT)>()};
164    auto hex_literal_span{MakeUCharSpan(hex_literal_array)};
165    BOOST_CHECK_EQUAL_COLLECTIONS(hex_literal_span.begin(), hex_literal_span.end(), expected.begin(), expected.end());
166
167    const std::vector<std::byte> hex_literal_vector{operator""_hex_v<util::detail::Hex(HEX_PARSE_INPUT)>()};
168    auto hex_literal_vec_span = MakeUCharSpan(hex_literal_vector);
169    BOOST_CHECK_EQUAL_COLLECTIONS(hex_literal_vec_span.begin(), hex_literal_vec_span.end(), expected.begin(), expected.end());
170
171    constexpr std::array<uint8_t, 65> hex_literal_array_uint8{operator""_hex_u8<util::detail::Hex(HEX_PARSE_INPUT)>()};
172    BOOST_CHECK_EQUAL_COLLECTIONS(hex_literal_array_uint8.begin(), hex_literal_array_uint8.end(), expected.begin(), expected.end());
173
174    result = operator""_hex_v_u8<util::detail::Hex(HEX_PARSE_INPUT)>();
175    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
176
177    result = ParseHex(HEX_PARSE_INPUT);
178    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
179
180    result = TryParseHex<uint8_t>(HEX_PARSE_INPUT).value();
181    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
182
183    // Spaces between bytes must be supported
184    expected = {0x12, 0x34, 0x56, 0x78};
185    result = ParseHex("12 34 56 78");
186    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
187    result = TryParseHex<uint8_t>("12 34 56 78").value();
188    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
189
190    // Leading space must be supported
191    expected = {0x89, 0x34, 0x56, 0x78};
192    result = ParseHex(" 89 34 56 78");
193    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
194    result = TryParseHex<uint8_t>(" 89 34 56 78").value();
195    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
196
197    // Mixed case and spaces are supported
198    expected = {0xff, 0xaa};
199    result = ParseHex("     Ff        aA    ");
200    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
201    result = TryParseHex<uint8_t>("     Ff        aA    ").value();
202    BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
203
204    // Empty string is supported
205    static_assert(""_hex.empty());
206    static_assert(""_hex_u8.empty());
207    BOOST_CHECK_EQUAL(""_hex_v.size(), 0);
208    BOOST_CHECK_EQUAL(""_hex_v_u8.size(), 0);
209    BOOST_CHECK_EQUAL(ParseHex("").size(), 0);
210    BOOST_CHECK_EQUAL(TryParseHex<uint8_t>("").value().size(), 0);
211
212    // Spaces between nibbles is treated as invalid
213    BOOST_CHECK_EQUAL(ParseHex("AAF F").size(), 0);
214    BOOST_CHECK(!TryParseHex("AAF F").has_value());
215
216    // Embedded null is treated as invalid
217    const std::string with_embedded_null{" 11 "s
218                                         " \0 "
219                                         " 22 "s};
220    BOOST_CHECK_EQUAL(with_embedded_null.size(), 11);
221    BOOST_CHECK_EQUAL(ParseHex(with_embedded_null).size(), 0);
222    BOOST_CHECK(!TryParseHex(with_embedded_null).has_value());
223
224    // Non-hex is treated as invalid
225    BOOST_CHECK_EQUAL(ParseHex("1234 invalid 1234").size(), 0);
226    BOOST_CHECK(!TryParseHex("1234 invalid 1234").has_value());
227
228    // Truncated input is treated as invalid
229    BOOST_CHECK_EQUAL(ParseHex("12 3").size(), 0);
230    BOOST_CHECK(!TryParseHex("12 3").has_value());
231}
232
233BOOST_AUTO_TEST_CASE(consteval_hex_digit)
234{
235    BOOST_CHECK_EQUAL(ConstevalHexDigit('0'), 0);
236    BOOST_CHECK_EQUAL(ConstevalHexDigit('9'), 9);
237    BOOST_CHECK_EQUAL(ConstevalHexDigit('a'), 0xa);
238    BOOST_CHECK_EQUAL(ConstevalHexDigit('f'), 0xf);
239}
240
241BOOST_AUTO_TEST_CASE(util_HexStr)
242{
243    BOOST_CHECK_EQUAL(HexStr(HEX_PARSE_OUTPUT), HEX_PARSE_INPUT);
244    BOOST_CHECK_EQUAL(HexStr(std::span{HEX_PARSE_OUTPUT}.last(0)), "");
245    BOOST_CHECK_EQUAL(HexStr(std::span{HEX_PARSE_OUTPUT}.first(0)), "");
246
247    {
248        constexpr std::string_view out_exp{"04678afdb0"};
249        constexpr std::span in_s{HEX_PARSE_OUTPUT, out_exp.size() / 2};
250        const std::span<const uint8_t> in_u{MakeUCharSpan(in_s)};

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.