Bitcoin Core 30.99.0
P2P Digital Currency
walletdb.h
Go to the documentation of this file.
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>
11#include <script/sign.h>
12#include <wallet/db.h>
13#include <wallet/walletutil.h>
14
15#include <cstdint>
16#include <string>
17#include <vector>
18
19class CScript;
20class uint160;
21class uint256;
22struct CBlockLocator;
23
24namespace wallet {
25class CMasterKey;
26class CWallet;
27class CWalletTx;
28struct WalletContext;
29
30// Logs information about the database, including available engines, features, and other capabilities
31void LogDBInfo();
32
43enum class DBErrors : int
44{
45 LOAD_OK = 0,
46 NEED_RESCAN = 1,
47 NEED_REWRITE = 2,
50 TOO_NEW = 5,
52 LOAD_FAIL = 7,
54 LEGACY_WALLET = 9,
55 CORRUPT = 10,
56};
57
58namespace DBKeys {
59extern const std::string ACENTRY;
60extern const std::string ACTIVEEXTERNALSPK;
61extern const std::string ACTIVEINTERNALSPK;
62extern const std::string BESTBLOCK;
63extern const std::string BESTBLOCK_NOMERKLE;
64extern const std::string CRYPTED_KEY;
65extern const std::string CSCRIPT;
66extern const std::string DEFAULTKEY;
67extern const std::string DESTDATA;
68extern const std::string FLAGS;
69extern const std::string HDCHAIN;
70extern const std::string KEY;
71extern const std::string KEYMETA;
72extern const std::string LOCKED_UTXO;
73extern const std::string MASTER_KEY;
74extern const std::string MINVERSION;
75extern const std::string NAME;
76extern const std::string OLD_KEY;
77extern const std::string ORDERPOSNEXT;
78extern const std::string POOL;
79extern const std::string PURPOSE;
80extern const std::string SETTINGS;
81extern const std::string TX;
82extern const std::string VERSION;
83extern const std::string WALLETDESCRIPTOR;
84extern const std::string WALLETDESCRIPTORCKEY;
85extern const std::string WALLETDESCRIPTORKEY;
86extern const std::string WATCHMETA;
87extern const std::string WATCHS;
88
89// Keys in this set pertain only to the legacy wallet (LegacyScriptPubKeyMan) and are removed during migration from legacy to descriptors.
90extern const std::unordered_set<std::string> LEGACY_TYPES;
91} // namespace DBKeys
92
93/* simple HD chain data model */
95{
96public:
100 int64_t m_next_external_index{0}; // Next index in the keypool to be used. Memory only.
101 int64_t m_next_internal_index{0}; // Next index in the keypool to be used. Memory only.
102
103 static const int VERSION_HD_BASE = 1;
104 static const int VERSION_HD_CHAIN_SPLIT = 2;
107
109
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 {
124 }
125
126 bool operator==(const CHDChain& chain) const
127 {
128 return seed_id == chain.seed_id;
129 }
130};
131
133{
134public:
135 static const int VERSION_BASIC=1;
136 static const int VERSION_WITH_HDDATA=10;
137 static const int VERSION_WITH_KEY_ORIGIN = 12;
140 int64_t nCreateTime; // 0 means unknown
141 std::string hdKeypath; //optional HD/bip32 keypath. Still used to determine whether a key is a seed. Also kept for backwards compatibility
142 CKeyID hd_seed_id; //id of the HD seed used to derive this key
143 KeyOriginInfo key_origin; // Key origin info with path and fingerprint
144 bool has_key_origin = false;
145
147 {
148 SetNull();
149 }
150 explicit CKeyMetadata(int64_t nCreateTime_)
151 {
152 SetNull();
153 nCreateTime = nCreateTime_;
154 }
155
157 {
158 READWRITE(obj.nVersion, obj.nCreateTime);
159 if (obj.nVersion >= VERSION_WITH_HDDATA) {
160 READWRITE(obj.hdKeypath, obj.hd_seed_id);
161 }
162 if (obj.nVersion >= VERSION_WITH_KEY_ORIGIN)
163 {
164 READWRITE(obj.key_origin);
165 READWRITE(obj.has_key_origin);
166 }
167 }
168
169 void SetNull()
170 {
172 nCreateTime = 0;
173 hdKeypath.clear();
176 has_key_origin = false;
177 }
178};
179
181{
182 std::function<void()> on_commit, on_abort;
183};
184
193{
194private:
195 template <typename K, typename T>
196 bool WriteIC(const K& key, const T& value, bool fOverwrite = true)
197 {
198 if (!m_batch->Write(key, value, fOverwrite)) {
199 return false;
200 }
201 return true;
202 }
203
204 template <typename K>
205 bool EraseIC(const K& key)
206 {
207 if (!m_batch->Erase(key)) {
208 return false;
209 }
210 return true;
211 }
212
213public:
214 explicit WalletBatch(WalletDatabase &database) :
215 m_batch(database.MakeBatch())
216 {
217 }
218 WalletBatch(const WalletBatch&) = delete;
220
221 bool WriteName(const std::string& strAddress, const std::string& strName);
222 bool EraseName(const std::string& strAddress);
223
224 bool WritePurpose(const std::string& strAddress, const std::string& purpose);
225 bool ErasePurpose(const std::string& strAddress);
226
227 bool WriteTx(const CWalletTx& wtx);
228 bool EraseTx(Txid hash);
229
230 bool WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, const bool overwrite);
231 bool WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata &keyMeta);
232 bool WriteCryptedKey(const CPubKey& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, const CKeyMetadata &keyMeta);
233 bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey);
234 bool EraseMasterKey(unsigned int id);
235
236 bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta);
237 bool EraseWatchOnly(const CScript &script);
238
239 bool WriteBestBlock(const CBlockLocator& locator);
240 bool ReadBestBlock(CBlockLocator& locator);
241
242 // Returns true if wallet stores encryption keys
243 bool IsEncrypted();
244
245 bool WriteOrderPosNext(int64_t nOrderPosNext);
246
247 bool WriteDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const CPrivKey& privkey);
248 bool WriteCryptedDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const std::vector<unsigned char>& secret);
249 bool WriteDescriptor(const uint256& desc_id, const WalletDescriptor& descriptor);
250 bool WriteDescriptorDerivedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index, uint32_t der_index);
251 bool WriteDescriptorParentCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
252 bool WriteDescriptorLastHardenedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
253 bool WriteDescriptorCacheItems(const uint256& desc_id, const DescriptorCache& cache);
254
255 bool WriteLockedUTXO(const COutPoint& output);
256 bool EraseLockedUTXO(const COutPoint& output);
257
258 bool WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent);
259 bool WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request);
260 bool EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id);
261 bool EraseAddressData(const CTxDestination& dest);
262
263 bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256& id, bool internal);
264 bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal);
265
266 DBErrors LoadWallet(CWallet* pwallet);
267
269 bool EraseRecords(const std::unordered_set<std::string>& types);
270
271 bool WriteWalletFlags(const uint64_t flags);
273 bool TxnBegin();
275 bool TxnCommit();
277 bool TxnAbort();
278 bool HasActiveTxn() { return m_batch->HasActiveTxn(); }
279
281 void RegisterTxnListener(const DbTxnListener& l);
282
283private:
284 std::unique_ptr<DatabaseBatch> m_batch;
285
286 // External functions listening to the current db txn outcome.
287 // Listeners are cleared at the end of the transaction.
288 std::vector<DbTxnListener> m_txn_listeners;
289};
290
303bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func);
304
305bool LoadKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
306bool LoadCryptedKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
307bool LoadEncryptionKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
308bool LoadHDChain(CWallet* pwallet, DataStream& ssValue, std::string& strErr);
309
313} // namespace wallet
314
315#endif // BITCOIN_WALLET_WALLETDB_H
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, PayToAnchor, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
Definition: addresstype.h:143
int flags
Definition: bitcoin-tx.cpp:529
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:24
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
An encapsulated public key.
Definition: pubkey.h:34
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:413
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:130
Cache for single descriptor's derived extended pubkeys.
Definition: descriptor.h:19
constexpr void SetNull()
Definition: uint256.h:55
160-bit opaque blob.
Definition: uint256.h:184
256-bit opaque blob.
Definition: uint256.h:196
SERIALIZE_METHODS(CHDChain, obj)
Definition: walletdb.h:110
void SetNull()
Definition: walletdb.h:118
uint32_t nInternalChainCounter
Definition: walletdb.h:98
static const int VERSION_HD_BASE
Definition: walletdb.h:103
uint32_t nExternalChainCounter
Definition: walletdb.h:97
int64_t m_next_external_index
Definition: walletdb.h:100
static const int VERSION_HD_CHAIN_SPLIT
Definition: walletdb.h:104
CKeyID seed_id
seed hash160
Definition: walletdb.h:99
bool operator==(const CHDChain &chain) const
Definition: walletdb.h:126
int64_t m_next_internal_index
Definition: walletdb.h:101
static const int CURRENT_VERSION
Definition: walletdb.h:105
static const int VERSION_WITH_KEY_ORIGIN
Definition: walletdb.h:137
SERIALIZE_METHODS(CKeyMetadata, obj)
Definition: walletdb.h:156
std::string hdKeypath
Definition: walletdb.h:141
CKeyMetadata(int64_t nCreateTime_)
Definition: walletdb.h:150
bool has_key_origin
Whether the key_origin is useful.
Definition: walletdb.h:144
KeyOriginInfo key_origin
Definition: walletdb.h:143
static const int VERSION_BASIC
Definition: walletdb.h:135
static const int VERSION_WITH_HDDATA
Definition: walletdb.h:136
static const int CURRENT_VERSION
Definition: walletdb.h:138
Private key encryption is done based on a CMasterKey, which holds a salt and random encryption key.
Definition: crypter.h:35
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
Definition: wallet.h:311
A transaction with a bunch of additional info that only the owner cares about.
Definition: transaction.h:195
RAII class that provides access to a WalletDatabase.
Definition: db.h:51
Access to the wallet database.
Definition: walletdb.h:193
bool WriteDescriptor(const uint256 &desc_id, const WalletDescriptor &descriptor)
Definition: walletdb.cpp:240
bool TxnAbort()
Abort current transaction.
Definition: walletdb.cpp:1291
bool WriteDescriptorParentCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
Definition: walletdb.cpp:252
bool EraseName(const std::string &strAddress)
Definition: walletdb.cpp:81
DBErrors LoadWallet(CWallet *pwallet)
Definition: walletdb.cpp:1115
bool WriteBestBlock(const CBlockLocator &locator)
Definition: walletdb.cpp:180
void RegisterTxnListener(const DbTxnListener &l)
Registers db txn callback functions.
Definition: walletdb.cpp:1304
bool ReadBestBlock(CBlockLocator &locator)
Definition: walletdb.cpp:186
bool WriteDescriptorCacheItems(const uint256 &desc_id, const DescriptorCache &cache)
Definition: walletdb.cpp:266
bool WriteMasterKey(unsigned int nID, const CMasterKey &kMasterKey)
Definition: walletdb.cpp:154
std::vector< DbTxnListener > m_txn_listeners
Definition: walletdb.h:288
bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta)
Definition: walletdb.cpp:164
bool TxnBegin()
Begin a new transaction.
Definition: walletdb.cpp:1273
bool WriteAddressPreviouslySpent(const CTxDestination &dest, bool previously_spent)
Definition: walletdb.cpp:1238
bool EraseAddressReceiveRequest(const CTxDestination &dest, const std::string &id)
Definition: walletdb.cpp:1249
bool TxnCommit()
Commit current transaction.
Definition: walletdb.cpp:1278
bool WriteName(const std::string &strAddress, const std::string &strName)
Definition: walletdb.cpp:76
WalletBatch(WalletDatabase &database)
Definition: walletdb.h:214
bool WritePurpose(const std::string &strAddress, const std::string &purpose)
Definition: walletdb.cpp:88
WalletBatch & operator=(const WalletBatch &)=delete
std::unique_ptr< DatabaseBatch > m_batch
Definition: walletdb.h:284
bool EraseRecords(const std::unordered_set< std::string > &types)
Delete records of the given types.
Definition: walletdb.cpp:1266
WalletBatch(const WalletBatch &)=delete
bool WriteWalletFlags(const uint64_t flags)
Definition: walletdb.cpp:1261
bool WriteKeyMetadata(const CKeyMetadata &meta, const CPubKey &pubkey, const bool overwrite)
Definition: walletdb.cpp:108
bool WriteDescriptorLastHardenedCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
Definition: walletdb.cpp:259
bool WriteIC(const K &key, const T &value, bool fOverwrite=true)
Definition: walletdb.h:196
bool EraseAddressData(const CTxDestination &dest)
Definition: walletdb.cpp:1254
bool WriteOrderPosNext(int64_t nOrderPosNext)
Definition: walletdb.cpp:203
bool WriteTx(const CWalletTx &wtx)
Definition: walletdb.cpp:98
bool WriteKey(const CPubKey &vchPubKey, const CPrivKey &vchPrivKey, const CKeyMetadata &keyMeta)
Definition: walletdb.cpp:113
bool EraseIC(const K &key)
Definition: walletdb.h:205
bool WriteCryptedKey(const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret, const CKeyMetadata &keyMeta)
Definition: walletdb.cpp:128
bool ErasePurpose(const std::string &strAddress)
Definition: walletdb.cpp:93
bool EraseLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:293
bool WriteDescriptorDerivedCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index, uint32_t der_index)
Definition: walletdb.cpp:245
bool WriteCryptedDescriptorKey(const uint256 &desc_id, const CPubKey &pubkey, const std::vector< unsigned char > &secret)
Definition: walletdb.cpp:231
bool WriteLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:288
bool EraseMasterKey(unsigned int id)
Definition: walletdb.cpp:159
bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256 &id, bool internal)
Definition: walletdb.cpp:208
bool EraseTx(Txid hash)
Definition: walletdb.cpp:103
bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal)
Definition: walletdb.cpp:214
bool WriteDescriptorKey(const uint256 &desc_id, const CPubKey &pubkey, const CPrivKey &privkey)
Definition: walletdb.cpp:220
bool WriteAddressReceiveRequest(const CTxDestination &dest, const std::string &id, const std::string &receive_request)
Definition: walletdb.cpp:1244
bool EraseWatchOnly(const CScript &script)
Definition: walletdb.cpp:172
An instance of this class represents one database.
Definition: db.h:130
Descriptor with some wallet metadata.
Definition: walletutil.h:64
std::vector< unsigned char, secure_allocator< unsigned char > > CPrivKey
CPrivKey is a serialized private key, with all parameters included (SIZE bytes)
Definition: key.h:23
const std::string NAME
Definition: walletdb.cpp:48
const std::string BESTBLOCK
Definition: walletdb.cpp:36
const std::string WALLETDESCRIPTORCKEY
Definition: walletdb.cpp:59
const std::string WATCHS
Definition: walletdb.cpp:62
const std::string POOL
Definition: walletdb.cpp:51
const std::string MINVERSION
Definition: walletdb.cpp:47
const std::string WATCHMETA
Definition: walletdb.cpp:61
const std::string DEFAULTKEY
Definition: walletdb.cpp:39
const std::string OLD_KEY
Definition: walletdb.cpp:49
const std::string WALLETDESCRIPTORKEY
Definition: walletdb.cpp:60
const std::string ACENTRY
Definition: walletdb.cpp:32
const std::string ACTIVEEXTERNALSPK
Definition: walletdb.cpp:33
const std::string TX
Definition: walletdb.cpp:54
const std::string KEY
Definition: walletdb.cpp:44
const std::string CRYPTED_KEY
Definition: walletdb.cpp:37
const std::string DESTDATA
Definition: walletdb.cpp:40
const std::string CSCRIPT
Definition: walletdb.cpp:38
const std::unordered_set< std::string > LEGACY_TYPES
Definition: walletdb.cpp:63
const std::string SETTINGS
Definition: walletdb.cpp:53
const std::string BESTBLOCK_NOMERKLE
Definition: walletdb.cpp:35
const std::string LOCKED_UTXO
Definition: walletdb.cpp:45
const std::string ACTIVEINTERNALSPK
Definition: walletdb.cpp:34
const std::string HDCHAIN
Definition: walletdb.cpp:42
const std::string ORDERPOSNEXT
Definition: walletdb.cpp:50
const std::string FLAGS
Definition: walletdb.cpp:41
const std::string VERSION
Definition: walletdb.cpp:55
const std::string MASTER_KEY
Definition: walletdb.cpp:46
const std::string KEYMETA
Definition: walletdb.cpp:43
const std::string PURPOSE
Definition: walletdb.cpp:52
const std::string WALLETDESCRIPTOR
Definition: walletdb.cpp:56
bool LoadKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:298
static bool RunWithinTxn(WalletBatch &batch, std::string_view process_desc, const std::function< bool(WalletBatch &)> &func)
Definition: walletdb.cpp:1209
bool LoadCryptedKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:364
DBErrors
Overview of wallet database classes:
Definition: walletdb.h:44
@ EXTERNAL_SIGNER_SUPPORT_REQUIRED
bool LoadEncryptionKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:403
bool HasLegacyRecords(CWallet &wallet)
Returns true if there are any DBKeys::LEGACY_TYPES record in the wallet db.
Definition: walletdb.cpp:515
void LogDBInfo()
Definition: walletdb.cpp:66
bool LoadHDChain(CWallet *pwallet, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:430
#define READWRITE(...)
Definition: serialize.h:145
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:124
void clear()
Definition: keyorigin.h:42
std::function< void()> on_commit
Definition: walletdb.h:182
std::function< void()> on_abort
Definition: walletdb.h:182