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.

12,187 bytes · SHA-256 57cbdcd5140a9fab… · View upstream ↗

1// Copyright (c) 2018-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 <boost/test/unit_test.hpp>
6
7#include <test/util/common.h>
8#include <test/util/setup_common.h>
9#include <util/check.h>
10#include <util/fs.h>
11#include <util/translation.h>
12#include <wallet/sqlite.h>
13#include <wallet/migrate.h>
14#include <wallet/test/util.h>
15#include <wallet/walletutil.h>
16
17#include <cstddef>
18#include <memory>
19#include <span>
20#include <string>
21#include <string_view>
22#include <utility>
23#include <vector>
24
25inline std::ostream& operator<<(std::ostream& os, const std::pair<const SerializeData, SerializeData>& kv)
26{
27    std::span key{kv.first}, value{kv.second};
28    os << "(\"" << std::string_view{reinterpret_cast<const char*>(key.data()), key.size()} << "\", \""
29       << std::string_view{reinterpret_cast<const char*>(value.data()), value.size()} << "\")";
30    return os;
31}
32
33namespace wallet {
34
35inline std::span<const std::byte> StringBytes(std::string_view str)
36{
37    return std::as_bytes(std::span{str});
38}
39
40static SerializeData StringData(std::string_view str)
41{
42    auto bytes = StringBytes(str);
43    return SerializeData{bytes.begin(), bytes.end()};
44}
45
46static void CheckPrefix(DatabaseBatch& batch, std::span<const std::byte> prefix, MockableData expected)
47{
48    std::unique_ptr<DatabaseCursor> cursor = batch.GetNewPrefixCursor(prefix);
49    MockableData actual;
50    while (true) {
51        DataStream key, value;
52        DatabaseCursor::Status status = cursor->Next(key, value);
53        if (status == DatabaseCursor::Status::DONE) break;
54        BOOST_CHECK(status == DatabaseCursor::Status::MORE);
55        BOOST_CHECK(
56            actual.emplace(SerializeData(key.begin(), key.end()), SerializeData(value.begin(), value.end())).second);
57    }
58    BOOST_CHECK_EQUAL_COLLECTIONS(actual.begin(), actual.end(), expected.begin(), expected.end());
59}
60
61BOOST_FIXTURE_TEST_SUITE(db_tests, BasicTestingSetup)
62
63static std::vector<std::unique_ptr<WalletDatabase>> TestDatabases(const fs::path& path_root)
64{
65    std::vector<std::unique_ptr<WalletDatabase>> dbs;
66    DatabaseOptions options;
67    DatabaseStatus status;
68    bilingual_str error;
69    // Unable to test BerkeleyRO since we cannot create a new BDB database to open
70    dbs.emplace_back(MakeSQLiteDatabase(path_root / "sqlite", options, status, error));
71    dbs.emplace_back(CreateMockableWalletDatabase());
72    return dbs;
73}
74
75BOOST_AUTO_TEST_CASE(db_cursor_prefix_range_test)
76{
77    // Test each supported db
78    for (const auto& database : TestDatabases(m_path_root)) {
79        std::vector<std::string> prefixes = {"", "FIRST", "SECOND", "P\xfe\xff", "P\xff\x01", "\xff\xff"};
80
81        std::unique_ptr<DatabaseBatch> handler = Assert(database)->MakeBatch();
82        // Write elements to it
83        for (unsigned int i = 0; i < 10; i++) {
84            for (const auto& prefix : prefixes) {
85                BOOST_CHECK(handler->Write(std::make_pair(prefix, i), i));
86            }
87        }
88
89        // Now read all the items by prefix and verify that each element gets parsed correctly
90        for (const auto& prefix : prefixes) {
91            DataStream s_prefix;
92            s_prefix << prefix;
93            std::unique_ptr<DatabaseCursor> cursor = handler->GetNewPrefixCursor(s_prefix);
94            DataStream key;
95            DataStream value;
96            for (int i = 0; i < 10; i++) {
97                DatabaseCursor::Status status = cursor->Next(key, value);
98                BOOST_CHECK_EQUAL(status, DatabaseCursor::Status::MORE);
99
100                std::string key_back;
101                unsigned int i_back;
102                key >> key_back >> i_back;
103                BOOST_CHECK_EQUAL(key_back, prefix);
104
105                unsigned int value_back;
106                value >> value_back;
107                BOOST_CHECK_EQUAL(value_back, i_back);
108            }
109
110            // Let's now read it once more, it should return DONE
111            BOOST_CHECK(cursor->Next(key, value) == DatabaseCursor::Status::DONE);
112        }
113        handler.reset();
114        database->Close();
115    }
116}
117
118// Lower level DatabaseBase::GetNewPrefixCursor test, to cover cases that aren't
119// covered in the higher level test above. The higher level test uses
120// serialized strings which are prefixed with string length, so it doesn't test
121// truly empty prefixes or prefixes that begin with \xff
122BOOST_AUTO_TEST_CASE(db_cursor_prefix_byte_test)
123{
124    const MockableData::value_type
125        e{StringData(""), StringData("e")},
126        p{StringData("prefix"), StringData("p")},
127        ps{StringData("prefixsuffix"), StringData("ps")},
128        f{StringData("\xff"), StringData("f")},
129        fs{StringData("\xffsuffix"), StringData("fs")},
130        ff{StringData("\xff\xff"), StringData("ff")},
131        ffs{StringData("\xff\xffsuffix"), StringData("ffs")};
132    for (const auto& database : TestDatabases(m_path_root)) {
133        std::unique_ptr<DatabaseBatch> batch = database->MakeBatch();
134
135        // Write elements to it if not berkeleyro
136        for (const auto& [k, v] : {e, p, ps, f, fs, ff, ffs}) {
137            batch->Write(std::span{k}, std::span{v});
138        }
139
140        CheckPrefix(*batch, StringBytes(""), {e, p, ps, f, fs, ff, ffs});
141        CheckPrefix(*batch, StringBytes("prefix"), {p, ps});
142        CheckPrefix(*batch, StringBytes("\xff"), {f, fs, ff, ffs});
143        CheckPrefix(*batch, StringBytes("\xff\xff"), {ff, ffs});
144        batch.reset();
145        database->Close();
146    }
147}
148
149BOOST_AUTO_TEST_CASE(db_availability_after_write_error)
150{
151    // Ensures the database remains accessible without deadlocking after a write error.
152    // To simulate the behavior, record overwrites are disallowed, and the test verifies
153    // that the database remains active after failing to store an existing record.
154    for (const auto& database : TestDatabases(m_path_root)) {
155        // Write original record
156        std::unique_ptr<DatabaseBatch> batch = database->MakeBatch();
157        std::string key = "key";
158        std::string value = "value";
159        std::string value2 = "value_2";
160        BOOST_CHECK(batch->Write(key, value));
161        // Attempt to overwrite the record (expect failure)
162        BOOST_CHECK(!batch->Write(key, value2, /*fOverwrite=*/false));
163        // Successfully overwrite the record
164        BOOST_CHECK(batch->Write(key, value2, /*fOverwrite=*/true));
165        // Sanity-check; read and verify the overwritten value
166        std::string read_value;
167        BOOST_CHECK(batch->Read(key, read_value));
168        BOOST_CHECK_EQUAL(read_value, value2);
169    }
170}
171
172// Verify 'ErasePrefix' functionality using db keys similar to the ones used by the wallet.
173// Keys are in the form of std::pair<TYPE, ENTRY_ID>
174BOOST_AUTO_TEST_CASE(erase_prefix)
175{
176    const std::string key = "key";
177    const std::string key2 = "key2";
178    const std::string value = "value";
179    const std::string value2 = "value_2";
180    auto make_key = [](std::string type, std::string id) { return std::make_pair(type, id); };
181
182    for (const auto& database : TestDatabases(m_path_root)) {
183        if (dynamic_cast<BerkeleyRODatabase*>(database.get())) {
184            // Skip this test if BerkeleyRO
185            continue;
186        }
187        std::unique_ptr<DatabaseBatch> batch = database->MakeBatch();
188
189        // Write two entries with the same key type prefix, a third one with a different prefix
190        // and a fourth one with the type-id values inverted
191        BOOST_CHECK(batch->Write(make_key(key, value), value));
192        BOOST_CHECK(batch->Write(make_key(key, value2), value2));
193        BOOST_CHECK(batch->Write(make_key(key2, value), value));
194        BOOST_CHECK(batch->Write(make_key(value, key), value));
195
196        // Erase the ones with the same prefix and verify result
197        BOOST_CHECK(batch->TxnBegin());
198        BOOST_CHECK(batch->ErasePrefix(DataStream() << key));
199        BOOST_CHECK(batch->TxnCommit());
200
201        BOOST_CHECK(!batch->Exists(make_key(key, value)));
202        BOOST_CHECK(!batch->Exists(make_key(key, value2)));
203        // Also verify that entries with a different prefix were not erased
204        BOOST_CHECK(batch->Exists(make_key(key2, value)));
205        BOOST_CHECK(batch->Exists(make_key(value, key)));
206    }
207}
208
209// Test-only statement execution error
210constexpr int TEST_SQLITE_ERROR = -999;
211
212class DbExecBlocker : public SQliteExecHandler
213{
214private:
215    SQliteExecHandler m_base_exec;
216    std::set<std::string> m_blocked_statements;
217public:
218    DbExecBlocker(std::set<std::string> blocked_statements) : m_blocked_statements(blocked_statements) {}
219    int Exec(SQLiteDatabase& database, const std::string& statement) override {
220        if (m_blocked_statements.contains(statement)) return TEST_SQLITE_ERROR;
221        return m_base_exec.Exec(database, statement);
222    }
223};
224
225BOOST_AUTO_TEST_CASE(txn_close_failure_dangling_txn)
226{
227    // Verifies that there is no active dangling, to-be-reversed db txn
228    // after the batch object that initiated it is destroyed.
229    DatabaseOptions options;
230    DatabaseStatus status;
231    bilingual_str error;
232    std::unique_ptr<SQLiteDatabase> database = MakeSQLiteDatabase(m_path_root / "sqlite", options, status, error);
233
234    std::string key = "key";
235    std::string value = "value";
236
237    std::unique_ptr<SQLiteBatch> batch = std::make_unique<SQLiteBatch>(*database);
238    BOOST_CHECK(batch->TxnBegin());
239    BOOST_CHECK(batch->Write(key, value));
240    // Set a handler to prevent txn abortion during destruction.
241    // Mimicking a db statement execution failure.
242    batch->SetExecHandler(std::make_unique<DbExecBlocker>(std::set<std::string>{"ROLLBACK TRANSACTION"}));
243    // Destroy batch
244    batch.reset();
245
246    // Ensure there is no dangling, to-be-reversed db txn
247    BOOST_CHECK(!database->HasActiveTxn());
248
249    // And, just as a sanity check; verify that new batchs only write what they suppose to write
250    // and nothing else.

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.