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 server340 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.

11,946 bytes · SHA-256 87372ec4ce233854… · View upstream ↗

1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-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#ifndef BITCOIN_WALLET_WALLETDB_H
7#define BITCOIN_WALLET_WALLETDB_H
8
9#include <key.h>
10#include <primitives/transaction.h>
11#include <primitives/transaction_identifier.h>
12#include <script/sign.h>
13#include <wallet/db.h>
14#include <wallet/walletutil.h>
15
16#include <cstdint>
17#include <string>
18#include <unordered_set>
19#include <vector>
20
21class CScript;
22class uint160;
23class uint256;
24struct CBlockLocator;
25
26namespace wallet {
27class CMasterKey;
28class CWallet;
29class CWalletTx;
30struct WalletContext;
31
32// Logs information about the database, including available engines, features, and other capabilities
33void LogDBInfo();
34
35/**
36 * Overview of wallet database classes:
37 *
38 * - WalletBatch is an abstract modifier object for the wallet database, and encapsulates a database
39 *   batch update as well as methods to act on the database. It should be agnostic to the database implementation.
40 */
41
42/** Error statuses for the wallet database.
43 * Values are in order of severity. When multiple errors occur, the most severe (highest value) will be returned.
44 */
45enum class DBErrors : int
46{
47    LOAD_OK = 0,
48    NEED_RESCAN = 1,
49    EXTERNAL_SIGNER_SUPPORT_REQUIRED = 3,
50    NONCRITICAL_ERROR = 4,
51    TOO_NEW = 5,
52    UNKNOWN_DESCRIPTOR = 6,
53    LOAD_FAIL = 7,
54    UNEXPECTED_LEGACY_ENTRY = 8,
55    LEGACY_WALLET = 9,
56    CORRUPT = 10,
57};
58
59namespace DBKeys {
60extern const std::string ACENTRY;
61extern const std::string ACTIVEEXTERNALSPK;
62extern const std::string ACTIVEINTERNALSPK;
63extern const std::string BESTBLOCK;
64extern const std::string BESTBLOCK_NOMERKLE;
65extern const std::string CRYPTED_KEY;
66extern const std::string CSCRIPT;
67extern const std::string DEFAULTKEY;
68extern const std::string DESTDATA;
69extern const std::string FLAGS;
70extern const std::string HDCHAIN;
71extern const std::string KEY;
72extern const std::string KEYMETA;
73extern const std::string LOCKED_UTXO;
74extern const std::string MASTER_KEY;
75extern const std::string MINVERSION;
76extern const std::string NAME;
77extern const std::string OLD_KEY;
78extern const std::string ORDERPOSNEXT;
79extern const std::string POOL;
80extern const std::string PURPOSE;
81extern const std::string SETTINGS;
82extern const std::string TX;
83extern const std::string WTX_VARIANT;
84extern const std::string VERSION;
85extern const std::string WALLETDESCRIPTOR;
86extern const std::string WALLETDESCRIPTORCKEY;
87extern const std::string WALLETDESCRIPTORKEY;
88extern const std::string WATCHMETA;
89extern const std::string WATCHS;
90
91// Keys in this set pertain only to legacy wallets and are removed during migration to descriptors.
92extern const std::unordered_set<std::string> LEGACY_TYPES;
93} // namespace DBKeys
94
95/* simple HD chain data model */
96class CHDChain
97{
98public:
99    uint32_t nExternalChainCounter;
100    uint32_t nInternalChainCounter;
101    CKeyID seed_id; //!< seed hash160
102
103    static constexpr int VERSION_HD_BASE{1};
104    static constexpr int VERSION_HD_CHAIN_SPLIT{2};
105    static constexpr int CURRENT_VERSION{VERSION_HD_CHAIN_SPLIT};
106    int nVersion;
107
108    CHDChain() { SetNull(); }
109
110    SERIALIZE_METHODS(CHDChain, obj)
111    {
112        READWRITE(obj.nVersion, obj.nExternalChainCounter, obj.seed_id);
113        if (obj.nVersion >= VERSION_HD_CHAIN_SPLIT) {
114            READWRITE(obj.nInternalChainCounter);
115        }
116    }
117
118    void SetNull()
119    {
120        nVersion = CHDChain::CURRENT_VERSION;
121        nExternalChainCounter = 0;
122        nInternalChainCounter = 0;
123        seed_id.SetNull();
124    }
125
126    bool operator==(const CHDChain& chain) const
127    {
128        return seed_id == chain.seed_id;
129    }
130    bool operator<(const CHDChain& chain) const
131    {
132        return seed_id < chain.seed_id;
133    }
134};
135
136class CKeyMetadata
137{
138public:
139    static constexpr int VERSION_BASIC{1};
140    static constexpr int VERSION_WITH_HDDATA{10};
141    static constexpr int VERSION_WITH_KEY_ORIGIN{12};
142    static constexpr int CURRENT_VERSION{VERSION_WITH_KEY_ORIGIN};
143    int nVersion;
144    int64_t nCreateTime; // 0 means unknown
145    std::string hdKeypath; //optional HD/bip32 keypath. Still used to determine whether a key is a seed. Also kept for backwards compatibility
146    CKeyID hd_seed_id; //id of the HD seed used to derive this key
147    KeyOriginInfo key_origin; // Key origin info with path and fingerprint
148    bool has_key_origin = false; //!< Whether the key_origin is useful
149
150    CKeyMetadata()
151    {
152        SetNull();
153    }
154    explicit CKeyMetadata(int64_t nCreateTime_)
155    {
156        SetNull();
157        nCreateTime = nCreateTime_;
158    }
159
160    SERIALIZE_METHODS(CKeyMetadata, obj)
161    {
162        READWRITE(obj.nVersion, obj.nCreateTime);
163        if (obj.nVersion >= VERSION_WITH_HDDATA) {
164            READWRITE(obj.hdKeypath, obj.hd_seed_id);
165        }
166        if (obj.nVersion >= VERSION_WITH_KEY_ORIGIN)
167        {
168            READWRITE(obj.key_origin);
169            READWRITE(obj.has_key_origin);
170        }
171    }
172
173    void SetNull()
174    {
175        nVersion = CKeyMetadata::CURRENT_VERSION;
176        nCreateTime = 0;
177        hdKeypath.clear();
178        hd_seed_id.SetNull();
179        key_origin.clear();
180        has_key_origin = false;
181    }
182};
183
184struct DbTxnListener
185{
186    std::function<void()> on_commit, on_abort;
187};
188
189/** Access to the wallet database.
190 * Opens the database and provides read and write access to it. Each read and write is its own transaction.
191 * Multiple operation transactions can be started using TxnBegin() and committed using TxnCommit()
192 * Otherwise the transaction will be committed when the object goes out of scope.
193 * Optionally (on by default) it will flush to disk on close.
194 * Every 1000 writes will automatically trigger a flush to disk.
195 */
196class WalletBatch
197{
198private:
199    template <typename K, typename T>
200    bool WriteIC(const K& key, const T& value, bool fOverwrite = true)
201    {
202        if (!m_batch->Write(key, value, fOverwrite)) {
203            return false;
204        }
205        return true;
206    }
207
208    template <typename K>
209    bool EraseIC(const K& key)
210    {
211        if (!m_batch->Erase(key)) {
212            return false;
213        }
214        return true;
215    }
216
217public:
218    explicit WalletBatch(WalletDatabase &database) :
219        m_batch(database.MakeBatch())
220    {
221    }
222    WalletBatch(const WalletBatch&) = delete;
223    WalletBatch& operator=(const WalletBatch&) = delete;
224
225    bool WriteName(const std::string& strAddress, const std::string& strName);
226    bool EraseName(const std::string& strAddress);
227
228    bool WritePurpose(const std::string& strAddress, const std::string& purpose);
229    bool ErasePurpose(const std::string& strAddress);
230
231    // Write a CWalletTx and all variant witness txs (single tx record and multiple wtxvariant records)
232    bool WriteFullTx(const CWalletTx& wtx);
233    bool EraseTx(Txid hash);
234    // Write a single witness variant of CWalletTx (single wtxvariant record)
235    bool WriteWtxVariant(const Txid& txid, const CTransactionRef& tx);
236    // Write only the canonical witness tx and all of the tx metadata (single tx record)
237    bool WriteTxMetadata(const CWalletTx& wtx);
238
239    bool WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, bool overwrite);
240    bool WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata &keyMeta);
241    bool WriteCryptedKey(const CPubKey& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, const CKeyMetadata &keyMeta);
242    bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey);
243    bool EraseMasterKey(unsigned int id);
244
245    bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta);
246
247    bool WriteBestBlock(const CBlockLocator& locator);
248    bool ReadBestBlock(CBlockLocator& locator);
249
250    // Returns true if wallet stores encryption keys

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

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.