Branch data Line data Source code
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 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
7 : :
8 : : #include <wallet/walletdb.h>
9 : :
10 : : #include <common/system.h>
11 : : #include <key_io.h>
12 : : #include <protocol.h>
13 : : #include <script/script.h>
14 : : #include <serialize.h>
15 : : #include <sync.h>
16 : : #include <util/bip32.h>
17 : : #include <util/check.h>
18 : : #include <util/fs.h>
19 : : #include <util/time.h>
20 : : #include <util/translation.h>
21 : : #ifdef USE_BDB
22 : : #include <wallet/bdb.h>
23 : : #endif
24 : : #include <wallet/migrate.h>
25 : : #ifdef USE_SQLITE
26 : : #include <wallet/sqlite.h>
27 : : #endif
28 : : #include <wallet/wallet.h>
29 : :
30 : : #include <atomic>
31 : : #include <optional>
32 : : #include <string>
33 : :
34 : : namespace wallet {
35 : : namespace DBKeys {
36 : : const std::string ACENTRY{"acentry"};
37 : : const std::string ACTIVEEXTERNALSPK{"activeexternalspk"};
38 : : const std::string ACTIVEINTERNALSPK{"activeinternalspk"};
39 : : const std::string BESTBLOCK_NOMERKLE{"bestblock_nomerkle"};
40 : : const std::string BESTBLOCK{"bestblock"};
41 : : const std::string CRYPTED_KEY{"ckey"};
42 : : const std::string CSCRIPT{"cscript"};
43 : : const std::string DEFAULTKEY{"defaultkey"};
44 : : const std::string DESTDATA{"destdata"};
45 : : const std::string FLAGS{"flags"};
46 : : const std::string HDCHAIN{"hdchain"};
47 : : const std::string KEYMETA{"keymeta"};
48 : : const std::string KEY{"key"};
49 : : const std::string LOCKED_UTXO{"lockedutxo"};
50 : : const std::string MASTER_KEY{"mkey"};
51 : : const std::string MINVERSION{"minversion"};
52 : : const std::string NAME{"name"};
53 : : const std::string OLD_KEY{"wkey"};
54 : : const std::string ORDERPOSNEXT{"orderposnext"};
55 : : const std::string POOL{"pool"};
56 : : const std::string PURPOSE{"purpose"};
57 : : const std::string SETTINGS{"settings"};
58 : : const std::string TX{"tx"};
59 : : const std::string VERSION{"version"};
60 : : const std::string WALLETDESCRIPTOR{"walletdescriptor"};
61 : : const std::string WALLETDESCRIPTORCACHE{"walletdescriptorcache"};
62 : : const std::string WALLETDESCRIPTORLHCACHE{"walletdescriptorlhcache"};
63 : : const std::string WALLETDESCRIPTORCKEY{"walletdescriptorckey"};
64 : : const std::string WALLETDESCRIPTORKEY{"walletdescriptorkey"};
65 : : const std::string WATCHMETA{"watchmeta"};
66 : : const std::string WATCHS{"watchs"};
67 : : const std::unordered_set<std::string> LEGACY_TYPES{CRYPTED_KEY, CSCRIPT, DEFAULTKEY, HDCHAIN, KEYMETA, KEY, OLD_KEY, POOL, WATCHMETA, WATCHS};
68 : : } // namespace DBKeys
69 : :
70 : : //
71 : : // WalletBatch
72 : : //
73 : :
74 : 468522 : bool WalletBatch::WriteName(const std::string& strAddress, const std::string& strName)
75 : : {
76 [ + - ]: 937044 : return WriteIC(std::make_pair(DBKeys::NAME, strAddress), strName);
77 : : }
78 : :
79 : 0 : bool WalletBatch::EraseName(const std::string& strAddress)
80 : : {
81 : : // This should only be used for sending addresses, never for receiving addresses,
82 : : // receiving addresses must always have an address book entry if they're not change return.
83 [ # # ]: 0 : return EraseIC(std::make_pair(DBKeys::NAME, strAddress));
84 : : }
85 : :
86 : 468522 : bool WalletBatch::WritePurpose(const std::string& strAddress, const std::string& strPurpose)
87 : : {
88 [ + - ]: 937044 : return WriteIC(std::make_pair(DBKeys::PURPOSE, strAddress), strPurpose);
89 : : }
90 : :
91 : 0 : bool WalletBatch::ErasePurpose(const std::string& strAddress)
92 : : {
93 [ # # ]: 0 : return EraseIC(std::make_pair(DBKeys::PURPOSE, strAddress));
94 : : }
95 : :
96 : 188271 : bool WalletBatch::WriteTx(const CWalletTx& wtx)
97 : : {
98 [ + - ]: 188271 : return WriteIC(std::make_pair(DBKeys::TX, wtx.GetHash()), wtx);
99 : : }
100 : :
101 : 0 : bool WalletBatch::EraseTx(uint256 hash)
102 : : {
103 [ # # ]: 0 : return EraseIC(std::make_pair(DBKeys::TX, hash));
104 : : }
105 : :
106 : 0 : bool WalletBatch::WriteKeyMetadata(const CKeyMetadata& meta, const CPubKey& pubkey, const bool overwrite)
107 : : {
108 [ # # ]: 0 : return WriteIC(std::make_pair(DBKeys::KEYMETA, pubkey), meta, overwrite);
109 : : }
110 : :
111 : 0 : bool WalletBatch::WriteKey(const CPubKey& vchPubKey, const CPrivKey& vchPrivKey, const CKeyMetadata& keyMeta)
112 : : {
113 [ # # ]: 0 : if (!WriteKeyMetadata(keyMeta, vchPubKey, false)) {
114 : : return false;
115 : : }
116 : :
117 : : // hash pubkey/privkey to accelerate wallet load
118 : 0 : std::vector<unsigned char> vchKey;
119 [ # # ]: 0 : vchKey.reserve(vchPubKey.size() + vchPrivKey.size());
120 [ # # ]: 0 : vchKey.insert(vchKey.end(), vchPubKey.begin(), vchPubKey.end());
121 [ # # ]: 0 : vchKey.insert(vchKey.end(), vchPrivKey.begin(), vchPrivKey.end());
122 : :
123 [ # # # # : 0 : return WriteIC(std::make_pair(DBKeys::KEY, vchPubKey), std::make_pair(vchPrivKey, Hash(vchKey)), false);
# # ]
124 : 0 : }
125 : :
126 : 0 : bool WalletBatch::WriteCryptedKey(const CPubKey& vchPubKey,
127 : : const std::vector<unsigned char>& vchCryptedSecret,
128 : : const CKeyMetadata &keyMeta)
129 : : {
130 [ # # ]: 0 : if (!WriteKeyMetadata(keyMeta, vchPubKey, true)) {
131 : : return false;
132 : : }
133 : :
134 : : // Compute a checksum of the encrypted key
135 : 0 : uint256 checksum = Hash(vchCryptedSecret);
136 : :
137 : 0 : const auto key = std::make_pair(DBKeys::CRYPTED_KEY, vchPubKey);
138 [ # # # # : 0 : if (!WriteIC(key, std::make_pair(vchCryptedSecret, checksum), false)) {
# # ]
139 : : // It may already exist, so try writing just the checksum
140 : 0 : std::vector<unsigned char> val;
141 [ # # # # ]: 0 : if (!m_batch->Read(key, val)) {
142 : : return false;
143 : : }
144 [ # # # # : 0 : if (!WriteIC(key, std::make_pair(val, checksum), true)) {
# # ]
145 : : return false;
146 : : }
147 : 0 : }
148 [ # # # # ]: 0 : EraseIC(std::make_pair(DBKeys::KEY, vchPubKey));
149 : 0 : return true;
150 : 0 : }
151 : :
152 : 0 : bool WalletBatch::WriteMasterKey(unsigned int nID, const CMasterKey& kMasterKey)
153 : : {
154 [ # # ]: 0 : return WriteIC(std::make_pair(DBKeys::MASTER_KEY, nID), kMasterKey, true);
155 : : }
156 : :
157 : 0 : bool WalletBatch::WriteCScript(const uint160& hash, const CScript& redeemScript)
158 : : {
159 [ # # ]: 0 : return WriteIC(std::make_pair(DBKeys::CSCRIPT, hash), redeemScript, false);
160 : : }
161 : :
162 : 0 : bool WalletBatch::WriteWatchOnly(const CScript &dest, const CKeyMetadata& keyMeta)
163 : : {
164 [ # # # # ]: 0 : if (!WriteIC(std::make_pair(DBKeys::WATCHMETA, dest), keyMeta)) {
165 : : return false;
166 : : }
167 [ # # ]: 0 : return WriteIC(std::make_pair(DBKeys::WATCHS, dest), uint8_t{'1'});
168 : : }
169 : :
170 : 0 : bool WalletBatch::EraseWatchOnly(const CScript &dest)
171 : : {
172 [ # # # # ]: 0 : if (!EraseIC(std::make_pair(DBKeys::WATCHMETA, dest))) {
173 : : return false;
174 : : }
175 [ # # ]: 0 : return EraseIC(std::make_pair(DBKeys::WATCHS, dest));
176 : : }
177 : :
178 : 0 : bool WalletBatch::WriteBestBlock(const CBlockLocator& locator)
179 : : {
180 [ # # ]: 0 : WriteIC(DBKeys::BESTBLOCK, CBlockLocator()); // Write empty block locator so versions that require a merkle branch automatically rescan
181 : 0 : return WriteIC(DBKeys::BESTBLOCK_NOMERKLE, locator);
182 : : }
183 : :
184 : 0 : bool WalletBatch::ReadBestBlock(CBlockLocator& locator)
185 : : {
186 [ # # # # ]: 0 : if (m_batch->Read(DBKeys::BESTBLOCK, locator) && !locator.vHave.empty()) return true;
187 : 0 : return m_batch->Read(DBKeys::BESTBLOCK_NOMERKLE, locator);
188 : : }
189 : :
190 : 0 : bool WalletBatch::IsEncrypted()
191 : : {
192 : 0 : DataStream prefix;
193 [ # # ]: 0 : prefix << DBKeys::MASTER_KEY;
194 [ # # # # ]: 0 : if (auto cursor = m_batch->GetNewPrefixCursor(prefix)) {
195 : 0 : DataStream k, v;
196 [ # # # # ]: 0 : if (cursor->Next(k, v) == DatabaseCursor::Status::MORE) return true;
197 : 0 : }
198 : 0 : return false;
199 : 0 : }
200 : :
201 : 188271 : bool WalletBatch::WriteOrderPosNext(int64_t nOrderPosNext)
202 : : {
203 : 188271 : return WriteIC(DBKeys::ORDERPOSNEXT, nOrderPosNext);
204 : : }
205 : :
206 : 0 : bool WalletBatch::ReadPool(int64_t nPool, CKeyPool& keypool)
207 : : {
208 [ # # ]: 0 : return m_batch->Read(std::make_pair(DBKeys::POOL, nPool), keypool);
209 : : }
210 : :
211 : 0 : bool WalletBatch::WritePool(int64_t nPool, const CKeyPool& keypool)
212 : : {
213 [ # # ]: 0 : return WriteIC(std::make_pair(DBKeys::POOL, nPool), keypool);
214 : : }
215 : :
216 : 0 : bool WalletBatch::ErasePool(int64_t nPool)
217 : : {
218 [ # # ]: 0 : return EraseIC(std::make_pair(DBKeys::POOL, nPool));
219 : : }
220 : :
221 : 0 : bool WalletBatch::WriteMinVersion(int nVersion)
222 : : {
223 : 0 : return WriteIC(DBKeys::MINVERSION, nVersion);
224 : : }
225 : :
226 : 28584 : bool WalletBatch::WriteActiveScriptPubKeyMan(uint8_t type, const uint256& id, bool internal)
227 : : {
228 [ + + ]: 42876 : std::string key = internal ? DBKeys::ACTIVEINTERNALSPK : DBKeys::ACTIVEEXTERNALSPK;
229 [ + - + - ]: 28584 : return WriteIC(make_pair(key, type), id);
230 : 28584 : }
231 : :
232 : 0 : bool WalletBatch::EraseActiveScriptPubKeyMan(uint8_t type, bool internal)
233 : : {
234 [ # # ]: 0 : const std::string key{internal ? DBKeys::ACTIVEINTERNALSPK : DBKeys::ACTIVEEXTERNALSPK};
235 [ # # # # ]: 0 : return EraseIC(make_pair(key, type));
236 : 0 : }
237 : :
238 : 29637 : bool WalletBatch::WriteDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const CPrivKey& privkey)
239 : : {
240 : : // hash pubkey/privkey to accelerate wallet load
241 : 29637 : std::vector<unsigned char> key;
242 [ + - ]: 29637 : key.reserve(pubkey.size() + privkey.size());
243 [ + - ]: 29637 : key.insert(key.end(), pubkey.begin(), pubkey.end());
244 [ + - ]: 29637 : key.insert(key.end(), privkey.begin(), privkey.end());
245 : :
246 [ + - + - : 59274 : return WriteIC(std::make_pair(DBKeys::WALLETDESCRIPTORKEY, std::make_pair(desc_id, pubkey)), std::make_pair(privkey, Hash(key)), false);
+ - ]
247 : 29637 : }
248 : :
249 : 0 : bool WalletBatch::WriteCryptedDescriptorKey(const uint256& desc_id, const CPubKey& pubkey, const std::vector<unsigned char>& secret)
250 : : {
251 [ # # # # ]: 0 : if (!WriteIC(std::make_pair(DBKeys::WALLETDESCRIPTORCKEY, std::make_pair(desc_id, pubkey)), secret, false)) {
252 : : return false;
253 : : }
254 [ # # ]: 0 : EraseIC(std::make_pair(DBKeys::WALLETDESCRIPTORKEY, std::make_pair(desc_id, pubkey)));
255 : 0 : return true;
256 : : }
257 : :
258 : 2127522 : bool WalletBatch::WriteDescriptor(const uint256& desc_id, const WalletDescriptor& descriptor)
259 : : {
260 [ + - ]: 2127522 : return WriteIC(make_pair(DBKeys::WALLETDESCRIPTOR, desc_id), descriptor);
261 : : }
262 : :
263 : 1634 : bool WalletBatch::WriteDescriptorDerivedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index, uint32_t der_index)
264 : : {
265 : 1634 : std::vector<unsigned char> ser_xpub(BIP32_EXTKEY_SIZE);
266 [ + - ]: 1634 : xpub.Encode(ser_xpub.data());
267 [ + - + - ]: 1634 : return WriteIC(std::make_pair(std::make_pair(DBKeys::WALLETDESCRIPTORCACHE, desc_id), std::make_pair(key_exp_index, der_index)), ser_xpub);
268 : 1634 : }
269 : :
270 : 30169 : bool WalletBatch::WriteDescriptorParentCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index)
271 : : {
272 : 30169 : std::vector<unsigned char> ser_xpub(BIP32_EXTKEY_SIZE);
273 [ + - ]: 30169 : xpub.Encode(ser_xpub.data());
274 [ + - + - ]: 30169 : return WriteIC(std::make_pair(std::make_pair(DBKeys::WALLETDESCRIPTORCACHE, desc_id), key_exp_index), ser_xpub);
275 : 30169 : }
276 : :
277 : 155 : bool WalletBatch::WriteDescriptorLastHardenedCache(const CExtPubKey& xpub, const uint256& desc_id, uint32_t key_exp_index)
278 : : {
279 : 155 : std::vector<unsigned char> ser_xpub(BIP32_EXTKEY_SIZE);
280 [ + - ]: 155 : xpub.Encode(ser_xpub.data());
281 [ + - + - ]: 155 : return WriteIC(std::make_pair(std::make_pair(DBKeys::WALLETDESCRIPTORLHCACHE, desc_id), key_exp_index), ser_xpub);
282 : 155 : }
283 : :
284 : 757034 : bool WalletBatch::WriteDescriptorCacheItems(const uint256& desc_id, const DescriptorCache& cache)
285 : : {
286 [ + + ]: 787203 : for (const auto& parent_xpub_pair : cache.GetCachedParentExtPubKeys()) {
287 [ + - - + ]: 30169 : if (!WriteDescriptorParentCache(parent_xpub_pair.second, desc_id, parent_xpub_pair.first)) {
288 : 0 : return false;
289 : : }
290 : 0 : }
291 [ + + ]: 758668 : for (const auto& derived_xpub_map_pair : cache.GetCachedDerivedExtPubKeys()) {
292 [ + + ]: 3268 : for (const auto& derived_xpub_pair : derived_xpub_map_pair.second) {
293 [ + - - + ]: 1634 : if (!WriteDescriptorDerivedCache(derived_xpub_pair.second, desc_id, derived_xpub_map_pair.first, derived_xpub_pair.first)) {
294 : 0 : return false;
295 : : }
296 : : }
297 : 0 : }
298 [ + + ]: 757189 : for (const auto& lh_xpub_pair : cache.GetCachedLastHardenedExtPubKeys()) {
299 [ + - - + ]: 155 : if (!WriteDescriptorLastHardenedCache(lh_xpub_pair.second, desc_id, lh_xpub_pair.first)) {
300 : 0 : return false;
301 : : }
302 : 0 : }
303 : 757034 : return true;
304 : : }
305 : :
306 : 0 : bool WalletBatch::WriteLockedUTXO(const COutPoint& output)
307 : : {
308 [ # # ]: 0 : return WriteIC(std::make_pair(DBKeys::LOCKED_UTXO, std::make_pair(output.hash, output.n)), uint8_t{'1'});
309 : : }
310 : :
311 : 0 : bool WalletBatch::EraseLockedUTXO(const COutPoint& output)
312 : : {
313 [ # # ]: 0 : return EraseIC(std::make_pair(DBKeys::LOCKED_UTXO, std::make_pair(output.hash, output.n)));
314 : : }
315 : :
316 : 0 : bool LoadKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr)
317 : : {
318 : 0 : LOCK(pwallet->cs_wallet);
319 : 0 : try {
320 [ # # ]: 0 : CPubKey vchPubKey;
321 [ # # ]: 0 : ssKey >> vchPubKey;
322 [ # # ]: 0 : if (!vchPubKey.IsValid())
323 : : {
324 [ # # # # ]: 0 : strErr = "Error reading wallet database: CPubKey corrupt";
325 : : return false;
326 : : }
327 : 0 : CKey key;
328 : 0 : CPrivKey pkey;
329 : 0 : uint256 hash;
330 : :
331 [ # # ]: 0 : ssValue >> pkey;
332 : :
333 : : // Old wallets store keys as DBKeys::KEY [pubkey] => [privkey]
334 : : // ... which was slow for wallets with lots of keys, because the public key is re-derived from the private key
335 : : // using EC operations as a checksum.
336 : : // Newer wallets store keys as DBKeys::KEY [pubkey] => [privkey][hash(pubkey,privkey)], which is much faster while
337 : : // remaining backwards-compatible.
338 : 0 : try
339 : : {
340 [ # # ]: 0 : ssValue >> hash;
341 : : }
342 [ - - ]: 0 : catch (const std::ios_base::failure&) {}
343 : :
344 : 0 : bool fSkipCheck = false;
345 : :
346 [ # # ]: 0 : if (!hash.IsNull())
347 : : {
348 : : // hash pubkey/privkey to accelerate wallet load
349 : 0 : std::vector<unsigned char> vchKey;
350 [ # # ]: 0 : vchKey.reserve(vchPubKey.size() + pkey.size());
351 [ # # ]: 0 : vchKey.insert(vchKey.end(), vchPubKey.begin(), vchPubKey.end());
352 [ # # ]: 0 : vchKey.insert(vchKey.end(), pkey.begin(), pkey.end());
353 : :
354 [ # # # # ]: 0 : if (Hash(vchKey) != hash)
355 : : {
356 [ # # ]: 0 : strErr = "Error reading wallet database: CPubKey/CPrivKey corrupt";
357 : 0 : return false;
358 : : }
359 : :
360 : 0 : fSkipCheck = true;
361 : 0 : }
362 : :
363 [ # # # # ]: 0 : if (!key.Load(pkey, vchPubKey, fSkipCheck))
364 : : {
365 [ # # ]: 0 : strErr = "Error reading wallet database: CPrivKey corrupt";
366 : : return false;
367 : : }
368 [ # # # # : 0 : if (!pwallet->GetOrCreateLegacyDataSPKM()->LoadKey(key, vchPubKey))
# # ]
369 : : {
370 [ # # ]: 0 : strErr = "Error reading wallet database: LegacyDataSPKM::LoadKey failed";
371 : : return false;
372 : : }
373 [ # # ]: 0 : } catch (const std::exception& e) {
374 [ - - ]: 0 : if (strErr.empty()) {
375 [ - - ]: 0 : strErr = e.what();
376 : : }
377 : 0 : return false;
378 : 0 : }
379 : 0 : return true;
380 : 0 : }
381 : :
382 : 0 : bool LoadCryptedKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr)
383 : : {
384 : 0 : LOCK(pwallet->cs_wallet);
385 : 0 : try {
386 [ # # ]: 0 : CPubKey vchPubKey;
387 [ # # ]: 0 : ssKey >> vchPubKey;
388 [ # # ]: 0 : if (!vchPubKey.IsValid())
389 : : {
390 [ # # # # ]: 0 : strErr = "Error reading wallet database: CPubKey corrupt";
391 : : return false;
392 : : }
393 : 0 : std::vector<unsigned char> vchPrivKey;
394 [ # # ]: 0 : ssValue >> vchPrivKey;
395 : :
396 : : // Get the checksum and check it
397 : 0 : bool checksum_valid = false;
398 [ # # ]: 0 : if (!ssValue.eof()) {
399 : 0 : uint256 checksum;
400 [ # # ]: 0 : ssValue >> checksum;
401 [ # # # # ]: 0 : if (!(checksum_valid = Hash(vchPrivKey) == checksum)) {
402 [ # # ]: 0 : strErr = "Error reading wallet database: Encrypted key corrupt";
403 : : return false;
404 : : }
405 : : }
406 : :
407 [ # # # # : 0 : if (!pwallet->GetOrCreateLegacyDataSPKM()->LoadCryptedKey(vchPubKey, vchPrivKey, checksum_valid))
# # ]
408 : : {
409 [ # # ]: 0 : strErr = "Error reading wallet database: LegacyDataSPKM::LoadCryptedKey failed";
410 : : return false;
411 : : }
412 [ # # ]: 0 : } catch (const std::exception& e) {
413 [ - - ]: 0 : if (strErr.empty()) {
414 [ - - ]: 0 : strErr = e.what();
415 : : }
416 : 0 : return false;
417 : 0 : }
418 : 0 : return true;
419 : 0 : }
420 : :
421 : 0 : bool LoadEncryptionKey(CWallet* pwallet, DataStream& ssKey, DataStream& ssValue, std::string& strErr)
422 : : {
423 : 0 : LOCK(pwallet->cs_wallet);
424 : 0 : try {
425 : : // Master encryption key is loaded into only the wallet and not any of the ScriptPubKeyMans.
426 : 0 : unsigned int nID;
427 [ # # ]: 0 : ssKey >> nID;
428 [ # # ]: 0 : CMasterKey kMasterKey;
429 [ # # ]: 0 : ssValue >> kMasterKey;
430 [ # # ]: 0 : if(pwallet->mapMasterKeys.count(nID) != 0)
431 : : {
432 [ # # ]: 0 : strErr = strprintf("Error reading wallet database: duplicate CMasterKey id %u", nID);
433 : 0 : return false;
434 : : }
435 [ # # # # ]: 0 : pwallet->mapMasterKeys[nID] = kMasterKey;
436 [ # # ]: 0 : if (pwallet->nMasterKeyMaxID < nID)
437 : 0 : pwallet->nMasterKeyMaxID = nID;
438 : :
439 [ # # ]: 0 : } catch (const std::exception& e) {
440 [ - - ]: 0 : if (strErr.empty()) {
441 [ - - ]: 0 : strErr = e.what();
442 : : }
443 : 0 : return false;
444 : 0 : }
445 : 0 : return true;
446 : 0 : }
447 : :
448 : 0 : bool LoadHDChain(CWallet* pwallet, DataStream& ssValue, std::string& strErr)
449 : : {
450 : 0 : LOCK(pwallet->cs_wallet);
451 : 0 : try {
452 : 0 : CHDChain chain;
453 [ # # ]: 0 : ssValue >> chain;
454 [ # # # # ]: 0 : pwallet->GetOrCreateLegacyDataSPKM()->LoadHDChain(chain);
455 [ - - ]: 0 : } catch (const std::exception& e) {
456 [ - - ]: 0 : if (strErr.empty()) {
457 [ - - ]: 0 : strErr = e.what();
458 : : }
459 : 0 : return false;
460 : 0 : }
461 : : return true;
462 : 0 : }
463 : :
464 : 0 : static DBErrors LoadMinVersion(CWallet* pwallet, DatabaseBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
465 : : {
466 : 0 : AssertLockHeld(pwallet->cs_wallet);
467 : 0 : int nMinVersion = 0;
468 [ # # ]: 0 : if (batch.Read(DBKeys::MINVERSION, nMinVersion)) {
469 [ # # ]: 0 : if (nMinVersion > FEATURE_LATEST)
470 : : return DBErrors::TOO_NEW;
471 : 0 : pwallet->LoadMinVersion(nMinVersion);
472 : : }
473 : : return DBErrors::LOAD_OK;
474 : : }
475 : :
476 : 0 : static DBErrors LoadWalletFlags(CWallet* pwallet, DatabaseBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
477 : : {
478 : 0 : AssertLockHeld(pwallet->cs_wallet);
479 : 0 : uint64_t flags;
480 [ # # ]: 0 : if (batch.Read(DBKeys::FLAGS, flags)) {
481 [ # # ]: 0 : if (!pwallet->LoadWalletFlags(flags)) {
482 : 0 : pwallet->WalletLogPrintf("Error reading wallet database: Unknown non-tolerable wallet flags found\n");
483 : 0 : return DBErrors::TOO_NEW;
484 : : }
485 : : }
486 : : return DBErrors::LOAD_OK;
487 : : }
488 : :
489 : : struct LoadResult
490 : : {
491 : : DBErrors m_result{DBErrors::LOAD_OK};
492 : : int m_records{0};
493 : : };
494 : :
495 : : using LoadFunc = std::function<DBErrors(CWallet* pwallet, DataStream& key, DataStream& value, std::string& err)>;
496 : 0 : static LoadResult LoadRecords(CWallet* pwallet, DatabaseBatch& batch, const std::string& key, DataStream& prefix, LoadFunc load_func)
497 : : {
498 : 0 : LoadResult result;
499 : 0 : DataStream ssKey;
500 : 0 : DataStream ssValue{};
501 : :
502 [ # # ]: 0 : Assume(!prefix.empty());
503 [ # # ]: 0 : std::unique_ptr<DatabaseCursor> cursor = batch.GetNewPrefixCursor(prefix);
504 [ # # ]: 0 : if (!cursor) {
505 [ # # ]: 0 : pwallet->WalletLogPrintf("Error getting database cursor for '%s' records\n", key);
506 : 0 : result.m_result = DBErrors::CORRUPT;
507 : 0 : return result;
508 : : }
509 : :
510 : 0 : while (true) {
511 [ # # ]: 0 : DatabaseCursor::Status status = cursor->Next(ssKey, ssValue);
512 [ # # ]: 0 : if (status == DatabaseCursor::Status::DONE) {
513 : : break;
514 [ # # ]: 0 : } else if (status == DatabaseCursor::Status::FAIL) {
515 [ # # ]: 0 : pwallet->WalletLogPrintf("Error reading next '%s' record for wallet database\n", key);
516 : 0 : result.m_result = DBErrors::CORRUPT;
517 : 0 : return result;
518 : : }
519 [ # # ]: 0 : std::string type;
520 [ # # ]: 0 : ssKey >> type;
521 [ # # ]: 0 : assert(type == key);
522 [ # # ]: 0 : std::string error;
523 [ # # ]: 0 : DBErrors record_res = load_func(pwallet, ssKey, ssValue, error);
524 [ # # ]: 0 : if (record_res != DBErrors::LOAD_OK) {
525 [ # # ]: 0 : pwallet->WalletLogPrintf("%s\n", error);
526 : : }
527 [ # # ]: 0 : result.m_result = std::max(result.m_result, record_res);
528 : 0 : ++result.m_records;
529 : 0 : }
530 : 0 : return result;
531 : 0 : }
532 : :
533 : 0 : static LoadResult LoadRecords(CWallet* pwallet, DatabaseBatch& batch, const std::string& key, LoadFunc load_func)
534 : : {
535 : 0 : DataStream prefix;
536 [ # # ]: 0 : prefix << key;
537 [ # # # # ]: 0 : return LoadRecords(pwallet, batch, key, prefix, load_func);
538 : 0 : }
539 : :
540 : 0 : static DBErrors LoadLegacyWalletRecords(CWallet* pwallet, DatabaseBatch& batch, int last_client) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
541 : : {
542 : 0 : AssertLockHeld(pwallet->cs_wallet);
543 : 0 : DBErrors result = DBErrors::LOAD_OK;
544 : :
545 : : // Make sure descriptor wallets don't have any legacy records
546 [ # # ]: 0 : if (pwallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
547 [ # # ]: 0 : for (const auto& type : DBKeys::LEGACY_TYPES) {
548 : 0 : DataStream key;
549 : 0 : DataStream value{};
550 : :
551 : 0 : DataStream prefix;
552 [ # # ]: 0 : prefix << type;
553 [ # # ]: 0 : std::unique_ptr<DatabaseCursor> cursor = batch.GetNewPrefixCursor(prefix);
554 [ # # ]: 0 : if (!cursor) {
555 [ # # ]: 0 : pwallet->WalletLogPrintf("Error getting database cursor for '%s' records\n", type);
556 : : return DBErrors::CORRUPT;
557 : : }
558 : :
559 [ # # ]: 0 : DatabaseCursor::Status status = cursor->Next(key, value);
560 [ # # ]: 0 : if (status != DatabaseCursor::Status::DONE) {
561 [ # # ]: 0 : pwallet->WalletLogPrintf("Error: Unexpected legacy entry found in descriptor wallet %s. The wallet might have been tampered with or created with malicious intent.\n", pwallet->GetName());
562 : : return DBErrors::UNEXPECTED_LEGACY_ENTRY;
563 : : }
564 : 0 : }
565 : :
566 : : return DBErrors::LOAD_OK;
567 : : }
568 : :
569 : : // Load HD Chain
570 : : // Note: There should only be one HDCHAIN record with no data following the type
571 [ # # ]: 0 : LoadResult hd_chain_res = LoadRecords(pwallet, batch, DBKeys::HDCHAIN,
572 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
573 [ # # ]: 0 : return LoadHDChain(pwallet, value, err) ? DBErrors:: LOAD_OK : DBErrors::CORRUPT;
574 : : });
575 [ # # ]: 0 : result = std::max(result, hd_chain_res.m_result);
576 : :
577 : : // Load unencrypted keys
578 [ # # ]: 0 : LoadResult key_res = LoadRecords(pwallet, batch, DBKeys::KEY,
579 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
580 [ # # ]: 0 : return LoadKey(pwallet, key, value, err) ? DBErrors::LOAD_OK : DBErrors::CORRUPT;
581 : : });
582 [ # # ]: 0 : result = std::max(result, key_res.m_result);
583 : :
584 : : // Load encrypted keys
585 [ # # ]: 0 : LoadResult ckey_res = LoadRecords(pwallet, batch, DBKeys::CRYPTED_KEY,
586 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
587 [ # # ]: 0 : return LoadCryptedKey(pwallet, key, value, err) ? DBErrors::LOAD_OK : DBErrors::CORRUPT;
588 : : });
589 [ # # ]: 0 : result = std::max(result, ckey_res.m_result);
590 : :
591 : : // Load scripts
592 [ # # ]: 0 : LoadResult script_res = LoadRecords(pwallet, batch, DBKeys::CSCRIPT,
593 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& strErr) {
594 : 0 : uint160 hash;
595 : 0 : key >> hash;
596 : 0 : CScript script;
597 [ # # ]: 0 : value >> script;
598 [ # # # # : 0 : if (!pwallet->GetOrCreateLegacyDataSPKM()->LoadCScript(script))
# # ]
599 : : {
600 [ # # ]: 0 : strErr = "Error reading wallet database: LegacyDataSPKM::LoadCScript failed";
601 : : return DBErrors::NONCRITICAL_ERROR;
602 : : }
603 : : return DBErrors::LOAD_OK;
604 : 0 : });
605 [ # # ]: 0 : result = std::max(result, script_res.m_result);
606 : :
607 : : // Check whether rewrite is needed
608 [ # # ]: 0 : if (ckey_res.m_records > 0) {
609 : : // Rewrite encrypted wallets of versions 0.4.0 and 0.5.0rc:
610 [ # # # # ]: 0 : if (last_client == 40000 || last_client == 50000) result = std::max(result, DBErrors::NEED_REWRITE);
611 : : }
612 : :
613 : : // Load keymeta
614 [ # # ]: 0 : std::map<uint160, CHDChain> hd_chains;
615 : 0 : LoadResult keymeta_res = LoadRecords(pwallet, batch, DBKeys::KEYMETA,
616 [ # # ]: 0 : [&hd_chains] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& strErr) {
617 : 0 : CPubKey vchPubKey;
618 : 0 : key >> vchPubKey;
619 : 0 : CKeyMetadata keyMeta;
620 [ # # ]: 0 : value >> keyMeta;
621 [ # # # # : 0 : pwallet->GetOrCreateLegacyDataSPKM()->LoadKeyMetadata(vchPubKey.GetID(), keyMeta);
# # ]
622 : :
623 : : // Extract some CHDChain info from this metadata if it has any
624 [ # # # # : 0 : if (keyMeta.nVersion >= CKeyMetadata::VERSION_WITH_HDDATA && !keyMeta.hd_seed_id.IsNull() && keyMeta.hdKeypath.size() > 0) {
# # ]
625 : : // Get the path from the key origin or from the path string
626 : : // Not applicable when path is "s" or "m" as those indicate a seed
627 : : // See https://github.com/bitcoin/bitcoin/pull/12924
628 : 0 : bool internal = false;
629 : 0 : uint32_t index = 0;
630 [ # # # # ]: 0 : if (keyMeta.hdKeypath != "s" && keyMeta.hdKeypath != "m") {
631 : 0 : std::vector<uint32_t> path;
632 [ # # ]: 0 : if (keyMeta.has_key_origin) {
633 : : // We have a key origin, so pull it from its path vector
634 [ # # ]: 0 : path = keyMeta.key_origin.path;
635 : : } else {
636 : : // No key origin, have to parse the string
637 [ # # # # ]: 0 : if (!ParseHDKeypath(keyMeta.hdKeypath, path)) {
638 [ # # ]: 0 : strErr = "Error reading wallet database: keymeta with invalid HD keypath";
639 : : return DBErrors::NONCRITICAL_ERROR;
640 : : }
641 : : }
642 : :
643 : : // Extract the index and internal from the path
644 : : // Path string is m/0'/k'/i'
645 : : // Path vector is [0', k', i'] (but as ints OR'd with the hardened bit
646 : : // k == 0 for external, 1 for internal. i is the index
647 [ # # ]: 0 : if (path.size() != 3) {
648 [ # # ]: 0 : strErr = "Error reading wallet database: keymeta found with unexpected path";
649 : : return DBErrors::NONCRITICAL_ERROR;
650 : : }
651 [ # # ]: 0 : if (path[0] != 0x80000000) {
652 [ # # ]: 0 : strErr = strprintf("Unexpected path index of 0x%08x (expected 0x80000000) for the element at index 0", path[0]);
653 : 0 : return DBErrors::NONCRITICAL_ERROR;
654 : : }
655 [ # # # # ]: 0 : if (path[1] != 0x80000000 && path[1] != (1 | 0x80000000)) {
656 [ # # ]: 0 : strErr = strprintf("Unexpected path index of 0x%08x (expected 0x80000000 or 0x80000001) for the element at index 1", path[1]);
657 : 0 : return DBErrors::NONCRITICAL_ERROR;
658 : : }
659 [ # # ]: 0 : if ((path[2] & 0x80000000) == 0) {
660 [ # # ]: 0 : strErr = strprintf("Unexpected path index of 0x%08x (expected to be greater than or equal to 0x80000000)", path[2]);
661 : 0 : return DBErrors::NONCRITICAL_ERROR;
662 : : }
663 : 0 : internal = path[1] == (1 | 0x80000000);
664 : 0 : index = path[2] & ~0x80000000;
665 : 0 : }
666 : :
667 : : // Insert a new CHDChain, or get the one that already exists
668 [ # # # # ]: 0 : auto [ins, inserted] = hd_chains.emplace(keyMeta.hd_seed_id, CHDChain());
669 [ # # ]: 0 : CHDChain& chain = ins->second;
670 [ # # ]: 0 : if (inserted) {
671 : : // For new chains, we want to default to VERSION_HD_BASE until we see an internal
672 : 0 : chain.nVersion = CHDChain::VERSION_HD_BASE;
673 : 0 : chain.seed_id = keyMeta.hd_seed_id;
674 : : }
675 [ # # ]: 0 : if (internal) {
676 : 0 : chain.nVersion = CHDChain::VERSION_HD_CHAIN_SPLIT;
677 [ # # ]: 0 : chain.nInternalChainCounter = std::max(chain.nInternalChainCounter, index + 1);
678 : : } else {
679 [ # # ]: 0 : chain.nExternalChainCounter = std::max(chain.nExternalChainCounter, index + 1);
680 : : }
681 : : }
682 : : return DBErrors::LOAD_OK;
683 : 0 : });
684 [ # # ]: 0 : result = std::max(result, keymeta_res.m_result);
685 : :
686 : : // Set inactive chains
687 [ # # ]: 0 : if (!hd_chains.empty()) {
688 [ # # ]: 0 : LegacyDataSPKM* legacy_spkm = pwallet->GetLegacyDataSPKM();
689 [ # # ]: 0 : if (legacy_spkm) {
690 [ # # # # ]: 0 : for (const auto& [hd_seed_id, chain] : hd_chains) {
691 [ # # ]: 0 : if (hd_seed_id != legacy_spkm->GetHDChain().seed_id) {
692 [ # # ]: 0 : legacy_spkm->AddInactiveHDChain(chain);
693 : : }
694 : : }
695 : : } else {
696 [ # # ]: 0 : pwallet->WalletLogPrintf("Inactive HD Chains found but no Legacy ScriptPubKeyMan\n");
697 : 0 : result = DBErrors::CORRUPT;
698 : : }
699 : : }
700 : :
701 : : // Load watchonly scripts
702 [ # # ]: 0 : LoadResult watch_script_res = LoadRecords(pwallet, batch, DBKeys::WATCHS,
703 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
704 : 0 : CScript script;
705 [ # # ]: 0 : key >> script;
706 : 0 : uint8_t fYes;
707 [ # # ]: 0 : value >> fYes;
708 [ # # ]: 0 : if (fYes == '1') {
709 [ # # # # ]: 0 : pwallet->GetOrCreateLegacyDataSPKM()->LoadWatchOnly(script);
710 : : }
711 : 0 : return DBErrors::LOAD_OK;
712 : 0 : });
713 [ # # ]: 0 : result = std::max(result, watch_script_res.m_result);
714 : :
715 : : // Load watchonly meta
716 [ # # ]: 0 : LoadResult watch_meta_res = LoadRecords(pwallet, batch, DBKeys::WATCHMETA,
717 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
718 : 0 : CScript script;
719 [ # # ]: 0 : key >> script;
720 : 0 : CKeyMetadata keyMeta;
721 [ # # ]: 0 : value >> keyMeta;
722 [ # # # # : 0 : pwallet->GetOrCreateLegacyDataSPKM()->LoadScriptMetadata(CScriptID(script), keyMeta);
# # ]
723 : 0 : return DBErrors::LOAD_OK;
724 : 0 : });
725 [ # # ]: 0 : result = std::max(result, watch_meta_res.m_result);
726 : :
727 : : // Load keypool
728 [ # # ]: 0 : LoadResult pool_res = LoadRecords(pwallet, batch, DBKeys::POOL,
729 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
730 : 0 : int64_t nIndex;
731 : 0 : key >> nIndex;
732 : 0 : CKeyPool keypool;
733 : 0 : value >> keypool;
734 : 0 : pwallet->GetOrCreateLegacyDataSPKM()->LoadKeyPool(nIndex, keypool);
735 : 0 : return DBErrors::LOAD_OK;
736 : : });
737 [ # # ]: 0 : result = std::max(result, pool_res.m_result);
738 : :
739 : : // Deal with old "wkey" and "defaultkey" records.
740 : : // These are not actually loaded, but we need to check for them
741 : :
742 : : // We don't want or need the default key, but if there is one set,
743 : : // we want to make sure that it is valid so that we can detect corruption
744 : : // Note: There should only be one DEFAULTKEY with nothing trailing the type
745 [ # # ]: 0 : LoadResult default_key_res = LoadRecords(pwallet, batch, DBKeys::DEFAULTKEY,
746 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
747 [ # # ]: 0 : CPubKey default_pubkey;
748 : 0 : try {
749 [ # # ]: 0 : value >> default_pubkey;
750 [ - - ]: 0 : } catch (const std::exception& e) {
751 [ - - ]: 0 : err = e.what();
752 : 0 : return DBErrors::CORRUPT;
753 : 0 : }
754 [ # # ]: 0 : if (!default_pubkey.IsValid()) {
755 : 0 : err = "Error reading wallet database: Default Key corrupt";
756 : 0 : return DBErrors::CORRUPT;
757 : : }
758 : : return DBErrors::LOAD_OK;
759 : : });
760 [ # # ]: 0 : result = std::max(result, default_key_res.m_result);
761 : :
762 : : // "wkey" records are unsupported, if we see any, throw an error
763 [ # # ]: 0 : LoadResult wkey_res = LoadRecords(pwallet, batch, DBKeys::OLD_KEY,
764 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
765 : 0 : err = "Found unsupported 'wkey' record, try loading with version 0.18";
766 : 0 : return DBErrors::LOAD_FAIL;
767 : : });
768 [ # # ]: 0 : result = std::max(result, wkey_res.m_result);
769 : :
770 [ # # ]: 0 : if (result <= DBErrors::NONCRITICAL_ERROR) {
771 : : // Only do logging and time first key update if there were no critical errors
772 : 0 : pwallet->WalletLogPrintf("Legacy Wallet Keys: %u plaintext, %u encrypted, %u w/ metadata, %u total.\n",
773 [ # # ]: 0 : key_res.m_records, ckey_res.m_records, keymeta_res.m_records, key_res.m_records + ckey_res.m_records);
774 : :
775 : : // nTimeFirstKey is only reliable if all keys have metadata
776 [ # # # # : 0 : if (pwallet->IsLegacy() && (key_res.m_records + ckey_res.m_records + watch_script_res.m_records) != (keymeta_res.m_records + watch_meta_res.m_records)) {
# # ]
777 [ # # ]: 0 : auto spk_man = pwallet->GetLegacyScriptPubKeyMan();
778 [ # # ]: 0 : if (spk_man) {
779 [ # # ]: 0 : LOCK(spk_man->cs_KeyStore);
780 [ # # ]: 0 : spk_man->UpdateTimeFirstKey(1);
781 : 0 : }
782 : : }
783 : : }
784 : :
785 : 0 : return result;
786 : 0 : }
787 : :
788 : : template<typename... Args>
789 : 0 : static DataStream PrefixStream(const Args&... args)
790 : : {
791 : 0 : DataStream prefix;
792 [ # # ]: 0 : SerializeMany(prefix, args...);
793 : 0 : return prefix;
794 : 0 : }
795 : :
796 : 0 : static DBErrors LoadDescriptorWalletRecords(CWallet* pwallet, DatabaseBatch& batch, int last_client) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
797 : : {
798 : 0 : AssertLockHeld(pwallet->cs_wallet);
799 : :
800 : : // Load descriptor record
801 : 0 : int num_keys = 0;
802 : 0 : int num_ckeys= 0;
803 [ # # ]: 0 : LoadResult desc_res = LoadRecords(pwallet, batch, DBKeys::WALLETDESCRIPTOR,
804 : 0 : [&batch, &num_keys, &num_ckeys, &last_client] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& strErr) {
805 : 0 : DBErrors result = DBErrors::LOAD_OK;
806 : :
807 : 0 : uint256 id;
808 : 0 : key >> id;
809 : 0 : WalletDescriptor desc;
810 : 0 : try {
811 [ # # ]: 0 : value >> desc;
812 [ - - ]: 0 : } catch (const std::ios_base::failure& e) {
813 [ - - ]: 0 : strErr = strprintf("Error: Unrecognized descriptor found in wallet %s. ", pwallet->GetName());
814 : 0 : strErr += (last_client > CLIENT_VERSION) ? "The wallet might had been created on a newer version. " :
815 [ - - ]: 0 : "The database might be corrupted or the software version is not compatible with one of your wallet descriptors. ";
816 [ - - ]: 0 : strErr += "Please try running the latest software version";
817 : : // Also include error details
818 [ - - ]: 0 : strErr = strprintf("%s\nDetails: %s", strErr, e.what());
819 : 0 : return DBErrors::UNKNOWN_DESCRIPTOR;
820 : 0 : }
821 [ # # ]: 0 : DescriptorScriptPubKeyMan& spkm = pwallet->LoadDescriptorScriptPubKeyMan(id, desc);
822 : :
823 : : // Prior to doing anything with this spkm, verify ID compatibility
824 [ # # # # ]: 0 : if (id != spkm.GetID()) {
825 [ # # ]: 0 : strErr = "The descriptor ID calculated by the wallet differs from the one in DB";
826 : : return DBErrors::CORRUPT;
827 : : }
828 : :
829 : 0 : DescriptorCache cache;
830 : :
831 : : // Get key cache for this descriptor
832 [ # # ]: 0 : DataStream prefix = PrefixStream(DBKeys::WALLETDESCRIPTORCACHE, id);
833 : 0 : LoadResult key_cache_res = LoadRecords(pwallet, batch, DBKeys::WALLETDESCRIPTORCACHE, prefix,
834 [ # # ]: 0 : [&id, &cache] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
835 : 0 : bool parent = true;
836 : 0 : uint256 desc_id;
837 : 0 : uint32_t key_exp_index;
838 : 0 : uint32_t der_index;
839 : 0 : key >> desc_id;
840 [ # # ]: 0 : assert(desc_id == id);
841 : 0 : key >> key_exp_index;
842 : :
843 : : // if the der_index exists, it's a derived xpub
844 : 0 : try
845 : : {
846 [ # # ]: 0 : key >> der_index;
847 : : parent = false;
848 : : }
849 : 0 : catch (...) {}
850 : :
851 : 0 : std::vector<unsigned char> ser_xpub(BIP32_EXTKEY_SIZE);
852 [ # # ]: 0 : value >> ser_xpub;
853 [ # # ]: 0 : CExtPubKey xpub;
854 [ # # ]: 0 : xpub.Decode(ser_xpub.data());
855 [ # # ]: 0 : if (parent) {
856 [ # # ]: 0 : cache.CacheParentExtPubKey(key_exp_index, xpub);
857 : : } else {
858 [ # # ]: 0 : cache.CacheDerivedExtPubKey(key_exp_index, der_index, xpub);
859 : : }
860 : 0 : return DBErrors::LOAD_OK;
861 : 0 : });
862 [ # # ]: 0 : result = std::max(result, key_cache_res.m_result);
863 : :
864 : : // Get last hardened cache for this descriptor
865 [ # # ]: 0 : prefix = PrefixStream(DBKeys::WALLETDESCRIPTORLHCACHE, id);
866 : 0 : LoadResult lh_cache_res = LoadRecords(pwallet, batch, DBKeys::WALLETDESCRIPTORLHCACHE, prefix,
867 [ # # ]: 0 : [&id, &cache] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
868 : 0 : uint256 desc_id;
869 : 0 : uint32_t key_exp_index;
870 : 0 : key >> desc_id;
871 [ # # ]: 0 : assert(desc_id == id);
872 : 0 : key >> key_exp_index;
873 : :
874 : 0 : std::vector<unsigned char> ser_xpub(BIP32_EXTKEY_SIZE);
875 [ # # ]: 0 : value >> ser_xpub;
876 [ # # ]: 0 : CExtPubKey xpub;
877 [ # # ]: 0 : xpub.Decode(ser_xpub.data());
878 [ # # ]: 0 : cache.CacheLastHardenedExtPubKey(key_exp_index, xpub);
879 : 0 : return DBErrors::LOAD_OK;
880 : 0 : });
881 [ # # ]: 0 : result = std::max(result, lh_cache_res.m_result);
882 : :
883 : : // Set the cache for this descriptor
884 [ # # ]: 0 : auto spk_man = (DescriptorScriptPubKeyMan*)pwallet->GetScriptPubKeyMan(id);
885 [ # # ]: 0 : assert(spk_man);
886 [ # # ]: 0 : spk_man->SetCache(cache);
887 : :
888 : : // Get unencrypted keys
889 [ # # ]: 0 : prefix = PrefixStream(DBKeys::WALLETDESCRIPTORKEY, id);
890 : 0 : LoadResult key_res = LoadRecords(pwallet, batch, DBKeys::WALLETDESCRIPTORKEY, prefix,
891 [ # # ]: 0 : [&id, &spk_man] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& strErr) {
892 : 0 : uint256 desc_id;
893 : 0 : CPubKey pubkey;
894 : 0 : key >> desc_id;
895 [ # # ]: 0 : assert(desc_id == id);
896 : 0 : key >> pubkey;
897 [ # # ]: 0 : if (!pubkey.IsValid())
898 : : {
899 : 0 : strErr = "Error reading wallet database: descriptor unencrypted key CPubKey corrupt";
900 : 0 : return DBErrors::CORRUPT;
901 : : }
902 : 0 : CKey privkey;
903 : 0 : CPrivKey pkey;
904 : 0 : uint256 hash;
905 : :
906 [ # # ]: 0 : value >> pkey;
907 [ # # ]: 0 : value >> hash;
908 : :
909 : : // hash pubkey/privkey to accelerate wallet load
910 : 0 : std::vector<unsigned char> to_hash;
911 [ # # ]: 0 : to_hash.reserve(pubkey.size() + pkey.size());
912 [ # # ]: 0 : to_hash.insert(to_hash.end(), pubkey.begin(), pubkey.end());
913 [ # # ]: 0 : to_hash.insert(to_hash.end(), pkey.begin(), pkey.end());
914 : :
915 [ # # # # ]: 0 : if (Hash(to_hash) != hash)
916 : : {
917 [ # # ]: 0 : strErr = "Error reading wallet database: descriptor unencrypted key CPubKey/CPrivKey corrupt";
918 : : return DBErrors::CORRUPT;
919 : : }
920 : :
921 [ # # # # ]: 0 : if (!privkey.Load(pkey, pubkey, true))
922 : : {
923 [ # # ]: 0 : strErr = "Error reading wallet database: descriptor unencrypted key CPrivKey corrupt";
924 : : return DBErrors::CORRUPT;
925 : : }
926 [ # # # # ]: 0 : spk_man->AddKey(pubkey.GetID(), privkey);
927 : : return DBErrors::LOAD_OK;
928 : 0 : });
929 [ # # ]: 0 : result = std::max(result, key_res.m_result);
930 : 0 : num_keys = key_res.m_records;
931 : :
932 : : // Get encrypted keys
933 [ # # ]: 0 : prefix = PrefixStream(DBKeys::WALLETDESCRIPTORCKEY, id);
934 : 0 : LoadResult ckey_res = LoadRecords(pwallet, batch, DBKeys::WALLETDESCRIPTORCKEY, prefix,
935 [ # # ]: 0 : [&id, &spk_man] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
936 : 0 : uint256 desc_id;
937 : 0 : CPubKey pubkey;
938 : 0 : key >> desc_id;
939 [ # # ]: 0 : assert(desc_id == id);
940 : 0 : key >> pubkey;
941 [ # # ]: 0 : if (!pubkey.IsValid())
942 : : {
943 : 0 : err = "Error reading wallet database: descriptor encrypted key CPubKey corrupt";
944 : 0 : return DBErrors::CORRUPT;
945 : : }
946 : 0 : std::vector<unsigned char> privkey;
947 [ # # ]: 0 : value >> privkey;
948 : :
949 [ # # # # ]: 0 : spk_man->AddCryptedKey(pubkey.GetID(), pubkey, privkey);
950 : 0 : return DBErrors::LOAD_OK;
951 : 0 : });
952 [ # # ]: 0 : result = std::max(result, ckey_res.m_result);
953 : 0 : num_ckeys = ckey_res.m_records;
954 : :
955 : 0 : return result;
956 : 0 : });
957 : :
958 [ # # ]: 0 : if (desc_res.m_result <= DBErrors::NONCRITICAL_ERROR) {
959 : : // Only log if there are no critical errors
960 : 0 : pwallet->WalletLogPrintf("Descriptors: %u, Descriptor Keys: %u plaintext, %u encrypted, %u total.\n",
961 : 0 : desc_res.m_records, num_keys, num_ckeys, num_keys + num_ckeys);
962 : : }
963 : :
964 : 0 : return desc_res.m_result;
965 : : }
966 : :
967 : 0 : static DBErrors LoadAddressBookRecords(CWallet* pwallet, DatabaseBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
968 : : {
969 : 0 : AssertLockHeld(pwallet->cs_wallet);
970 : 0 : DBErrors result = DBErrors::LOAD_OK;
971 : :
972 : : // Load name record
973 [ # # ]: 0 : LoadResult name_res = LoadRecords(pwallet, batch, DBKeys::NAME,
974 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet) {
975 [ # # ]: 0 : std::string strAddress;
976 [ # # ]: 0 : key >> strAddress;
977 [ # # ]: 0 : std::string label;
978 [ # # ]: 0 : value >> label;
979 [ # # # # : 0 : pwallet->m_address_book[DecodeDestination(strAddress)].SetLabel(label);
# # ]
980 : 0 : return DBErrors::LOAD_OK;
981 : 0 : });
982 [ # # ]: 0 : result = std::max(result, name_res.m_result);
983 : :
984 : : // Load purpose record
985 [ # # ]: 0 : LoadResult purpose_res = LoadRecords(pwallet, batch, DBKeys::PURPOSE,
986 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet) {
987 [ # # ]: 0 : std::string strAddress;
988 [ # # ]: 0 : key >> strAddress;
989 [ # # ]: 0 : std::string purpose_str;
990 [ # # ]: 0 : value >> purpose_str;
991 [ # # ]: 0 : std::optional<AddressPurpose> purpose{PurposeFromString(purpose_str)};
992 [ # # ]: 0 : if (!purpose) {
993 [ # # ]: 0 : pwallet->WalletLogPrintf("Warning: nonstandard purpose string '%s' for address '%s'\n", purpose_str, strAddress);
994 : : }
995 [ # # # # ]: 0 : pwallet->m_address_book[DecodeDestination(strAddress)].purpose = purpose;
996 : 0 : return DBErrors::LOAD_OK;
997 : 0 : });
998 [ # # ]: 0 : result = std::max(result, purpose_res.m_result);
999 : :
1000 : : // Load destination data record
1001 [ # # ]: 0 : LoadResult dest_res = LoadRecords(pwallet, batch, DBKeys::DESTDATA,
1002 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet) {
1003 [ # # ]: 0 : std::string strAddress, strKey, strValue;
1004 [ # # ]: 0 : key >> strAddress;
1005 [ # # ]: 0 : key >> strKey;
1006 [ # # ]: 0 : value >> strValue;
1007 [ # # ]: 0 : const CTxDestination& dest{DecodeDestination(strAddress)};
1008 [ # # ]: 0 : if (strKey.compare("used") == 0) {
1009 : : // Load "used" key indicating if an IsMine address has
1010 : : // previously been spent from with avoid_reuse option enabled.
1011 : : // The strValue is not used for anything currently, but could
1012 : : // hold more information in the future. Current values are just
1013 : : // "1" or "p" for present (which was written prior to
1014 : : // f5ba424cd44619d9b9be88b8593d69a7ba96db26).
1015 [ # # ]: 0 : pwallet->LoadAddressPreviouslySpent(dest);
1016 [ # # # # ]: 0 : } else if (strKey.compare(0, 2, "rr") == 0) {
1017 : : // Load "rr##" keys where ## is a decimal number, and strValue
1018 : : // is a serialized RecentRequestEntry object.
1019 [ # # # # ]: 0 : pwallet->LoadAddressReceiveRequest(dest, strKey.substr(2), strValue);
1020 : : }
1021 : 0 : return DBErrors::LOAD_OK;
1022 : 0 : });
1023 [ # # ]: 0 : result = std::max(result, dest_res.m_result);
1024 : :
1025 : 0 : return result;
1026 : : }
1027 : :
1028 : 0 : static DBErrors LoadTxRecords(CWallet* pwallet, DatabaseBatch& batch, std::vector<uint256>& upgraded_txs, bool& any_unordered) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
1029 : : {
1030 : 0 : AssertLockHeld(pwallet->cs_wallet);
1031 : 0 : DBErrors result = DBErrors::LOAD_OK;
1032 : :
1033 : : // Load tx record
1034 : 0 : any_unordered = false;
1035 : 0 : LoadResult tx_res = LoadRecords(pwallet, batch, DBKeys::TX,
1036 [ # # ]: 0 : [&any_unordered, &upgraded_txs] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet) {
1037 : 0 : DBErrors result = DBErrors::LOAD_OK;
1038 : 0 : uint256 hash;
1039 : 0 : key >> hash;
1040 : : // LoadToWallet call below creates a new CWalletTx that fill_wtx
1041 : : // callback fills with transaction metadata.
1042 : 0 : auto fill_wtx = [&](CWalletTx& wtx, bool new_tx) {
1043 [ # # ]: 0 : if(!new_tx) {
1044 : : // There's some corruption here since the tx we just tried to load was already in the wallet.
1045 : 0 : err = "Error: Corrupt transaction found. This can be fixed by removing transactions from wallet and rescanning.";
1046 : 0 : result = DBErrors::CORRUPT;
1047 : 0 : return false;
1048 : : }
1049 : 0 : value >> wtx;
1050 [ # # ]: 0 : if (wtx.GetHash() != hash)
1051 : : return false;
1052 : :
1053 : : // Undo serialize changes in 31600
1054 [ # # ]: 0 : if (31404 <= wtx.fTimeReceivedIsTxTime && wtx.fTimeReceivedIsTxTime <= 31703)
1055 : : {
1056 [ # # ]: 0 : if (!value.empty())
1057 : : {
1058 : 0 : uint8_t fTmp;
1059 : 0 : uint8_t fUnused;
1060 [ # # ]: 0 : std::string unused_string;
1061 [ # # # # : 0 : value >> fTmp >> fUnused >> unused_string;
# # ]
1062 : 0 : pwallet->WalletLogPrintf("LoadWallet() upgrading tx ver=%d %d %s\n",
1063 [ # # # # ]: 0 : wtx.fTimeReceivedIsTxTime, fTmp, hash.ToString());
1064 : 0 : wtx.fTimeReceivedIsTxTime = fTmp;
1065 : 0 : }
1066 : : else
1067 : : {
1068 [ # # ]: 0 : pwallet->WalletLogPrintf("LoadWallet() repairing tx ver=%d %s\n", wtx.fTimeReceivedIsTxTime, hash.ToString());
1069 : 0 : wtx.fTimeReceivedIsTxTime = 0;
1070 : : }
1071 : 0 : upgraded_txs.push_back(hash);
1072 : : }
1073 : :
1074 [ # # ]: 0 : if (wtx.nOrderPos == -1)
1075 : 0 : any_unordered = true;
1076 : :
1077 : : return true;
1078 : 0 : };
1079 [ # # # # ]: 0 : if (!pwallet->LoadToWallet(hash, fill_wtx)) {
1080 : : // Use std::max as fill_wtx may have already set result to CORRUPT
1081 [ # # ]: 0 : result = std::max(result, DBErrors::NEED_RESCAN);
1082 : : }
1083 : 0 : return result;
1084 : : });
1085 [ # # ]: 0 : result = std::max(result, tx_res.m_result);
1086 : :
1087 : : // Load locked utxo record
1088 [ # # ]: 0 : LoadResult locked_utxo_res = LoadRecords(pwallet, batch, DBKeys::LOCKED_UTXO,
1089 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet) {
1090 : 0 : Txid hash;
1091 : 0 : uint32_t n;
1092 : 0 : key >> hash;
1093 : 0 : key >> n;
1094 : 0 : pwallet->LockCoin(COutPoint(hash, n));
1095 : 0 : return DBErrors::LOAD_OK;
1096 : : });
1097 [ # # ]: 0 : result = std::max(result, locked_utxo_res.m_result);
1098 : :
1099 : : // Load orderposnext record
1100 : : // Note: There should only be one ORDERPOSNEXT record with nothing trailing the type
1101 [ # # ]: 0 : LoadResult order_pos_res = LoadRecords(pwallet, batch, DBKeys::ORDERPOSNEXT,
1102 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet) {
1103 : 0 : try {
1104 [ # # ]: 0 : value >> pwallet->nOrderPosNext;
1105 [ - - ]: 0 : } catch (const std::exception& e) {
1106 [ - - ]: 0 : err = e.what();
1107 : 0 : return DBErrors::NONCRITICAL_ERROR;
1108 : 0 : }
1109 : 0 : return DBErrors::LOAD_OK;
1110 : : });
1111 [ # # ]: 0 : result = std::max(result, order_pos_res.m_result);
1112 : :
1113 : 0 : return result;
1114 : : }
1115 : :
1116 : 0 : static DBErrors LoadActiveSPKMs(CWallet* pwallet, DatabaseBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
1117 : : {
1118 : 0 : AssertLockHeld(pwallet->cs_wallet);
1119 : 0 : DBErrors result = DBErrors::LOAD_OK;
1120 : :
1121 : : // Load spk records
1122 [ # # ]: 0 : std::set<std::pair<OutputType, bool>> seen_spks;
1123 [ # # # # : 0 : for (const auto& spk_key : {DBKeys::ACTIVEEXTERNALSPK, DBKeys::ACTIVEINTERNALSPK}) {
# # # # ]
1124 : 0 : LoadResult spkm_res = LoadRecords(pwallet, batch, spk_key,
1125 [ # # ]: 0 : [&seen_spks, &spk_key] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& strErr) {
1126 : 0 : uint8_t output_type;
1127 : 0 : key >> output_type;
1128 : 0 : uint256 id;
1129 : 0 : value >> id;
1130 : :
1131 : 0 : bool internal = spk_key == DBKeys::ACTIVEINTERNALSPK;
1132 [ # # ]: 0 : auto [it, insert] = seen_spks.emplace(static_cast<OutputType>(output_type), internal);
1133 [ # # ]: 0 : if (!insert) {
1134 : 0 : strErr = "Multiple ScriptpubKeyMans specified for a single type";
1135 : 0 : return DBErrors::CORRUPT;
1136 : : }
1137 : 0 : pwallet->LoadActiveScriptPubKeyMan(id, static_cast<OutputType>(output_type), /*internal=*/internal);
1138 : 0 : return DBErrors::LOAD_OK;
1139 : : });
1140 [ # # ]: 0 : result = std::max(result, spkm_res.m_result);
1141 [ # # # # ]: 0 : }
1142 : 0 : return result;
1143 : 0 : }
1144 : :
1145 : 0 : static DBErrors LoadDecryptionKeys(CWallet* pwallet, DatabaseBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet->cs_wallet)
1146 : : {
1147 : 0 : AssertLockHeld(pwallet->cs_wallet);
1148 : :
1149 : : // Load decryption key (mkey) records
1150 [ # # ]: 0 : LoadResult mkey_res = LoadRecords(pwallet, batch, DBKeys::MASTER_KEY,
1151 : 0 : [] (CWallet* pwallet, DataStream& key, DataStream& value, std::string& err) {
1152 [ # # ]: 0 : if (!LoadEncryptionKey(pwallet, key, value, err)) {
1153 : 0 : return DBErrors::CORRUPT;
1154 : : }
1155 : : return DBErrors::LOAD_OK;
1156 : : });
1157 : 0 : return mkey_res.m_result;
1158 : : }
1159 : :
1160 : 0 : DBErrors WalletBatch::LoadWallet(CWallet* pwallet)
1161 : : {
1162 : 0 : DBErrors result = DBErrors::LOAD_OK;
1163 : 0 : bool any_unordered = false;
1164 : 0 : std::vector<uint256> upgraded_txs;
1165 : :
1166 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
1167 : :
1168 : : // Last client version to open this wallet
1169 : 0 : int last_client = CLIENT_VERSION;
1170 [ # # ]: 0 : bool has_last_client = m_batch->Read(DBKeys::VERSION, last_client);
1171 [ # # # # ]: 0 : pwallet->WalletLogPrintf("Wallet file version = %d, last client version = %d\n", pwallet->GetVersion(), last_client);
1172 : :
1173 : 0 : try {
1174 [ # # # # ]: 0 : if ((result = LoadMinVersion(pwallet, *m_batch)) != DBErrors::LOAD_OK) return result;
1175 : :
1176 : : // Load wallet flags, so they are known when processing other records.
1177 : : // The FLAGS key is absent during wallet creation.
1178 [ # # # # ]: 0 : if ((result = LoadWalletFlags(pwallet, *m_batch)) != DBErrors::LOAD_OK) return result;
1179 : :
1180 : : #ifndef ENABLE_EXTERNAL_SIGNER
1181 [ # # # # ]: 0 : if (pwallet->IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER)) {
1182 [ # # ]: 0 : pwallet->WalletLogPrintf("Error: External signer wallet being loaded without external signer support compiled\n");
1183 : : return DBErrors::EXTERNAL_SIGNER_SUPPORT_REQUIRED;
1184 : : }
1185 : : #endif
1186 : :
1187 : : // Load legacy wallet keys
1188 [ # # # # ]: 0 : result = std::max(LoadLegacyWalletRecords(pwallet, *m_batch, last_client), result);
1189 : :
1190 : : // Load descriptors
1191 [ # # # # ]: 0 : result = std::max(LoadDescriptorWalletRecords(pwallet, *m_batch, last_client), result);
1192 : : // Early return if there are unknown descriptors. Later loading of ACTIVEINTERNALSPK and ACTIVEEXTERNALEXPK
1193 : : // may reference the unknown descriptor's ID which can result in a misleading corruption error
1194 : : // when in reality the wallet is simply too new.
1195 [ # # ]: 0 : if (result == DBErrors::UNKNOWN_DESCRIPTOR) return result;
1196 : :
1197 : : // Load address book
1198 [ # # # # ]: 0 : result = std::max(LoadAddressBookRecords(pwallet, *m_batch), result);
1199 : :
1200 : : // Load tx records
1201 [ # # # # ]: 0 : result = std::max(LoadTxRecords(pwallet, *m_batch, upgraded_txs, any_unordered), result);
1202 : :
1203 : : // Load SPKMs
1204 [ # # # # ]: 0 : result = std::max(LoadActiveSPKMs(pwallet, *m_batch), result);
1205 : :
1206 : : // Load decryption keys
1207 [ # # # # ]: 0 : result = std::max(LoadDecryptionKeys(pwallet, *m_batch), result);
1208 : 0 : } catch (...) {
1209 : : // Exceptions that can be ignored or treated as non-critical are handled by the individual loading functions.
1210 : : // Any uncaught exceptions will be caught here and treated as critical.
1211 : 0 : result = DBErrors::CORRUPT;
1212 [ - - ]: 0 : }
1213 : :
1214 : : // Any wallet corruption at all: skip any rewriting or
1215 : : // upgrading, we don't want to make it worse.
1216 [ # # ]: 0 : if (result != DBErrors::LOAD_OK)
1217 : : return result;
1218 : :
1219 [ # # ]: 0 : for (const uint256& hash : upgraded_txs)
1220 [ # # # # ]: 0 : WriteTx(pwallet->mapWallet.at(hash));
1221 : :
1222 [ # # # # ]: 0 : if (!has_last_client || last_client != CLIENT_VERSION) // Update
1223 [ # # ]: 0 : m_batch->Write(DBKeys::VERSION, CLIENT_VERSION);
1224 : :
1225 [ # # ]: 0 : if (any_unordered)
1226 [ # # ]: 0 : result = pwallet->ReorderTransactions();
1227 : :
1228 : : // Upgrade all of the wallet keymetadata to have the hd master key id
1229 : : // This operation is not atomic, but if it fails, updated entries are still backwards compatible with older software
1230 : 0 : try {
1231 [ # # ]: 0 : pwallet->UpgradeKeyMetadata();
1232 : 0 : } catch (...) {
1233 : 0 : result = DBErrors::CORRUPT;
1234 [ - - ]: 0 : }
1235 : :
1236 : : // Upgrade all of the descriptor caches to cache the last hardened xpub
1237 : : // This operation is not atomic, but if it fails, only new entries are added so it is backwards compatible
1238 : 0 : try {
1239 [ # # ]: 0 : pwallet->UpgradeDescriptorCache();
1240 : 0 : } catch (...) {
1241 : 0 : result = DBErrors::CORRUPT;
1242 [ - - ]: 0 : }
1243 : :
1244 : 0 : return result;
1245 : 0 : }
1246 : :
1247 : 0 : static bool RunWithinTxn(WalletBatch& batch, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func)
1248 : : {
1249 [ # # ]: 0 : if (!batch.TxnBegin()) {
1250 [ # # ]: 0 : LogDebug(BCLog::WALLETDB, "Error: cannot create db txn for %s\n", process_desc);
1251 : 0 : return false;
1252 : : }
1253 : :
1254 : : // Run procedure
1255 [ # # ]: 0 : if (!func(batch)) {
1256 [ # # ]: 0 : LogDebug(BCLog::WALLETDB, "Error: %s failed\n", process_desc);
1257 : 0 : batch.TxnAbort();
1258 : 0 : return false;
1259 : : }
1260 : :
1261 [ # # ]: 0 : if (!batch.TxnCommit()) {
1262 [ # # ]: 0 : LogDebug(BCLog::WALLETDB, "Error: cannot commit db txn for %s\n", process_desc);
1263 : 0 : return false;
1264 : : }
1265 : :
1266 : : // All good
1267 : : return true;
1268 : : }
1269 : :
1270 : 0 : bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func)
1271 : : {
1272 : 0 : WalletBatch batch(database);
1273 [ # # ]: 0 : return RunWithinTxn(batch, process_desc, func);
1274 : 0 : }
1275 : :
1276 : 0 : void MaybeCompactWalletDB(WalletContext& context)
1277 : : {
1278 : 0 : static std::atomic<bool> fOneThread(false);
1279 [ # # ]: 0 : if (fOneThread.exchange(true)) {
1280 : : return;
1281 : : }
1282 : :
1283 [ # # ]: 0 : for (const std::shared_ptr<CWallet>& pwallet : GetWallets(context)) {
1284 : 0 : WalletDatabase& dbh = pwallet->GetDatabase();
1285 : :
1286 [ # # ]: 0 : unsigned int nUpdateCounter = dbh.nUpdateCounter;
1287 : :
1288 [ # # ]: 0 : if (dbh.nLastSeen != nUpdateCounter) {
1289 : 0 : dbh.nLastSeen = nUpdateCounter;
1290 [ # # ]: 0 : dbh.nLastWalletUpdate = GetTime();
1291 : : }
1292 : :
1293 [ # # # # : 0 : if (dbh.nLastFlushed != nUpdateCounter && GetTime() - dbh.nLastWalletUpdate >= 2) {
# # ]
1294 [ # # # # ]: 0 : if (dbh.PeriodicFlush()) {
1295 : 0 : dbh.nLastFlushed = nUpdateCounter;
1296 : : }
1297 : : }
1298 : 0 : }
1299 : :
1300 : 0 : fOneThread = false;
1301 : : }
1302 : :
1303 : 0 : bool WalletBatch::WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent)
1304 : : {
1305 [ # # # # ]: 0 : auto key{std::make_pair(DBKeys::DESTDATA, std::make_pair(EncodeDestination(dest), std::string("used")))};
1306 [ # # # # : 0 : return previously_spent ? WriteIC(key, std::string("1")) : EraseIC(key);
# # # # ]
1307 : 0 : }
1308 : :
1309 : 0 : bool WalletBatch::WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request)
1310 : : {
1311 [ # # # # : 0 : return WriteIC(std::make_pair(DBKeys::DESTDATA, std::make_pair(EncodeDestination(dest), "rr" + id)), receive_request);
# # ]
1312 : : }
1313 : :
1314 : 0 : bool WalletBatch::EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id)
1315 : : {
1316 [ # # # # : 0 : return EraseIC(std::make_pair(DBKeys::DESTDATA, std::make_pair(EncodeDestination(dest), "rr" + id)));
# # ]
1317 : : }
1318 : :
1319 : 0 : bool WalletBatch::EraseAddressData(const CTxDestination& dest)
1320 : : {
1321 : 0 : DataStream prefix;
1322 [ # # # # ]: 0 : prefix << DBKeys::DESTDATA << EncodeDestination(dest);
1323 [ # # ]: 0 : return m_batch->ErasePrefix(prefix);
1324 : 0 : }
1325 : :
1326 : 0 : bool WalletBatch::WriteHDChain(const CHDChain& chain)
1327 : : {
1328 : 0 : return WriteIC(DBKeys::HDCHAIN, chain);
1329 : : }
1330 : :
1331 : 7549 : bool WalletBatch::WriteWalletFlags(const uint64_t flags)
1332 : : {
1333 : 7549 : return WriteIC(DBKeys::FLAGS, flags);
1334 : : }
1335 : :
1336 : 0 : bool WalletBatch::EraseRecords(const std::unordered_set<std::string>& types)
1337 : : {
1338 : 0 : return std::all_of(types.begin(), types.end(), [&](const std::string& type) {
1339 [ # # # # ]: 0 : return m_batch->ErasePrefix(DataStream() << type);
1340 : 0 : });
1341 : : }
1342 : :
1343 : 1329261 : bool WalletBatch::TxnBegin()
1344 : : {
1345 : 1329261 : return m_batch->TxnBegin();
1346 : : }
1347 : :
1348 : 1329261 : bool WalletBatch::TxnCommit()
1349 : : {
1350 : 1329261 : bool res = m_batch->TxnCommit();
1351 [ + - ]: 1329261 : if (res) {
1352 [ - + ]: 1329261 : for (const auto& listener : m_txn_listeners) {
1353 : 0 : listener.on_commit();
1354 : : }
1355 : : // txn finished, clear listeners
1356 : 1329261 : m_txn_listeners.clear();
1357 : : }
1358 : 1329261 : return res;
1359 : : }
1360 : :
1361 : 0 : bool WalletBatch::TxnAbort()
1362 : : {
1363 : 0 : bool res = m_batch->TxnAbort();
1364 [ # # ]: 0 : if (res) {
1365 [ # # ]: 0 : for (const auto& listener : m_txn_listeners) {
1366 : 0 : listener.on_abort();
1367 : : }
1368 : : // txn finished, clear listeners
1369 : 0 : m_txn_listeners.clear();
1370 : : }
1371 : 0 : return res;
1372 : : }
1373 : :
1374 : 0 : void WalletBatch::RegisterTxnListener(const DbTxnListener& l)
1375 : : {
1376 [ # # ]: 0 : assert(m_batch->HasActiveTxn());
1377 : 0 : m_txn_listeners.emplace_back(l);
1378 : 0 : }
1379 : :
1380 : 0 : std::unique_ptr<WalletDatabase> MakeDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error)
1381 : : {
1382 : 0 : bool exists;
1383 : 0 : try {
1384 [ # # ]: 0 : exists = fs::symlink_status(path).type() != fs::file_type::not_found;
1385 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
1386 [ - - - - : 0 : error = Untranslated(strprintf("Failed to access database path '%s': %s", fs::PathToString(path), fsbridge::get_filesystem_error_message(e)));
- - ]
1387 : 0 : status = DatabaseStatus::FAILED_BAD_PATH;
1388 : 0 : return nullptr;
1389 : 0 : }
1390 : :
1391 : 0 : std::optional<DatabaseFormat> format;
1392 [ # # ]: 0 : if (exists) {
1393 [ # # # # ]: 0 : if (IsBDBFile(BDBDataFile(path))) {
1394 : 0 : format = DatabaseFormat::BERKELEY;
1395 : : }
1396 [ # # # # ]: 0 : if (IsSQLiteFile(SQLiteDataFile(path))) {
1397 [ # # ]: 0 : if (format) {
1398 [ # # # # ]: 0 : error = Untranslated(strprintf("Failed to load database path '%s'. Data is in ambiguous format.", fs::PathToString(path)));
1399 : 0 : status = DatabaseStatus::FAILED_BAD_FORMAT;
1400 : 0 : return nullptr;
1401 : : }
1402 : 0 : format = DatabaseFormat::SQLITE;
1403 : : }
1404 [ # # ]: 0 : } else if (options.require_existing) {
1405 [ # # # # ]: 0 : error = Untranslated(strprintf("Failed to load database path '%s'. Path does not exist.", fs::PathToString(path)));
1406 : 0 : status = DatabaseStatus::FAILED_NOT_FOUND;
1407 : 0 : return nullptr;
1408 : : }
1409 : :
1410 [ # # # # ]: 0 : if (!format && options.require_existing) {
1411 [ # # # # ]: 0 : error = Untranslated(strprintf("Failed to load database path '%s'. Data is not in recognized format.", fs::PathToString(path)));
1412 : 0 : status = DatabaseStatus::FAILED_BAD_FORMAT;
1413 : 0 : return nullptr;
1414 : : }
1415 : :
1416 [ # # # # ]: 0 : if (format && options.require_create) {
1417 [ # # # # ]: 0 : error = Untranslated(strprintf("Failed to create database path '%s'. Database already exists.", fs::PathToString(path)));
1418 : 0 : status = DatabaseStatus::FAILED_ALREADY_EXISTS;
1419 : 0 : return nullptr;
1420 : : }
1421 : :
1422 : : // If BERKELEY was the format, then change the format from BERKELEY to BERKELEY_RO
1423 [ # # # # : 0 : if (format && options.require_format && format == DatabaseFormat::BERKELEY && options.require_format == DatabaseFormat::BERKELEY_RO) {
# # # # ]
1424 : 0 : format = DatabaseFormat::BERKELEY_RO;
1425 : : }
1426 : :
1427 : : // A db already exists so format is set, but options also specifies the format, so make sure they agree
1428 [ # # # # : 0 : if (format && options.require_format && format != options.require_format) {
# # ]
1429 [ # # # # ]: 0 : error = Untranslated(strprintf("Failed to load database path '%s'. Data is not in required format.", fs::PathToString(path)));
1430 : 0 : status = DatabaseStatus::FAILED_BAD_FORMAT;
1431 : 0 : return nullptr;
1432 : : }
1433 : :
1434 : : // Format is not set when a db doesn't already exist, so use the format specified by the options if it is set.
1435 [ # # # # ]: 0 : if (!format && options.require_format) format = options.require_format;
1436 : :
1437 : : // If the format is not specified or detected, choose the default format based on what is available. We prefer BDB over SQLite for now.
1438 [ # # ]: 0 : if (!format) {
1439 : : #ifdef USE_SQLITE
1440 : 0 : format = DatabaseFormat::SQLITE;
1441 : : #endif
1442 : : #ifdef USE_BDB
1443 : : format = DatabaseFormat::BERKELEY;
1444 : : #endif
1445 : : }
1446 : :
1447 [ # # ]: 0 : if (format == DatabaseFormat::SQLITE) {
1448 : : #ifdef USE_SQLITE
1449 : 0 : if constexpr (true) {
1450 : 0 : return MakeSQLiteDatabase(path, options, status, error);
1451 : : } else
1452 : : #endif
1453 : : {
1454 : : error = Untranslated(strprintf("Failed to open database path '%s'. Build does not support SQLite database format.", fs::PathToString(path)));
1455 : : status = DatabaseStatus::FAILED_BAD_FORMAT;
1456 : : return nullptr;
1457 : : }
1458 : : }
1459 : :
1460 [ # # ]: 0 : if (format == DatabaseFormat::BERKELEY_RO) {
1461 : 0 : return MakeBerkeleyRODatabase(path, options, status, error);
1462 : : }
1463 : :
1464 : : #ifdef USE_BDB
1465 : : if constexpr (true) {
1466 : : return MakeBerkeleyDatabase(path, options, status, error);
1467 : : } else
1468 : : #endif
1469 : 0 : {
1470 [ # # # # ]: 0 : error = Untranslated(strprintf("Failed to open database path '%s'. Build does not support Berkeley DB database format.", fs::PathToString(path)));
1471 : 0 : status = DatabaseStatus::FAILED_BAD_FORMAT;
1472 : 0 : return nullptr;
1473 : : }
1474 : : }
1475 : : } // namespace wallet
|
