Bitcoin Core 29.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-2022 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 <script/sign.h>
11#include <wallet/db.h>
12#include <wallet/walletutil.h>
13#include <key.h>
14
15#include <stdint.h>
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
40enum class DBErrors : int
41{
42 LOAD_OK = 0,
43 NEED_RESCAN = 1,
44 NEED_REWRITE = 2,
47 TOO_NEW = 5,
49 LOAD_FAIL = 7,
51 LEGACY_WALLET = 9,
52 CORRUPT = 10,
53};
54
55namespace DBKeys {
56extern const std::string ACENTRY;
57extern const std::string ACTIVEEXTERNALSPK;
58extern const std::string ACTIVEINTERNALSPK;
59extern const std::string BESTBLOCK;
60extern const std::string BESTBLOCK_NOMERKLE;
61extern const std::string CRYPTED_KEY;
62extern const std::string CSCRIPT;
63extern const std::string DEFAULTKEY;
64extern const std::string DESTDATA;
65extern const std::string FLAGS;
66extern const std::string HDCHAIN;
67extern const std::string KEY;
68extern const std::string KEYMETA;
69extern const std::string LOCKED_UTXO;
70extern const std::string MASTER_KEY;
71extern const std::string MINVERSION;
72extern const std::string NAME;
73extern const std::string OLD_KEY;
74extern const std::string ORDERPOSNEXT;
75extern const std::string POOL;
76extern const std::string PURPOSE;
77extern const std::string SETTINGS;
78extern const std::string TX;
79extern const std::string VERSION;
80extern const std::string WALLETDESCRIPTOR;
81extern const std::string WALLETDESCRIPTORCKEY;
82extern const std::string WALLETDESCRIPTORKEY;
83extern const std::string WATCHMETA;
84extern const std::string WATCHS;
85
86// Keys in this set pertain only to the legacy wallet (LegacyScriptPubKeyMan) and are removed during migration from legacy to descriptors.
87extern const std::unordered_set<std::string> LEGACY_TYPES;
88} // namespace DBKeys
89
90/* simple HD chain data model */
92{
93public:
97 int64_t m_next_external_index{0}; // Next index in the keypool to be used. Memory only.
98 int64_t m_next_internal_index{0}; // Next index in the keypool to be used. Memory only.
99
100 static const int VERSION_HD_BASE = 1;
101 static const int VERSION_HD_CHAIN_SPLIT = 2;
104
106
108 {
109 READWRITE(obj.nVersion, obj.nExternalChainCounter, obj.seed_id);
110 if (obj.nVersion >= VERSION_HD_CHAIN_SPLIT) {
111 READWRITE(obj.nInternalChainCounter);
112 }
113 }
114
115 void SetNull()
116 {
121 }
122
123 bool operator==(const CHDChain& chain) const
124 {
125 return seed_id == chain.seed_id;
126 }
127};
128
130{
131public:
132 static const int VERSION_BASIC=1;
133 static const int VERSION_WITH_HDDATA=10;
134 static const int VERSION_WITH_KEY_ORIGIN = 12;
137 int64_t nCreateTime; // 0 means unknown
138 std::string hdKeypath; //optional HD/bip32 keypath. Still used to determine whether a key is a seed. Also kept for backwards compatibility
139 CKeyID hd_seed_id; //id of the HD seed used to derive this key
140 KeyOriginInfo key_origin; // Key origin info with path and fingerprint
141 bool has_key_origin = false;
142
144 {
145 SetNull();
146 }
147 explicit CKeyMetadata(int64_t nCreateTime_)
148 {
149 SetNull();
150 nCreateTime = nCreateTime_;
151 }
152
154 {
155 READWRITE(obj.nVersion, obj.nCreateTime);
156 if (obj.nVersion >= VERSION_WITH_HDDATA) {
157 READWRITE(obj.hdKeypath, obj.hd_seed_id);
158 }
159 if (obj.nVersion >= VERSION_WITH_KEY_ORIGIN)
160 {
161 READWRITE(obj.key_origin);
162 READWRITE(obj.has_key_origin);
163 }
164 }
165
166 void SetNull()
167 {
169 nCreateTime = 0;
170 hdKeypath.clear();
173 has_key_origin = false;
174 }
175};
176
178{
179 std::function<void()> on_commit, on_abort;
180};
181
190{
191private:
192 template <typename K, typename T>
193 bool WriteIC(const K& key, const T& value, bool fOverwrite = true)
194 {
195 if (!m_batch->Write(key, value, fOverwrite)) {
196 return false;
197 }
198 return true;
199 }
200
201 template <typename K>
202 bool EraseIC(const K& key)
203 {
204 if (!m_batch->Erase(key)) {
205 return false;
206 }
207 return true;
208 }
209
210public:
211 explicit WalletBatch(WalletDatabase &database) :
212 m_batch(database.MakeBatch())
213 {
214 }
215 WalletBatch(const WalletBatch&) = delete;
217
218 bool WriteName(const std::string& strAddress, const std::string& strName);
219 bool EraseName(const std::string& strAddress);
220
221 bool WritePurpose(const std::string& strAddress, const std::string& purpose);
222 bool ErasePurpose(const std::string& strAddress);
223
224 bool WriteTx(const CWalletTx& wtx);
225 bool EraseTx(Txid hash);
226
227 bool WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, const bool overwrite);
228 bool WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata &keyMeta);
229 bool WriteCryptedKey(const CPubKey& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, const CKeyMetadata &keyMeta);
230 bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey);
231 bool EraseMasterKey(unsigned int id);
232
233 bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta);
234 bool EraseWatchOnly(const CScript &script);
235
236 bool WriteBestBlock(const CBlockLocator& locator);
237 bool ReadBestBlock(CBlockLocator& locator);
238
239 // Returns true if wallet stores encryption keys
240 bool IsEncrypted();
241
242 bool WriteOrderPosNext(int64_t nOrderPosNext);
243
244 bool WriteMinVersion(int nVersion);
245
246 bool WriteDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const CPrivKey& privkey);
247 bool WriteCryptedDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const std::vector<unsigned char>& secret);
248 bool WriteDescriptor(const uint256& desc_id, const WalletDescriptor& descriptor);
249 bool WriteDescriptorDerivedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index, uint32_t der_index);
250 bool WriteDescriptorParentCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
251 bool WriteDescriptorLastHardenedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
252 bool WriteDescriptorCacheItems(const uint256& desc_id, const DescriptorCache& cache);
253
254 bool WriteLockedUTXO(const COutPoint& output);
255 bool EraseLockedUTXO(const COutPoint& output);
256
257 bool WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent);
258 bool WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request);
259 bool EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id);
260 bool EraseAddressData(const CTxDestination& dest);
261
262 bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256& id, bool internal);
263 bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal);
264
265 DBErrors LoadWallet(CWallet* pwallet);
266
268 bool EraseRecords(const std::unordered_set<std::string>& types);
269
270 bool WriteWalletFlags(const uint64_t flags);
272 bool TxnBegin();
274 bool TxnCommit();
276 bool TxnAbort();
277 bool HasActiveTxn() { return m_batch->HasActiveTxn(); }
278
280 void RegisterTxnListener(const DbTxnListener& l);
281
282private:
283 std::unique_ptr<DatabaseBatch> m_batch;
284
285 // External functions listening to the current db txn outcome.
286 // Listeners are cleared at the end of the transaction.
287 std::vector<DbTxnListener> m_txn_listeners;
288};
289
302bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func);
303
304bool LoadKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
305bool LoadCryptedKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
306bool LoadEncryptionKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
307bool LoadHDChain(CWallet* pwallet, DataStream& ssValue, std::string& strErr);
308
312} // namespace wallet
313
314#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:415
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:147
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:107
void SetNull()
Definition: walletdb.h:115
uint32_t nInternalChainCounter
Definition: walletdb.h:95
static const int VERSION_HD_BASE
Definition: walletdb.h:100
uint32_t nExternalChainCounter
Definition: walletdb.h:94
int64_t m_next_external_index
Definition: walletdb.h:97
static const int VERSION_HD_CHAIN_SPLIT
Definition: walletdb.h:101
CKeyID seed_id
seed hash160
Definition: walletdb.h:96
bool operator==(const CHDChain &chain) const
Definition: walletdb.h:123
int64_t m_next_internal_index
Definition: walletdb.h:98
static const int CURRENT_VERSION
Definition: walletdb.h:102
static const int VERSION_WITH_KEY_ORIGIN
Definition: walletdb.h:134
SERIALIZE_METHODS(CKeyMetadata, obj)
Definition: walletdb.h:153
std::string hdKeypath
Definition: walletdb.h:138
CKeyMetadata(int64_t nCreateTime_)
Definition: walletdb.h:147
bool has_key_origin
Whether the key_origin is useful.
Definition: walletdb.h:141
KeyOriginInfo key_origin
Definition: walletdb.h:140
static const int VERSION_BASIC
Definition: walletdb.h:132
static const int VERSION_WITH_HDDATA
Definition: walletdb.h:133
static const int CURRENT_VERSION
Definition: walletdb.h:135
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:301
A transaction with a bunch of additional info that only the owner cares about.
Definition: transaction.h:177
RAII class that provides access to a WalletDatabase.
Definition: db.h:51
Access to the wallet database.
Definition: walletdb.h:190
bool WriteDescriptor(const uint256 &desc_id, const WalletDescriptor &descriptor)
Definition: walletdb.cpp:239
bool TxnAbort()
Abort current transaction.
Definition: walletdb.cpp:1325
bool WriteDescriptorParentCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
Definition: walletdb.cpp:251
bool EraseName(const std::string &strAddress)
Definition: walletdb.cpp:75
DBErrors LoadWallet(CWallet *pwallet)
Definition: walletdb.cpp:1149
bool WriteBestBlock(const CBlockLocator &locator)
Definition: walletdb.cpp:174
void RegisterTxnListener(const DbTxnListener &l)
Registers db txn callback functions.
Definition: walletdb.cpp:1338
bool ReadBestBlock(CBlockLocator &locator)
Definition: walletdb.cpp:180
bool WriteDescriptorCacheItems(const uint256 &desc_id, const DescriptorCache &cache)
Definition: walletdb.cpp:265
bool WriteMasterKey(unsigned int nID, const CMasterKey &kMasterKey)
Definition: walletdb.cpp:148
std::vector< DbTxnListener > m_txn_listeners
Definition: walletdb.h:287
bool WriteMinVersion(int nVersion)
Definition: walletdb.cpp:202
bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta)
Definition: walletdb.cpp:158
bool TxnBegin()
Begin a new transaction.
Definition: walletdb.cpp:1307
bool WriteAddressPreviouslySpent(const CTxDestination &dest, bool previously_spent)
Definition: walletdb.cpp:1272
bool EraseAddressReceiveRequest(const CTxDestination &dest, const std::string &id)
Definition: walletdb.cpp:1283
bool TxnCommit()
Commit current transaction.
Definition: walletdb.cpp:1312
bool WriteName(const std::string &strAddress, const std::string &strName)
Definition: walletdb.cpp:70
WalletBatch(WalletDatabase &database)
Definition: walletdb.h:211
bool WritePurpose(const std::string &strAddress, const std::string &purpose)
Definition: walletdb.cpp:82
WalletBatch & operator=(const WalletBatch &)=delete
std::unique_ptr< DatabaseBatch > m_batch
Definition: walletdb.h:283
bool EraseRecords(const std::unordered_set< std::string > &types)
Delete records of the given types.
Definition: walletdb.cpp:1300
WalletBatch(const WalletBatch &)=delete
bool WriteWalletFlags(const uint64_t flags)
Definition: walletdb.cpp:1295
bool WriteKeyMetadata(const CKeyMetadata &meta, const CPubKey &pubkey, const bool overwrite)
Definition: walletdb.cpp:102
bool WriteDescriptorLastHardenedCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
Definition: walletdb.cpp:258
bool WriteIC(const K &key, const T &value, bool fOverwrite=true)
Definition: walletdb.h:193
bool EraseAddressData(const CTxDestination &dest)
Definition: walletdb.cpp:1288
bool WriteOrderPosNext(int64_t nOrderPosNext)
Definition: walletdb.cpp:197
bool WriteTx(const CWalletTx &wtx)
Definition: walletdb.cpp:92
bool WriteKey(const CPubKey &vchPubKey, const CPrivKey &vchPrivKey, const CKeyMetadata &keyMeta)
Definition: walletdb.cpp:107
bool EraseIC(const K &key)
Definition: walletdb.h:202
bool WriteCryptedKey(const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret, const CKeyMetadata &keyMeta)
Definition: walletdb.cpp:122
bool ErasePurpose(const std::string &strAddress)
Definition: walletdb.cpp:87
bool EraseLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:292
bool WriteDescriptorDerivedCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index, uint32_t der_index)
Definition: walletdb.cpp:244
bool WriteCryptedDescriptorKey(const uint256 &desc_id, const CPubKey &pubkey, const std::vector< unsigned char > &secret)
Definition: walletdb.cpp:230
bool WriteLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:287
bool EraseMasterKey(unsigned int id)
Definition: walletdb.cpp:153
bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256 &id, bool internal)
Definition: walletdb.cpp:207
bool EraseTx(Txid hash)
Definition: walletdb.cpp:97
bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal)
Definition: walletdb.cpp:213
bool WriteDescriptorKey(const uint256 &desc_id, const CPubKey &pubkey, const CPrivKey &privkey)
Definition: walletdb.cpp:219
bool WriteAddressReceiveRequest(const CTxDestination &dest, const std::string &id, const std::string &receive_request)
Definition: walletdb.cpp:1278
bool EraseWatchOnly(const CScript &script)
Definition: walletdb.cpp:166
An instance of this class represents one database.
Definition: db.h:130
Descriptor with some wallet metadata.
Definition: walletutil.h:85
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:297
static bool RunWithinTxn(WalletBatch &batch, std::string_view process_desc, const std::function< bool(WalletBatch &)> &func)
Definition: walletdb.cpp:1243
bool LoadCryptedKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:363
DBErrors
Overview of wallet database classes:
Definition: walletdb.h:41
@ EXTERNAL_SIGNER_SUPPORT_REQUIRED
bool LoadEncryptionKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:402
bool HasLegacyRecords(CWallet &wallet)
Returns true if there are any DBKeys::LEGACY_TYPES record in the wallet db.
Definition: walletdb.cpp:527
bool LoadHDChain(CWallet *pwallet, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:429
#define READWRITE(...)
Definition: serialize.h:156
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:179
std::function< void()> on_abort
Definition: walletdb.h:179