Bitcoin Core  27.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>
10 #include <wallet/db.h>
11 #include <wallet/walletutil.h>
12 #include <key.h>
13 
14 #include <stdint.h>
15 #include <string>
16 #include <vector>
17 
18 class CScript;
19 class uint160;
20 class uint256;
21 struct CBlockLocator;
22 
23 namespace wallet {
24 class CKeyPool;
25 class CMasterKey;
26 class CWallet;
27 class CWalletTx;
28 struct WalletContext;
29 
42 static const bool DEFAULT_FLUSHWALLET = true;
43 
47 enum class DBErrors : int
48 {
49  LOAD_OK = 0,
50  NEED_RESCAN = 1,
51  NEED_REWRITE = 2,
54  TOO_NEW = 5,
56  LOAD_FAIL = 7,
58  CORRUPT = 9,
59 };
60 
61 namespace DBKeys {
62 extern const std::string ACENTRY;
63 extern const std::string ACTIVEEXTERNALSPK;
64 extern const std::string ACTIVEINTERNALSPK;
65 extern const std::string BESTBLOCK;
66 extern const std::string BESTBLOCK_NOMERKLE;
67 extern const std::string CRYPTED_KEY;
68 extern const std::string CSCRIPT;
69 extern const std::string DEFAULTKEY;
70 extern const std::string DESTDATA;
71 extern const std::string FLAGS;
72 extern const std::string HDCHAIN;
73 extern const std::string KEY;
74 extern const std::string KEYMETA;
75 extern const std::string LOCKED_UTXO;
76 extern const std::string MASTER_KEY;
77 extern const std::string MINVERSION;
78 extern const std::string NAME;
79 extern const std::string OLD_KEY;
80 extern const std::string ORDERPOSNEXT;
81 extern const std::string POOL;
82 extern const std::string PURPOSE;
83 extern const std::string SETTINGS;
84 extern const std::string TX;
85 extern const std::string VERSION;
86 extern const std::string WALLETDESCRIPTOR;
87 extern const std::string WALLETDESCRIPTORCKEY;
88 extern const std::string WALLETDESCRIPTORKEY;
89 extern const std::string WATCHMETA;
90 extern const std::string WATCHS;
91 
92 // Keys in this set pertain only to the legacy wallet (LegacyScriptPubKeyMan) and are removed during migration from legacy to descriptors.
93 extern const std::unordered_set<std::string> LEGACY_TYPES;
94 } // namespace DBKeys
95 
96 /* simple HD chain data model */
97 class CHDChain
98 {
99 public:
103  int64_t m_next_external_index{0}; // Next index in the keypool to be used. Memory only.
104  int64_t m_next_internal_index{0}; // Next index in the keypool to be used. Memory only.
105 
106  static const int VERSION_HD_BASE = 1;
107  static const int VERSION_HD_CHAIN_SPLIT = 2;
109  int nVersion;
110 
111  CHDChain() { SetNull(); }
112 
114  {
115  READWRITE(obj.nVersion, obj.nExternalChainCounter, obj.seed_id);
116  if (obj.nVersion >= VERSION_HD_CHAIN_SPLIT) {
117  READWRITE(obj.nInternalChainCounter);
118  }
119  }
120 
121  void SetNull()
122  {
126  seed_id.SetNull();
127  }
128 
129  bool operator==(const CHDChain& chain) const
130  {
131  return seed_id == chain.seed_id;
132  }
133 };
134 
136 {
137 public:
138  static const int VERSION_BASIC=1;
139  static const int VERSION_WITH_HDDATA=10;
140  static const int VERSION_WITH_KEY_ORIGIN = 12;
142  int nVersion;
143  int64_t nCreateTime; // 0 means unknown
144  std::string hdKeypath; //optional HD/bip32 keypath. Still used to determine whether a key is a seed. Also kept for backwards compatibility
145  CKeyID hd_seed_id; //id of the HD seed used to derive this key
146  KeyOriginInfo key_origin; // Key origin info with path and fingerprint
147  bool has_key_origin = false;
148 
150  {
151  SetNull();
152  }
153  explicit CKeyMetadata(int64_t nCreateTime_)
154  {
155  SetNull();
156  nCreateTime = nCreateTime_;
157  }
158 
160  {
161  READWRITE(obj.nVersion, obj.nCreateTime);
162  if (obj.nVersion >= VERSION_WITH_HDDATA) {
163  READWRITE(obj.hdKeypath, obj.hd_seed_id);
164  }
165  if (obj.nVersion >= VERSION_WITH_KEY_ORIGIN)
166  {
167  READWRITE(obj.key_origin);
168  READWRITE(obj.has_key_origin);
169  }
170  }
171 
172  void SetNull()
173  {
175  nCreateTime = 0;
176  hdKeypath.clear();
178  key_origin.clear();
179  has_key_origin = false;
180  }
181 };
182 
191 {
192 private:
193  template <typename K, typename T>
194  bool WriteIC(const K& key, const T& value, bool fOverwrite = true)
195  {
196  if (!m_batch->Write(key, value, fOverwrite)) {
197  return false;
198  }
200  if (m_database.nUpdateCounter % 1000 == 0) {
201  m_batch->Flush();
202  }
203  return true;
204  }
205 
206  template <typename K>
207  bool EraseIC(const K& key)
208  {
209  if (!m_batch->Erase(key)) {
210  return false;
211  }
213  if (m_database.nUpdateCounter % 1000 == 0) {
214  m_batch->Flush();
215  }
216  return true;
217  }
218 
219 public:
220  explicit WalletBatch(WalletDatabase &database, bool _fFlushOnClose = true) :
221  m_batch(database.MakeBatch(_fFlushOnClose)),
222  m_database(database)
223  {
224  }
225  WalletBatch(const WalletBatch&) = delete;
226  WalletBatch& operator=(const WalletBatch&) = delete;
227 
228  bool WriteName(const std::string& strAddress, const std::string& strName);
229  bool EraseName(const std::string& strAddress);
230 
231  bool WritePurpose(const std::string& strAddress, const std::string& purpose);
232  bool ErasePurpose(const std::string& strAddress);
233 
234  bool WriteTx(const CWalletTx& wtx);
235  bool EraseTx(uint256 hash);
236 
237  bool WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, const bool overwrite);
238  bool WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata &keyMeta);
239  bool WriteCryptedKey(const CPubKey& vchPubKey, const std::vector<unsigned char>& vchCryptedSecret, const CKeyMetadata &keyMeta);
240  bool WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey);
241 
242  bool WriteCScript(const uint160& hash, const CScript& redeemScript);
243 
244  bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta);
245  bool EraseWatchOnly(const CScript &script);
246 
247  bool WriteBestBlock(const CBlockLocator& locator);
248  bool ReadBestBlock(CBlockLocator& locator);
249 
250  bool WriteOrderPosNext(int64_t nOrderPosNext);
251 
252  bool ReadPool(int64_t nPool, CKeyPool& keypool);
253  bool WritePool(int64_t nPool, const CKeyPool& keypool);
254  bool ErasePool(int64_t nPool);
255 
256  bool WriteMinVersion(int nVersion);
257 
258  bool WriteDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const CPrivKey& privkey);
259  bool WriteCryptedDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const std::vector<unsigned char>& secret);
260  bool WriteDescriptor(const uint256& desc_id, const WalletDescriptor& descriptor);
261  bool WriteDescriptorDerivedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index, uint32_t der_index);
262  bool WriteDescriptorParentCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
263  bool WriteDescriptorLastHardenedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index);
264  bool WriteDescriptorCacheItems(const uint256& desc_id, const DescriptorCache& cache);
265 
266  bool WriteLockedUTXO(const COutPoint& output);
267  bool EraseLockedUTXO(const COutPoint& output);
268 
269  bool WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent);
270  bool WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request);
271  bool EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id);
272  bool EraseAddressData(const CTxDestination& dest);
273 
274  bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256& id, bool internal);
275  bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal);
276 
277  DBErrors LoadWallet(CWallet* pwallet);
278 
280  bool WriteHDChain(const CHDChain& chain);
281 
283  bool EraseRecords(const std::unordered_set<std::string>& types);
284 
285  bool WriteWalletFlags(const uint64_t flags);
287  bool TxnBegin();
289  bool TxnCommit();
291  bool TxnAbort();
292 private:
293  std::unique_ptr<DatabaseBatch> m_batch;
295 };
296 
309 bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func);
310 
312 void MaybeCompactWalletDB(WalletContext& context);
313 
314 bool LoadKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
315 bool LoadCryptedKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
316 bool LoadEncryptionKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr);
317 bool LoadHDChain(CWallet* pwallet, DataStream& ssValue, std::string& strErr);
318 } // namespace wallet
319 
320 #endif // BITCOIN_WALLET_WALLETDB_H
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
Definition: addresstype.h:131
int flags
Definition: bitcoin-tx.cpp:528
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:414
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:49
160-bit opaque blob.
Definition: uint256.h:95
256-bit opaque blob.
Definition: uint256.h:106
SERIALIZE_METHODS(CHDChain, obj)
Definition: walletdb.h:113
void SetNull()
Definition: walletdb.h:121
uint32_t nInternalChainCounter
Definition: walletdb.h:101
static const int VERSION_HD_BASE
Definition: walletdb.h:106
uint32_t nExternalChainCounter
Definition: walletdb.h:100
int64_t m_next_external_index
Definition: walletdb.h:103
static const int VERSION_HD_CHAIN_SPLIT
Definition: walletdb.h:107
CKeyID seed_id
seed hash160
Definition: walletdb.h:102
bool operator==(const CHDChain &chain) const
Definition: walletdb.h:129
int64_t m_next_internal_index
Definition: walletdb.h:104
static const int CURRENT_VERSION
Definition: walletdb.h:108
static const int VERSION_WITH_KEY_ORIGIN
Definition: walletdb.h:140
SERIALIZE_METHODS(CKeyMetadata, obj)
Definition: walletdb.h:159
std::string hdKeypath
Definition: walletdb.h:144
CKeyMetadata(int64_t nCreateTime_)
Definition: walletdb.h:153
bool has_key_origin
Whether the key_origin is useful.
Definition: walletdb.h:147
KeyOriginInfo key_origin
Definition: walletdb.h:146
static const int VERSION_BASIC
Definition: walletdb.h:138
static const int VERSION_WITH_HDDATA
Definition: walletdb.h:139
static const int CURRENT_VERSION
Definition: walletdb.h:141
A key from a CWallet's keypool.
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
Access to the wallet database.
Definition: walletdb.h:191
bool WriteDescriptor(const uint256 &desc_id, const WalletDescriptor &descriptor)
Definition: walletdb.cpp:247
bool TxnAbort()
Abort current transaction.
Definition: walletdb.cpp:1344
bool WriteDescriptorParentCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
Definition: walletdb.cpp:259
bool EraseName(const std::string &strAddress)
Definition: walletdb.cpp:79
DBErrors LoadWallet(CWallet *pwallet)
Definition: walletdb.cpp:1149
bool WriteBestBlock(const CBlockLocator &locator)
Definition: walletdb.cpp:178
bool ReadBestBlock(CBlockLocator &locator)
Definition: walletdb.cpp:184
bool WriteDescriptorCacheItems(const uint256 &desc_id, const DescriptorCache &cache)
Definition: walletdb.cpp:273
bool EraseTx(uint256 hash)
Definition: walletdb.cpp:101
bool WriteHDChain(const CHDChain &chain)
write the hdchain model (external chain child index counter)
Definition: walletdb.cpp:1315
bool WriteMasterKey(unsigned int nID, const CMasterKey &kMasterKey)
Definition: walletdb.cpp:152
bool WriteMinVersion(int nVersion)
Definition: walletdb.cpp:210
bool WriteWatchOnly(const CScript &script, const CKeyMetadata &keymeta)
Definition: walletdb.cpp:162
bool TxnBegin()
Begin a new transaction.
Definition: walletdb.cpp:1334
bool WriteAddressPreviouslySpent(const CTxDestination &dest, bool previously_spent)
Definition: walletdb.cpp:1292
bool EraseAddressReceiveRequest(const CTxDestination &dest, const std::string &id)
Definition: walletdb.cpp:1303
bool TxnCommit()
Commit current transaction.
Definition: walletdb.cpp:1339
bool WriteName(const std::string &strAddress, const std::string &strName)
Definition: walletdb.cpp:74
bool WritePurpose(const std::string &strAddress, const std::string &purpose)
Definition: walletdb.cpp:86
std::unique_ptr< DatabaseBatch > m_batch
Definition: walletdb.h:293
bool EraseRecords(const std::unordered_set< std::string > &types)
Delete records of the given types.
Definition: walletdb.cpp:1325
WalletBatch(const WalletBatch &)=delete
bool WriteWalletFlags(const uint64_t flags)
Definition: walletdb.cpp:1320
bool WriteKeyMetadata(const CKeyMetadata &meta, const CPubKey &pubkey, const bool overwrite)
Definition: walletdb.cpp:106
bool WriteDescriptorLastHardenedCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
Definition: walletdb.cpp:266
bool WriteIC(const K &key, const T &value, bool fOverwrite=true)
Definition: walletdb.h:194
bool EraseAddressData(const CTxDestination &dest)
Definition: walletdb.cpp:1308
bool WriteOrderPosNext(int64_t nOrderPosNext)
Definition: walletdb.cpp:190
WalletDatabase & m_database
Definition: walletdb.h:294
bool WriteTx(const CWalletTx &wtx)
Definition: walletdb.cpp:96
bool WriteKey(const CPubKey &vchPubKey, const CPrivKey &vchPrivKey, const CKeyMetadata &keyMeta)
Definition: walletdb.cpp:111
bool ReadPool(int64_t nPool, CKeyPool &keypool)
Definition: walletdb.cpp:195
bool EraseIC(const K &key)
Definition: walletdb.h:207
bool WriteCryptedKey(const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret, const CKeyMetadata &keyMeta)
Definition: walletdb.cpp:126
bool ErasePurpose(const std::string &strAddress)
Definition: walletdb.cpp:91
bool EraseLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:300
WalletBatch(WalletDatabase &database, bool _fFlushOnClose=true)
Definition: walletdb.h:220
bool WriteDescriptorDerivedCache(const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index, uint32_t der_index)
Definition: walletdb.cpp:252
WalletBatch & operator=(const WalletBatch &)=delete
bool WriteCryptedDescriptorKey(const uint256 &desc_id, const CPubKey &pubkey, const std::vector< unsigned char > &secret)
Definition: walletdb.cpp:238
bool WriteLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:295
bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256 &id, bool internal)
Definition: walletdb.cpp:215
bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal)
Definition: walletdb.cpp:221
bool WritePool(int64_t nPool, const CKeyPool &keypool)
Definition: walletdb.cpp:200
bool WriteDescriptorKey(const uint256 &desc_id, const CPubKey &pubkey, const CPrivKey &privkey)
Definition: walletdb.cpp:227
bool WriteCScript(const uint160 &hash, const CScript &redeemScript)
Definition: walletdb.cpp:157
bool WriteAddressReceiveRequest(const CTxDestination &dest, const std::string &id, const std::string &receive_request)
Definition: walletdb.cpp:1298
bool ErasePool(int64_t nPool)
Definition: walletdb.cpp:205
bool EraseWatchOnly(const CScript &script)
Definition: walletdb.cpp:170
An instance of this class represents one database.
Definition: db.h:130
virtual void IncrementUpdateCounter()=0
std::atomic< unsigned int > nUpdateCounter
Definition: db.h:174
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:52
const std::string BESTBLOCK
Definition: walletdb.cpp:40
const std::string WALLETDESCRIPTORCKEY
Definition: walletdb.cpp:63
const std::string WATCHS
Definition: walletdb.cpp:66
const std::string POOL
Definition: walletdb.cpp:55
const std::string MINVERSION
Definition: walletdb.cpp:51
const std::string WATCHMETA
Definition: walletdb.cpp:65
const std::string DEFAULTKEY
Definition: walletdb.cpp:43
const std::string OLD_KEY
Definition: walletdb.cpp:53
const std::string WALLETDESCRIPTORKEY
Definition: walletdb.cpp:64
const std::string ACENTRY
Definition: walletdb.cpp:36
const std::string ACTIVEEXTERNALSPK
Definition: walletdb.cpp:37
const std::string TX
Definition: walletdb.cpp:58
const std::string KEY
Definition: walletdb.cpp:48
const std::string CRYPTED_KEY
Definition: walletdb.cpp:41
const std::string DESTDATA
Definition: walletdb.cpp:44
const std::string CSCRIPT
Definition: walletdb.cpp:42
const std::unordered_set< std::string > LEGACY_TYPES
Definition: walletdb.cpp:67
const std::string SETTINGS
Definition: walletdb.cpp:57
const std::string BESTBLOCK_NOMERKLE
Definition: walletdb.cpp:39
const std::string LOCKED_UTXO
Definition: walletdb.cpp:49
const std::string ACTIVEINTERNALSPK
Definition: walletdb.cpp:38
const std::string HDCHAIN
Definition: walletdb.cpp:46
const std::string ORDERPOSNEXT
Definition: walletdb.cpp:54
const std::string FLAGS
Definition: walletdb.cpp:45
const std::string VERSION
Definition: walletdb.cpp:59
const std::string MASTER_KEY
Definition: walletdb.cpp:50
const std::string KEYMETA
Definition: walletdb.cpp:47
const std::string PURPOSE
Definition: walletdb.cpp:56
const std::string WALLETDESCRIPTOR
Definition: walletdb.cpp:60
bool LoadKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:305
void MaybeCompactWalletDB(WalletContext &context)
Compacts BDB state so that wallet.dat is self-contained (if there are changes)
Definition: walletdb.cpp:1265
static bool RunWithinTxn(WalletBatch &batch, std::string_view process_desc, const std::function< bool(WalletBatch &)> &func)
Definition: walletdb.cpp:1236
bool LoadCryptedKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:371
DBErrors
Error statuses for the wallet database.
Definition: walletdb.h:48
@ EXTERNAL_SIGNER_SUPPORT_REQUIRED
bool LoadEncryptionKey(CWallet *pwallet, DataStream &ssKey, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:410
bool LoadHDChain(CWallet *pwallet, DataStream &ssValue, std::string &strErr)
Definition: walletdb.cpp:437
static const bool DEFAULT_FLUSHWALLET
Overview of wallet database classes:
Definition: walletdb.h:42
#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
WalletContext struct containing references to state shared between CWallet instances,...
Definition: context.h:36