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.

6,058 bytes · SHA-256 1f99af14d266e30a… · View upstream ↗

1// Copyright (c) 2017 Pieter Wuille
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
6#include <bech32.h>
7#include <util/strencodings.h>
8
9#include <boost/test/unit_test.hpp>
10
11#include <string>
12
13BOOST_AUTO_TEST_SUITE(bech32_tests)
14
15BOOST_AUTO_TEST_CASE(bech32_testvectors_valid)
16{
17    static const std::string CASES[] = {
18        "A12UEL5L",
19        "a12uel5l",
20        "an83characterlonghumanreadablepartthatcontainsthenumber1andtheexcludedcharactersbio1tt5tgs",
21        "abcdef1qpzry9x8gf2tvdw0s3jn54khce6mua7lmqqqxw",
22        "11qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqc8247j",
23        "split1checkupstagehandshakeupstreamerranterredcaperred2y9e3w",
24        "?1ezyfcl",
25    };
26    for (const std::string& str : CASES) {
27        const auto dec = bech32::Decode(str);
28        BOOST_CHECK(dec.encoding == bech32::Encoding::BECH32);
29        std::string recode = bech32::Encode(bech32::Encoding::BECH32, dec.hrp, dec.data);
30        BOOST_CHECK(!recode.empty());
31        BOOST_CHECK(CaseInsensitiveEqual(str, recode));
32    }
33}
34
35BOOST_AUTO_TEST_CASE(bech32m_testvectors_valid)
36{
37    static const std::string CASES[] = {
38        "A1LQFN3A",
39        "a1lqfn3a",
40        "an83characterlonghumanreadablepartthatcontainsthetheexcludedcharactersbioandnumber11sg7hg6",
41        "abcdef1l7aum6echk45nj3s0wdvt2fg8x9yrzpqzd3ryx",
42        "11llllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllludsr8",
43        "split1checkupstagehandshakeupstreamerranterredcaperredlc445v",
44        "?1v759aa"
45    };
46    for (const std::string& str : CASES) {
47        const auto dec = bech32::Decode(str);
48        BOOST_CHECK(dec.encoding == bech32::Encoding::BECH32M);
49        std::string recode = bech32::Encode(bech32::Encoding::BECH32M, dec.hrp, dec.data);
50        BOOST_CHECK(!recode.empty());
51        BOOST_CHECK(CaseInsensitiveEqual(str, recode));
52    }
53}
54
55BOOST_AUTO_TEST_CASE(bech32_testvectors_invalid)
56{
57    static const std::string CASES[] = {
58        " 1nwldj5",
59        "\x7f""1axkwrx",
60        "\x80""1eym55h",
61        "an84characterslonghumanreadablepartthatcontainsthenumber1andtheexcludedcharactersbio1569pvx",
62        "pzry9x0s0muk",
63        "1pzry9x0s0muk",
64        "x1b4n0q5v",
65        "li1dgmt3",
66        "de1lg7wt\xff",
67        "A1G7SGD8",
68        "10a06t8",
69        "1qzzfhee",
70        "a12UEL5L",
71        "A12uEL5L",
72        "abcdef1qpzrz9x8gf2tvdw0s3jn54khce6mua7lmqqqxw",
73        "test1zg69w7y6hn0aqy352euf40x77qddq3dc",
74        std::string(100, 'q'),
75    };
76    static const std::pair<std::string, std::vector<int>> ERRORS[] = {
77        {"Invalid character or mixed case", {0}},
78        {"Invalid character or mixed case", {0}},
79        {"Invalid character or mixed case", {0}},
80        {"Bech32 string too long", {90}},
81        {"Missing separator", {}},
82        {"Invalid separator position", {0}},
83        {"Invalid Base 32 character", {2}},
84        {"Invalid separator position", {2}},
85        {"Invalid character or mixed case", {8}},
86        {"Invalid checksum", {}}, // The checksum is calculated using the uppercase form so the entire string is invalid, not just a few characters
87        {"Invalid separator position", {0}},
88        {"Invalid separator position", {0}},
89        {"Invalid character or mixed case", {3, 4, 5, 7}},
90        {"Invalid character or mixed case", {3}},
91        {"Invalid Bech32 checksum", {11}},
92        {"Invalid Bech32 checksum", {9, 16}},
93        {"Bech32 string too long", {90}},
94    };
95    static_assert(std::size(CASES) == std::size(ERRORS), "Bech32 CASES and ERRORS should have the same length");
96
97    int i = 0;
98    for (const std::string& str : CASES) {
99        const auto& err = ERRORS[i];
100        const auto dec = bech32::Decode(str);
101        BOOST_CHECK(dec.encoding == bech32::Encoding::INVALID);
102        auto [error, error_locations] = bech32::LocateErrors(str);
103        BOOST_CHECK_EQUAL(err.first, error);
104        BOOST_CHECK(err.second == error_locations);
105        i++;
106    }
107}
108
109BOOST_AUTO_TEST_CASE(bech32m_testvectors_invalid)
110{
111    static const std::string CASES[] = {
112        " 1xj0phk",
113        "\x7f""1g6xzxy",
114        "\x80""1vctc34",
115        "an84characterslonghumanreadablepartthatcontainsthetheexcludedcharactersbioandnumber11d6pts4",
116        "qyrz8wqd2c9m",
117        "1qyrz8wqd2c9m",
118        "y1b0jsk6g",
119        "lt1igcx5c0",
120        "in1muywd",
121        "mm1crxm3i",
122        "au1s5cgom",
123        "M1VUXWEZ",
124        "16plkw9",
125        "1p2gdwpf",
126        "abcdef1l7aum6echk45nj2s0wdvt2fg8x9yrzpqzd3ryx",
127        "test1zg69v7y60n00qy352euf40x77qcusag6",
128    };
129    static const std::pair<std::string, std::vector<int>> ERRORS[] = {
130        {"Invalid character or mixed case", {0}},
131        {"Invalid character or mixed case", {0}},
132        {"Invalid character or mixed case", {0}},
133        {"Bech32 string too long", {90}},
134        {"Missing separator", {}},
135        {"Invalid separator position", {0}},
136        {"Invalid Base 32 character", {2}},
137        {"Invalid Base 32 character", {3}},
138        {"Invalid separator position", {2}},
139        {"Invalid Base 32 character", {8}},
140        {"Invalid Base 32 character", {7}},
141        {"Invalid checksum", {}},
142        {"Invalid separator position", {0}},
143        {"Invalid separator position", {0}},
144        {"Invalid Bech32m checksum", {21}},
145        {"Invalid Bech32m checksum", {13, 32}},
146    };
147    static_assert(std::size(CASES) == std::size(ERRORS), "Bech32m CASES and ERRORS should have the same length");
148
149    int i = 0;
150    for (const std::string& str : CASES) {
151        const auto& err = ERRORS[i];
152        const auto dec = bech32::Decode(str);
153        BOOST_CHECK(dec.encoding == bech32::Encoding::INVALID);
154        auto [error, error_locations] = bech32::LocateErrors(str);
155        BOOST_CHECK_EQUAL(err.first, error);
156        BOOST_CHECK(err.second == error_locations);
157        i++;
158    }
159}
160
161BOOST_AUTO_TEST_SUITE_END()
162

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.