Bitcoin Core 30.99.0
P2P Digital Currency
wallet.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <wallet/wallet.h>
7
8#include <bitcoin-build-config.h> // IWYU pragma: keep
9#include <addresstype.h>
10#include <blockfilter.h>
11#include <chain.h>
12#include <coins.h>
13#include <common/args.h>
14#include <common/messages.h>
15#include <common/settings.h>
16#include <common/signmessage.h>
17#include <common/system.h>
18#include <consensus/amount.h>
19#include <consensus/consensus.h>
21#include <external_signer.h>
22#include <interfaces/chain.h>
23#include <interfaces/handler.h>
24#include <interfaces/wallet.h>
25#include <kernel/chain.h>
27#include <key.h>
28#include <key_io.h>
29#include <logging.h>
30#include <node/types.h>
31#include <outputtype.h>
32#include <policy/feerate.h>
33#include <policy/truc_policy.h>
34#include <primitives/block.h>
36#include <psbt.h>
37#include <pubkey.h>
38#include <random.h>
39#include <script/descriptor.h>
40#include <script/interpreter.h>
41#include <script/script.h>
42#include <script/sign.h>
44#include <script/solver.h>
45#include <serialize.h>
46#include <span.h>
47#include <streams.h>
50#include <support/cleanse.h>
51#include <sync.h>
52#include <tinyformat.h>
53#include <uint256.h>
54#include <univalue.h>
55#include <util/check.h>
56#include <util/fs.h>
57#include <util/fs_helpers.h>
58#include <util/moneystr.h>
59#include <util/result.h>
60#include <util/string.h>
61#include <util/time.h>
62#include <util/translation.h>
63#include <wallet/coincontrol.h>
64#include <wallet/context.h>
65#include <wallet/crypter.h>
66#include <wallet/db.h>
69#include <wallet/transaction.h>
70#include <wallet/types.h>
71#include <wallet/walletdb.h>
72#include <wallet/walletutil.h>
73
74#include <algorithm>
75#include <cassert>
76#include <condition_variable>
77#include <exception>
78#include <optional>
79#include <stdexcept>
80#include <thread>
81#include <tuple>
82#include <variant>
83
84struct KeyOriginInfo;
85
91using util::ToString;
92
93namespace wallet {
94
95bool AddWalletSetting(interfaces::Chain& chain, const std::string& wallet_name)
96{
97 const auto update_function = [&wallet_name](common::SettingsValue& setting_value) {
98 if (!setting_value.isArray()) setting_value.setArray();
99 for (const auto& value : setting_value.getValues()) {
100 if (value.isStr() && value.get_str() == wallet_name) return interfaces::SettingsAction::SKIP_WRITE;
101 }
102 setting_value.push_back(wallet_name);
104 };
105 return chain.updateRwSetting("wallet", update_function);
106}
107
108bool RemoveWalletSetting(interfaces::Chain& chain, const std::string& wallet_name)
109{
110 const auto update_function = [&wallet_name](common::SettingsValue& setting_value) {
111 if (!setting_value.isArray()) return interfaces::SettingsAction::SKIP_WRITE;
113 for (const auto& value : setting_value.getValues()) {
114 if (!value.isStr() || value.get_str() != wallet_name) new_value.push_back(value);
115 }
116 if (new_value.size() == setting_value.size()) return interfaces::SettingsAction::SKIP_WRITE;
117 setting_value = std::move(new_value);
119 };
120 return chain.updateRwSetting("wallet", update_function);
121}
122
124 const std::string& wallet_name,
125 std::optional<bool> load_on_startup,
126 std::vector<bilingual_str>& warnings)
127{
128 if (!load_on_startup) return;
129 if (load_on_startup.value() && !AddWalletSetting(chain, wallet_name)) {
130 warnings.emplace_back(Untranslated("Wallet load on startup setting could not be updated, so wallet may not be loaded next node startup."));
131 } else if (!load_on_startup.value() && !RemoveWalletSetting(chain, wallet_name)) {
132 warnings.emplace_back(Untranslated("Wallet load on startup setting could not be updated, so wallet may still be loaded next node startup."));
133 }
134}
135
142{
143 if (chain.isInMempool(tx.GetHash())) {
145 } else if (tx.state<TxStateInMempool>()) {
147 }
148}
149
150bool AddWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet)
151{
152 LOCK(context.wallets_mutex);
153 assert(wallet);
154 std::vector<std::shared_ptr<CWallet>>::const_iterator i = std::find(context.wallets.begin(), context.wallets.end(), wallet);
155 if (i != context.wallets.end()) return false;
156 context.wallets.push_back(wallet);
157 wallet->ConnectScriptPubKeyManNotifiers();
158 wallet->NotifyCanGetAddressesChanged();
159 return true;
160}
161
162bool RemoveWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet, std::optional<bool> load_on_start, std::vector<bilingual_str>& warnings)
163{
164 assert(wallet);
165
166 interfaces::Chain& chain = wallet->chain();
167 std::string name = wallet->GetName();
168 WITH_LOCK(wallet->cs_wallet, wallet->WriteBestBlock());
169
170 // Unregister with the validation interface which also drops shared pointers.
171 wallet->m_chain_notifications_handler.reset();
172 {
173 LOCK(context.wallets_mutex);
174 std::vector<std::shared_ptr<CWallet>>::iterator i = std::find(context.wallets.begin(), context.wallets.end(), wallet);
175 if (i == context.wallets.end()) return false;
176 context.wallets.erase(i);
177 }
178 // Notify unload so that upper layers release the shared pointer.
179 wallet->NotifyUnload();
180
181 // Write the wallet setting
182 UpdateWalletSetting(chain, name, load_on_start, warnings);
183
184 return true;
185}
186
187bool RemoveWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet, std::optional<bool> load_on_start)
188{
189 std::vector<bilingual_str> warnings;
190 return RemoveWallet(context, wallet, load_on_start, warnings);
191}
192
193std::vector<std::shared_ptr<CWallet>> GetWallets(WalletContext& context)
194{
195 LOCK(context.wallets_mutex);
196 return context.wallets;
197}
198
199std::shared_ptr<CWallet> GetDefaultWallet(WalletContext& context, size_t& count)
200{
201 LOCK(context.wallets_mutex);
202 count = context.wallets.size();
203 return count == 1 ? context.wallets[0] : nullptr;
204}
205
206std::shared_ptr<CWallet> GetWallet(WalletContext& context, const std::string& name)
207{
208 LOCK(context.wallets_mutex);
209 for (const std::shared_ptr<CWallet>& wallet : context.wallets) {
210 if (wallet->GetName() == name) return wallet;
211 }
212 return nullptr;
213}
214
215std::unique_ptr<interfaces::Handler> HandleLoadWallet(WalletContext& context, LoadWalletFn load_wallet)
216{
217 LOCK(context.wallets_mutex);
218 auto it = context.wallet_load_fns.emplace(context.wallet_load_fns.end(), std::move(load_wallet));
219 return interfaces::MakeCleanupHandler([&context, it] { LOCK(context.wallets_mutex); context.wallet_load_fns.erase(it); });
220}
221
222void NotifyWalletLoaded(WalletContext& context, const std::shared_ptr<CWallet>& wallet)
223{
224 LOCK(context.wallets_mutex);
225 for (auto& load_wallet : context.wallet_load_fns) {
226 load_wallet(interfaces::MakeWallet(context, wallet));
227 }
228}
229
232static std::condition_variable g_wallet_release_cv;
233static std::set<std::string> g_loading_wallet_set GUARDED_BY(g_loading_wallet_mutex);
234static std::set<std::string> g_unloading_wallet_set GUARDED_BY(g_wallet_release_mutex);
235
236// Custom deleter for shared_ptr<CWallet>.
238{
239 const std::string name = wallet->GetName();
240 wallet->WalletLogPrintf("Releasing wallet %s..\n", name);
241 delete wallet;
242 // Wallet is now released, notify WaitForDeleteWallet, if any.
243 {
245 if (g_unloading_wallet_set.erase(name) == 0) {
246 // WaitForDeleteWallet was not called for this wallet, all done.
247 return;
248 }
249 }
250 g_wallet_release_cv.notify_all();
251}
252
253void WaitForDeleteWallet(std::shared_ptr<CWallet>&& wallet)
254{
255 // Mark wallet for unloading.
256 const std::string name = wallet->GetName();
257 {
259 g_unloading_wallet_set.insert(name);
260 // Do not expect to be the only one removing this wallet.
261 // Multiple threads could simultaneously be waiting for deletion.
262 }
263
264 // Time to ditch our shared_ptr and wait for FlushAndDeleteWallet call.
265 wallet.reset();
266 {
268 while (g_unloading_wallet_set.count(name) == 1) {
269 g_wallet_release_cv.wait(lock);
270 }
271 }
272}
273
274namespace {
275std::shared_ptr<CWallet> LoadWalletInternal(WalletContext& context, const std::string& name, std::optional<bool> load_on_start, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings)
276{
277 try {
278 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(name, options, status, error);
279 if (!database) {
280 error = Untranslated("Wallet file verification failed.") + Untranslated(" ") + error;
281 return nullptr;
282 }
283
284 context.chain->initMessage(_("Loading wallet…"));
285 std::shared_ptr<CWallet> wallet = CWallet::Create(context, name, std::move(database), options.create_flags, error, warnings);
286 if (!wallet) {
287 error = Untranslated("Wallet loading failed.") + Untranslated(" ") + error;
289 return nullptr;
290 }
291
292 NotifyWalletLoaded(context, wallet);
293 AddWallet(context, wallet);
294 wallet->postInitProcess();
295
296 // Write the wallet setting
297 UpdateWalletSetting(*context.chain, name, load_on_start, warnings);
298
299 return wallet;
300 } catch (const std::runtime_error& e) {
301 error = Untranslated(e.what());
303 return nullptr;
304 }
305}
306
307class FastWalletRescanFilter
308{
309public:
310 FastWalletRescanFilter(const CWallet& wallet) : m_wallet(wallet)
311 {
312 // create initial filter with scripts from all ScriptPubKeyMans
313 for (auto spkm : m_wallet.GetAllScriptPubKeyMans()) {
314 auto desc_spkm{dynamic_cast<DescriptorScriptPubKeyMan*>(spkm)};
315 assert(desc_spkm != nullptr);
316 AddScriptPubKeys(desc_spkm);
317 // save each range descriptor's end for possible future filter updates
318 if (desc_spkm->IsHDEnabled()) {
319 m_last_range_ends.emplace(desc_spkm->GetID(), desc_spkm->GetEndRange());
320 }
321 }
322 }
323
324 void UpdateIfNeeded()
325 {
326 // repopulate filter with new scripts if top-up has happened since last iteration
327 for (const auto& [desc_spkm_id, last_range_end] : m_last_range_ends) {
328 auto desc_spkm{dynamic_cast<DescriptorScriptPubKeyMan*>(m_wallet.GetScriptPubKeyMan(desc_spkm_id))};
329 assert(desc_spkm != nullptr);
330 int32_t current_range_end{desc_spkm->GetEndRange()};
331 if (current_range_end > last_range_end) {
332 AddScriptPubKeys(desc_spkm, last_range_end);
333 m_last_range_ends.at(desc_spkm->GetID()) = current_range_end;
334 }
335 }
336 }
337
338 std::optional<bool> MatchesBlock(const uint256& block_hash) const
339 {
340 return m_wallet.chain().blockFilterMatchesAny(BlockFilterType::BASIC, block_hash, m_filter_set);
341 }
342
343private:
344 const CWallet& m_wallet;
351 std::map<uint256, int32_t> m_last_range_ends;
353
354 void AddScriptPubKeys(const DescriptorScriptPubKeyMan* desc_spkm, int32_t last_range_end = 0)
355 {
356 for (const auto& script_pub_key : desc_spkm->GetScriptPubKeys(last_range_end)) {
357 m_filter_set.emplace(script_pub_key.begin(), script_pub_key.end());
358 }
359 }
360};
361} // namespace
362
363std::shared_ptr<CWallet> LoadWallet(WalletContext& context, const std::string& name, std::optional<bool> load_on_start, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings)
364{
365 auto result = WITH_LOCK(g_loading_wallet_mutex, return g_loading_wallet_set.insert(name));
366 if (!result.second) {
367 error = Untranslated("Wallet already loading.");
369 return nullptr;
370 }
371 auto wallet = LoadWalletInternal(context, name, load_on_start, options, status, error, warnings);
372 WITH_LOCK(g_loading_wallet_mutex, g_loading_wallet_set.erase(result.first));
373 return wallet;
374}
375
376std::shared_ptr<CWallet> CreateWallet(WalletContext& context, const std::string& name, std::optional<bool> load_on_start, DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings)
377{
378 uint64_t wallet_creation_flags = options.create_flags;
379 const SecureString& passphrase = options.create_passphrase;
380
381 // Only descriptor wallets can be created
382 Assert(wallet_creation_flags & WALLET_FLAG_DESCRIPTORS);
384
385 // Indicate that the wallet is actually supposed to be blank and not just blank to make it encrypted
386 bool create_blank = (wallet_creation_flags & WALLET_FLAG_BLANK_WALLET);
387
388 // Born encrypted wallets need to be created blank first.
389 if (!passphrase.empty()) {
390 wallet_creation_flags |= WALLET_FLAG_BLANK_WALLET;
391 }
392
393 // Private keys must be disabled for an external signer wallet
394 if ((wallet_creation_flags & WALLET_FLAG_EXTERNAL_SIGNER) && !(wallet_creation_flags & WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
395 error = Untranslated("Private keys must be disabled when using an external signer");
397 return nullptr;
398 }
399
400 // Do not allow a passphrase when private keys are disabled
401 if (!passphrase.empty() && (wallet_creation_flags & WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
402 error = Untranslated("Passphrase provided but private keys are disabled. A passphrase is only used to encrypt private keys, so cannot be used for wallets with private keys disabled.");
404 return nullptr;
405 }
406
407 // Wallet::Verify will check if we're trying to create a wallet with a duplicate name.
408 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(name, options, status, error);
409 if (!database) {
410 error = Untranslated("Wallet file verification failed.") + Untranslated(" ") + error;
412 return nullptr;
413 }
414
415 // Make the wallet
416 context.chain->initMessage(_("Loading wallet…"));
417 std::shared_ptr<CWallet> wallet = CWallet::Create(context, name, std::move(database), wallet_creation_flags, error, warnings);
418 if (!wallet) {
419 error = Untranslated("Wallet creation failed.") + Untranslated(" ") + error;
421 return nullptr;
422 }
423
424 // Encrypt the wallet
425 if (!passphrase.empty() && !(wallet_creation_flags & WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
426 if (!wallet->EncryptWallet(passphrase)) {
427 error = Untranslated("Error: Wallet created but failed to encrypt.");
429 return nullptr;
430 }
431 if (!create_blank) {
432 // Unlock the wallet
433 if (!wallet->Unlock(passphrase)) {
434 error = Untranslated("Error: Wallet was encrypted but could not be unlocked");
436 return nullptr;
437 }
438
439 // Set a seed for the wallet
440 {
441 LOCK(wallet->cs_wallet);
442 wallet->SetupDescriptorScriptPubKeyMans();
443 }
444
445 // Relock the wallet
446 wallet->Lock();
447 }
448 }
449
450 NotifyWalletLoaded(context, wallet);
451 AddWallet(context, wallet);
452 wallet->postInitProcess();
453
454 // Write the wallet settings
455 UpdateWalletSetting(*context.chain, name, load_on_start, warnings);
456
458 return wallet;
459}
460
461// Re-creates wallet from the backup file by renaming and moving it into the wallet's directory.
462// If 'load_after_restore=true', the wallet object will be fully initialized and appended to the context.
463std::shared_ptr<CWallet> RestoreWallet(WalletContext& context, const fs::path& backup_file, const std::string& wallet_name, std::optional<bool> load_on_start, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings, bool load_after_restore)
464{
465 DatabaseOptions options;
466 ReadDatabaseArgs(*context.args, options);
467 options.require_existing = true;
468
469 const fs::path wallet_path = fsbridge::AbsPathJoin(GetWalletDir(), fs::u8path(wallet_name));
470 auto wallet_file = wallet_path / "wallet.dat";
471 std::shared_ptr<CWallet> wallet;
472
473 try {
474 if (!fs::exists(backup_file)) {
475 error = Untranslated("Backup file does not exist");
477 return nullptr;
478 }
479
480 if (fs::exists(wallet_path) || !TryCreateDirectories(wallet_path)) {
481 error = Untranslated(strprintf("Failed to create database path '%s'. Database already exists.", fs::PathToString(wallet_path)));
483 return nullptr;
484 }
485
486 fs::copy_file(backup_file, wallet_file, fs::copy_options::none);
487
488 if (load_after_restore) {
489 wallet = LoadWallet(context, wallet_name, load_on_start, options, status, error, warnings);
490 }
491 } catch (const std::exception& e) {
492 assert(!wallet);
493 if (!error.empty()) error += Untranslated("\n");
494 error += Untranslated(strprintf("Unexpected exception: %s", e.what()));
495 }
496
497 // Remove created wallet path only when loading fails
498 if (load_after_restore && !wallet) {
499 fs::remove_all(wallet_path);
500 }
501
502 return wallet;
503}
504
510const CWalletTx* CWallet::GetWalletTx(const Txid& hash) const
511{
513 const auto it = mapWallet.find(hash);
514 if (it == mapWallet.end())
515 return nullptr;
516 return &(it->second);
517}
518
520{
522 return;
523 }
524
526 DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
527 desc_spkm->UpgradeDescriptorCache();
528 }
530}
531
532/* Given a wallet passphrase string and an unencrypted master key, determine the proper key
533 * derivation parameters (should take at least 100ms) and encrypt the master key. */
534static bool EncryptMasterKey(const SecureString& wallet_passphrase, const CKeyingMaterial& plain_master_key, CMasterKey& master_key)
535{
536 constexpr MillisecondsDouble target{100};
537 auto start{SteadyClock::now()};
538 CCrypter crypter;
539
540 crypter.SetKeyFromPassphrase(wallet_passphrase, master_key.vchSalt, master_key.nDeriveIterations, master_key.nDerivationMethod);
541 master_key.nDeriveIterations = static_cast<unsigned int>(master_key.nDeriveIterations * target / (SteadyClock::now() - start));
542
543 start = SteadyClock::now();
544 crypter.SetKeyFromPassphrase(wallet_passphrase, master_key.vchSalt, master_key.nDeriveIterations, master_key.nDerivationMethod);
545 master_key.nDeriveIterations = (master_key.nDeriveIterations + static_cast<unsigned int>(master_key.nDeriveIterations * target / (SteadyClock::now() - start))) / 2;
546
549 }
550
551 if (!crypter.SetKeyFromPassphrase(wallet_passphrase, master_key.vchSalt, master_key.nDeriveIterations, master_key.nDerivationMethod)) {
552 return false;
553 }
554 if (!crypter.Encrypt(plain_master_key, master_key.vchCryptedKey)) {
555 return false;
556 }
557
558 return true;
559}
560
561static bool DecryptMasterKey(const SecureString& wallet_passphrase, const CMasterKey& master_key, CKeyingMaterial& plain_master_key)
562{
563 CCrypter crypter;
564 if (!crypter.SetKeyFromPassphrase(wallet_passphrase, master_key.vchSalt, master_key.nDeriveIterations, master_key.nDerivationMethod)) {
565 return false;
566 }
567 if (!crypter.Decrypt(master_key.vchCryptedKey, plain_master_key)) {
568 return false;
569 }
570
571 return true;
572}
573
574bool CWallet::Unlock(const SecureString& strWalletPassphrase)
575{
576 CKeyingMaterial plain_master_key;
577
578 {
580 for (const auto& [_, master_key] : mapMasterKeys)
581 {
582 if (!DecryptMasterKey(strWalletPassphrase, master_key, plain_master_key)) {
583 continue; // try another master key
584 }
585 if (Unlock(plain_master_key)) {
586 // Now that we've unlocked, upgrade the descriptor cache
588 return true;
589 }
590 }
591 }
592 return false;
593}
594
595bool CWallet::ChangeWalletPassphrase(const SecureString& strOldWalletPassphrase, const SecureString& strNewWalletPassphrase)
596{
597 bool fWasLocked = IsLocked();
598
599 {
601 Lock();
602
603 CKeyingMaterial plain_master_key;
604 for (auto& [master_key_id, master_key] : mapMasterKeys)
605 {
606 if (!DecryptMasterKey(strOldWalletPassphrase, master_key, plain_master_key)) {
607 return false;
608 }
609 if (Unlock(plain_master_key))
610 {
611 if (!EncryptMasterKey(strNewWalletPassphrase, plain_master_key, master_key)) {
612 return false;
613 }
614 WalletLogPrintf("Wallet passphrase changed to an nDeriveIterations of %i\n", master_key.nDeriveIterations);
615
616 WalletBatch(GetDatabase()).WriteMasterKey(master_key_id, master_key);
617 if (fWasLocked)
618 Lock();
619 return true;
620 }
621 }
622 }
623
624 return false;
625}
626
627void CWallet::SetLastBlockProcessedInMem(int block_height, uint256 block_hash)
628{
630
631 m_last_block_processed = block_hash;
632 m_last_block_processed_height = block_height;
633}
634
635void CWallet::SetLastBlockProcessed(int block_height, uint256 block_hash)
636{
638
639 SetLastBlockProcessedInMem(block_height, block_hash);
641}
642
643std::set<Txid> CWallet::GetConflicts(const Txid& txid) const
644{
645 std::set<Txid> result;
647
648 const auto it = mapWallet.find(txid);
649 if (it == mapWallet.end())
650 return result;
651 const CWalletTx& wtx = it->second;
652
653 std::pair<TxSpends::const_iterator, TxSpends::const_iterator> range;
654
655 for (const CTxIn& txin : wtx.tx->vin)
656 {
657 if (mapTxSpends.count(txin.prevout) <= 1)
658 continue; // No conflict if zero or one spends
659 range = mapTxSpends.equal_range(txin.prevout);
660 for (TxSpends::const_iterator _it = range.first; _it != range.second; ++_it)
661 result.insert(_it->second);
662 }
663 return result;
664}
665
667{
669 const Txid& txid = tx->GetHash();
670 for (unsigned int i = 0; i < tx->vout.size(); ++i) {
671 if (IsSpent(COutPoint(txid, i))) {
672 return true;
673 }
674 }
675 return false;
676}
677
679{
680 GetDatabase().Close();
681}
682
683void CWallet::SyncMetaData(std::pair<TxSpends::iterator, TxSpends::iterator> range)
684{
685 // We want all the wallet transactions in range to have the same metadata as
686 // the oldest (smallest nOrderPos).
687 // So: find smallest nOrderPos:
688
689 int nMinOrderPos = std::numeric_limits<int>::max();
690 const CWalletTx* copyFrom = nullptr;
691 for (TxSpends::iterator it = range.first; it != range.second; ++it) {
692 const CWalletTx* wtx = &mapWallet.at(it->second);
693 if (wtx->nOrderPos < nMinOrderPos) {
694 nMinOrderPos = wtx->nOrderPos;
695 copyFrom = wtx;
696 }
697 }
698
699 if (!copyFrom) {
700 return;
701 }
702
703 // Now copy data from copyFrom to rest:
704 for (TxSpends::iterator it = range.first; it != range.second; ++it)
705 {
706 const Txid& hash = it->second;
707 CWalletTx* copyTo = &mapWallet.at(hash);
708 if (copyFrom == copyTo) continue;
709 assert(copyFrom && "Oldest wallet transaction in range assumed to have been found.");
710 if (!copyFrom->IsEquivalentTo(*copyTo)) continue;
711 copyTo->mapValue = copyFrom->mapValue;
712 copyTo->vOrderForm = copyFrom->vOrderForm;
713 // nTimeReceived not copied on purpose
714 copyTo->nTimeSmart = copyFrom->nTimeSmart;
715 // nOrderPos not copied on purpose
716 // cached members not copied on purpose
717 }
718}
719
724bool CWallet::IsSpent(const COutPoint& outpoint) const
725{
726 std::pair<TxSpends::const_iterator, TxSpends::const_iterator> range;
727 range = mapTxSpends.equal_range(outpoint);
728
729 for (TxSpends::const_iterator it = range.first; it != range.second; ++it) {
730 const Txid& txid = it->second;
731 const auto mit = mapWallet.find(txid);
732 if (mit != mapWallet.end()) {
733 const auto& wtx = mit->second;
734 if (!wtx.isAbandoned() && !wtx.isBlockConflicted() && !wtx.isMempoolConflicted())
735 return true; // Spent
736 }
737 }
738 return false;
739}
740
741void CWallet::AddToSpends(const COutPoint& outpoint, const Txid& txid)
742{
743 mapTxSpends.insert(std::make_pair(outpoint, txid));
744
745 UnlockCoin(outpoint);
746
747 std::pair<TxSpends::iterator, TxSpends::iterator> range;
748 range = mapTxSpends.equal_range(outpoint);
749 SyncMetaData(range);
750}
751
752
754{
755 if (wtx.IsCoinBase()) // Coinbases don't spend anything!
756 return;
757
758 for (const CTxIn& txin : wtx.tx->vin)
759 AddToSpends(txin.prevout, wtx.GetHash());
760}
761
762bool CWallet::EncryptWallet(const SecureString& strWalletPassphrase)
763{
764 // Only descriptor wallets can be encrypted
766
767 if (IsCrypted())
768 return false;
769
770 CKeyingMaterial plain_master_key;
771
772 plain_master_key.resize(WALLET_CRYPTO_KEY_SIZE);
773 GetStrongRandBytes(plain_master_key);
774
775 CMasterKey master_key;
776
777 master_key.vchSalt.resize(WALLET_CRYPTO_SALT_SIZE);
778 GetStrongRandBytes(master_key.vchSalt);
779
780 if (!EncryptMasterKey(strWalletPassphrase, plain_master_key, master_key)) {
781 return false;
782 }
783 WalletLogPrintf("Encrypting Wallet with an nDeriveIterations of %i\n", master_key.nDeriveIterations);
784
785 {
787 mapMasterKeys[++nMasterKeyMaxID] = master_key;
788 WalletBatch* encrypted_batch = new WalletBatch(GetDatabase());
789 if (!encrypted_batch->TxnBegin()) {
790 delete encrypted_batch;
791 encrypted_batch = nullptr;
792 return false;
793 }
794 encrypted_batch->WriteMasterKey(nMasterKeyMaxID, master_key);
795
796 for (const auto& spk_man_pair : m_spk_managers) {
797 auto spk_man = spk_man_pair.second.get();
798 if (!spk_man->Encrypt(plain_master_key, encrypted_batch)) {
799 encrypted_batch->TxnAbort();
800 delete encrypted_batch;
801 encrypted_batch = nullptr;
802 // We now probably have half of our keys encrypted in memory, and half not...
803 // die and let the user reload the unencrypted wallet.
804 assert(false);
805 }
806 }
807
808 if (!encrypted_batch->TxnCommit()) {
809 delete encrypted_batch;
810 encrypted_batch = nullptr;
811 // We now have keys encrypted in memory, but not on disk...
812 // die to avoid confusion and let the user reload the unencrypted wallet.
813 assert(false);
814 }
815
816 delete encrypted_batch;
817 encrypted_batch = nullptr;
818
819 Lock();
820 Unlock(strWalletPassphrase);
821
822 // Make new descriptors with a new seed
825 }
826 Lock();
827
828 // Need to completely rewrite the wallet file; if we don't, the database might keep
829 // bits of the unencrypted private key in slack space in the database file.
831 }
833
834 return true;
835}
836
838{
840 WalletBatch batch(GetDatabase());
841
842 // Old wallets didn't have any defined order for transactions
843 // Probably a bad idea to change the output of this
844
845 // First: get all CWalletTx into a sorted-by-time multimap.
846 typedef std::multimap<int64_t, CWalletTx*> TxItems;
847 TxItems txByTime;
848
849 for (auto& entry : mapWallet)
850 {
851 CWalletTx* wtx = &entry.second;
852 txByTime.insert(std::make_pair(wtx->nTimeReceived, wtx));
853 }
854
855 nOrderPosNext = 0;
856 std::vector<int64_t> nOrderPosOffsets;
857 for (TxItems::iterator it = txByTime.begin(); it != txByTime.end(); ++it)
858 {
859 CWalletTx *const pwtx = (*it).second;
860 int64_t& nOrderPos = pwtx->nOrderPos;
861
862 if (nOrderPos == -1)
863 {
864 nOrderPos = nOrderPosNext++;
865 nOrderPosOffsets.push_back(nOrderPos);
866
867 if (!batch.WriteTx(*pwtx))
868 return DBErrors::LOAD_FAIL;
869 }
870 else
871 {
872 int64_t nOrderPosOff = 0;
873 for (const int64_t& nOffsetStart : nOrderPosOffsets)
874 {
875 if (nOrderPos >= nOffsetStart)
876 ++nOrderPosOff;
877 }
878 nOrderPos += nOrderPosOff;
879 nOrderPosNext = std::max(nOrderPosNext, nOrderPos + 1);
880
881 if (!nOrderPosOff)
882 continue;
883
884 // Since we're changing the order, write it back
885 if (!batch.WriteTx(*pwtx))
886 return DBErrors::LOAD_FAIL;
887 }
888 }
889 batch.WriteOrderPosNext(nOrderPosNext);
890
891 return DBErrors::LOAD_OK;
892}
893
895{
897 int64_t nRet = nOrderPosNext++;
898 if (batch) {
899 batch->WriteOrderPosNext(nOrderPosNext);
900 } else {
901 WalletBatch(GetDatabase()).WriteOrderPosNext(nOrderPosNext);
902 }
903 return nRet;
904}
905
907{
908 {
910 for (auto& [_, wtx] : mapWallet)
911 wtx.MarkDirty();
912 }
913}
914
915bool CWallet::MarkReplaced(const Txid& originalHash, const Txid& newHash)
916{
918
919 auto mi = mapWallet.find(originalHash);
920
921 // There is a bug if MarkReplaced is not called on an existing wallet transaction.
922 assert(mi != mapWallet.end());
923
924 CWalletTx& wtx = (*mi).second;
925
926 // Ensure for now that we're not overwriting data
927 assert(wtx.mapValue.count("replaced_by_txid") == 0);
928
929 wtx.mapValue["replaced_by_txid"] = newHash.ToString();
930
931 // Refresh mempool status without waiting for transactionRemovedFromMempool or transactionAddedToMempool
933
934 WalletBatch batch(GetDatabase());
935
936 bool success = true;
937 if (!batch.WriteTx(wtx)) {
938 WalletLogPrintf("%s: Updating batch tx %s failed\n", __func__, wtx.GetHash().ToString());
939 success = false;
940 }
941
943
944 return success;
945}
946
947void CWallet::SetSpentKeyState(WalletBatch& batch, const Txid& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations)
948{
950 const CWalletTx* srctx = GetWalletTx(hash);
951 if (!srctx) return;
952
953 CTxDestination dst;
954 if (ExtractDestination(srctx->tx->vout[n].scriptPubKey, dst)) {
955 if (IsMine(dst)) {
956 if (used != IsAddressPreviouslySpent(dst)) {
957 if (used) {
958 tx_destinations.insert(dst);
959 }
960 SetAddressPreviouslySpent(batch, dst, used);
961 }
962 }
963 }
964}
965
966bool CWallet::IsSpentKey(const CScript& scriptPubKey) const
967{
969 CTxDestination dest;
970 if (!ExtractDestination(scriptPubKey, dest)) {
971 return false;
972 }
973 if (IsAddressPreviouslySpent(dest)) {
974 return true;
975 }
976 return false;
977}
978
979CWalletTx* CWallet::AddToWallet(CTransactionRef tx, const TxState& state, const UpdateWalletTxFn& update_wtx, bool rescanning_old_block)
980{
982
983 WalletBatch batch(GetDatabase());
984
985 Txid hash = tx->GetHash();
986
988 // Mark used destinations
989 std::set<CTxDestination> tx_destinations;
990
991 for (const CTxIn& txin : tx->vin) {
992 const COutPoint& op = txin.prevout;
993 SetSpentKeyState(batch, op.hash, op.n, true, tx_destinations);
994 }
995
996 MarkDestinationsDirty(tx_destinations);
997 }
998
999 // Inserts only if not already there, returns tx inserted or tx found
1000 auto ret = mapWallet.emplace(std::piecewise_construct, std::forward_as_tuple(hash), std::forward_as_tuple(tx, state));
1001 CWalletTx& wtx = (*ret.first).second;
1002 bool fInsertedNew = ret.second;
1003 bool fUpdated = update_wtx && update_wtx(wtx, fInsertedNew);
1004 if (fInsertedNew) {
1005 wtx.nTimeReceived = GetTime();
1006 wtx.nOrderPos = IncOrderPosNext(&batch);
1007 wtx.m_it_wtxOrdered = wtxOrdered.insert(std::make_pair(wtx.nOrderPos, &wtx));
1008 wtx.nTimeSmart = ComputeTimeSmart(wtx, rescanning_old_block);
1009 AddToSpends(wtx);
1010
1011 // Update birth time when tx time is older than it.
1013 }
1014
1015 if (!fInsertedNew)
1016 {
1017 if (state.index() != wtx.m_state.index()) {
1018 wtx.m_state = state;
1019 fUpdated = true;
1020 } else {
1023 }
1024 // If we have a witness-stripped version of this transaction, and we
1025 // see a new version with a witness, then we must be upgrading a pre-segwit
1026 // wallet. Store the new version of the transaction with the witness,
1027 // as the stripped-version must be invalid.
1028 // TODO: Store all versions of the transaction, instead of just one.
1029 if (tx->HasWitness() && !wtx.tx->HasWitness()) {
1030 wtx.SetTx(tx);
1031 fUpdated = true;
1032 }
1033 }
1034
1035 // Mark inactive coinbase transactions and their descendants as abandoned
1036 if (wtx.IsCoinBase() && wtx.isInactive()) {
1037 std::vector<CWalletTx*> txs{&wtx};
1038
1039 TxStateInactive inactive_state = TxStateInactive{/*abandoned=*/true};
1040
1041 while (!txs.empty()) {
1042 CWalletTx* desc_tx = txs.back();
1043 txs.pop_back();
1044 desc_tx->m_state = inactive_state;
1045 // Break caches since we have changed the state
1046 desc_tx->MarkDirty();
1047 batch.WriteTx(*desc_tx);
1048 MarkInputsDirty(desc_tx->tx);
1049 for (unsigned int i = 0; i < desc_tx->tx->vout.size(); ++i) {
1050 COutPoint outpoint(desc_tx->GetHash(), i);
1051 std::pair<TxSpends::const_iterator, TxSpends::const_iterator> range = mapTxSpends.equal_range(outpoint);
1052 for (TxSpends::const_iterator it = range.first; it != range.second; ++it) {
1053 const auto wit = mapWallet.find(it->second);
1054 if (wit != mapWallet.end()) {
1055 txs.push_back(&wit->second);
1056 }
1057 }
1058 }
1059 }
1060 }
1061
1063 WalletLogPrintf("AddToWallet %s %s%s %s\n", hash.ToString(), (fInsertedNew ? "new" : ""), (fUpdated ? "update" : ""), TxStateString(state));
1064
1065 // Write to disk
1066 if (fInsertedNew || fUpdated)
1067 if (!batch.WriteTx(wtx))
1068 return nullptr;
1069
1070 // Break debit/credit balance caches:
1071 wtx.MarkDirty();
1072
1073 // Cache the outputs that belong to the wallet
1074 RefreshTXOsFromTx(wtx);
1075
1076 // Notify UI of new or updated transaction
1077 NotifyTransactionChanged(hash, fInsertedNew ? CT_NEW : CT_UPDATED);
1078
1079#if HAVE_SYSTEM
1080 // notify an external script when a wallet transaction comes in or is updated
1081 std::string strCmd = m_notify_tx_changed_script;
1082
1083 if (!strCmd.empty())
1084 {
1085 ReplaceAll(strCmd, "%s", hash.GetHex());
1086 if (auto* conf = wtx.state<TxStateConfirmed>())
1087 {
1088 ReplaceAll(strCmd, "%b", conf->confirmed_block_hash.GetHex());
1089 ReplaceAll(strCmd, "%h", ToString(conf->confirmed_block_height));
1090 } else {
1091 ReplaceAll(strCmd, "%b", "unconfirmed");
1092 ReplaceAll(strCmd, "%h", "-1");
1093 }
1094#ifndef WIN32
1095 // Substituting the wallet name isn't currently supported on windows
1096 // because windows shell escaping has not been implemented yet:
1097 // https://github.com/bitcoin/bitcoin/pull/13339#issuecomment-537384875
1098 // A few ways it could be implemented in the future are described in:
1099 // https://github.com/bitcoin/bitcoin/pull/13339#issuecomment-461288094
1100 ReplaceAll(strCmd, "%w", ShellEscape(GetName()));
1101#endif
1102 std::thread t(runCommand, strCmd);
1103 t.detach(); // thread runs free
1104 }
1105#endif
1106
1107 return &wtx;
1108}
1109
1110bool CWallet::LoadToWallet(const Txid& hash, const UpdateWalletTxFn& fill_wtx)
1111{
1112 const auto& ins = mapWallet.emplace(std::piecewise_construct, std::forward_as_tuple(hash), std::forward_as_tuple(nullptr, TxStateInactive{}));
1113 CWalletTx& wtx = ins.first->second;
1114 if (!fill_wtx(wtx, ins.second)) {
1115 return false;
1116 }
1117 // If wallet doesn't have a chain (e.g when using bitcoin-wallet tool),
1118 // don't bother to update txn.
1119 if (HaveChain()) {
1120 wtx.updateState(chain());
1121 }
1122 if (/* insertion took place */ ins.second) {
1123 wtx.m_it_wtxOrdered = wtxOrdered.insert(std::make_pair(wtx.nOrderPos, &wtx));
1124 }
1125 AddToSpends(wtx);
1126 for (const CTxIn& txin : wtx.tx->vin) {
1127 auto it = mapWallet.find(txin.prevout.hash);
1128 if (it != mapWallet.end()) {
1129 CWalletTx& prevtx = it->second;
1130 if (auto* prev = prevtx.state<TxStateBlockConflicted>()) {
1131 MarkConflicted(prev->conflicting_block_hash, prev->conflicting_block_height, wtx.GetHash());
1132 }
1133 }
1134 }
1135
1136 // Update birth time when tx time is older than it.
1138
1139 // Make sure the tx outputs are known by the wallet
1140 RefreshTXOsFromTx(wtx);
1141 return true;
1142}
1143
1144bool CWallet::AddToWalletIfInvolvingMe(const CTransactionRef& ptx, const SyncTxState& state, bool fUpdate, bool rescanning_old_block)
1145{
1146 const CTransaction& tx = *ptx;
1147 {
1149
1150 if (auto* conf = std::get_if<TxStateConfirmed>(&state)) {
1151 for (const CTxIn& txin : tx.vin) {
1152 std::pair<TxSpends::const_iterator, TxSpends::const_iterator> range = mapTxSpends.equal_range(txin.prevout);
1153 while (range.first != range.second) {
1154 if (range.first->second != tx.GetHash()) {
1155 WalletLogPrintf("Transaction %s (in block %s) conflicts with wallet transaction %s (both spend %s:%i)\n", tx.GetHash().ToString(), conf->confirmed_block_hash.ToString(), range.first->second.ToString(), range.first->first.hash.ToString(), range.first->first.n);
1156 MarkConflicted(conf->confirmed_block_hash, conf->confirmed_block_height, range.first->second);
1157 }
1158 range.first++;
1159 }
1160 }
1161 }
1162
1163 bool fExisted = mapWallet.count(tx.GetHash()) != 0;
1164 if (fExisted && !fUpdate) return false;
1165 if (fExisted || IsMine(tx) || IsFromMe(tx))
1166 {
1167 /* Check if any keys in the wallet keypool that were supposed to be unused
1168 * have appeared in a new transaction. If so, remove those keys from the keypool.
1169 * This can happen when restoring an old wallet backup that does not contain
1170 * the mostly recently created transactions from newer versions of the wallet.
1171 */
1172
1173 // loop though all outputs
1174 for (const CTxOut& txout: tx.vout) {
1175 for (const auto& spk_man : GetScriptPubKeyMans(txout.scriptPubKey)) {
1176 for (auto &dest : spk_man->MarkUnusedAddresses(txout.scriptPubKey)) {
1177 // If internal flag is not defined try to infer it from the ScriptPubKeyMan
1178 if (!dest.internal.has_value()) {
1179 dest.internal = IsInternalScriptPubKeyMan(spk_man);
1180 }
1181
1182 // skip if can't determine whether it's a receiving address or not
1183 if (!dest.internal.has_value()) continue;
1184
1185 // If this is a receiving address and it's not in the address book yet
1186 // (e.g. it wasn't generated on this node or we're restoring from backup)
1187 // add it to the address book for proper transaction accounting
1188 if (!*dest.internal && !FindAddressBookEntry(dest.dest, /* allow_change= */ false)) {
1190 }
1191 }
1192 }
1193 }
1194
1195 // Block disconnection override an abandoned tx as unconfirmed
1196 // which means user may have to call abandontransaction again
1197 TxState tx_state = std::visit([](auto&& s) -> TxState { return s; }, state);
1198 CWalletTx* wtx = AddToWallet(MakeTransactionRef(tx), tx_state, /*update_wtx=*/nullptr, rescanning_old_block);
1199 if (!wtx) {
1200 // Can only be nullptr if there was a db write error (missing db, read-only db or a db engine internal writing error).
1201 // As we only store arriving transaction in this process, and we don't want an inconsistent state, let's throw an error.
1202 throw std::runtime_error("DB error adding transaction to wallet, write failed");
1203 }
1204 return true;
1205 }
1206 }
1207 return false;
1208}
1209
1211{
1212 LOCK(cs_wallet);
1213 const CWalletTx* wtx = GetWalletTx(hashTx);
1214 return wtx && !wtx->isAbandoned() && GetTxDepthInMainChain(*wtx) == 0 && !wtx->InMempool();
1215}
1216
1217void CWallet::UpdateTrucSiblingConflicts(const CWalletTx& parent_wtx, const Txid& child_txid, bool add_conflict) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
1218{
1219 // Find all other txs in our wallet that spend utxos from this parent
1220 // so that we can mark them as mempool-conflicted by this new tx.
1221 for (long unsigned int i = 0; i < parent_wtx.tx->vout.size(); i++) {
1222 for (auto range = mapTxSpends.equal_range(COutPoint(parent_wtx.tx->GetHash(), i)); range.first != range.second; range.first++) {
1223 const Txid& sibling_txid = range.first->second;
1224 // Skip the child_tx itself
1225 if (sibling_txid == child_txid) continue;
1226 RecursiveUpdateTxState(/*batch=*/nullptr, sibling_txid, [&child_txid, add_conflict](CWalletTx& wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
1227 return add_conflict ? (wtx.mempool_conflicts.insert(child_txid).second ? TxUpdate::CHANGED : TxUpdate::UNCHANGED)
1228 : (wtx.mempool_conflicts.erase(child_txid) ? TxUpdate::CHANGED : TxUpdate::UNCHANGED);
1229 });
1230 }
1231 }
1232}
1233
1235{
1236 for (const CTxIn& txin : tx->vin) {
1237 auto it = mapWallet.find(txin.prevout.hash);
1238 if (it != mapWallet.end()) {
1239 it->second.MarkDirty();
1240 }
1241 }
1242}
1243
1245{
1246 LOCK(cs_wallet);
1247 auto it = mapWallet.find(hashTx);
1248 assert(it != mapWallet.end());
1249 return AbandonTransaction(it->second);
1250}
1251
1253{
1254 // Can't mark abandoned if confirmed or in mempool
1255 if (GetTxDepthInMainChain(tx) != 0 || tx.InMempool()) {
1256 return false;
1257 }
1258
1259 auto try_updating_state = [](CWalletTx& wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
1260 // If the orig tx was not in block/mempool, none of its spends can be.
1261 assert(!wtx.isConfirmed());
1262 assert(!wtx.InMempool());
1263 // If already conflicted or abandoned, no need to set abandoned
1264 if (!wtx.isBlockConflicted() && !wtx.isAbandoned()) {
1265 wtx.m_state = TxStateInactive{/*abandoned=*/true};
1267 }
1268 return TxUpdate::UNCHANGED;
1269 };
1270
1271 // Iterate over all its outputs, and mark transactions in the wallet that spend them abandoned too.
1272 // States are not permanent, so these transactions can become unabandoned if they are re-added to the
1273 // mempool, or confirmed in a block, or conflicted.
1274 // Note: If the reorged coinbase is re-added to the main chain, the descendants that have not had their
1275 // states change will remain abandoned and will require manual broadcast if the user wants them.
1276
1277 RecursiveUpdateTxState(tx.GetHash(), try_updating_state);
1278
1279 return true;
1280}
1281
1282void CWallet::MarkConflicted(const uint256& hashBlock, int conflicting_height, const Txid& hashTx)
1283{
1284 LOCK(cs_wallet);
1285
1286 // If number of conflict confirms cannot be determined, this means
1287 // that the block is still unknown or not yet part of the main chain,
1288 // for example when loading the wallet during a reindex. Do nothing in that
1289 // case.
1290 if (m_last_block_processed_height < 0 || conflicting_height < 0) {
1291 return;
1292 }
1293 int conflictconfirms = (m_last_block_processed_height - conflicting_height + 1) * -1;
1294 if (conflictconfirms >= 0)
1295 return;
1296
1297 auto try_updating_state = [&](CWalletTx& wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
1298 if (conflictconfirms < GetTxDepthInMainChain(wtx)) {
1299 // Block is 'more conflicted' than current confirm; update.
1300 // Mark transaction as conflicted with this block.
1301 wtx.m_state = TxStateBlockConflicted{hashBlock, conflicting_height};
1302 return TxUpdate::CHANGED;
1303 }
1304 return TxUpdate::UNCHANGED;
1305 };
1306
1307 // Iterate over all its outputs, and mark transactions in the wallet that spend them conflicted too.
1308 RecursiveUpdateTxState(hashTx, try_updating_state);
1309
1310}
1311
1312void CWallet::RecursiveUpdateTxState(const Txid& tx_hash, const TryUpdatingStateFn& try_updating_state) {
1313 WalletBatch batch(GetDatabase());
1314 RecursiveUpdateTxState(&batch, tx_hash, try_updating_state);
1315}
1316
1317void CWallet::RecursiveUpdateTxState(WalletBatch* batch, const Txid& tx_hash, const TryUpdatingStateFn& try_updating_state) {
1318 std::set<Txid> todo;
1319 std::set<Txid> done;
1320
1321 todo.insert(tx_hash);
1322
1323 while (!todo.empty()) {
1324 Txid now = *todo.begin();
1325 todo.erase(now);
1326 done.insert(now);
1327 auto it = mapWallet.find(now);
1328 assert(it != mapWallet.end());
1329 CWalletTx& wtx = it->second;
1330
1331 TxUpdate update_state = try_updating_state(wtx);
1332 if (update_state != TxUpdate::UNCHANGED) {
1333 wtx.MarkDirty();
1334 if (batch) batch->WriteTx(wtx);
1335 // Iterate over all its outputs, and update those tx states as well (if applicable)
1336 for (unsigned int i = 0; i < wtx.tx->vout.size(); ++i) {
1337 std::pair<TxSpends::const_iterator, TxSpends::const_iterator> range = mapTxSpends.equal_range(COutPoint(now, i));
1338 for (TxSpends::const_iterator iter = range.first; iter != range.second; ++iter) {
1339 if (!done.count(iter->second)) {
1340 todo.insert(iter->second);
1341 }
1342 }
1343 }
1344
1345 if (update_state == TxUpdate::NOTIFY_CHANGED) {
1347 }
1348
1349 // If a transaction changes its tx state, that usually changes the balance
1350 // available of the outputs it spends. So force those to be recomputed
1351 MarkInputsDirty(wtx.tx);
1352 }
1353 }
1354}
1355
1356bool CWallet::SyncTransaction(const CTransactionRef& ptx, const SyncTxState& state, bool update_tx, bool rescanning_old_block)
1357{
1358 if (!AddToWalletIfInvolvingMe(ptx, state, update_tx, rescanning_old_block))
1359 return false; // Not one of ours
1360
1361 // If a transaction changes 'conflicted' state, that changes the balance
1362 // available of the outputs it spends. So force those to be
1363 // recomputed, also:
1364 MarkInputsDirty(ptx);
1365 return true;
1366}
1367
1369 LOCK(cs_wallet);
1371
1372 auto it = mapWallet.find(tx->GetHash());
1373 if (it != mapWallet.end()) {
1374 RefreshMempoolStatus(it->second, chain());
1375 }
1376
1377 const Txid& txid = tx->GetHash();
1378
1379 for (const CTxIn& tx_in : tx->vin) {
1380 // For each wallet transaction spending this prevout..
1381 for (auto range = mapTxSpends.equal_range(tx_in.prevout); range.first != range.second; range.first++) {
1382 const Txid& spent_id = range.first->second;
1383 // Skip the recently added tx
1384 if (spent_id == txid) continue;
1385 RecursiveUpdateTxState(/*batch=*/nullptr, spent_id, [&txid](CWalletTx& wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
1386 return wtx.mempool_conflicts.insert(txid).second ? TxUpdate::CHANGED : TxUpdate::UNCHANGED;
1387 });
1388 }
1389
1390 }
1391
1392 if (tx->version == TRUC_VERSION) {
1393 // Unconfirmed TRUC transactions are only allowed a 1-parent-1-child topology.
1394 // For any unconfirmed v3 parents (there should be a maximum of 1 except in reorgs),
1395 // record this child so the wallet doesn't try to spend any other outputs
1396 for (const CTxIn& tx_in : tx->vin) {
1397 auto parent_it = mapWallet.find(tx_in.prevout.hash);
1398 if (parent_it != mapWallet.end()) {
1399 CWalletTx& parent_wtx = parent_it->second;
1400 if (parent_wtx.isUnconfirmed()) {
1401 parent_wtx.truc_child_in_mempool = tx->GetHash();
1402 // Even though these siblings do not spend the same utxos, they can't
1403 // be present in the mempool at the same time because of TRUC policy rules
1404 UpdateTrucSiblingConflicts(parent_wtx, txid, /*add_conflict=*/true);
1405 }
1406 }
1407 }
1408 }
1409}
1410
1412 LOCK(cs_wallet);
1413 auto it = mapWallet.find(tx->GetHash());
1414 if (it != mapWallet.end()) {
1415 RefreshMempoolStatus(it->second, chain());
1416 }
1417 // Handle transactions that were removed from the mempool because they
1418 // conflict with transactions in a newly connected block.
1419 if (reason == MemPoolRemovalReason::CONFLICT) {
1420 // Trigger external -walletnotify notifications for these transactions.
1421 // Set Status::UNCONFIRMED instead of Status::CONFLICTED for a few reasons:
1422 //
1423 // 1. The transactionRemovedFromMempool callback does not currently
1424 // provide the conflicting block's hash and height, and for backwards
1425 // compatibility reasons it may not be not safe to store conflicted
1426 // wallet transactions with a null block hash. See
1427 // https://github.com/bitcoin/bitcoin/pull/18600#discussion_r420195993.
1428 // 2. For most of these transactions, the wallet's internal conflict
1429 // detection in the blockConnected handler will subsequently call
1430 // MarkConflicted and update them with CONFLICTED status anyway. This
1431 // applies to any wallet transaction that has inputs spent in the
1432 // block, or that has ancestors in the wallet with inputs spent by
1433 // the block.
1434 // 3. Longstanding behavior since the sync implementation in
1435 // https://github.com/bitcoin/bitcoin/pull/9371 and the prior sync
1436 // implementation before that was to mark these transactions
1437 // unconfirmed rather than conflicted.
1438 //
1439 // Nothing described above should be seen as an unchangeable requirement
1440 // when improving this code in the future. The wallet's heuristics for
1441 // distinguishing between conflicted and unconfirmed transactions are
1442 // imperfect, and could be improved in general, see
1443 // https://github.com/bitcoin-core/bitcoin-devwiki/wiki/Wallet-Transaction-Conflict-Tracking
1445 }
1446
1447 const Txid& txid = tx->GetHash();
1448
1449 for (const CTxIn& tx_in : tx->vin) {
1450 // Iterate over all wallet transactions spending txin.prev
1451 // and recursively mark them as no longer conflicting with
1452 // txid
1453 for (auto range = mapTxSpends.equal_range(tx_in.prevout); range.first != range.second; range.first++) {
1454 const Txid& spent_id = range.first->second;
1455
1456 RecursiveUpdateTxState(/*batch=*/nullptr, spent_id, [&txid](CWalletTx& wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
1457 return wtx.mempool_conflicts.erase(txid) ? TxUpdate::CHANGED : TxUpdate::UNCHANGED;
1458 });
1459 }
1460 }
1461
1462 if (tx->version == TRUC_VERSION) {
1463 // If this tx has a parent, unset its truc_child_in_mempool to make it possible
1464 // to spend from the parent again. If this tx was replaced by another
1465 // child of the same parent, transactionAddedToMempool
1466 // will update truc_child_in_mempool
1467 for (const CTxIn& tx_in : tx->vin) {
1468 auto parent_it = mapWallet.find(tx_in.prevout.hash);
1469 if (parent_it != mapWallet.end()) {
1470 CWalletTx& parent_wtx = parent_it->second;
1471 if (parent_wtx.truc_child_in_mempool == tx->GetHash()) {
1472 parent_wtx.truc_child_in_mempool = std::nullopt;
1473 UpdateTrucSiblingConflicts(parent_wtx, txid, /*add_conflict=*/false);
1474 }
1475 }
1476 }
1477 }
1478}
1479
1481{
1482 if (role == ChainstateRole::BACKGROUND) {
1483 return;
1484 }
1485 assert(block.data);
1486 LOCK(cs_wallet);
1487
1488 // Update the best block in memory first. This will set the best block's height, which is
1489 // needed by MarkConflicted.
1491
1492 // No need to scan block if it was created before the wallet birthday.
1493 // Uses chain max time and twice the grace period to adjust time for block time variability.
1494 if (block.chain_time_max < m_birth_time.load() - (TIMESTAMP_WINDOW * 2)) return;
1495
1496 // Scan block
1497 bool wallet_updated = false;
1498 for (size_t index = 0; index < block.data->vtx.size(); index++) {
1499 wallet_updated |= SyncTransaction(block.data->vtx[index], TxStateConfirmed{block.hash, block.height, static_cast<int>(index)});
1501 }
1502
1503 // Update on disk if this block resulted in us updating a tx, or periodically every 144 blocks (~1 day)
1504 if (wallet_updated || block.height % 144 == 0) {
1506 }
1507}
1508
1510{
1511 assert(block.data);
1512 LOCK(cs_wallet);
1513
1514 // At block disconnection, this will change an abandoned transaction to
1515 // be unconfirmed, whether or not the transaction is added back to the mempool.
1516 // User may have to call abandontransaction again. It may be addressed in the
1517 // future with a stickier abandoned state or even removing abandontransaction call.
1518 int disconnect_height = block.height;
1519
1520 for (size_t index = 0; index < block.data->vtx.size(); index++) {
1521 const CTransactionRef& ptx = block.data->vtx[index];
1522 // Coinbase transactions are not only inactive but also abandoned,
1523 // meaning they should never be relayed standalone via the p2p protocol.
1524 SyncTransaction(ptx, TxStateInactive{/*abandoned=*/index == 0});
1525
1526 for (const CTxIn& tx_in : ptx->vin) {
1527 // No other wallet transactions conflicted with this transaction
1528 if (mapTxSpends.count(tx_in.prevout) < 1) continue;
1529
1530 std::pair<TxSpends::const_iterator, TxSpends::const_iterator> range = mapTxSpends.equal_range(tx_in.prevout);
1531
1532 // For all of the spends that conflict with this transaction
1533 for (TxSpends::const_iterator _it = range.first; _it != range.second; ++_it) {
1534 CWalletTx& wtx = mapWallet.find(_it->second)->second;
1535
1536 if (!wtx.isBlockConflicted()) continue;
1537
1538 auto try_updating_state = [&](CWalletTx& tx) {
1539 if (!tx.isBlockConflicted()) return TxUpdate::UNCHANGED;
1540 if (tx.state<TxStateBlockConflicted>()->conflicting_block_height >= disconnect_height) {
1541 tx.m_state = TxStateInactive{};
1542 return TxUpdate::CHANGED;
1543 }
1544 return TxUpdate::UNCHANGED;
1545 };
1546
1547 RecursiveUpdateTxState(wtx.tx->GetHash(), try_updating_state);
1548 }
1549 }
1550 }
1551
1552 // Update the best block
1553 SetLastBlockProcessed(block.height - 1, *Assert(block.prev_hash));
1554}
1555
1557{
1559}
1560
1561void CWallet::BlockUntilSyncedToCurrentChain() const {
1563 // Skip the queue-draining stuff if we know we're caught up with
1564 // chain().Tip(), otherwise put a callback in the validation interface queue and wait
1565 // for the queue to drain enough to execute it (indicating we are caught up
1566 // at least with the time we entered this function).
1567 uint256 last_block_hash = WITH_LOCK(cs_wallet, return m_last_block_processed);
1568 chain().waitForNotificationsIfTipChanged(last_block_hash);
1569}
1570
1571// Note that this function doesn't distinguish between a 0-valued input,
1572// and a not-"is mine" input.
1574{
1575 LOCK(cs_wallet);
1576 auto txo = GetTXO(txin.prevout);
1577 if (txo) {
1578 return txo->GetTxOut().nValue;
1579 }
1580 return 0;
1581}
1582
1583bool CWallet::IsMine(const CTxOut& txout) const
1584{
1586 return IsMine(txout.scriptPubKey);
1587}
1588
1589bool CWallet::IsMine(const CTxDestination& dest) const
1590{
1592 return IsMine(GetScriptForDestination(dest));
1593}
1594
1596{
1598
1599 // Search the cache so that IsMine is called only on the relevant SPKMs instead of on everything in m_spk_managers
1600 const auto& it = m_cached_spks.find(script);
1601 if (it != m_cached_spks.end()) {
1602 bool res = false;
1603 for (const auto& spkm : it->second) {
1604 res = res || spkm->IsMine(script);
1605 }
1606 Assume(res);
1607 return res;
1608 }
1609
1610 return false;
1611}
1612
1613bool CWallet::IsMine(const CTransaction& tx) const
1614{
1616 for (const CTxOut& txout : tx.vout)
1617 if (IsMine(txout))
1618 return true;
1619 return false;
1620}
1621
1622bool CWallet::IsMine(const COutPoint& outpoint) const
1623{
1625 auto wtx = GetWalletTx(outpoint.hash);
1626 if (!wtx) {
1627 return false;
1628 }
1629 if (outpoint.n >= wtx->tx->vout.size()) {
1630 return false;
1631 }
1632 return IsMine(wtx->tx->vout[outpoint.n]);
1633}
1634
1635bool CWallet::IsFromMe(const CTransaction& tx) const
1636{
1637 LOCK(cs_wallet);
1638 for (const CTxIn& txin : tx.vin) {
1639 if (GetTXO(txin.prevout)) return true;
1640 }
1641 return false;
1642}
1643
1645{
1646 CAmount nDebit = 0;
1647 for (const CTxIn& txin : tx.vin)
1648 {
1649 nDebit += GetDebit(txin);
1650 if (!MoneyRange(nDebit))
1651 throw std::runtime_error(std::string(__func__) + ": value out of range");
1652 }
1653 return nDebit;
1654}
1655
1657{
1658 // All Active ScriptPubKeyMans must be HD for this to be true
1659 bool result = false;
1660 for (const auto& spk_man : GetActiveScriptPubKeyMans()) {
1661 if (!spk_man->IsHDEnabled()) return false;
1662 result = true;
1663 }
1664 return result;
1665}
1666
1667bool CWallet::CanGetAddresses(bool internal) const
1668{
1669 LOCK(cs_wallet);
1670 if (m_spk_managers.empty()) return false;
1671 for (OutputType t : OUTPUT_TYPES) {
1672 auto spk_man = GetScriptPubKeyMan(t, internal);
1673 if (spk_man && spk_man->CanGetAddresses(internal)) {
1674 return true;
1675 }
1676 }
1677 return false;
1678}
1679
1681{
1682 WalletBatch batch(GetDatabase());
1683 return SetWalletFlagWithDB(batch, flags);
1684}
1685
1687{
1688 LOCK(cs_wallet);
1690 if (!batch.WriteWalletFlags(m_wallet_flags))
1691 throw std::runtime_error(std::string(__func__) + ": writing wallet flags failed");
1692}
1693
1694void CWallet::UnsetWalletFlag(uint64_t flag)
1695{
1696 WalletBatch batch(GetDatabase());
1697 UnsetWalletFlagWithDB(batch, flag);
1698}
1699
1701{
1702 LOCK(cs_wallet);
1703 m_wallet_flags &= ~flag;
1704 if (!batch.WriteWalletFlags(m_wallet_flags))
1705 throw std::runtime_error(std::string(__func__) + ": writing wallet flags failed");
1706}
1707
1709{
1711}
1712
1713bool CWallet::IsWalletFlagSet(uint64_t flag) const
1714{
1715 return (m_wallet_flags & flag);
1716}
1717
1719{
1720 LOCK(cs_wallet);
1721 if (((flags & KNOWN_WALLET_FLAGS) >> 32) ^ (flags >> 32)) {
1722 // contains unknown non-tolerable wallet flags
1723 return false;
1724 }
1726
1727 return true;
1728}
1729
1731{
1732 LOCK(cs_wallet);
1733
1734 // We should never be writing unknown non-tolerable wallet flags
1735 assert(((flags & KNOWN_WALLET_FLAGS) >> 32) == (flags >> 32));
1736 // This should only be used once, when creating a new wallet - so current flags are expected to be blank
1737 assert(m_wallet_flags == 0);
1738
1739 if (!WalletBatch(GetDatabase()).WriteWalletFlags(flags)) {
1740 throw std::runtime_error(std::string(__func__) + ": writing wallet flags failed");
1741 }
1742
1743 if (!LoadWalletFlags(flags)) assert(false);
1744}
1745
1747{
1748 return m_wallet_flags;
1749}
1750
1752{
1753 int64_t birthtime = m_birth_time.load();
1754 if (time < birthtime) {
1755 m_birth_time = time;
1756 }
1757}
1758
1767int64_t CWallet::RescanFromTime(int64_t startTime, const WalletRescanReserver& reserver, bool update)
1768{
1769 // Find starting block. May be null if nCreateTime is greater than the
1770 // highest blockchain timestamp, in which case there is nothing that needs
1771 // to be scanned.
1772 int start_height = 0;
1773 uint256 start_block;
1774 bool start = chain().findFirstBlockWithTimeAndHeight(startTime - TIMESTAMP_WINDOW, 0, FoundBlock().hash(start_block).height(start_height));
1775 WalletLogPrintf("%s: Rescanning last %i blocks\n", __func__, start ? WITH_LOCK(cs_wallet, return GetLastBlockHeight()) - start_height + 1 : 0);
1776
1777 if (start) {
1778 // TODO: this should take into account failure by ScanResult::USER_ABORT
1779 ScanResult result = ScanForWalletTransactions(start_block, start_height, /*max_height=*/{}, reserver, /*fUpdate=*/update, /*save_progress=*/false);
1780 if (result.status == ScanResult::FAILURE) {
1781 int64_t time_max;
1782 CHECK_NONFATAL(chain().findBlock(result.last_failed_block, FoundBlock().maxTime(time_max)));
1783 return time_max + TIMESTAMP_WINDOW + 1;
1784 }
1785 }
1786 return startTime;
1787}
1788
1811CWallet::ScanResult CWallet::ScanForWalletTransactions(const uint256& start_block, int start_height, std::optional<int> max_height, const WalletRescanReserver& reserver, bool fUpdate, const bool save_progress)
1812{
1813 constexpr auto INTERVAL_TIME{60s};
1814 auto current_time{reserver.now()};
1815 auto start_time{reserver.now()};
1816
1817 assert(reserver.isReserved());
1818
1819 uint256 block_hash = start_block;
1820 ScanResult result;
1821
1822 std::unique_ptr<FastWalletRescanFilter> fast_rescan_filter;
1823 if (chain().hasBlockFilterIndex(BlockFilterType::BASIC)) fast_rescan_filter = std::make_unique<FastWalletRescanFilter>(*this);
1824
1825 WalletLogPrintf("Rescan started from block %s... (%s)\n", start_block.ToString(),
1826 fast_rescan_filter ? "fast variant using block filters" : "slow variant inspecting all blocks");
1827
1828 fAbortRescan = false;
1829 ShowProgress(strprintf("[%s] %s", DisplayName(), _("Rescanning…")), 0); // show rescan progress in GUI as dialog or on splashscreen, if rescan required on startup (e.g. due to corruption)
1830 uint256 tip_hash = WITH_LOCK(cs_wallet, return GetLastBlockHash());
1831 uint256 end_hash = tip_hash;
1832 if (max_height) chain().findAncestorByHeight(tip_hash, *max_height, FoundBlock().hash(end_hash));
1833 double progress_begin = chain().guessVerificationProgress(block_hash);
1834 double progress_end = chain().guessVerificationProgress(end_hash);
1835 double progress_current = progress_begin;
1836 int block_height = start_height;
1837 while (!fAbortRescan && !chain().shutdownRequested()) {
1838 if (progress_end - progress_begin > 0.0) {
1839 m_scanning_progress = (progress_current - progress_begin) / (progress_end - progress_begin);
1840 } else { // avoid divide-by-zero for single block scan range (i.e. start and stop hashes are equal)
1842 }
1843 if (block_height % 100 == 0 && progress_end - progress_begin > 0.0) {
1844 ShowProgress(strprintf("[%s] %s", DisplayName(), _("Rescanning…")), std::max(1, std::min(99, (int)(m_scanning_progress * 100))));
1845 }
1846
1847 bool next_interval = reserver.now() >= current_time + INTERVAL_TIME;
1848 if (next_interval) {
1849 current_time = reserver.now();
1850 WalletLogPrintf("Still rescanning. At block %d. Progress=%f\n", block_height, progress_current);
1851 }
1852
1853 bool fetch_block{true};
1854 if (fast_rescan_filter) {
1855 fast_rescan_filter->UpdateIfNeeded();
1856 auto matches_block{fast_rescan_filter->MatchesBlock(block_hash)};
1857 if (matches_block.has_value()) {
1858 if (*matches_block) {
1859 LogDebug(BCLog::SCAN, "Fast rescan: inspect block %d [%s] (filter matched)\n", block_height, block_hash.ToString());
1860 } else {
1861 result.last_scanned_block = block_hash;
1862 result.last_scanned_height = block_height;
1863 fetch_block = false;
1864 }
1865 } else {
1866 LogDebug(BCLog::SCAN, "Fast rescan: inspect block %d [%s] (WARNING: block filter not found!)\n", block_height, block_hash.ToString());
1867 }
1868 }
1869
1870 // Find next block separately from reading data above, because reading
1871 // is slow and there might be a reorg while it is read.
1872 bool block_still_active = false;
1873 bool next_block = false;
1874 uint256 next_block_hash;
1875 chain().findBlock(block_hash, FoundBlock().inActiveChain(block_still_active).nextBlock(FoundBlock().inActiveChain(next_block).hash(next_block_hash)));
1876
1877 if (fetch_block) {
1878 // Read block data and locator if needed (the locator is usually null unless we need to save progress)
1879 CBlock block;
1880 CBlockLocator loc;
1881 // Find block
1882 FoundBlock found_block{FoundBlock().data(block)};
1883 if (save_progress && next_interval) found_block.locator(loc);
1884 chain().findBlock(block_hash, found_block);
1885
1886 if (!block.IsNull()) {
1887 LOCK(cs_wallet);
1888 if (!block_still_active) {
1889 // Abort scan if current block is no longer active, to prevent
1890 // marking transactions as coming from the wrong block.
1891 result.last_failed_block = block_hash;
1892 result.status = ScanResult::FAILURE;
1893 break;
1894 }
1895 for (size_t posInBlock = 0; posInBlock < block.vtx.size(); ++posInBlock) {
1896 SyncTransaction(block.vtx[posInBlock], TxStateConfirmed{block_hash, block_height, static_cast<int>(posInBlock)}, fUpdate, /*rescanning_old_block=*/true);
1897 }
1898 // scan succeeded, record block as most recent successfully scanned
1899 result.last_scanned_block = block_hash;
1900 result.last_scanned_height = block_height;
1901
1902 if (!loc.IsNull()) {
1903 WalletLogPrintf("Saving scan progress %d.\n", block_height);
1904 WalletBatch batch(GetDatabase());
1905 batch.WriteBestBlock(loc);
1906 }
1907 } else {
1908 // could not scan block, keep scanning but record this block as the most recent failure
1909 result.last_failed_block = block_hash;
1910 result.status = ScanResult::FAILURE;
1911 }
1912 }
1913 if (max_height && block_height >= *max_height) {
1914 break;
1915 }
1916 // If rescanning was triggered with cs_wallet permanently locked (AttachChain), additional blocks that were connected during the rescan
1917 // aren't processed here but will be processed with the pending blockConnected notifications after the lock is released.
1918 // If rescanning without a permanent cs_wallet lock, additional blocks that were added during the rescan will be re-processed if
1919 // the notification was processed and the last block height was updated.
1920 if (block_height >= WITH_LOCK(cs_wallet, return GetLastBlockHeight())) {
1921 break;
1922 }
1923
1924 {
1925 if (!next_block) {
1926 // break successfully when rescan has reached the tip, or
1927 // previous block is no longer on the chain due to a reorg
1928 break;
1929 }
1930
1931 // increment block and verification progress
1932 block_hash = next_block_hash;
1933 ++block_height;
1934 progress_current = chain().guessVerificationProgress(block_hash);
1935
1936 // handle updated tip hash
1937 const uint256 prev_tip_hash = tip_hash;
1938 tip_hash = WITH_LOCK(cs_wallet, return GetLastBlockHash());
1939 if (!max_height && prev_tip_hash != tip_hash) {
1940 // in case the tip has changed, update progress max
1941 progress_end = chain().guessVerificationProgress(tip_hash);
1942 }
1943 }
1944 }
1945 if (!max_height) {
1946 WalletLogPrintf("Scanning current mempool transactions.\n");
1947 WITH_LOCK(cs_wallet, chain().requestMempoolTransactions(*this));
1948 }
1949 ShowProgress(strprintf("[%s] %s", DisplayName(), _("Rescanning…")), 100); // hide progress dialog in GUI
1950 if (block_height && fAbortRescan) {
1951 WalletLogPrintf("Rescan aborted at block %d. Progress=%f\n", block_height, progress_current);
1953 } else if (block_height && chain().shutdownRequested()) {
1954 WalletLogPrintf("Rescan interrupted by shutdown request at block %d. Progress=%f\n", block_height, progress_current);
1956 } else {
1957 WalletLogPrintf("Rescan completed in %15dms\n", Ticks<std::chrono::milliseconds>(reserver.now() - start_time));
1958 }
1959 return result;
1960}
1961
1962bool CWallet::SubmitTxMemoryPoolAndRelay(CWalletTx& wtx, std::string& err_string, bool relay) const
1963{
1965
1966 // Can't relay if wallet is not broadcasting
1967 if (!GetBroadcastTransactions()) return false;
1968 // Don't relay abandoned transactions
1969 if (wtx.isAbandoned()) return false;
1970 // Don't try to submit coinbase transactions. These would fail anyway but would
1971 // cause log spam.
1972 if (wtx.IsCoinBase()) return false;
1973 // Don't try to submit conflicted or confirmed transactions.
1974 if (GetTxDepthInMainChain(wtx) != 0) return false;
1975
1976 // Submit transaction to mempool for relay
1977 WalletLogPrintf("Submitting wtx %s to mempool for relay\n", wtx.GetHash().ToString());
1978 // We must set TxStateInMempool here. Even though it will also be set later by the
1979 // entered-mempool callback, if we did not there would be a race where a
1980 // user could call sendmoney in a loop and hit spurious out of funds errors
1981 // because we think that this newly generated transaction's change is
1982 // unavailable as we're not yet aware that it is in the mempool.
1983 //
1984 // If broadcast fails for any reason, trying to set wtx.m_state here would be incorrect.
1985 // If transaction was previously in the mempool, it should be updated when
1986 // TransactionRemovedFromMempool fires.
1987 bool ret = chain().broadcastTransaction(wtx.tx, m_default_max_tx_fee, relay, err_string);
1988 if (ret) wtx.m_state = TxStateInMempool{};
1989 return ret;
1990}
1991
1992std::set<Txid> CWallet::GetTxConflicts(const CWalletTx& wtx) const
1993{
1995
1996 const Txid myHash{wtx.GetHash()};
1997 std::set<Txid> result{GetConflicts(myHash)};
1998 result.erase(myHash);
1999 return result;
2000}
2001
2003{
2004 // Don't attempt to resubmit if the wallet is configured to not broadcast
2005 if (!fBroadcastTransactions) return false;
2006
2007 // During reindex, importing and IBD, old wallet transactions become
2008 // unconfirmed. Don't resend them as that would spam other nodes.
2009 // We only allow forcing mempool submission when not relaying to avoid this spam.
2010 if (!chain().isReadyToBroadcast()) return false;
2011
2012 // Do this infrequently and randomly to avoid giving away
2013 // that these are our transactions.
2014 if (NodeClock::now() < m_next_resend) return false;
2015
2016 return true;
2017}
2018
2020
2021// Resubmit transactions from the wallet to the mempool, optionally asking the
2022// mempool to relay them. On startup, we will do this for all unconfirmed
2023// transactions but will not ask the mempool to relay them. We do this on startup
2024// to ensure that our own mempool is aware of our transactions. There
2025// is a privacy side effect here as not broadcasting on startup also means that we won't
2026// inform the world of our wallet's state, particularly if the wallet (or node) is not
2027// yet synced.
2028//
2029// Otherwise this function is called periodically in order to relay our unconfirmed txs.
2030// We do this on a random timer to slightly obfuscate which transactions
2031// come from our wallet.
2032//
2033// TODO: Ideally, we'd only resend transactions that we think should have been
2034// mined in the most recent block. Any transaction that wasn't in the top
2035// blockweight of transactions in the mempool shouldn't have been mined,
2036// and so is probably just sitting in the mempool waiting to be confirmed.
2037// Rebroadcasting does nothing to speed up confirmation and only damages
2038// privacy.
2039//
2040// The `force` option results in all unconfirmed transactions being submitted to
2041// the mempool. This does not necessarily result in those transactions being relayed,
2042// that depends on the `relay` option. Periodic rebroadcast uses the pattern
2043// relay=true force=false, while loading into the mempool
2044// (on start, or after import) uses relay=false force=true.
2045void CWallet::ResubmitWalletTransactions(bool relay, bool force)
2046{
2047 // Don't attempt to resubmit if the wallet is configured to not broadcast,
2048 // even if forcing.
2049 if (!fBroadcastTransactions) return;
2050
2051 int submitted_tx_count = 0;
2052
2053 { // cs_wallet scope
2054 LOCK(cs_wallet);
2055
2056 // First filter for the transactions we want to rebroadcast.
2057 // We use a set with WalletTxOrderComparator so that rebroadcasting occurs in insertion order
2058 std::set<CWalletTx*, WalletTxOrderComparator> to_submit;
2059 for (auto& [txid, wtx] : mapWallet) {
2060 // Only rebroadcast unconfirmed txs
2061 if (!wtx.isUnconfirmed()) continue;
2062
2063 // Attempt to rebroadcast all txes more than 5 minutes older than
2064 // the last block, or all txs if forcing.
2065 if (!force && wtx.nTimeReceived > m_best_block_time - 5 * 60) continue;
2066 to_submit.insert(&wtx);
2067 }
2068 // Now try submitting the transactions to the memory pool and (optionally) relay them.
2069 for (auto wtx : to_submit) {
2070 std::string unused_err_string;
2071 if (SubmitTxMemoryPoolAndRelay(*wtx, unused_err_string, relay)) ++submitted_tx_count;
2072 }
2073 } // cs_wallet
2074
2075 if (submitted_tx_count > 0) {
2076 WalletLogPrintf("%s: resubmit %u unconfirmed transactions\n", __func__, submitted_tx_count);
2077 }
2078}
2079 // end of mapWallet
2081
2083{
2084 for (const std::shared_ptr<CWallet>& pwallet : GetWallets(context)) {
2085 if (!pwallet->ShouldResend()) continue;
2086 pwallet->ResubmitWalletTransactions(/*relay=*/true, /*force=*/false);
2087 pwallet->SetNextResend();
2088 }
2089}
2090
2091
2093{
2095
2096 // Build coins map
2097 std::map<COutPoint, Coin> coins;
2098 for (auto& input : tx.vin) {
2099 const auto mi = mapWallet.find(input.prevout.hash);
2100 if(mi == mapWallet.end() || input.prevout.n >= mi->second.tx->vout.size()) {
2101 return false;
2102 }
2103 const CWalletTx& wtx = mi->second;
2104 int prev_height = wtx.state<TxStateConfirmed>() ? wtx.state<TxStateConfirmed>()->confirmed_block_height : 0;
2105 coins[input.prevout] = Coin(wtx.tx->vout[input.prevout.n], prev_height, wtx.IsCoinBase());
2106 }
2107 std::map<int, bilingual_str> input_errors;
2108 return SignTransaction(tx, coins, SIGHASH_DEFAULT, input_errors);
2109}
2110
2111bool CWallet::SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, bilingual_str>& input_errors) const
2112{
2113 // Try to sign with all ScriptPubKeyMans
2114 for (ScriptPubKeyMan* spk_man : GetAllScriptPubKeyMans()) {
2115 // spk_man->SignTransaction will return true if the transaction is complete,
2116 // so we can exit early and return true if that happens
2117 if (spk_man->SignTransaction(tx, coins, sighash, input_errors)) {
2118 return true;
2119 }
2120 }
2121
2122 // At this point, one input was not fully signed otherwise we would have exited already
2123 return false;
2124}
2125
2126std::optional<PSBTError> CWallet::FillPSBT(PartiallySignedTransaction& psbtx, bool& complete, std::optional<int> sighash_type, bool sign, bool bip32derivs, size_t * n_signed, bool finalize) const
2127{
2128 if (n_signed) {
2129 *n_signed = 0;
2130 }
2131 LOCK(cs_wallet);
2132 // Get all of the previous transactions
2133 for (unsigned int i = 0; i < psbtx.tx->vin.size(); ++i) {
2134 const CTxIn& txin = psbtx.tx->vin[i];
2135 PSBTInput& input = psbtx.inputs.at(i);
2136
2137 if (PSBTInputSigned(input)) {
2138 continue;
2139 }
2140
2141 // If we have no utxo, grab it from the wallet.
2142 if (!input.non_witness_utxo) {
2143 const Txid& txhash = txin.prevout.hash;
2144 const auto it = mapWallet.find(txhash);
2145 if (it != mapWallet.end()) {
2146 const CWalletTx& wtx = it->second;
2147 // We only need the non_witness_utxo, which is a superset of the witness_utxo.
2148 // The signing code will switch to the smaller witness_utxo if this is ok.
2149 input.non_witness_utxo = wtx.tx;
2150 }
2151 }
2152 }
2153
2154 const PrecomputedTransactionData txdata = PrecomputePSBTData(psbtx);
2155
2156 // Fill in information from ScriptPubKeyMans
2157 for (ScriptPubKeyMan* spk_man : GetAllScriptPubKeyMans()) {
2158 int n_signed_this_spkm = 0;
2159 const auto error{spk_man->FillPSBT(psbtx, txdata, sighash_type, sign, bip32derivs, &n_signed_this_spkm, finalize)};
2160 if (error) {
2161 return error;
2162 }
2163
2164 if (n_signed) {
2165 (*n_signed) += n_signed_this_spkm;
2166 }
2167 }
2168
2170
2171 // Complete if every input is now signed
2172 complete = true;
2173 for (size_t i = 0; i < psbtx.inputs.size(); ++i) {
2174 complete &= PSBTInputSignedAndVerified(psbtx, i, &txdata);
2175 }
2176
2177 return {};
2178}
2179
2180SigningResult CWallet::SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const
2181{
2182 SignatureData sigdata;
2183 CScript script_pub_key = GetScriptForDestination(pkhash);
2184 for (const auto& spk_man_pair : m_spk_managers) {
2185 if (spk_man_pair.second->CanProvide(script_pub_key, sigdata)) {
2186 LOCK(cs_wallet); // DescriptorScriptPubKeyMan calls IsLocked which can lock cs_wallet in a deadlocking order
2187 return spk_man_pair.second->SignMessage(message, pkhash, str_sig);
2188 }
2189 }
2191}
2192
2193OutputType CWallet::TransactionChangeType(const std::optional<OutputType>& change_type, const std::vector<CRecipient>& vecSend) const
2194{
2195 // If -changetype is specified, always use that change type.
2196 if (change_type) {
2197 return *change_type;
2198 }
2199
2200 // if m_default_address_type is legacy, use legacy address as change.
2202 return OutputType::LEGACY;
2203 }
2204
2205 bool any_tr{false};
2206 bool any_wpkh{false};
2207 bool any_sh{false};
2208 bool any_pkh{false};
2209
2210 for (const auto& recipient : vecSend) {
2211 if (std::get_if<WitnessV1Taproot>(&recipient.dest)) {
2212 any_tr = true;
2213 } else if (std::get_if<WitnessV0KeyHash>(&recipient.dest)) {
2214 any_wpkh = true;
2215 } else if (std::get_if<ScriptHash>(&recipient.dest)) {
2216 any_sh = true;
2217 } else if (std::get_if<PKHash>(&recipient.dest)) {
2218 any_pkh = true;
2219 }
2220 }
2221
2222 const bool has_bech32m_spkman(GetScriptPubKeyMan(OutputType::BECH32M, /*internal=*/true));
2223 if (has_bech32m_spkman && any_tr) {
2224 // Currently tr is the only type supported by the BECH32M spkman
2225 return OutputType::BECH32M;
2226 }
2227 const bool has_bech32_spkman(GetScriptPubKeyMan(OutputType::BECH32, /*internal=*/true));
2228 if (has_bech32_spkman && any_wpkh) {
2229 // Currently wpkh is the only type supported by the BECH32 spkman
2230 return OutputType::BECH32;
2231 }
2232 const bool has_p2sh_segwit_spkman(GetScriptPubKeyMan(OutputType::P2SH_SEGWIT, /*internal=*/true));
2233 if (has_p2sh_segwit_spkman && any_sh) {
2234 // Currently sh_wpkh is the only type supported by the P2SH_SEGWIT spkman
2235 // As of 2021 about 80% of all SH are wrapping WPKH, so use that
2237 }
2238 const bool has_legacy_spkman(GetScriptPubKeyMan(OutputType::LEGACY, /*internal=*/true));
2239 if (has_legacy_spkman && any_pkh) {
2240 // Currently pkh is the only type supported by the LEGACY spkman
2241 return OutputType::LEGACY;
2242 }
2243
2244 if (has_bech32m_spkman) {
2245 return OutputType::BECH32M;
2246 }
2247 if (has_bech32_spkman) {
2248 return OutputType::BECH32;
2249 }
2250 // else use m_default_address_type for change
2252}
2253
2254void CWallet::CommitTransaction(CTransactionRef tx, mapValue_t mapValue, std::vector<std::pair<std::string, std::string>> orderForm)
2255{
2256 LOCK(cs_wallet);
2257 WalletLogPrintf("CommitTransaction:\n%s\n", util::RemoveSuffixView(tx->ToString(), "\n"));
2258
2259 // Add tx to wallet, because if it has change it's also ours,
2260 // otherwise just for transaction history.
2261 CWalletTx* wtx = AddToWallet(tx, TxStateInactive{}, [&](CWalletTx& wtx, bool new_tx) {
2262 CHECK_NONFATAL(wtx.mapValue.empty());
2263 CHECK_NONFATAL(wtx.vOrderForm.empty());
2264 wtx.mapValue = std::move(mapValue);
2265 wtx.vOrderForm = std::move(orderForm);
2266 return true;
2267 });
2268
2269 // wtx can only be null if the db write failed.
2270 if (!wtx) {
2271 throw std::runtime_error(std::string(__func__) + ": Wallet db error, transaction commit failed");
2272 }
2273
2274 // Notify that old coins are spent
2275 for (const CTxIn& txin : tx->vin) {
2276 CWalletTx &coin = mapWallet.at(txin.prevout.hash);
2277 coin.MarkDirty();
2279 }
2280
2282 // Don't submit tx to the mempool
2283 return;
2284 }
2285
2286 std::string err_string;
2287 if (!SubmitTxMemoryPoolAndRelay(*wtx, err_string, true)) {
2288 WalletLogPrintf("CommitTransaction(): Transaction cannot be broadcast immediately, %s\n", err_string);
2289 // TODO: if we expect the failure to be long term or permanent, instead delete wtx from the wallet and return failure.
2290 }
2291}
2292
2294{
2295 LOCK(cs_wallet);
2296
2297 Assert(m_spk_managers.empty());
2298 Assert(m_wallet_flags == 0);
2299 DBErrors nLoadWalletRet = WalletBatch(GetDatabase()).LoadWallet(this);
2300 if (nLoadWalletRet == DBErrors::NEED_REWRITE)
2301 {
2302 if (GetDatabase().Rewrite())
2303 {
2304 for (const auto& spk_man_pair : m_spk_managers) {
2305 spk_man_pair.second->RewriteDB();
2306 }
2307 }
2308 }
2309
2310 if (m_spk_managers.empty()) {
2313 }
2314
2315 return nLoadWalletRet;
2316}
2317
2318util::Result<void> CWallet::RemoveTxs(std::vector<Txid>& txs_to_remove)
2319{
2321 bilingual_str str_err; // future: make RunWithinTxn return a util::Result
2322 bool was_txn_committed = RunWithinTxn(GetDatabase(), /*process_desc=*/"remove transactions", [&](WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
2323 util::Result<void> result{RemoveTxs(batch, txs_to_remove)};
2324 if (!result) str_err = util::ErrorString(result);
2325 return result.has_value();
2326 });
2327 if (!str_err.empty()) return util::Error{str_err};
2328 if (!was_txn_committed) return util::Error{_("Error starting/committing db txn for wallet transactions removal process")};
2329 return {}; // all good
2330}
2331
2332util::Result<void> CWallet::RemoveTxs(WalletBatch& batch, std::vector<Txid>& txs_to_remove)
2333{
2335 if (!batch.HasActiveTxn()) return util::Error{strprintf(_("The transactions removal process can only be executed within a db txn"))};
2336
2337 // Check for transaction existence and remove entries from disk
2338 std::vector<decltype(mapWallet)::const_iterator> erased_txs;
2339 bilingual_str str_err;
2340 for (const Txid& hash : txs_to_remove) {
2341 auto it_wtx = mapWallet.find(hash);
2342 if (it_wtx == mapWallet.end()) {
2343 return util::Error{strprintf(_("Transaction %s does not belong to this wallet"), hash.GetHex())};
2344 }
2345 if (!batch.EraseTx(hash)) {
2346 return util::Error{strprintf(_("Failure removing transaction: %s"), hash.GetHex())};
2347 }
2348 erased_txs.emplace_back(it_wtx);
2349 }
2350
2351 // Register callback to update the memory state only when the db txn is actually dumped to disk
2352 batch.RegisterTxnListener({.on_commit=[&, erased_txs]() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
2353 // Update the in-memory state and notify upper layers about the removals
2354 for (const auto& it : erased_txs) {
2355 const Txid hash{it->first};
2356 wtxOrdered.erase(it->second.m_it_wtxOrdered);
2357 for (const auto& txin : it->second.tx->vin)
2358 mapTxSpends.erase(txin.prevout);
2359 for (unsigned int i = 0; i < it->second.tx->vout.size(); ++i) {
2360 m_txos.erase(COutPoint(hash, i));
2361 }
2362 mapWallet.erase(it);
2364 }
2365
2366 MarkDirty();
2367 }, .on_abort={}});
2368
2369 return {};
2370}
2371
2372bool CWallet::SetAddressBookWithDB(WalletBatch& batch, const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& new_purpose)
2373{
2374 bool fUpdated = false;
2375 bool is_mine;
2376 std::optional<AddressPurpose> purpose;
2377 {
2378 LOCK(cs_wallet);
2379 std::map<CTxDestination, CAddressBookData>::iterator mi = m_address_book.find(address);
2380 fUpdated = mi != m_address_book.end() && !mi->second.IsChange();
2381
2382 CAddressBookData& record = mi != m_address_book.end() ? mi->second : m_address_book[address];
2383 record.SetLabel(strName);
2384 is_mine = IsMine(address);
2385 if (new_purpose) { /* update purpose only if requested */
2386 record.purpose = new_purpose;
2387 }
2388 purpose = record.purpose;
2389 }
2390
2391 const std::string& encoded_dest = EncodeDestination(address);
2392 if (new_purpose && !batch.WritePurpose(encoded_dest, PurposeToString(*new_purpose))) {
2393 WalletLogPrintf("Error: fail to write address book 'purpose' entry\n");
2394 return false;
2395 }
2396 if (!batch.WriteName(encoded_dest, strName)) {
2397 WalletLogPrintf("Error: fail to write address book 'name' entry\n");
2398 return false;
2399 }
2400
2401 // In very old wallets, address purpose may not be recorded so we derive it from IsMine
2402 NotifyAddressBookChanged(address, strName, is_mine,
2403 purpose.value_or(is_mine ? AddressPurpose::RECEIVE : AddressPurpose::SEND),
2404 (fUpdated ? CT_UPDATED : CT_NEW));
2405 return true;
2406}
2407
2408bool CWallet::SetAddressBook(const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& purpose)
2409{
2410 WalletBatch batch(GetDatabase());
2411 return SetAddressBookWithDB(batch, address, strName, purpose);
2412}
2413
2415{
2416 return RunWithinTxn(GetDatabase(), /*process_desc=*/"address book entry removal", [&](WalletBatch& batch){
2417 return DelAddressBookWithDB(batch, address);
2418 });
2419}
2420
2422{
2423 const std::string& dest = EncodeDestination(address);
2424 {
2425 LOCK(cs_wallet);
2426 // If we want to delete receiving addresses, we should avoid calling EraseAddressData because it will delete the previously_spent value. Could instead just erase the label so it becomes a change address, and keep the data.
2427 // NOTE: This isn't a problem for sending addresses because they don't have any data that needs to be kept.
2428 // When adding new address data, it should be considered here whether to retain or delete it.
2429 if (IsMine(address)) {
2430 WalletLogPrintf("%s called with IsMine address, NOT SUPPORTED. Please report this bug! %s\n", __func__, CLIENT_BUGREPORT);
2431 return false;
2432 }
2433 // Delete data rows associated with this address
2434 if (!batch.EraseAddressData(address)) {
2435 WalletLogPrintf("Error: cannot erase address book entry data\n");
2436 return false;
2437 }
2438
2439 // Delete purpose entry
2440 if (!batch.ErasePurpose(dest)) {
2441 WalletLogPrintf("Error: cannot erase address book entry purpose\n");
2442 return false;
2443 }
2444
2445 // Delete name entry
2446 if (!batch.EraseName(dest)) {
2447 WalletLogPrintf("Error: cannot erase address book entry name\n");
2448 return false;
2449 }
2450
2451 // finally, remove it from the map
2452 m_address_book.erase(address);
2453 }
2454
2455 // All good, signal changes
2456 NotifyAddressBookChanged(address, "", /*is_mine=*/false, AddressPurpose::SEND, CT_DELETED);
2457 return true;
2458}
2459
2461{
2463
2464 unsigned int count = 0;
2465 for (auto spk_man : m_external_spk_managers) {
2466 count += spk_man.second->GetKeyPoolSize();
2467 }
2468
2469 return count;
2470}
2471
2472unsigned int CWallet::GetKeyPoolSize() const
2473{
2475
2476 unsigned int count = 0;
2477 for (auto spk_man : GetActiveScriptPubKeyMans()) {
2478 count += spk_man->GetKeyPoolSize();
2479 }
2480 return count;
2481}
2482
2483bool CWallet::TopUpKeyPool(unsigned int kpSize)
2484{
2485 LOCK(cs_wallet);
2486 bool res = true;
2487 for (auto spk_man : GetActiveScriptPubKeyMans()) {
2488 res &= spk_man->TopUp(kpSize);
2489 }
2490 return res;
2491}
2492
2494{
2495 LOCK(cs_wallet);
2496 auto spk_man = GetScriptPubKeyMan(type, /*internal=*/false);
2497 if (!spk_man) {
2498 return util::Error{strprintf(_("Error: No %s addresses available."), FormatOutputType(type))};
2499 }
2500
2501 auto op_dest = spk_man->GetNewDestination(type);
2502 if (op_dest) {
2503 SetAddressBook(*op_dest, label, AddressPurpose::RECEIVE);
2504 }
2505
2506 return op_dest;
2507}
2508
2510{
2511 LOCK(cs_wallet);
2512
2513 ReserveDestination reservedest(this, type);
2514 auto op_dest = reservedest.GetReservedDestination(true);
2515 if (op_dest) reservedest.KeepDestination();
2516
2517 return op_dest;
2518}
2519
2520void CWallet::MarkDestinationsDirty(const std::set<CTxDestination>& destinations) {
2521 for (auto& entry : mapWallet) {
2522 CWalletTx& wtx = entry.second;
2523 if (wtx.m_is_cache_empty) continue;
2524 for (unsigned int i = 0; i < wtx.tx->vout.size(); i++) {
2525 CTxDestination dst;
2526 if (ExtractDestination(wtx.tx->vout[i].scriptPubKey, dst) && destinations.count(dst)) {
2527 wtx.MarkDirty();
2528 break;
2529 }
2530 }
2531 }
2532}
2533
2535{
2537 for (const std::pair<const CTxDestination, CAddressBookData>& item : m_address_book) {
2538 const auto& entry = item.second;
2539 func(item.first, entry.GetLabel(), entry.IsChange(), entry.purpose);
2540 }
2541}
2542
2543std::vector<CTxDestination> CWallet::ListAddrBookAddresses(const std::optional<AddrBookFilter>& _filter) const
2544{
2546 std::vector<CTxDestination> result;
2547 AddrBookFilter filter = _filter ? *_filter : AddrBookFilter();
2548 ForEachAddrBookEntry([&result, &filter](const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose>& purpose) {
2549 // Filter by change
2550 if (filter.ignore_change && is_change) return;
2551 // Filter by label
2552 if (filter.m_op_label && *filter.m_op_label != label) return;
2553 // All good
2554 result.emplace_back(dest);
2555 });
2556 return result;
2557}
2558
2559std::set<std::string> CWallet::ListAddrBookLabels(const std::optional<AddressPurpose> purpose) const
2560{
2562 std::set<std::string> label_set;
2563 ForEachAddrBookEntry([&](const CTxDestination& _dest, const std::string& _label,
2564 bool _is_change, const std::optional<AddressPurpose>& _purpose) {
2565 if (_is_change) return;
2566 if (!purpose || purpose == _purpose) {
2567 label_set.insert(_label);
2568 }
2569 });
2570 return label_set;
2571}
2572
2574{
2576 if (!m_spk_man) {
2577 return util::Error{strprintf(_("Error: No %s addresses available."), FormatOutputType(type))};
2578 }
2579
2580 if (nIndex == -1) {
2581 int64_t index;
2582 auto op_address = m_spk_man->GetReservedDestination(type, internal, index);
2583 if (!op_address) return op_address;
2584 nIndex = index;
2585 address = *op_address;
2586 }
2587 return address;
2588}
2589
2591{
2592 if (nIndex != -1) {
2594 }
2595 nIndex = -1;
2597}
2598
2600{
2601 if (nIndex != -1) {
2603 }
2604 nIndex = -1;
2606}
2607
2609{
2610 CScript scriptPubKey = GetScriptForDestination(dest);
2611 for (const auto& spk_man : GetScriptPubKeyMans(scriptPubKey)) {
2612 auto signer_spk_man = dynamic_cast<ExternalSignerScriptPubKeyMan *>(spk_man);
2613 if (signer_spk_man == nullptr) {
2614 continue;
2615 }
2617 if (!signer) throw std::runtime_error(util::ErrorString(signer).original);
2618 return signer_spk_man->DisplayAddress(dest, *signer);
2619 }
2620 return util::Error{_("There is no ScriptPubKeyManager for this address")};
2621}
2622
2623void CWallet::LoadLockedCoin(const COutPoint& coin, bool persistent)
2624{
2626 m_locked_coins.emplace(coin, persistent);
2627}
2628
2629bool CWallet::LockCoin(const COutPoint& output, bool persist)
2630{
2632 LoadLockedCoin(output, persist);
2633 if (persist) {
2634 WalletBatch batch(GetDatabase());
2635 return batch.WriteLockedUTXO(output);
2636 }
2637 return true;
2638}
2639
2641{
2643 auto locked_coin_it = m_locked_coins.find(output);
2644 if (locked_coin_it != m_locked_coins.end()) {
2645 bool persisted = locked_coin_it->second;
2646 m_locked_coins.erase(locked_coin_it);
2647 if (persisted) {
2648 WalletBatch batch(GetDatabase());
2649 return batch.EraseLockedUTXO(output);
2650 }
2651 }
2652 return true;
2653}
2654
2656{
2658 bool success = true;
2659 WalletBatch batch(GetDatabase());
2660 for (const auto& [coin, persistent] : m_locked_coins) {
2661 if (persistent) success = success && batch.EraseLockedUTXO(coin);
2662 }
2663 m_locked_coins.clear();
2664 return success;
2665}
2666
2667bool CWallet::IsLockedCoin(const COutPoint& output) const
2668{
2670 return m_locked_coins.count(output) > 0;
2671}
2672
2673void CWallet::ListLockedCoins(std::vector<COutPoint>& vOutpts) const
2674{
2676 for (const auto& [coin, _] : m_locked_coins) {
2677 vOutpts.push_back(coin);
2678 }
2679}
2680
2704unsigned int CWallet::ComputeTimeSmart(const CWalletTx& wtx, bool rescanning_old_block) const
2705{
2706 std::optional<uint256> block_hash;
2707 if (auto* conf = wtx.state<TxStateConfirmed>()) {
2708 block_hash = conf->confirmed_block_hash;
2709 } else if (auto* conf = wtx.state<TxStateBlockConflicted>()) {
2710 block_hash = conf->conflicting_block_hash;
2711 }
2712
2713 unsigned int nTimeSmart = wtx.nTimeReceived;
2714 if (block_hash) {
2715 int64_t blocktime;
2716 int64_t block_max_time;
2717 if (chain().findBlock(*block_hash, FoundBlock().time(blocktime).maxTime(block_max_time))) {
2718 if (rescanning_old_block) {
2719 nTimeSmart = block_max_time;
2720 } else {
2721 int64_t latestNow = wtx.nTimeReceived;
2722 int64_t latestEntry = 0;
2723
2724 // Tolerate times up to the last timestamp in the wallet not more than 5 minutes into the future
2725 int64_t latestTolerated = latestNow + 300;
2726 const TxItems& txOrdered = wtxOrdered;
2727 for (auto it = txOrdered.rbegin(); it != txOrdered.rend(); ++it) {
2728 CWalletTx* const pwtx = it->second;
2729 if (pwtx == &wtx) {
2730 continue;
2731 }
2732 int64_t nSmartTime;
2733 nSmartTime = pwtx->nTimeSmart;
2734 if (!nSmartTime) {
2735 nSmartTime = pwtx->nTimeReceived;
2736 }
2737 if (nSmartTime <= latestTolerated) {
2738 latestEntry = nSmartTime;
2739 if (nSmartTime > latestNow) {
2740 latestNow = nSmartTime;
2741 }
2742 break;
2743 }
2744 }
2745
2746 nTimeSmart = std::max(latestEntry, std::min(blocktime, latestNow));
2747 }
2748 } else {
2749 WalletLogPrintf("%s: found %s in block %s not in index\n", __func__, wtx.GetHash().ToString(), block_hash->ToString());
2750 }
2751 }
2752 return nTimeSmart;
2753}
2754
2756{
2757 if (std::get_if<CNoDestination>(&dest))
2758 return false;
2759
2760 if (!used) {
2761 if (auto* data{common::FindKey(m_address_book, dest)}) data->previously_spent = false;
2762 return batch.WriteAddressPreviouslySpent(dest, false);
2763 }
2764
2766 return batch.WriteAddressPreviouslySpent(dest, true);
2767}
2768
2770{
2771 m_address_book[dest].previously_spent = true;
2772}
2773
2774void CWallet::LoadAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& request)
2775{
2776 m_address_book[dest].receive_requests[id] = request;
2777}
2778
2780{
2781 if (auto* data{common::FindKey(m_address_book, dest)}) return data->previously_spent;
2782 return false;
2783}
2784
2785std::vector<std::string> CWallet::GetAddressReceiveRequests() const
2786{
2787 std::vector<std::string> values;
2788 for (const auto& [dest, entry] : m_address_book) {
2789 for (const auto& [id, request] : entry.receive_requests) {
2790 values.emplace_back(request);
2791 }
2792 }
2793 return values;
2794}
2795
2796bool CWallet::SetAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id, const std::string& value)
2797{
2798 if (!batch.WriteAddressReceiveRequest(dest, id, value)) return false;
2799 m_address_book[dest].receive_requests[id] = value;
2800 return true;
2801}
2802
2803bool CWallet::EraseAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id)
2804{
2805 if (!batch.EraseAddressReceiveRequest(dest, id)) return false;
2806 m_address_book[dest].receive_requests.erase(id);
2807 return true;
2808}
2809
2811{
2812 // Do some checking on wallet path. It should be either a:
2813 //
2814 // 1. Path where a directory can be created.
2815 // 2. Path to an existing directory.
2816 // 3. Path to a symlink to a directory.
2817 // 4. For backwards compatibility, the name of a data file in -walletdir.
2818 const fs::path wallet_path = fsbridge::AbsPathJoin(GetWalletDir(), fs::PathFromString(name));
2819 fs::file_type path_type = fs::symlink_status(wallet_path).type();
2820 if (!(path_type == fs::file_type::not_found || path_type == fs::file_type::directory ||
2821 (path_type == fs::file_type::symlink && fs::is_directory(wallet_path)) ||
2822 (path_type == fs::file_type::regular && fs::PathFromString(name).filename() == fs::PathFromString(name)))) {
2824 "Invalid -wallet path '%s'. -wallet path should point to a directory where wallet.dat and "
2825 "database/log.?????????? files can be stored, a location where such a directory could be created, "
2826 "or (for backwards compatibility) the name of an existing data file in -walletdir (%s)",
2828 }
2829 return wallet_path;
2830}
2831
2832std::unique_ptr<WalletDatabase> MakeWalletDatabase(const std::string& name, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error_string)
2833{
2834 const auto& wallet_path = GetWalletPath(name);
2835 if (!wallet_path) {
2836 error_string = util::ErrorString(wallet_path);
2838 return nullptr;
2839 }
2840 return MakeDatabase(*wallet_path, options, status, error_string);
2841}
2842
2843std::shared_ptr<CWallet> CWallet::Create(WalletContext& context, const std::string& name, std::unique_ptr<WalletDatabase> database, uint64_t wallet_creation_flags, bilingual_str& error, std::vector<bilingual_str>& warnings)
2844{
2845 interfaces::Chain* chain = context.chain;
2846 ArgsManager& args = *Assert(context.args);
2847 const std::string& walletFile = database->Filename();
2848
2849 const auto start{SteadyClock::now()};
2850 // TODO: Can't use std::make_shared because we need a custom deleter but
2851 // should be possible to use std::allocate_shared.
2852 std::shared_ptr<CWallet> walletInstance(new CWallet(chain, name, std::move(database)), FlushAndDeleteWallet);
2853 walletInstance->m_keypool_size = std::max(args.GetIntArg("-keypool", DEFAULT_KEYPOOL_SIZE), int64_t{1});
2854 walletInstance->m_notify_tx_changed_script = args.GetArg("-walletnotify", "");
2855
2856 // Load wallet
2857 bool rescan_required = false;
2858 DBErrors nLoadWalletRet = walletInstance->LoadWallet();
2859 if (nLoadWalletRet != DBErrors::LOAD_OK) {
2860 if (nLoadWalletRet == DBErrors::CORRUPT) {
2861 error = strprintf(_("Error loading %s: Wallet corrupted"), walletFile);
2862 return nullptr;
2863 }
2864 else if (nLoadWalletRet == DBErrors::NONCRITICAL_ERROR)
2865 {
2866 warnings.push_back(strprintf(_("Error reading %s! All keys read correctly, but transaction data"
2867 " or address metadata may be missing or incorrect."),
2868 walletFile));
2869 }
2870 else if (nLoadWalletRet == DBErrors::TOO_NEW) {
2871 error = strprintf(_("Error loading %s: Wallet requires newer version of %s"), walletFile, CLIENT_NAME);
2872 return nullptr;
2873 }
2874 else if (nLoadWalletRet == DBErrors::EXTERNAL_SIGNER_SUPPORT_REQUIRED) {
2875 error = strprintf(_("Error loading %s: External signer wallet being loaded without external signer support compiled"), walletFile);
2876 return nullptr;
2877 }
2878 else if (nLoadWalletRet == DBErrors::NEED_REWRITE)
2879 {
2880 error = strprintf(_("Wallet needed to be rewritten: restart %s to complete"), CLIENT_NAME);
2881 return nullptr;
2882 } else if (nLoadWalletRet == DBErrors::NEED_RESCAN) {
2883 warnings.push_back(strprintf(_("Error reading %s! Transaction data may be missing or incorrect."
2884 " Rescanning wallet."), walletFile));
2885 rescan_required = true;
2886 } else if (nLoadWalletRet == DBErrors::UNKNOWN_DESCRIPTOR) {
2887 error = strprintf(_("Unrecognized descriptor found. Loading wallet %s\n\n"
2888 "The wallet might have been created on a newer version.\n"
2889 "Please try running the latest software version.\n"), walletFile);
2890 return nullptr;
2891 } else if (nLoadWalletRet == DBErrors::UNEXPECTED_LEGACY_ENTRY) {
2892 error = strprintf(_("Unexpected legacy entry in descriptor wallet found. Loading wallet %s\n\n"
2893 "The wallet might have been tampered with or created with malicious intent.\n"), walletFile);
2894 return nullptr;
2895 } else if (nLoadWalletRet == DBErrors::LEGACY_WALLET) {
2896 error = strprintf(_("Error loading %s: Wallet is a legacy wallet. Please migrate to a descriptor wallet using the migration tool (migratewallet RPC)."), walletFile);
2897 return nullptr;
2898 } else {
2899 error = strprintf(_("Error loading %s"), walletFile);
2900 return nullptr;
2901 }
2902 }
2903
2904 // This wallet is in its first run if there are no ScriptPubKeyMans and it isn't blank or no privkeys
2905 const bool fFirstRun = walletInstance->m_spk_managers.empty() &&
2906 !walletInstance->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) &&
2907 !walletInstance->IsWalletFlagSet(WALLET_FLAG_BLANK_WALLET);
2908 if (fFirstRun)
2909 {
2910 LOCK(walletInstance->cs_wallet);
2911
2912 // Init with passed flags.
2913 // Always set the cache upgrade flag as this feature is supported from the beginning.
2914 walletInstance->InitWalletFlags(wallet_creation_flags | WALLET_FLAG_LAST_HARDENED_XPUB_CACHED);
2915
2916 // Only descriptor wallets can be created
2917 assert(walletInstance->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
2918
2919 if ((wallet_creation_flags & WALLET_FLAG_EXTERNAL_SIGNER) || !(wallet_creation_flags & (WALLET_FLAG_DISABLE_PRIVATE_KEYS | WALLET_FLAG_BLANK_WALLET))) {
2920 walletInstance->SetupDescriptorScriptPubKeyMans();
2921 }
2922
2923 if (chain) {
2924 std::optional<int> tip_height = chain->getHeight();
2925 if (tip_height) {
2926 walletInstance->SetLastBlockProcessed(*tip_height, chain->getBlockHash(*tip_height));
2927 }
2928 }
2929 } else if (wallet_creation_flags & WALLET_FLAG_DISABLE_PRIVATE_KEYS) {
2930 // Make it impossible to disable private keys after creation
2931 error = strprintf(_("Error loading %s: Private keys can only be disabled during creation"), walletFile);
2932 return nullptr;
2933 } else if (walletInstance->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
2934 for (auto spk_man : walletInstance->GetActiveScriptPubKeyMans()) {
2935 if (spk_man->HavePrivateKeys()) {
2936 warnings.push_back(strprintf(_("Warning: Private keys detected in wallet {%s} with disabled private keys"), walletFile));
2937 break;
2938 }
2939 }
2940 }
2941
2942 if (!args.GetArg("-addresstype", "").empty()) {
2943 std::optional<OutputType> parsed = ParseOutputType(args.GetArg("-addresstype", ""));
2944 if (!parsed) {
2945 error = strprintf(_("Unknown address type '%s'"), args.GetArg("-addresstype", ""));
2946 return nullptr;
2947 }
2948 walletInstance->m_default_address_type = parsed.value();
2949 }
2950
2951 if (!args.GetArg("-changetype", "").empty()) {
2952 std::optional<OutputType> parsed = ParseOutputType(args.GetArg("-changetype", ""));
2953 if (!parsed) {
2954 error = strprintf(_("Unknown change type '%s'"), args.GetArg("-changetype", ""));
2955 return nullptr;
2956 }
2957 walletInstance->m_default_change_type = parsed.value();
2958 }
2959
2960 if (const auto arg{args.GetArg("-mintxfee")}) {
2961 std::optional<CAmount> min_tx_fee = ParseMoney(*arg);
2962 if (!min_tx_fee) {
2963 error = AmountErrMsg("mintxfee", *arg);
2964 return nullptr;
2965 } else if (min_tx_fee.value() > HIGH_TX_FEE_PER_KB) {
2966 warnings.push_back(AmountHighWarn("-mintxfee") + Untranslated(" ") +
2967 _("This is the minimum transaction fee you pay on every transaction."));
2968 }
2969
2970 walletInstance->m_min_fee = CFeeRate{min_tx_fee.value()};
2971 }
2972
2973 if (const auto arg{args.GetArg("-maxapsfee")}) {
2974 const std::string& max_aps_fee{*arg};
2975 if (max_aps_fee == "-1") {
2976 walletInstance->m_max_aps_fee = -1;
2977 } else if (std::optional<CAmount> max_fee = ParseMoney(max_aps_fee)) {
2978 if (max_fee.value() > HIGH_APS_FEE) {
2979 warnings.push_back(AmountHighWarn("-maxapsfee") + Untranslated(" ") +
2980 _("This is the maximum transaction fee you pay (in addition to the normal fee) to prioritize partial spend avoidance over regular coin selection."));
2981 }
2982 walletInstance->m_max_aps_fee = max_fee.value();
2983 } else {
2984 error = AmountErrMsg("maxapsfee", max_aps_fee);
2985 return nullptr;
2986 }
2987 }
2988
2989 if (const auto arg{args.GetArg("-fallbackfee")}) {
2990 std::optional<CAmount> fallback_fee = ParseMoney(*arg);
2991 if (!fallback_fee) {
2992 error = strprintf(_("Invalid amount for %s=<amount>: '%s'"), "-fallbackfee", *arg);
2993 return nullptr;
2994 } else if (fallback_fee.value() > HIGH_TX_FEE_PER_KB) {
2995 warnings.push_back(AmountHighWarn("-fallbackfee") + Untranslated(" ") +
2996 _("This is the transaction fee you may pay when fee estimates are not available."));
2997 }
2998 walletInstance->m_fallback_fee = CFeeRate{fallback_fee.value()};
2999 }
3000
3001 // Disable fallback fee in case value was set to 0, enable if non-null value
3002 walletInstance->m_allow_fallback_fee = walletInstance->m_fallback_fee.GetFeePerK() != 0;
3003
3004 if (const auto arg{args.GetArg("-discardfee")}) {
3005 std::optional<CAmount> discard_fee = ParseMoney(*arg);
3006 if (!discard_fee) {
3007 error = strprintf(_("Invalid amount for %s=<amount>: '%s'"), "-discardfee", *arg);
3008 return nullptr;
3009 } else if (discard_fee.value() > HIGH_TX_FEE_PER_KB) {
3010 warnings.push_back(AmountHighWarn("-discardfee") + Untranslated(" ") +
3011 _("This is the transaction fee you may discard if change is smaller than dust at this level"));
3012 }
3013 walletInstance->m_discard_rate = CFeeRate{discard_fee.value()};
3014 }
3015
3016 if (const auto arg{args.GetArg("-paytxfee")}) {
3017 warnings.push_back(_("-paytxfee is deprecated and will be fully removed in v31.0."));
3018
3019 std::optional<CAmount> pay_tx_fee = ParseMoney(*arg);
3020 if (!pay_tx_fee) {
3021 error = AmountErrMsg("paytxfee", *arg);
3022 return nullptr;
3023 } else if (pay_tx_fee.value() > HIGH_TX_FEE_PER_KB) {
3024 warnings.push_back(AmountHighWarn("-paytxfee") + Untranslated(" ") +
3025 _("This is the transaction fee you will pay if you send a transaction."));
3026 }
3027
3028 walletInstance->m_pay_tx_fee = CFeeRate{pay_tx_fee.value(), 1000};
3029
3030 if (chain && walletInstance->m_pay_tx_fee < chain->relayMinFee()) {
3031 error = strprintf(_("Invalid amount for %s=<amount>: '%s' (must be at least %s)"),
3032 "-paytxfee", *arg, chain->relayMinFee().ToString());
3033 return nullptr;
3034 }
3035 }
3036
3037 if (const auto arg{args.GetArg("-maxtxfee")}) {
3038 std::optional<CAmount> max_fee = ParseMoney(*arg);
3039 if (!max_fee) {
3040 error = AmountErrMsg("maxtxfee", *arg);
3041 return nullptr;
3042 } else if (max_fee.value() > HIGH_MAX_TX_FEE) {
3043 warnings.push_back(strprintf(_("%s is set very high! Fees this large could be paid on a single transaction."), "-maxtxfee"));
3044 }
3045
3046 if (chain && CFeeRate{max_fee.value(), 1000} < chain->relayMinFee()) {
3047 error = strprintf(_("Invalid amount for %s=<amount>: '%s' (must be at least the minrelay fee of %s to prevent stuck transactions)"),
3048 "-maxtxfee", *arg, chain->relayMinFee().ToString());
3049 return nullptr;
3050 }
3051
3052 walletInstance->m_default_max_tx_fee = max_fee.value();
3053 }
3054
3055 if (const auto arg{args.GetArg("-consolidatefeerate")}) {
3056 if (std::optional<CAmount> consolidate_feerate = ParseMoney(*arg)) {
3057 walletInstance->m_consolidate_feerate = CFeeRate(*consolidate_feerate);
3058 } else {
3059 error = AmountErrMsg("consolidatefeerate", *arg);
3060 return nullptr;
3061 }
3062 }
3063
3065 warnings.push_back(AmountHighWarn("-minrelaytxfee") + Untranslated(" ") +
3066 _("The wallet will avoid paying less than the minimum relay fee."));
3067 }
3068
3069 walletInstance->m_confirm_target = args.GetIntArg("-txconfirmtarget", DEFAULT_TX_CONFIRM_TARGET);
3070 walletInstance->m_spend_zero_conf_change = args.GetBoolArg("-spendzeroconfchange", DEFAULT_SPEND_ZEROCONF_CHANGE);
3071 walletInstance->m_signal_rbf = args.GetBoolArg("-walletrbf", DEFAULT_WALLET_RBF);
3072
3073 walletInstance->WalletLogPrintf("Wallet completed loading in %15dms\n", Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
3074
3075 // Try to top up keypool. No-op if the wallet is locked.
3076 walletInstance->TopUpKeyPool();
3077
3078 // Cache the first key time
3079 std::optional<int64_t> time_first_key;
3080 for (auto spk_man : walletInstance->GetAllScriptPubKeyMans()) {
3081 int64_t time = spk_man->GetTimeFirstKey();
3082 if (!time_first_key || time < *time_first_key) time_first_key = time;
3083 }
3084 if (time_first_key) walletInstance->MaybeUpdateBirthTime(*time_first_key);
3085
3086 if (chain && !AttachChain(walletInstance, *chain, rescan_required, error, warnings)) {
3087 walletInstance->m_chain_notifications_handler.reset(); // Reset this pointer so that the wallet will actually be unloaded
3088 return nullptr;
3089 }
3090
3091 {
3092 LOCK(walletInstance->cs_wallet);
3093 walletInstance->SetBroadcastTransactions(args.GetBoolArg("-walletbroadcast", DEFAULT_WALLETBROADCAST));
3094 walletInstance->WalletLogPrintf("setKeyPool.size() = %u\n", walletInstance->GetKeyPoolSize());
3095 walletInstance->WalletLogPrintf("mapWallet.size() = %u\n", walletInstance->mapWallet.size());
3096 walletInstance->WalletLogPrintf("m_address_book.size() = %u\n", walletInstance->m_address_book.size());
3097 }
3098
3099 return walletInstance;
3100}
3101
3102bool CWallet::AttachChain(const std::shared_ptr<CWallet>& walletInstance, interfaces::Chain& chain, const bool rescan_required, bilingual_str& error, std::vector<bilingual_str>& warnings)
3103{
3104 LOCK(walletInstance->cs_wallet);
3105 // allow setting the chain if it hasn't been set already but prevent changing it
3106 assert(!walletInstance->m_chain || walletInstance->m_chain == &chain);
3107 walletInstance->m_chain = &chain;
3108
3109 // Unless allowed, ensure wallet files are not reused across chains:
3110 if (!gArgs.GetBoolArg("-walletcrosschain", DEFAULT_WALLETCROSSCHAIN)) {
3111 WalletBatch batch(walletInstance->GetDatabase());
3112 CBlockLocator locator;
3113 if (batch.ReadBestBlock(locator) && locator.vHave.size() > 0 && chain.getHeight()) {
3114 // Wallet is assumed to be from another chain, if genesis block in the active
3115 // chain differs from the genesis block known to the wallet.
3116 if (chain.getBlockHash(0) != locator.vHave.back()) {
3117 error = Untranslated("Wallet files should not be reused across chains. Restart bitcoind with -walletcrosschain to override.");
3118 return false;
3119 }
3120 }
3121 }
3122
3123 // Register wallet with validationinterface. It's done before rescan to avoid
3124 // missing block connections during the rescan.
3125 // Because of the wallet lock being held, block connection notifications are going to
3126 // be pending on the validation-side until lock release. Blocks that are connected while the
3127 // rescan is ongoing will not be processed in the rescan but with the block connected notifications,
3128 // so the wallet will only be completeley synced after the notifications delivery.
3129 walletInstance->m_chain_notifications_handler = walletInstance->chain().handleNotifications(walletInstance);
3130
3131 // If rescan_required = true, rescan_height remains equal to 0
3132 int rescan_height = 0;
3133 if (!rescan_required)
3134 {
3135 WalletBatch batch(walletInstance->GetDatabase());
3136 CBlockLocator locator;
3137 if (batch.ReadBestBlock(locator)) {
3138 if (const std::optional<int> fork_height = chain.findLocatorFork(locator)) {
3139 rescan_height = *fork_height;
3140 }
3141 }
3142 }
3143
3144 const std::optional<int> tip_height = chain.getHeight();
3145 if (tip_height) {
3146 walletInstance->SetLastBlockProcessedInMem(*tip_height, chain.getBlockHash(*tip_height));
3147 } else {
3148 walletInstance->SetLastBlockProcessedInMem(-1, uint256());
3149 }
3150
3151 if (tip_height && *tip_height != rescan_height)
3152 {
3153 // No need to read and scan block if block was created before
3154 // our wallet birthday (as adjusted for block time variability)
3155 std::optional<int64_t> time_first_key = walletInstance->m_birth_time.load();
3156 if (time_first_key) {
3157 FoundBlock found = FoundBlock().height(rescan_height);
3158 chain.findFirstBlockWithTimeAndHeight(*time_first_key - TIMESTAMP_WINDOW, rescan_height, found);
3159 if (!found.found) {
3160 // We were unable to find a block that had a time more recent than our earliest timestamp
3161 // or a height higher than the wallet was synced to, indicating that the wallet is newer than the
3162 // current chain tip. Skip rescanning in this case.
3163 rescan_height = *tip_height;
3164 }
3165 }
3166
3167 // Technically we could execute the code below in any case, but performing the
3168 // `while` loop below can make startup very slow, so only check blocks on disk
3169 // if necessary.
3171 int block_height = *tip_height;
3172 while (block_height > 0 && chain.haveBlockOnDisk(block_height - 1) && rescan_height != block_height) {
3173 --block_height;
3174 }
3175
3176 if (rescan_height != block_height) {
3177 // We can't rescan beyond blocks we don't have data for, stop and throw an error.
3178 // This might happen if a user uses an old wallet within a pruned node
3179 // or if they ran -disablewallet for a longer time, then decided to re-enable
3180 // Exit early and print an error.
3181 // It also may happen if an assumed-valid chain is in use and therefore not
3182 // all block data is available.
3183 // If a block is pruned after this check, we will load the wallet,
3184 // but fail the rescan with a generic error.
3185
3186 error = chain.havePruned() ?
3187 _("Prune: last wallet synchronisation goes beyond pruned data. You need to -reindex (download the whole blockchain again in case of a pruned node)") :
3188 strprintf(_(
3189 "Error loading wallet. Wallet requires blocks to be downloaded, "
3190 "and software does not currently support loading wallets while "
3191 "blocks are being downloaded out of order when using assumeutxo "
3192 "snapshots. Wallet should be able to load successfully after "
3193 "node sync reaches height %s"), block_height);
3194 return false;
3195 }
3196 }
3197
3198 chain.initMessage(_("Rescanning…"));
3199 walletInstance->WalletLogPrintf("Rescanning last %i blocks (from block %i)...\n", *tip_height - rescan_height, rescan_height);
3200
3201 {
3202 WalletRescanReserver reserver(*walletInstance);
3203 if (!reserver.reserve()) {
3204 error = _("Failed to acquire rescan reserver during wallet initialization");
3205 return false;
3206 }
3207 ScanResult scan_res = walletInstance->ScanForWalletTransactions(chain.getBlockHash(rescan_height), rescan_height, /*max_height=*/{}, reserver, /*fUpdate=*/true, /*save_progress=*/true);
3208 if (ScanResult::SUCCESS != scan_res.status) {
3209 error = _("Failed to rescan the wallet during initialization");
3210 return false;
3211 }
3212 // Set and update the best block record
3213 // Set last block scanned as the last block processed as it may be different in case of a reorg.
3214 // Also save the best block locator because rescanning only updates it intermittently.
3215 walletInstance->SetLastBlockProcessed(*scan_res.last_scanned_height, scan_res.last_scanned_block);
3216 }
3217 }
3218
3219 return true;
3220}
3221
3222const CAddressBookData* CWallet::FindAddressBookEntry(const CTxDestination& dest, bool allow_change) const
3223{
3224 const auto& address_book_it = m_address_book.find(dest);
3225 if (address_book_it == m_address_book.end()) return nullptr;
3226 if ((!allow_change) && address_book_it->second.IsChange()) {
3227 return nullptr;
3228 }
3229 return &address_book_it->second;
3230}
3231
3233{
3234 // Add wallet transactions that aren't already in a block to mempool
3235 // Do this here as mempool requires genesis block to be loaded
3236 ResubmitWalletTransactions(/*relay=*/false, /*force=*/true);
3237
3238 // Update wallet transactions with current mempool transactions.
3239 WITH_LOCK(cs_wallet, chain().requestMempoolTransactions(*this));
3240}
3241
3242bool CWallet::BackupWallet(const std::string& strDest) const
3243{
3245 return GetDatabase().Backup(strDest);
3246}
3247
3249{
3251 if (auto* conf = wtx.state<TxStateConfirmed>()) {
3252 assert(conf->confirmed_block_height >= 0);
3253 return GetLastBlockHeight() - conf->confirmed_block_height + 1;
3254 } else if (auto* conf = wtx.state<TxStateBlockConflicted>()) {
3255 assert(conf->conflicting_block_height >= 0);
3256 return -1 * (GetLastBlockHeight() - conf->conflicting_block_height + 1);
3257 } else {
3258 return 0;
3259 }
3260}
3261
3263{
3265
3266 if (!wtx.IsCoinBase()) {
3267 return 0;
3268 }
3269 int chain_depth = GetTxDepthInMainChain(wtx);
3270 assert(chain_depth >= 0); // coinbase tx should not be conflicted
3271 return std::max(0, (COINBASE_MATURITY+1) - chain_depth);
3272}
3273
3275{
3277
3278 // note GetBlocksToMaturity is 0 for non-coinbase tx
3279 return GetTxBlocksToMaturity(wtx) > 0;
3280}
3281
3283{
3284 return HasEncryptionKeys();
3285}
3286
3288{
3289 if (!IsCrypted()) {
3290 return false;
3291 }
3292 LOCK(cs_wallet);
3293 return vMasterKey.empty();
3294}
3295
3297{
3298 if (!IsCrypted())
3299 return false;
3300
3301 {
3303 if (!vMasterKey.empty()) {
3304 memory_cleanse(vMasterKey.data(), vMasterKey.size() * sizeof(decltype(vMasterKey)::value_type));
3305 vMasterKey.clear();
3306 }
3307 }
3308
3309 NotifyStatusChanged(this);
3310 return true;
3311}
3312
3313bool CWallet::Unlock(const CKeyingMaterial& vMasterKeyIn)
3314{
3315 {
3316 LOCK(cs_wallet);
3317 for (const auto& spk_man_pair : m_spk_managers) {
3318 if (!spk_man_pair.second->CheckDecryptionKey(vMasterKeyIn)) {
3319 return false;
3320 }
3321 }
3322 vMasterKey = vMasterKeyIn;
3323 }
3324 NotifyStatusChanged(this);
3325 return true;
3326}
3327
3328std::set<ScriptPubKeyMan*> CWallet::GetActiveScriptPubKeyMans() const
3329{
3330 std::set<ScriptPubKeyMan*> spk_mans;
3331 for (bool internal : {false, true}) {
3332 for (OutputType t : OUTPUT_TYPES) {
3333 auto spk_man = GetScriptPubKeyMan(t, internal);
3334 if (spk_man) {
3335 spk_mans.insert(spk_man);
3336 }
3337 }
3338 }
3339 return spk_mans;
3340}
3341
3343{
3344 for (const auto& [_, ext_spkm] : m_external_spk_managers) {
3345 if (ext_spkm == &spkm) return true;
3346 }
3347 for (const auto& [_, int_spkm] : m_internal_spk_managers) {
3348 if (int_spkm == &spkm) return true;
3349 }
3350 return false;
3351}
3352
3353std::set<ScriptPubKeyMan*> CWallet::GetAllScriptPubKeyMans() const
3354{
3355 std::set<ScriptPubKeyMan*> spk_mans;
3356 for (const auto& spk_man_pair : m_spk_managers) {
3357 spk_mans.insert(spk_man_pair.second.get());
3358 }
3359 return spk_mans;
3360}
3361
3363{
3364 const std::map<OutputType, ScriptPubKeyMan*>& spk_managers = internal ? m_internal_spk_managers : m_external_spk_managers;
3365 std::map<OutputType, ScriptPubKeyMan*>::const_iterator it = spk_managers.find(type);
3366 if (it == spk_managers.end()) {
3367 return nullptr;
3368 }
3369 return it->second;
3370}
3371
3372std::set<ScriptPubKeyMan*> CWallet::GetScriptPubKeyMans(const CScript& script) const
3373{
3374 std::set<ScriptPubKeyMan*> spk_mans;
3375
3376 // Search the cache for relevant SPKMs instead of iterating m_spk_managers
3377 const auto& it = m_cached_spks.find(script);
3378 if (it != m_cached_spks.end()) {
3379 spk_mans.insert(it->second.begin(), it->second.end());
3380 }
3381 SignatureData sigdata;
3382 Assume(std::all_of(spk_mans.begin(), spk_mans.end(), [&script, &sigdata](ScriptPubKeyMan* spkm) { return spkm->CanProvide(script, sigdata); }));
3383
3384 return spk_mans;
3385}
3386
3388{
3389 if (m_spk_managers.count(id) > 0) {
3390 return m_spk_managers.at(id).get();
3391 }
3392 return nullptr;
3393}
3394
3395std::unique_ptr<SigningProvider> CWallet::GetSolvingProvider(const CScript& script) const
3396{
3397 SignatureData sigdata;
3398 return GetSolvingProvider(script, sigdata);
3399}
3400
3401std::unique_ptr<SigningProvider> CWallet::GetSolvingProvider(const CScript& script, SignatureData& sigdata) const
3402{
3403 // Search the cache for relevant SPKMs instead of iterating m_spk_managers
3404 const auto& it = m_cached_spks.find(script);
3405 if (it != m_cached_spks.end()) {
3406 // All spkms for a given script must already be able to make a SigningProvider for the script, so just return the first one.
3407 Assume(it->second.at(0)->CanProvide(script, sigdata));
3408 return it->second.at(0)->GetSolvingProvider(script);
3409 }
3410
3411 return nullptr;
3412}
3413
3414std::vector<WalletDescriptor> CWallet::GetWalletDescriptors(const CScript& script) const
3415{
3416 std::vector<WalletDescriptor> descs;
3417 for (const auto spk_man: GetScriptPubKeyMans(script)) {
3418 if (const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man)) {
3419 LOCK(desc_spk_man->cs_desc_man);
3420 descs.push_back(desc_spk_man->GetWalletDescriptor());
3421 }
3422 }
3423 return descs;
3424}
3425
3427{
3429 return nullptr;
3430 }
3432 if (it == m_internal_spk_managers.end()) return nullptr;
3433 return dynamic_cast<LegacyDataSPKM*>(it->second);
3434}
3435
3436void CWallet::AddScriptPubKeyMan(const uint256& id, std::unique_ptr<ScriptPubKeyMan> spkm_man)
3437{
3438 // Add spkm_man to m_spk_managers before calling any method
3439 // that might access it.
3440 const auto& spkm = m_spk_managers[id] = std::move(spkm_man);
3441
3442 // Update birth time if needed
3443 MaybeUpdateBirthTime(spkm->GetTimeFirstKey());
3444}
3445
3447{
3449 return GetLegacyDataSPKM();
3450}
3451
3453{
3455 return;
3456 }
3457
3458 Assert(m_database->Format() == "bdb_ro" || m_database->Format() == "mock");
3459 std::unique_ptr<ScriptPubKeyMan> spk_manager = std::make_unique<LegacyDataSPKM>(*this);
3460
3461 for (const auto& type : LEGACY_OUTPUT_TYPES) {
3462 m_internal_spk_managers[type] = spk_manager.get();
3463 m_external_spk_managers[type] = spk_manager.get();
3464 }
3465 uint256 id = spk_manager->GetID();
3466 AddScriptPubKeyMan(id, std::move(spk_manager));
3467}
3468
3469bool CWallet::WithEncryptionKey(std::function<bool (const CKeyingMaterial&)> cb) const
3470{
3471 LOCK(cs_wallet);
3472 return cb(vMasterKey);
3473}
3474
3476{
3477 return !mapMasterKeys.empty();
3478}
3479
3481{
3482 for (const auto& spkm : GetAllScriptPubKeyMans()) {
3483 if (spkm->HaveCryptedKeys()) return true;
3484 }
3485 return false;
3486}
3487
3489{
3490 for (const auto& spk_man : GetActiveScriptPubKeyMans()) {
3491 spk_man->NotifyCanGetAddressesChanged.connect(NotifyCanGetAddressesChanged);
3492 spk_man->NotifyFirstKeyTimeChanged.connect(std::bind(&CWallet::MaybeUpdateBirthTime, this, std::placeholders::_2));
3493 }
3494}
3495
3497{
3498 DescriptorScriptPubKeyMan* spk_manager;
3500 spk_manager = new ExternalSignerScriptPubKeyMan(*this, desc, m_keypool_size);
3501 } else {
3502 spk_manager = new DescriptorScriptPubKeyMan(*this, desc, m_keypool_size);
3503 }
3504 AddScriptPubKeyMan(id, std::unique_ptr<ScriptPubKeyMan>(spk_manager));
3505 return *spk_manager;
3506}
3507
3508DescriptorScriptPubKeyMan& CWallet::SetupDescriptorScriptPubKeyMan(WalletBatch& batch, const CExtKey& master_key, const OutputType& output_type, bool internal)
3509{
3511 auto spk_manager = std::unique_ptr<DescriptorScriptPubKeyMan>(new DescriptorScriptPubKeyMan(*this, m_keypool_size));
3512 if (IsCrypted()) {
3513 if (IsLocked()) {
3514 throw std::runtime_error(std::string(__func__) + ": Wallet is locked, cannot setup new descriptors");
3515 }
3516 if (!spk_manager->CheckDecryptionKey(vMasterKey) && !spk_manager->Encrypt(vMasterKey, &batch)) {
3517 throw std::runtime_error(std::string(__func__) + ": Could not encrypt new descriptors");
3518 }
3519 }
3520 spk_manager->SetupDescriptorGeneration(batch, master_key, output_type, internal);
3521 DescriptorScriptPubKeyMan* out = spk_manager.get();
3522 uint256 id = spk_manager->GetID();
3523 AddScriptPubKeyMan(id, std::move(spk_manager));
3524 AddActiveScriptPubKeyManWithDb(batch, id, output_type, internal);
3525 return *out;
3526}
3527
3529{
3531 for (bool internal : {false, true}) {
3532 for (OutputType t : OUTPUT_TYPES) {
3533 SetupDescriptorScriptPubKeyMan(batch, master_key, t, internal);
3534 }
3535 }
3536}
3537
3539{
3542 // Make a seed
3543 CKey seed_key = GenerateRandomKey();
3544 CPubKey seed = seed_key.GetPubKey();
3545 assert(seed_key.VerifyPubKey(seed));
3546
3547 // Get the extended key
3548 CExtKey master_key;
3549 master_key.SetSeed(seed_key);
3550
3551 SetupDescriptorScriptPubKeyMans(batch, master_key);
3552}
3553
3555{
3557
3559 if (!RunWithinTxn(GetDatabase(), /*process_desc=*/"setup descriptors", [&](WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet){
3561 return true;
3562 })) throw std::runtime_error("Error: cannot process db transaction for descriptors setup");
3563 } else {
3565 if (!signer) throw std::runtime_error(util::ErrorString(signer).original);
3566
3567 // TODO: add account parameter
3568 int account = 0;
3569 UniValue signer_res = signer->GetDescriptors(account);
3570
3571 if (!signer_res.isObject()) throw std::runtime_error(std::string(__func__) + ": Unexpected result");
3572
3573 WalletBatch batch(GetDatabase());
3574 if (!batch.TxnBegin()) throw std::runtime_error("Error: cannot create db transaction for descriptors import");
3575
3576 for (bool internal : {false, true}) {
3577 const UniValue& descriptor_vals = signer_res.find_value(internal ? "internal" : "receive");
3578 if (!descriptor_vals.isArray()) throw std::runtime_error(std::string(__func__) + ": Unexpected result");
3579 for (const UniValue& desc_val : descriptor_vals.get_array().getValues()) {
3580 const std::string& desc_str = desc_val.getValStr();
3582 std::string desc_error;
3583 auto descs = Parse(desc_str, keys, desc_error, false);
3584 if (descs.empty()) {
3585 throw std::runtime_error(std::string(__func__) + ": Invalid descriptor \"" + desc_str + "\" (" + desc_error + ")");
3586 }
3587 auto& desc = descs.at(0);
3588 if (!desc->GetOutputType()) {
3589 continue;
3590 }
3591 OutputType t = *desc->GetOutputType();
3592 auto spk_manager = std::unique_ptr<ExternalSignerScriptPubKeyMan>(new ExternalSignerScriptPubKeyMan(*this, m_keypool_size));
3593 spk_manager->SetupDescriptor(batch, std::move(desc));
3594 uint256 id = spk_manager->GetID();
3595 AddScriptPubKeyMan(id, std::move(spk_manager));
3596 AddActiveScriptPubKeyManWithDb(batch, id, t, internal);
3597 }
3598 }
3599
3600 // Ensure imported descriptors are committed to disk
3601 if (!batch.TxnCommit()) throw std::runtime_error("Error: cannot commit db transaction for descriptors import");
3602 }
3603}
3604
3606{
3607 WalletBatch batch(GetDatabase());
3608 return AddActiveScriptPubKeyManWithDb(batch, id, type, internal);
3609}
3610
3612{
3613 if (!batch.WriteActiveScriptPubKeyMan(static_cast<uint8_t>(type), id, internal)) {
3614 throw std::runtime_error(std::string(__func__) + ": writing active ScriptPubKeyMan id failed");
3615 }
3616 LoadActiveScriptPubKeyMan(id, type, internal);
3617}
3618
3620{
3621 // Activating ScriptPubKeyManager for a given output and change type is incompatible with legacy wallets.
3622 // Legacy wallets have only one ScriptPubKeyManager and it's active for all output and change types.
3624
3625 WalletLogPrintf("Setting spkMan to active: id = %s, type = %s, internal = %s\n", id.ToString(), FormatOutputType(type), internal ? "true" : "false");
3626 auto& spk_mans = internal ? m_internal_spk_managers : m_external_spk_managers;
3627 auto& spk_mans_other = internal ? m_external_spk_managers : m_internal_spk_managers;
3628 auto spk_man = m_spk_managers.at(id).get();
3629 spk_mans[type] = spk_man;
3630
3631 const auto it = spk_mans_other.find(type);
3632 if (it != spk_mans_other.end() && it->second == spk_man) {
3633 spk_mans_other.erase(type);
3634 }
3635
3637}
3638
3640{
3641 auto spk_man = GetScriptPubKeyMan(type, internal);
3642 if (spk_man != nullptr && spk_man->GetID() == id) {
3643 WalletLogPrintf("Deactivate spkMan: id = %s, type = %s, internal = %s\n", id.ToString(), FormatOutputType(type), internal ? "true" : "false");
3644 WalletBatch batch(GetDatabase());
3645 if (!batch.EraseActiveScriptPubKeyMan(static_cast<uint8_t>(type), internal)) {
3646 throw std::runtime_error(std::string(__func__) + ": erasing active ScriptPubKeyMan id failed");
3647 }
3648
3649 auto& spk_mans = internal ? m_internal_spk_managers : m_external_spk_managers;
3650 spk_mans.erase(type);
3651 }
3652
3654}
3655
3657{
3658 auto spk_man_pair = m_spk_managers.find(desc.id);
3659
3660 if (spk_man_pair != m_spk_managers.end()) {
3661 // Try to downcast to DescriptorScriptPubKeyMan then check if the descriptors match
3662 DescriptorScriptPubKeyMan* spk_manager = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man_pair->second.get());
3663 if (spk_manager != nullptr && spk_manager->HasWalletDescriptor(desc)) {
3664 return spk_manager;
3665 }
3666 }
3667
3668 return nullptr;
3669}
3670
3671std::optional<bool> CWallet::IsInternalScriptPubKeyMan(ScriptPubKeyMan* spk_man) const
3672{
3673 // only active ScriptPubKeyMan can be internal
3674 if (!GetActiveScriptPubKeyMans().count(spk_man)) {
3675 return std::nullopt;
3676 }
3677
3678 const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man);
3679 if (!desc_spk_man) {
3680 throw std::runtime_error(std::string(__func__) + ": unexpected ScriptPubKeyMan type.");
3681 }
3682
3683 LOCK(desc_spk_man->cs_desc_man);
3684 const auto& type = desc_spk_man->GetWalletDescriptor().descriptor->GetOutputType();
3685 assert(type.has_value());
3686
3687 return GetScriptPubKeyMan(*type, /* internal= */ true) == desc_spk_man;
3688}
3689
3691{
3693
3695
3696 auto spk_man = GetDescriptorScriptPubKeyMan(desc);
3697 if (spk_man) {
3698 WalletLogPrintf("Update existing descriptor: %s\n", desc.descriptor->ToString());
3699 if (auto spkm_res = spk_man->UpdateWalletDescriptor(desc); !spkm_res) {
3700 return util::Error{util::ErrorString(spkm_res)};
3701 }
3702 } else {
3703 auto new_spk_man = std::unique_ptr<DescriptorScriptPubKeyMan>(new DescriptorScriptPubKeyMan(*this, desc, m_keypool_size));
3704 spk_man = new_spk_man.get();
3705
3706 // Save the descriptor to memory
3707 uint256 id = new_spk_man->GetID();
3708 AddScriptPubKeyMan(id, std::move(new_spk_man));
3709 }
3710
3711 // Add the private keys to the descriptor
3712 for (const auto& entry : signing_provider.keys) {
3713 const CKey& key = entry.second;
3714 spk_man->AddDescriptorKey(key, key.GetPubKey());
3715 }
3716
3717 // Top up key pool, the manager will generate new scriptPubKeys internally
3718 if (!spk_man->TopUp()) {
3719 return util::Error{_("Could not top up scriptPubKeys")};
3720 }
3721
3722 // Apply the label if necessary
3723 // Note: we disable labels for ranged descriptors
3724 if (!desc.descriptor->IsRange()) {
3725 auto script_pub_keys = spk_man->GetScriptPubKeys();
3726 if (script_pub_keys.empty()) {
3727 return util::Error{_("Could not generate scriptPubKeys (cache is empty)")};
3728 }
3729
3730 if (!internal) {
3731 for (const auto& script : script_pub_keys) {
3732 CTxDestination dest;
3733 if (ExtractDestination(script, dest)) {
3735 }
3736 }
3737 }
3738 }
3739
3740 // Save the descriptor to DB
3741 spk_man->WriteDescriptor();
3742
3743 // Break balance caches so that outputs that are now IsMine in already known txs will be included in the balance
3744 MarkDirty();
3745
3746 return std::reference_wrapper(*spk_man);
3747}
3748
3750{
3752
3753 WalletLogPrintf("Migrating wallet storage database from BerkeleyDB to SQLite.\n");
3754
3755 if (m_database->Format() == "sqlite") {
3756 error = _("Error: This wallet already uses SQLite");
3757 return false;
3758 }
3759
3760 // Get all of the records for DB type migration
3761 std::unique_ptr<DatabaseBatch> batch = m_database->MakeBatch();
3762 std::unique_ptr<DatabaseCursor> cursor = batch->GetNewCursor();
3763 std::vector<std::pair<SerializeData, SerializeData>> records;
3764 if (!cursor) {
3765 error = _("Error: Unable to begin reading all records in the database");
3766 return false;
3767 }
3769 while (true) {
3770 DataStream ss_key{};
3771 DataStream ss_value{};
3772 status = cursor->Next(ss_key, ss_value);
3773 if (status != DatabaseCursor::Status::MORE) {
3774 break;
3775 }
3776 SerializeData key(ss_key.begin(), ss_key.end());
3777 SerializeData value(ss_value.begin(), ss_value.end());
3778 records.emplace_back(key, value);
3779 }
3780 cursor.reset();
3781 batch.reset();
3782 if (status != DatabaseCursor::Status::DONE) {
3783 error = _("Error: Unable to read all records in the database");
3784 return false;
3785 }
3786
3787 // Close this database and delete the file
3788 fs::path db_path = fs::PathFromString(m_database->Filename());
3789 m_database->Close();
3790 fs::remove(db_path);
3791
3792 // Generate the path for the location of the migrated wallet
3793 // Wallets that are plain files rather than wallet directories will be migrated to be wallet directories.
3794 const fs::path wallet_path = fsbridge::AbsPathJoin(GetWalletDir(), fs::PathFromString(m_name));
3795
3796 // Make new DB
3797 DatabaseOptions opts;
3798 opts.require_create = true;
3800 DatabaseStatus db_status;
3801 std::unique_ptr<WalletDatabase> new_db = MakeDatabase(wallet_path, opts, db_status, error);
3802 assert(new_db); // This is to prevent doing anything further with this wallet. The original file was deleted, but a backup exists.
3803 m_database.reset();
3804 m_database = std::move(new_db);
3805
3806 // Write existing records into the new DB
3807 batch = m_database->MakeBatch();
3808 bool began = batch->TxnBegin();
3809 assert(began); // This is a critical error, the new db could not be written to. The original db exists as a backup, but we should not continue execution.
3810 for (const auto& [key, value] : records) {
3811 if (!batch->Write(std::span{key}, std::span{value})) {
3812 batch->TxnAbort();
3813 m_database->Close();
3814 fs::remove(m_database->Filename());
3815 assert(false); // This is a critical error, the new db could not be written to. The original db exists as a backup, but we should not continue execution.
3816 }
3817 }
3818 bool committed = batch->TxnCommit();
3819 assert(committed); // This is a critical error, the new db could not be written to. The original db exists as a backup, but we should not continue execution.
3820 return true;
3821}
3822
3823std::optional<MigrationData> CWallet::GetDescriptorsForLegacy(bilingual_str& error) const
3824{
3826
3827 LegacyDataSPKM* legacy_spkm = GetLegacyDataSPKM();
3828 if (!Assume(legacy_spkm)) {
3829 // This shouldn't happen
3830 error = Untranslated(STR_INTERNAL_BUG("Error: Legacy wallet data missing"));
3831 return std::nullopt;
3832 }
3833
3834 std::optional<MigrationData> res = legacy_spkm->MigrateToDescriptor();
3835 if (res == std::nullopt) {
3836 error = _("Error: Unable to produce descriptors for this legacy wallet. Make sure to provide the wallet's passphrase if it is encrypted.");
3837 return std::nullopt;
3838 }
3839 return res;
3840}
3841
3843{
3845
3846 LegacyDataSPKM* legacy_spkm = GetLegacyDataSPKM();
3847 if (!Assume(legacy_spkm)) {
3848 // This shouldn't happen
3849 return util::Error{Untranslated(STR_INTERNAL_BUG("Error: Legacy wallet data missing"))};
3850 }
3851
3852 // Note: when the legacy wallet has no spendable scripts, it must be empty at the end of the process.
3853 bool has_spendable_material = !data.desc_spkms.empty() || data.master_key.key.IsValid();
3854
3855 // Get all invalid or non-watched scripts that will not be migrated
3856 std::set<CTxDestination> not_migrated_dests;
3857 for (const auto& script : legacy_spkm->GetNotMineScriptPubKeys()) {
3858 CTxDestination dest;
3859 if (ExtractDestination(script, dest)) not_migrated_dests.emplace(dest);
3860 }
3861
3862 // When the legacy wallet has no spendable scripts, the main wallet will be empty, leaving its script cache empty as well.
3863 // The watch-only and/or solvable wallet(s) will contain the scripts in their respective caches.
3864 if (!data.desc_spkms.empty()) Assume(!m_cached_spks.empty());
3865 if (!data.watch_descs.empty()) Assume(!data.watchonly_wallet->m_cached_spks.empty());
3866 if (!data.solvable_descs.empty()) Assume(!data.solvable_wallet->m_cached_spks.empty());
3867
3868 for (auto& desc_spkm : data.desc_spkms) {
3869 if (m_spk_managers.count(desc_spkm->GetID()) > 0) {
3870 return util::Error{_("Error: Duplicate descriptors created during migration. Your wallet may be corrupted.")};
3871 }
3872 uint256 id = desc_spkm->GetID();
3873 AddScriptPubKeyMan(id, std::move(desc_spkm));
3874 }
3875
3876 // Remove the LegacyScriptPubKeyMan from disk
3877 if (!legacy_spkm->DeleteRecordsWithDB(local_wallet_batch)) {
3878 return util::Error{_("Error: cannot remove legacy wallet records")};
3879 }
3880
3881 // Remove the LegacyScriptPubKeyMan from memory
3882 m_spk_managers.erase(legacy_spkm->GetID());
3885
3886 // Setup new descriptors (only if we are migrating any key material)
3887 SetWalletFlagWithDB(local_wallet_batch, WALLET_FLAG_DESCRIPTORS);
3888 if (has_spendable_material && !IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
3889 // Use the existing master key if we have it
3890 if (data.master_key.key.IsValid()) {
3891 SetupDescriptorScriptPubKeyMans(local_wallet_batch, data.master_key);
3892 } else {
3893 // Setup with a new seed if we don't.
3894 SetupOwnDescriptorScriptPubKeyMans(local_wallet_batch);
3895 }
3896 }
3897
3898 // Get best block locator so that we can copy it to the watchonly and solvables
3899 CBlockLocator best_block_locator;
3900 if (!local_wallet_batch.ReadBestBlock(best_block_locator)) {
3901 return util::Error{_("Error: Unable to read wallet's best block locator record")};
3902 }
3903
3904 // Update m_txos to match the descriptors remaining in this wallet
3905 m_txos.clear();
3907
3908 // Check if the transactions in the wallet are still ours. Either they belong here, or they belong in the watchonly wallet.
3909 // We need to go through these in the tx insertion order so that lookups to spends works.
3910 std::vector<Txid> txids_to_delete;
3911 std::unique_ptr<WalletBatch> watchonly_batch;
3912 if (data.watchonly_wallet) {
3913 watchonly_batch = std::make_unique<WalletBatch>(data.watchonly_wallet->GetDatabase());
3914 if (!watchonly_batch->TxnBegin()) return util::Error{strprintf(_("Error: database transaction cannot be executed for wallet %s"), data.watchonly_wallet->GetName())};
3915 // Copy the next tx order pos to the watchonly wallet
3916 LOCK(data.watchonly_wallet->cs_wallet);
3917 data.watchonly_wallet->nOrderPosNext = nOrderPosNext;
3918 watchonly_batch->WriteOrderPosNext(data.watchonly_wallet->nOrderPosNext);
3919 // Write the best block locator to avoid rescanning on reload
3920 if (!watchonly_batch->WriteBestBlock(best_block_locator)) {
3921 return util::Error{_("Error: Unable to write watchonly wallet best block locator record")};
3922 }
3923 }
3924 std::unique_ptr<WalletBatch> solvables_batch;
3925 if (data.solvable_wallet) {
3926 solvables_batch = std::make_unique<WalletBatch>(data.solvable_wallet->GetDatabase());
3927 if (!solvables_batch->TxnBegin()) return util::Error{strprintf(_("Error: database transaction cannot be executed for wallet %s"), data.solvable_wallet->GetName())};
3928 // Write the best block locator to avoid rescanning on reload
3929 if (!solvables_batch->WriteBestBlock(best_block_locator)) {
3930 return util::Error{_("Error: Unable to write solvable wallet best block locator record")};
3931 }
3932 }
3933 for (const auto& [_pos, wtx] : wtxOrdered) {
3934 // Check it is the watchonly wallet's
3935 // solvable_wallet doesn't need to be checked because transactions for those scripts weren't being watched for
3936 bool is_mine = IsMine(*wtx->tx) || IsFromMe(*wtx->tx);
3937 if (data.watchonly_wallet) {
3938 LOCK(data.watchonly_wallet->cs_wallet);
3939 if (data.watchonly_wallet->IsMine(*wtx->tx) || data.watchonly_wallet->IsFromMe(*wtx->tx)) {
3940 // Add to watchonly wallet
3941 const Txid& hash = wtx->GetHash();
3942 const CWalletTx& to_copy_wtx = *wtx;
3943 if (!data.watchonly_wallet->LoadToWallet(hash, [&](CWalletTx& ins_wtx, bool new_tx) EXCLUSIVE_LOCKS_REQUIRED(data.watchonly_wallet->cs_wallet) {
3944 if (!new_tx) return false;
3945 ins_wtx.SetTx(to_copy_wtx.tx);
3946 ins_wtx.CopyFrom(to_copy_wtx);
3947 return true;
3948 })) {
3949 return util::Error{strprintf(_("Error: Could not add watchonly tx %s to watchonly wallet"), wtx->GetHash().GetHex())};
3950 }
3951 watchonly_batch->WriteTx(data.watchonly_wallet->mapWallet.at(hash));
3952 // Mark as to remove from the migrated wallet only if it does not also belong to it
3953 if (!is_mine) {
3954 txids_to_delete.push_back(hash);
3955 }
3956 continue;
3957 }
3958 }
3959 if (!is_mine) {
3960 // Both not ours and not in the watchonly wallet
3961 return util::Error{strprintf(_("Error: Transaction %s in wallet cannot be identified to belong to migrated wallets"), wtx->GetHash().GetHex())};
3962 }
3963 }
3964
3965 // Do the removes
3966 if (txids_to_delete.size() > 0) {
3967 if (auto res = RemoveTxs(local_wallet_batch, txids_to_delete); !res) {
3968 return util::Error{_("Error: Could not delete watchonly transactions. ") + util::ErrorString(res)};
3969 }
3970 }
3971
3972 // Pair external wallets with their corresponding db handler
3973 std::vector<std::pair<std::shared_ptr<CWallet>, std::unique_ptr<WalletBatch>>> wallets_vec;
3974 if (data.watchonly_wallet) wallets_vec.emplace_back(data.watchonly_wallet, std::move(watchonly_batch));
3975 if (data.solvable_wallet) wallets_vec.emplace_back(data.solvable_wallet, std::move(solvables_batch));
3976
3977 // Write address book entry to disk
3978 auto func_store_addr = [](WalletBatch& batch, const CTxDestination& dest, const CAddressBookData& entry) {
3979 auto address{EncodeDestination(dest)};
3980 if (entry.purpose) batch.WritePurpose(address, PurposeToString(*entry.purpose));
3981 if (entry.label) batch.WriteName(address, *entry.label);
3982 for (const auto& [id, request] : entry.receive_requests) {
3983 batch.WriteAddressReceiveRequest(dest, id, request);
3984 }
3985 if (entry.previously_spent) batch.WriteAddressPreviouslySpent(dest, true);
3986 };
3987
3988 // Check the address book data in the same way we did for transactions
3989 std::vector<CTxDestination> dests_to_delete;
3990 for (const auto& [dest, record] : m_address_book) {
3991 // Ensure "receive" entries that are no longer part of the original wallet are transferred to another wallet
3992 // Entries for everything else ("send") will be cloned to all wallets.
3993 bool require_transfer = record.purpose == AddressPurpose::RECEIVE && !IsMine(dest);
3994 bool copied = false;
3995 for (auto& [wallet, batch] : wallets_vec) {
3996 LOCK(wallet->cs_wallet);
3997 if (require_transfer && !wallet->IsMine(dest)) continue;
3998
3999 // Copy the entire address book entry
4000 wallet->m_address_book[dest] = record;
4001 func_store_addr(*batch, dest, record);
4002
4003 copied = true;
4004 // Only delete 'receive' records that are no longer part of the original wallet
4005 if (require_transfer) {
4006 dests_to_delete.push_back(dest);
4007 break;
4008 }
4009 }
4010
4011 // Fail immediately if we ever found an entry that was ours and cannot be transferred
4012 // to any of the created wallets (watch-only, solvable).
4013 // Means that no inferred descriptor maps to the stored entry. Which mustn't happen.
4014 if (require_transfer && !copied) {
4015
4016 // Skip invalid/non-watched scripts that will not be migrated
4017 if (not_migrated_dests.count(dest) > 0) {
4018 dests_to_delete.push_back(dest);
4019 continue;
4020 }
4021
4022 return util::Error{_("Error: Address book data in wallet cannot be identified to belong to migrated wallets")};
4023 }
4024 }
4025
4026 // Persist external wallets address book entries
4027 for (auto& [wallet, batch] : wallets_vec) {
4028 if (!batch->TxnCommit()) {
4029 return util::Error{strprintf(_("Error: Unable to write data to disk for wallet %s"), wallet->GetName())};
4030 }
4031 }
4032
4033 // Remove the things to delete in this wallet
4034 if (dests_to_delete.size() > 0) {
4035 for (const auto& dest : dests_to_delete) {
4036 if (!DelAddressBookWithDB(local_wallet_batch, dest)) {
4037 return util::Error{_("Error: Unable to remove watchonly address book data")};
4038 }
4039 }
4040 }
4041
4042 // If there was no key material in the main wallet, there should be no records on it anymore.
4043 // This wallet will be discarded at the end of the process. Only wallets that contain the
4044 // migrated records will be presented to the user.
4045 if (!has_spendable_material) {
4046 if (!m_address_book.empty()) return util::Error{_("Error: Not all address book records were migrated")};
4047 if (!mapWallet.empty()) return util::Error{_("Error: Not all transaction records were migrated")};
4048 }
4049
4050 return {}; // all good
4051}
4052
4054{
4056}
4057
4059{
4060 AssertLockHeld(wallet.cs_wallet);
4061
4062 // Get all of the descriptors from the legacy wallet
4063 std::optional<MigrationData> data = wallet.GetDescriptorsForLegacy(error);
4064 if (data == std::nullopt) return false;
4065
4066 // Create the watchonly and solvable wallets if necessary
4067 if (data->watch_descs.size() > 0 || data->solvable_descs.size() > 0) {
4068 DatabaseOptions options;
4069 options.require_existing = false;
4070 options.require_create = true;
4072
4073 WalletContext empty_context;
4074 empty_context.args = context.args;
4075
4076 // Make the wallets
4078 if (wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE)) {
4080 }
4081 if (wallet.IsWalletFlagSet(WALLET_FLAG_KEY_ORIGIN_METADATA)) {
4083 }
4084 if (data->watch_descs.size() > 0) {
4085 wallet.WalletLogPrintf("Making a new watchonly wallet containing the watched scripts\n");
4086
4087 DatabaseStatus status;
4088 std::vector<bilingual_str> warnings;
4089 std::string wallet_name = wallet.GetName() + "_watchonly";
4090 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(wallet_name, options, status, error);
4091 if (!database) {
4092 error = strprintf(_("Wallet file creation failed: %s"), error);
4093 return false;
4094 }
4095
4096 data->watchonly_wallet = CWallet::Create(empty_context, wallet_name, std::move(database), options.create_flags, error, warnings);
4097 if (!data->watchonly_wallet) {
4098 error = _("Error: Failed to create new watchonly wallet");
4099 return false;
4100 }
4101 res.watchonly_wallet = data->watchonly_wallet;
4102 LOCK(data->watchonly_wallet->cs_wallet);
4103
4104 // Parse the descriptors and add them to the new wallet
4105 for (const auto& [desc_str, creation_time] : data->watch_descs) {
4106 // Parse the descriptor
4108 std::string parse_err;
4109 std::vector<std::unique_ptr<Descriptor>> descs = Parse(desc_str, keys, parse_err, /* require_checksum */ true);
4110 assert(descs.size() == 1); // It shouldn't be possible to have the LegacyScriptPubKeyMan make an invalid descriptor or a multipath descriptors
4111 assert(!descs.at(0)->IsRange()); // It shouldn't be possible to have LegacyScriptPubKeyMan make a ranged watchonly descriptor
4112
4113 // Add to the wallet
4114 WalletDescriptor w_desc(std::move(descs.at(0)), creation_time, 0, 0, 0);
4115 if (auto spkm_res = data->watchonly_wallet->AddWalletDescriptor(w_desc, keys, "", false); !spkm_res) {
4116 throw std::runtime_error(util::ErrorString(spkm_res).original);
4117 }
4118 }
4119
4120 // Add the wallet to settings
4121 UpdateWalletSetting(*context.chain, wallet_name, /*load_on_startup=*/true, warnings);
4122 }
4123 if (data->solvable_descs.size() > 0) {
4124 wallet.WalletLogPrintf("Making a new watchonly wallet containing the unwatched solvable scripts\n");
4125
4126 DatabaseStatus status;
4127 std::vector<bilingual_str> warnings;
4128 std::string wallet_name = wallet.GetName() + "_solvables";
4129 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(wallet_name, options, status, error);
4130 if (!database) {
4131 error = strprintf(_("Wallet file creation failed: %s"), error);
4132 return false;
4133 }
4134
4135 data->solvable_wallet = CWallet::Create(empty_context, wallet_name, std::move(database), options.create_flags, error, warnings);
4136 if (!data->solvable_wallet) {
4137 error = _("Error: Failed to create new watchonly wallet");
4138 return false;
4139 }
4140 res.solvables_wallet = data->solvable_wallet;
4141 LOCK(data->solvable_wallet->cs_wallet);
4142
4143 // Parse the descriptors and add them to the new wallet
4144 for (const auto& [desc_str, creation_time] : data->solvable_descs) {
4145 // Parse the descriptor
4147 std::string parse_err;
4148 std::vector<std::unique_ptr<Descriptor>> descs = Parse(desc_str, keys, parse_err, /* require_checksum */ true);
4149 assert(descs.size() == 1); // It shouldn't be possible to have the LegacyScriptPubKeyMan make an invalid descriptor or a multipath descriptors
4150 assert(!descs.at(0)->IsRange()); // It shouldn't be possible to have LegacyScriptPubKeyMan make a ranged watchonly descriptor
4151
4152 // Add to the wallet
4153 WalletDescriptor w_desc(std::move(descs.at(0)), creation_time, 0, 0, 0);
4154 if (auto spkm_res = data->solvable_wallet->AddWalletDescriptor(w_desc, keys, "", false); !spkm_res) {
4155 throw std::runtime_error(util::ErrorString(spkm_res).original);
4156 }
4157 }
4158
4159 // Add the wallet to settings
4160 UpdateWalletSetting(*context.chain, wallet_name, /*load_on_startup=*/true, warnings);
4161 }
4162 }
4163
4164 // Add the descriptors to wallet, remove LegacyScriptPubKeyMan, and cleanup txs and address book data
4165 return RunWithinTxn(wallet.GetDatabase(), /*process_desc=*/"apply migration process", [&](WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet){
4166 if (auto res_migration = wallet.ApplyMigrationData(batch, *data); !res_migration) {
4167 error = util::ErrorString(res_migration);
4168 return false;
4169 }
4170 wallet.WalletLogPrintf("Wallet migration complete.\n");
4171 return true;
4172 });
4173}
4174
4175util::Result<MigrationResult> MigrateLegacyToDescriptor(const std::string& wallet_name, const SecureString& passphrase, WalletContext& context)
4176{
4177 std::vector<bilingual_str> warnings;
4178 bilingual_str error;
4179
4180 // The only kind of wallets that could be loaded are descriptor ones, which don't need to be migrated.
4181 if (auto wallet = GetWallet(context, wallet_name)) {
4182 assert(wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
4183 return util::Error{_("Error: This wallet is already a descriptor wallet")};
4184 } else {
4185 // Check if the wallet is BDB
4186 const auto& wallet_path = GetWalletPath(wallet_name);
4187 if (!wallet_path) {
4188 return util::Error{util::ErrorString(wallet_path)};
4189 }
4190 if (!fs::exists(*wallet_path)) {
4191 return util::Error{_("Error: Wallet does not exist")};
4192 }
4193 if (!IsBDBFile(BDBDataFile(*wallet_path))) {
4194 return util::Error{_("Error: This wallet is already a descriptor wallet")};
4195 }
4196 }
4197
4198 // Load the wallet but only in the context of this function.
4199 // No signals should be connected nor should anything else be aware of this wallet
4200 WalletContext empty_context;
4201 empty_context.args = context.args;
4202 DatabaseOptions options;
4203 options.require_existing = true;
4204 options.require_format = DatabaseFormat::BERKELEY_RO;
4205 DatabaseStatus status;
4206 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(wallet_name, options, status, error);
4207 if (!database) {
4208 return util::Error{Untranslated("Wallet file verification failed.") + Untranslated(" ") + error};
4209 }
4210
4211 // Make the local wallet
4212 std::shared_ptr<CWallet> local_wallet = CWallet::Create(empty_context, wallet_name, std::move(database), options.create_flags, error, warnings);
4213 if (!local_wallet) {
4214 return util::Error{Untranslated("Wallet loading failed.") + Untranslated(" ") + error};
4215 }
4216
4217 return MigrateLegacyToDescriptor(std::move(local_wallet), passphrase, context);
4218}
4219
4220util::Result<MigrationResult> MigrateLegacyToDescriptor(std::shared_ptr<CWallet> local_wallet, const SecureString& passphrase, WalletContext& context)
4221{
4222 MigrationResult res;
4223 bilingual_str error;
4224 std::vector<bilingual_str> warnings;
4225
4226 DatabaseOptions options;
4227 options.require_existing = true;
4228 DatabaseStatus status;
4229
4230 const std::string wallet_name = local_wallet->GetName();
4231
4232 // Before anything else, check if there is something to migrate.
4233 if (local_wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
4234 return util::Error{_("Error: This wallet is already a descriptor wallet")};
4235 }
4236
4237 // Make a backup of the DB in the wallet's directory with a unique filename
4238 // using the wallet name and current timestamp. The backup filename is based
4239 // on the name of the parent directory containing the wallet data in most
4240 // cases, but in the case where the wallet name is a path to a data file,
4241 // the name of the data file is used, and in the case where the wallet name
4242 // is blank, "default_wallet" is used.
4243 const std::string backup_prefix = wallet_name.empty() ? "default_wallet" : [&] {
4244 // fs::weakly_canonical resolves relative specifiers and remove trailing slashes.
4245 const auto legacy_wallet_path = fs::weakly_canonical(GetWalletDir() / fs::PathFromString(wallet_name));
4246 return fs::PathToString(legacy_wallet_path.filename());
4247 }();
4248
4249 fs::path backup_filename = fs::PathFromString(strprintf("%s_%d.legacy.bak", backup_prefix, GetTime()));
4250 fs::path backup_path = fsbridge::AbsPathJoin(GetWalletDir(), backup_filename);
4251 if (!local_wallet->BackupWallet(fs::PathToString(backup_path))) {
4252 return util::Error{_("Error: Unable to make a backup of your wallet")};
4253 }
4254 res.backup_path = backup_path;
4255
4256 bool success = false;
4257
4258 // Unlock the wallet if needed
4259 if (local_wallet->IsLocked() && !local_wallet->Unlock(passphrase)) {
4260 if (passphrase.find('\0') == std::string::npos) {
4261 return util::Error{Untranslated("Error: Wallet decryption failed, the wallet passphrase was not provided or was incorrect.")};
4262 } else {
4263 return util::Error{Untranslated("Error: Wallet decryption failed, the wallet passphrase entered was incorrect. "
4264 "The passphrase contains a null character (ie - a zero byte). "
4265 "If this passphrase was set with a version of this software prior to 25.0, "
4266 "please try again with only the characters up to — but not including — "
4267 "the first null character.")};
4268 }
4269 }
4270
4271 // Indicates whether the current wallet is empty after migration.
4272 // Notes:
4273 // When non-empty: the local wallet becomes the main spendable wallet.
4274 // When empty: The local wallet is excluded from the result, as the
4275 // user does not expect an empty spendable wallet after
4276 // migrating only watch-only scripts.
4277 bool empty_local_wallet = false;
4278
4279 {
4280 LOCK(local_wallet->cs_wallet);
4281 // First change to using SQLite
4282 if (!local_wallet->MigrateToSQLite(error)) return util::Error{error};
4283
4284 // Do the migration of keys and scripts for non-empty wallets, and cleanup if it fails
4285 if (HasLegacyRecords(*local_wallet)) {
4286 success = DoMigration(*local_wallet, context, error, res);
4287 // No scripts mean empty wallet after migration
4288 empty_local_wallet = local_wallet->GetAllScriptPubKeyMans().empty();
4289 } else {
4290 // Make sure that descriptors flag is actually set
4291 local_wallet->SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
4292 success = true;
4293 }
4294 }
4295
4296 // In case of loading failure, we need to remember the wallet dirs to remove.
4297 // A `set` is used as it may be populated with the same wallet directory paths multiple times,
4298 // both before and after loading. This ensures the set is complete even if one of the wallets
4299 // fails to load.
4300 std::set<fs::path> wallet_dirs;
4301 if (success) {
4302 Assume(!res.wallet); // We will set it here.
4303 // Check if the local wallet is empty after migration
4304 if (empty_local_wallet) {
4305 // This wallet has no records. We can safely remove it.
4306 std::vector<fs::path> paths_to_remove = local_wallet->GetDatabase().Files();
4307 local_wallet.reset();
4308 for (const auto& path_to_remove : paths_to_remove) fs::remove_all(path_to_remove);
4309 }
4310
4311 // Migration successful, load all the migrated wallets.
4312 for (std::shared_ptr<CWallet>* wallet_ptr : {&local_wallet, &res.watchonly_wallet, &res.solvables_wallet}) {
4313 if (success && *wallet_ptr) {
4314 std::shared_ptr<CWallet>& wallet = *wallet_ptr;
4315 // Save db path and load wallet
4316 wallet_dirs.insert(fs::PathFromString(wallet->GetDatabase().Filename()).parent_path());
4317 assert(wallet.use_count() == 1);
4318 std::string wallet_name = wallet->GetName();
4319 wallet.reset();
4320 wallet = LoadWallet(context, wallet_name, /*load_on_start=*/std::nullopt, options, status, error, warnings);
4321 success = (wallet != nullptr);
4322
4323 // When no wallet is set, set the main wallet.
4324 if (success && !res.wallet) {
4325 res.wallet_name = wallet->GetName();
4326 res.wallet = std::move(wallet);
4327 }
4328 }
4329 }
4330 }
4331 if (!success) {
4332 // Make list of wallets to cleanup
4333 std::vector<std::shared_ptr<CWallet>> created_wallets;
4334 if (local_wallet) created_wallets.push_back(std::move(local_wallet));
4335 if (res.watchonly_wallet) created_wallets.push_back(std::move(res.watchonly_wallet));
4336 if (res.solvables_wallet) created_wallets.push_back(std::move(res.solvables_wallet));
4337
4338 // Get the directories to remove after unloading
4339 for (std::shared_ptr<CWallet>& w : created_wallets) {
4340 wallet_dirs.emplace(fs::PathFromString(w->GetDatabase().Filename()).parent_path());
4341 }
4342
4343 // Unload the wallets
4344 for (std::shared_ptr<CWallet>& w : created_wallets) {
4345 if (w->HaveChain()) {
4346 // Unloading for wallets that were loaded for normal use
4347 if (!RemoveWallet(context, w, /*load_on_start=*/false)) {
4348 error += _("\nUnable to cleanup failed migration");
4349 return util::Error{error};
4350 }
4351 WaitForDeleteWallet(std::move(w));
4352 } else {
4353 // Unloading for wallets in local context
4354 assert(w.use_count() == 1);
4355 w.reset();
4356 }
4357 }
4358
4359 // Delete the wallet directories
4360 for (const fs::path& dir : wallet_dirs) {
4361 fs::remove_all(dir);
4362 }
4363
4364 // Restore the backup
4365 // Convert the backup file to the wallet db file by renaming it and moving it into the wallet's directory.
4366 bilingual_str restore_error;
4367 const auto& ptr_wallet = RestoreWallet(context, backup_path, wallet_name, /*load_on_start=*/std::nullopt, status, restore_error, warnings, /*load_after_restore=*/false);
4368 if (!restore_error.empty()) {
4369 error += restore_error + _("\nUnable to restore backup of wallet.");
4370 return util::Error{error};
4371 }
4372 // Verify that the legacy wallet is not loaded after restoring from the backup.
4373 assert(!ptr_wallet);
4374
4375 return util::Error{error};
4376 }
4377 return res;
4378}
4379
4380void CWallet::CacheNewScriptPubKeys(const std::set<CScript>& spks, ScriptPubKeyMan* spkm)
4381{
4382 for (const auto& script : spks) {
4383 m_cached_spks[script].push_back(spkm);
4384 }
4385}
4386
4387void CWallet::TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm)
4388{
4389 // Update scriptPubKey cache
4390 CacheNewScriptPubKeys(spks, spkm);
4391}
4392
4393std::set<CExtPubKey> CWallet::GetActiveHDPubKeys() const
4394{
4395 AssertLockHeld(cs_wallet);
4396
4397 Assert(IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
4398
4399 std::set<CExtPubKey> active_xpubs;
4400 for (const auto& spkm : GetActiveScriptPubKeyMans()) {
4401 const DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
4402 assert(desc_spkm);
4403 LOCK(desc_spkm->cs_desc_man);
4404 WalletDescriptor w_desc = desc_spkm->GetWalletDescriptor();
4405
4406 std::set<CPubKey> desc_pubkeys;
4407 std::set<CExtPubKey> desc_xpubs;
4408 w_desc.descriptor->GetPubKeys(desc_pubkeys, desc_xpubs);
4409 active_xpubs.merge(std::move(desc_xpubs));
4410 }
4411 return active_xpubs;
4412}
4413
4414std::optional<CKey> CWallet::GetKey(const CKeyID& keyid) const
4415{
4416 Assert(IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
4417
4418 for (const auto& spkm : GetAllScriptPubKeyMans()) {
4419 const DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
4420 assert(desc_spkm);
4421 LOCK(desc_spkm->cs_desc_man);
4422 if (std::optional<CKey> key = desc_spkm->GetKey(keyid)) {
4423 return key;
4424 }
4425 }
4426 return std::nullopt;
4427}
4428
4429void CWallet::WriteBestBlock() const
4430{
4431 AssertLockHeld(cs_wallet);
4432
4433 if (!m_last_block_processed.IsNull()) {
4434 CBlockLocator loc;
4435 chain().findBlock(m_last_block_processed, FoundBlock().locator(loc));
4436
4437 if (!loc.IsNull()) {
4438 WalletBatch batch(GetDatabase());
4439 batch.WriteBestBlock(loc);
4440 }
4441 }
4442}
4443
4444void CWallet::RefreshTXOsFromTx(const CWalletTx& wtx)
4445{
4446 AssertLockHeld(cs_wallet);
4447 for (uint32_t i = 0; i < wtx.tx->vout.size(); ++i) {
4448 const CTxOut& txout = wtx.tx->vout.at(i);
4449 if (!IsMine(txout)) continue;
4450 COutPoint outpoint(wtx.GetHash(), i);
4451 if (m_txos.contains(outpoint)) {
4452 } else {
4453 m_txos.emplace(outpoint, WalletTXO{wtx, txout});
4454 }
4455 }
4456}
4457
4458void CWallet::RefreshAllTXOs()
4459{
4460 AssertLockHeld(cs_wallet);
4461 for (const auto& [_, wtx] : mapWallet) {
4462 RefreshTXOsFromTx(wtx);
4463 }
4464}
4465
4466std::optional<WalletTXO> CWallet::GetTXO(const COutPoint& outpoint) const
4467{
4468 AssertLockHeld(cs_wallet);
4469 const auto& it = m_txos.find(outpoint);
4470 if (it == m_txos.end()) {
4471 return std::nullopt;
4472 }
4473 return it->second;
4474}
4475} // namespace wallet
bool ExtractDestination(const CScript &scriptPubKey, CTxDestination &addressRet)
Parse a scriptPubKey for the destination.
Definition: addresstype.cpp:49
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, PayToAnchor, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
Definition: addresstype.h:143
bool MoneyRange(const CAmount &nValue)
Definition: amount.h:27
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
ArgsManager gArgs
Definition: args.cpp:42
int ret
if(!SetupNetworking())
int flags
Definition: bitcoin-tx.cpp:529
ArgsManager & args
Definition: bitcoind.cpp:277
static constexpr int64_t TIMESTAMP_WINDOW
Timestamp window used as a grace period by code that compares external timestamps (such as timestamps...
Definition: chain.h:37
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:102
#define Assert(val)
Identity function.
Definition: check.h:106
#define STR_INTERNAL_BUG(msg)
Definition: check.h:89
#define Assume(val)
Assume is the identity function.
Definition: check.h:118
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:482
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:457
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:507
bool IsNull() const
Definition: block.h:49
Definition: block.h:69
std::vector< CTransactionRef > vtx
Definition: block.h:72
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:35
std::string ToString(const FeeEstimateMode &fee_estimate_mode=FeeEstimateMode::BTC_KVB) const
Definition: feerate.cpp:29
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 vbytes.
Definition: feerate.h:63
An encapsulated private key.
Definition: key.h:35
CPubKey GetPubKey() const
Compute the public key from a private key.
Definition: key.cpp:182
bool VerifyPubKey(const CPubKey &vchPubKey) const
Verify thoroughly whether a private key and a public key match.
Definition: key.cpp:236
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
uint32_t n
Definition: transaction.h:32
Txid hash
Definition: transaction.h:31
An encapsulated public key.
Definition: pubkey.h:34
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:413
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:296
const std::vector< CTxOut > vout
Definition: transaction.h:307
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:343
const std::vector< CTxIn > vin
Definition: transaction.h:306
An input of a transaction.
Definition: transaction.h:67
COutPoint prevout
Definition: transaction.h:69
An output of a transaction.
Definition: transaction.h:150
CScript scriptPubKey
Definition: transaction.h:153
A UTXO entry.
Definition: coins.h:33
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:130
Fast randomness source.
Definition: random.h:386
std::unordered_set< Element, ByteVectorHash > ElementSet
Definition: blockfilter.h:32
Different type to mark Mutex at global scope.
Definition: sync.h:135
Tp rand_uniform_delay(const Tp &time, typename Tp::duration range) noexcept
Return the time point advanced by a uniform random duration.
Definition: random.h:329
void push_back(UniValue val)
Definition: univalue.cpp:104
bool isArray() const
Definition: univalue.h:87
const UniValue & find_value(std::string_view key) const
Definition: univalue.cpp:233
@ VARR
Definition: univalue.h:24
size_t size() const
Definition: univalue.h:71
const std::vector< UniValue > & getValues() const
const UniValue & get_array() const
bool isObject() const
Definition: univalue.h:88
std::string ToString() const
Definition: uint256.cpp:21
Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to acce...
Definition: chain.h:130
virtual std::optional< int > getHeight()=0
Get current chain height, not including genesis block (returns 0 if chain only contains genesis block...
virtual uint256 getBlockHash(int height)=0
Get block hash. Height must be valid or this function will abort.
virtual bool findFirstBlockWithTimeAndHeight(int64_t min_time, int min_height, const FoundBlock &block={})=0
Find first block in the chain with timestamp >= the given time and height >= than the given height,...
virtual bool havePruned()=0
Check if any block has been pruned.
virtual bool updateRwSetting(const std::string &name, const SettingsUpdate &update_function)=0
Updates a setting in <datadir>/settings.json.
virtual bool hasAssumedValidChain()=0
Return true if an assumed-valid chain is in use.
virtual bool isInMempool(const Txid &txid)=0
Check if transaction is in mempool.
virtual bool findAncestorByHeight(const uint256 &block_hash, int ancestor_height, const FoundBlock &ancestor_out={})=0
Find ancestor of block at specified height and optionally return ancestor information.
virtual bool findBlock(const uint256 &hash, const FoundBlock &block={})=0
Return whether node has the block and optionally return block metadata or contents.
virtual double guessVerificationProgress(const uint256 &block_hash)=0
Estimate fraction of total transactions verified if blocks up to the specified block hash are verifie...
virtual void waitForNotificationsIfTipChanged(const uint256 &old_tip)=0
Wait for pending notifications to be processed unless block hash points to the current chain tip.
virtual void initMessage(const std::string &message)=0
Send init message.
virtual bool broadcastTransaction(const CTransactionRef &tx, const CAmount &max_tx_fee, bool relay, std::string &err_string)=0
Transaction is added to memory pool, if the transaction fee is below the amount specified by max_tx_f...
virtual std::optional< int > findLocatorFork(const CBlockLocator &locator)=0
Return height of the highest block on chain in common with the locator, which will either be the orig...
virtual bool haveBlockOnDisk(int height)=0
Check that the block is available on disk (i.e.
virtual CFeeRate relayMinFee()=0
Relay current minimum fee (from -minrelaytxfee and -incrementalrelayfee settings).
Helper for findBlock to selectively return pieces of block data.
Definition: chain.h:49
FoundBlock & locator(CBlockLocator &locator)
Return locator if block is in the active chain.
Definition: chain.h:59
FoundBlock & height(int &height)
Definition: chain.h:52
FoundBlock & data(CBlock &data)
Read block data from disk.
Definition: chain.h:64
std::string ToString() const
constexpr const std::byte * begin() const
std::string GetHex() const
256-bit opaque blob.
Definition: uint256.h:196
Encryption/decryption context with key information.
Definition: crypter.h:72
bool Decrypt(std::span< const unsigned char > ciphertext, CKeyingMaterial &plaintext) const
Definition: crypter.cpp:94
bool SetKeyFromPassphrase(const SecureString &key_data, std::span< const unsigned char > salt, const unsigned int rounds, const unsigned int derivation_method)
Definition: crypter.cpp:41
bool Encrypt(const CKeyingMaterial &vchPlaintext, std::vector< unsigned char > &vchCiphertext) const
Definition: crypter.cpp:76
Private key encryption is done based on a CMasterKey, which holds a salt and random encryption key.
Definition: crypter.h:35
std::vector< unsigned char > vchSalt
Definition: crypter.h:38
unsigned int nDerivationMethod
0 = EVP_sha512()
Definition: crypter.h:40
std::vector< unsigned char > vchCryptedKey
Definition: crypter.h:37
unsigned int nDeriveIterations
Definition: crypter.h:41
static constexpr unsigned int DEFAULT_DERIVE_ITERATIONS
Default/minimum number of key derivation rounds.
Definition: crypter.h:48
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
Definition: wallet.h:311
void MarkDestinationsDirty(const std::set< CTxDestination > &destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Marks all outputs in each one of the destinations dirty, so their cache is reset and does not return ...
Definition: wallet.cpp:2520
bool SetAddressBook(const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &purpose)
Definition: wallet.cpp:2408
std::atomic< bool > fAbortRescan
Definition: wallet.h:317
bool TopUpKeyPool(unsigned int kpSize=0)
Definition: wallet.cpp:2483
bool HaveChain() const
Interface to assert chain access.
Definition: wallet.h:496
bool GetBroadcastTransactions() const
Inquire whether this wallet broadcasts transactions.
Definition: wallet.h:860
bool IsCrypted() const
Definition: wallet.cpp:3282
unsigned int GetKeyPoolSize() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2472
std::function< bool(CWalletTx &wtx, bool new_tx)> UpdateWalletTxFn
Callback for updating transaction metadata in mapWallet.
Definition: wallet.h:622
CAmount m_default_max_tx_fee
Absolute maximum transaction fee (in satoshis) used by default for the wallet.
Definition: wallet.h:744
std::optional< WalletTXO > GetTXO(const COutPoint &outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:4466
bool IsActiveScriptPubKeyMan(const ScriptPubKeyMan &spkm) const
Definition: wallet.cpp:3342
OutputType m_default_address_type
Definition: wallet.h:735
void AddActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal)
Adds the active ScriptPubKeyMan for the specified type and internal.
Definition: wallet.cpp:3605
void LoadActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal)
Loads an active ScriptPubKeyMan for the specified type and internal.
Definition: wallet.cpp:3619
std::unique_ptr< WalletDatabase > m_database
Internal database handle.
Definition: wallet.h:400
bool IsLockedCoin(const COutPoint &output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2667
bool SignTransaction(CMutableTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Fetch the inputs and sign with SIGHASH_ALL.
Definition: wallet.cpp:2092
CWallet(interfaces::Chain *chain, const std::string &name, std::unique_ptr< WalletDatabase > database)
Construct wallet with specified name and database implementation.
Definition: wallet.h:478
std::function< void(const CTxDestination &dest, const std::string &label, bool is_change, const std::optional< AddressPurpose > purpose)> ListAddrBookFunc
Walk-through the address book entries.
Definition: wallet.h:777
std::unique_ptr< SigningProvider > GetSolvingProvider(const CScript &script) const
Get the SigningProvider for a script.
Definition: wallet.cpp:3395
bool IsTxImmatureCoinBase(const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3274
void RefreshAllTXOs() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Cache outputs that belong to the wallet for all transactions in the wallet.
Definition: wallet.cpp:4458
void AddActiveScriptPubKeyManWithDb(WalletBatch &batch, uint256 id, OutputType type, bool internal)
Definition: wallet.cpp:3611
DBErrors LoadWallet()
Definition: wallet.cpp:2293
std::set< ScriptPubKeyMan * > GetActiveScriptPubKeyMans() const
Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers.
Definition: wallet.cpp:3328
const CAddressBookData * FindAddressBookEntry(const CTxDestination &, bool allow_change=false) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3222
void postInitProcess()
Wallet post-init setup Gives the wallet a chance to register repetitive tasks and complete post-init ...
Definition: wallet.cpp:3232
int GetTxDepthInMainChain(const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Return depth of transaction in blockchain: <0 : conflicts with a transaction this deep in the blockch...
Definition: wallet.cpp:3248
std::optional< common::PSBTError > FillPSBT(PartiallySignedTransaction &psbtx, bool &complete, std::optional< int > sighash_type=std::nullopt, bool sign=true, bool bip32derivs=true, size_t *n_signed=nullptr, bool finalize=true) const
Fills out a PSBT with information from the wallet.
Definition: wallet.cpp:2126
unsigned int nMasterKeyMaxID
Definition: wallet.h:475
bool SetAddressReceiveRequest(WalletBatch &batch, const CTxDestination &dest, const std::string &id, const std::string &value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2796
int GetLastBlockHeight() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Get last block processed height.
Definition: wallet.h:976
std::atomic< double > m_scanning_progress
Definition: wallet.h:321
LegacyDataSPKM * GetLegacyDataSPKM() const
Get the LegacyScriptPubKeyMan which is used for all types, internal, and external.
Definition: wallet.cpp:3426
std::vector< CTxDestination > ListAddrBookAddresses(const std::optional< AddrBookFilter > &filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Filter and retrieve destinations stored in the addressbook.
Definition: wallet.cpp:2543
DescriptorScriptPubKeyMan * GetDescriptorScriptPubKeyMan(const WalletDescriptor &desc) const
Return the DescriptorScriptPubKeyMan for a WalletDescriptor if it is already in the wallet.
Definition: wallet.cpp:3656
std::map< OutputType, ScriptPubKeyMan * > m_external_spk_managers
Definition: wallet.h:418
DescriptorScriptPubKeyMan & LoadDescriptorScriptPubKeyMan(uint256 id, WalletDescriptor &desc)
Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it.
Definition: wallet.cpp:3496
std::optional< MigrationData > GetDescriptorsForLegacy(bilingual_str &error) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Get all of the descriptors from a legacy wallet.
Definition: wallet.cpp:3823
bool HaveCryptedKeys() const
Definition: wallet.cpp:3480
LegacyDataSPKM * GetOrCreateLegacyDataSPKM()
Definition: wallet.cpp:3446
interfaces::Chain & chain() const
Interface for accessing chain state.
Definition: wallet.h:522
const std::string & GetName() const
Get a name for this wallet for logging/debugging purposes.
Definition: wallet.h:471
bool Unlock(const CKeyingMaterial &vMasterKeyIn)
Definition: wallet.cpp:3313
bool MigrateToSQLite(bilingual_str &error) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Move all records from the BDB database to a new SQLite database for storage.
Definition: wallet.cpp:3749
bool BackupWallet(const std::string &strDest) const
Definition: wallet.cpp:3242
std::map< OutputType, ScriptPubKeyMan * > m_internal_spk_managers
Definition: wallet.h:419
std::string m_name
Wallet name: relative directory name or "" for default wallet.
Definition: wallet.h:397
bool SetAddressPreviouslySpent(WalletBatch &batch, const CTxDestination &dest, bool used) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2755
util::Result< void > RemoveTxs(std::vector< Txid > &txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Erases the provided transactions from the wallet.
Definition: wallet.cpp:2318
util::Result< CTxDestination > GetNewDestination(const OutputType type, const std::string label)
Definition: wallet.cpp:2493
RecursiveMutex m_relock_mutex
Definition: wallet.h:599
std::string m_notify_tx_changed_script
Notify external script when a wallet transaction comes in or is updated (handled by -walletnotify)
Definition: wallet.h:750
std::vector< std::string > GetAddressReceiveRequests() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2785
std::vector< WalletDescriptor > GetWalletDescriptors(const CScript &script) const
Get the wallet descriptors for a script.
Definition: wallet.cpp:3414
bool fBroadcastTransactions
Whether this wallet will submit newly created transactions to the node's mempool and prompt rebroadca...
Definition: wallet.h:328
size_t KeypoolCountExternalKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2460
int GetTxBlocksToMaturity(const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3262
void WalletLogPrintf(util::ConstevalFormatString< sizeof...(Params)> wallet_fmt, const Params &... params) const
Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.
Definition: wallet.h:936
bool HasEncryptionKeys() const override
Definition: wallet.cpp:3475
static std::shared_ptr< CWallet > Create(WalletContext &context, const std::string &name, std::unique_ptr< WalletDatabase > database, uint64_t wallet_creation_flags, bilingual_str &error, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:2843
bool CanGrindR() const
Whether the (external) signer performs R-value signature grinding.
Definition: wallet.cpp:4053
std::optional< bool > IsInternalScriptPubKeyMan(ScriptPubKeyMan *spk_man) const
Returns whether the provided ScriptPubKeyMan is internal.
Definition: wallet.cpp:3671
void LoadLockedCoin(const COutPoint &coin, bool persistent) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2623
TxItems wtxOrdered
Definition: wallet.h:503
SigningResult SignMessage(const std::string &message, const PKHash &pkhash, std::string &str_sig) const
Definition: wallet.cpp:2180
MasterKeyMap mapMasterKeys
Definition: wallet.h:474
boost::signals2::signal< void(const Txid &hashTx, ChangeType status)> NotifyTransactionChanged
Wallet transaction added, removed or updated.
Definition: wallet.h:845
util::Result< void > ApplyMigrationData(WalletBatch &local_wallet_batch, MigrationData &data) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Adds the ScriptPubKeyMans given in MigrationData to this wallet, removes LegacyScriptPubKeyMan,...
Definition: wallet.cpp:3842
NodeClock::time_point m_next_resend
The next scheduled rebroadcast of wallet transactions.
Definition: wallet.h:325
WalletDatabase & GetDatabase() const override
Definition: wallet.h:463
bool EraseAddressReceiveRequest(WalletBatch &batch, const CTxDestination &dest, const std::string &id) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2803
bool SetAddressBookWithDB(WalletBatch &batch, const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &strPurpose)
Definition: wallet.cpp:2372
void WriteBestBlock() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Write the current best block to database.
Definition: wallet.cpp:4429
boost::signals2::signal< void(const std::string &title, int nProgress)> ShowProgress
Show progress e.g.
Definition: wallet.h:848
bool DelAddressBookWithDB(WalletBatch &batch, const CTxDestination &address)
Definition: wallet.cpp:2421
std::string DisplayName() const
Return wallet name for display, like LogName() but translates "default wallet" string.
Definition: wallet.h:928
void LoadAddressReceiveRequest(const CTxDestination &dest, const std::string &id, const std::string &request) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Appends payment request to destination.
Definition: wallet.cpp:2774
void AddScriptPubKeyMan(const uint256 &id, std::unique_ptr< ScriptPubKeyMan > spkm_man)
Definition: wallet.cpp:3436
void DeactivateScriptPubKeyMan(uint256 id, OutputType type, bool internal)
Remove specified ScriptPubKeyMan from set of active SPK managers.
Definition: wallet.cpp:3639
std::atomic< uint64_t > m_wallet_flags
WalletFlags set on this wallet.
Definition: wallet.h:383
bool LockCoin(const COutPoint &output, bool persist) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2629
std::set< std::string > ListAddrBookLabels(const std::optional< AddressPurpose > purpose) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Retrieve all the known labels in the address book.
Definition: wallet.cpp:2559
bool IsLocked() const override
Definition: wallet.cpp:3287
OutputType TransactionChangeType(const std::optional< OutputType > &change_type, const std::vector< CRecipient > &vecSend) const
Definition: wallet.cpp:2193
boost::signals2::signal< void()> NotifyCanGetAddressesChanged
Keypool has new keys.
Definition: wallet.h:851
std::set< ScriptPubKeyMan * > GetAllScriptPubKeyMans() const
Returns all unique ScriptPubKeyMans.
Definition: wallet.cpp:3353
void RefreshTXOsFromTx(const CWalletTx &wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Cache outputs that belong to the wallet from a single transaction.
Definition: wallet.cpp:4444
unsigned int ComputeTimeSmart(const CWalletTx &wtx, bool rescanning_old_block) const
Compute smart timestamp for a transaction being added to the wallet.
Definition: wallet.cpp:2704
void ListLockedCoins(std::vector< COutPoint > &vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2673
void CommitTransaction(CTransactionRef tx, mapValue_t mapValue, std::vector< std::pair< std::string, std::string > > orderForm)
Submit the transaction to the node's mempool and then relay to peers.
Definition: wallet.cpp:2254
bool UnlockAllCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2655
util::Result< CTxDestination > GetNewChangeDestination(const OutputType type)
Definition: wallet.cpp:2509
ScriptPubKeyMan * GetScriptPubKeyMan(const OutputType &type, bool internal) const
Get the ScriptPubKeyMan for the given OutputType and internal/external chain.
Definition: wallet.cpp:3362
bool IsAddressPreviouslySpent(const CTxDestination &dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2779
bool WithEncryptionKey(std::function< bool(const CKeyingMaterial &)> cb) const override
Pass the encryption key to cb().
Definition: wallet.cpp:3469
uint256 GetLastBlockHash() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.h:982
int64_t m_keypool_size
Number of pre-generated keys/scripts by each spkm (part of the look-ahead process,...
Definition: wallet.h:747
RecursiveMutex cs_wallet
Main wallet lock.
Definition: wallet.h:461
void ForEachAddrBookEntry(const ListAddrBookFunc &func) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2534
void ConnectScriptPubKeyManNotifiers()
Connect the signals from ScriptPubKeyMans to the signals in CWallet.
Definition: wallet.cpp:3488
bool DelAddressBook(const CTxDestination &address)
Definition: wallet.cpp:2414
std::atomic< int64_t > m_best_block_time
Definition: wallet.h:330
std::unordered_map< CScript, std::vector< ScriptPubKeyMan * >, SaltedSipHasher > m_cached_spks
Cache of descriptor ScriptPubKeys used for IsMine. Maps ScriptPubKey to set of spkms.
Definition: wallet.h:436
void SetupLegacyScriptPubKeyMan()
Make a Legacy(Data)SPKM and set it for all types, internal, and external.
Definition: wallet.cpp:3452
static bool AttachChain(const std::shared_ptr< CWallet > &wallet, interfaces::Chain &chain, const bool rescan_required, bilingual_str &error, std::vector< bilingual_str > &warnings)
Catch wallet up to current chain, scanning new blocks, updating the best block locator and m_last_blo...
Definition: wallet.cpp:3102
boost::signals2::signal< void(const CTxDestination &address, const std::string &label, bool isMine, AddressPurpose purpose, ChangeType status)> NotifyAddressBookChanged
Address book entry changed.
Definition: wallet.h:839
std::multimap< int64_t, CWalletTx * > TxItems
Definition: wallet.h:502
void SetupOwnDescriptorScriptPubKeyMans(WalletBatch &batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Create new seed and default DescriptorScriptPubKeyMans for this wallet.
Definition: wallet.cpp:3538
boost::signals2::signal< void(CWallet *wallet)> NotifyStatusChanged
Wallet status (encrypted, locked) changed.
Definition: wallet.h:857
void SetupDescriptorScriptPubKeyMans() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3554
DescriptorScriptPubKeyMan & SetupDescriptorScriptPubKeyMan(WalletBatch &batch, const CExtKey &master_key, const OutputType &output_type, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Create new DescriptorScriptPubKeyMan and add it to the wallet.
Definition: wallet.cpp:3508
std::map< uint256, std::unique_ptr< ScriptPubKeyMan > > m_spk_managers
Definition: wallet.h:423
std::function< TxUpdate(CWalletTx &wtx)> TryUpdatingStateFn
Definition: wallet.h:369
bool UnlockCoin(const COutPoint &output) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2640
std::atomic< int64_t > m_birth_time
Definition: wallet.h:334
void LoadAddressPreviouslySpent(const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Marks destination as previously spent.
Definition: wallet.cpp:2769
util::Result< std::reference_wrapper< DescriptorScriptPubKeyMan > > AddWalletDescriptor(WalletDescriptor &desc, const FlatSigningProvider &signing_provider, const std::string &label, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Add a descriptor to the wallet, return a ScriptPubKeyMan & associated output type.
Definition: wallet.cpp:3690
std::set< ScriptPubKeyMan * > GetScriptPubKeyMans(const CScript &script) const
Get all the ScriptPubKeyMans for a script.
Definition: wallet.cpp:3372
util::Result< void > DisplayAddress(const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Display address on an external signer.
Definition: wallet.cpp:2608
A transaction with a bunch of additional info that only the owner cares about.
Definition: transaction.h:195
bool isBlockConflicted() const
Definition: transaction.h:363
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:367
const T * state() const
Definition: transaction.h:354
bool IsEquivalentTo(const CWalletTx &tx) const
True if only scriptSigs are different.
Definition: transaction.cpp:12
std::vector< std::pair< std::string, std::string > > vOrderForm
Definition: transaction.h:223
std::set< Txid > mempool_conflicts
Definition: transaction.h:278
mapValue_t mapValue
Key/value map with information about the transaction.
Definition: transaction.h:222
void updateState(interfaces::Chain &chain)
Update transaction state when attaching to a chain, filling in heights of conflicted and confirmed bl...
Definition: transaction.cpp:38
int64_t nOrderPos
position in ordered transaction list
Definition: transaction.h:237
bool isUnconfirmed() const
Definition: transaction.h:365
unsigned int nTimeReceived
time received by this node
Definition: transaction.h:224
CTransactionRef tx
Definition: transaction.h:269
void SetTx(CTransactionRef arg)
Definition: transaction.h:332
bool IsCoinBase() const
Definition: transaction.h:369
bool InMempool() const
Definition: transaction.cpp:27
bool isAbandoned() const
Definition: transaction.h:361
std::optional< Txid > truc_child_in_mempool
Definition: transaction.h:282
bool isInactive() const
Definition: transaction.h:364
int64_t GetTxTime() const
Definition: transaction.cpp:32
bool m_is_cache_empty
This flag is true if all m_amounts caches are empty.
Definition: transaction.h:249
std::multimap< int64_t, CWalletTx * >::const_iterator m_it_wtxOrdered
Definition: transaction.h:238
unsigned int nTimeSmart
Stable timestamp that never changes, and reflects the order a transaction was added to the wallet.
Definition: transaction.h:234
void MarkDirty()
make sure balances are recalculated
Definition: transaction.h:338
WalletDescriptor GetWalletDescriptor() const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man)
std::optional< CKey > GetKey(const CKeyID &keyid) const EXCLUSIVE_LOCKS_REQUIRED(cs_desc_man)
Retrieve the particular key if it is available. Returns nullopt if the key is not in the wallet,...
bool HasWalletDescriptor(const WalletDescriptor &desc) const
static util::Result< ExternalSigner > GetExternalSigner()
bool DeleteRecordsWithDB(WalletBatch &batch)
Delete all the records of this LegacyScriptPubKeyMan from disk.
std::optional< MigrationData > MigrateToDescriptor()
Get the DescriptorScriptPubKeyMans (with private keys) that have the same scriptPubKeys as this Legac...
uint256 GetID() const override
std::unordered_set< CScript, SaltedSipHasher > GetNotMineScriptPubKeys() const
Retrieves scripts that were imported by bugs into the legacy spkm and are simply invalid,...
A wrapper to reserve an address from a wallet.
Definition: wallet.h:199
const CWallet *const pwallet
The wallet to reserve from.
Definition: wallet.h:202
void KeepDestination()
Keep the address. Do not return its key to the keypool when this object goes out of scope.
Definition: wallet.cpp:2590
CTxDestination address
The destination.
Definition: wallet.h:209
bool fInternal
Whether this is from the internal (change output) keypool.
Definition: wallet.h:211
void ReturnDestination()
Return reserved address.
Definition: wallet.cpp:2599
ScriptPubKeyMan * m_spk_man
The ScriptPubKeyMan to reserve from. Based on type when GetReservedDestination is called.
Definition: wallet.h:204
int64_t nIndex
The index of the address's key in the keypool.
Definition: wallet.h:207
OutputType const type
Definition: wallet.h:205
util::Result< CTxDestination > GetReservedDestination(bool internal)
Reserve an address.
Definition: wallet.cpp:2573
virtual void KeepDestination(int64_t index, const OutputType &type)
virtual void ReturnDestination(int64_t index, bool internal, const CTxDestination &addr)
virtual util::Result< CTxDestination > GetReservedDestination(const OutputType type, bool internal, int64_t &index)
Access to the wallet database.
Definition: walletdb.h:190
bool TxnAbort()
Abort current transaction.
Definition: walletdb.cpp:1285
bool EraseName(const std::string &strAddress)
Definition: walletdb.cpp:75
DBErrors LoadWallet(CWallet *pwallet)
Definition: walletdb.cpp:1109
bool WriteBestBlock(const CBlockLocator &locator)
Definition: walletdb.cpp:174
void RegisterTxnListener(const DbTxnListener &l)
Registers db txn callback functions.
Definition: walletdb.cpp:1298
bool ReadBestBlock(CBlockLocator &locator)
Definition: walletdb.cpp:180
bool WriteMasterKey(unsigned int nID, const CMasterKey &kMasterKey)
Definition: walletdb.cpp:148
bool TxnBegin()
Begin a new transaction.
Definition: walletdb.cpp:1267
bool WriteAddressPreviouslySpent(const CTxDestination &dest, bool previously_spent)
Definition: walletdb.cpp:1232
bool EraseAddressReceiveRequest(const CTxDestination &dest, const std::string &id)
Definition: walletdb.cpp:1243
bool TxnCommit()
Commit current transaction.
Definition: walletdb.cpp:1272
bool WriteName(const std::string &strAddress, const std::string &strName)
Definition: walletdb.cpp:70
bool WritePurpose(const std::string &strAddress, const std::string &purpose)
Definition: walletdb.cpp:82
bool WriteWalletFlags(const uint64_t flags)
Definition: walletdb.cpp:1255
bool EraseAddressData(const CTxDestination &dest)
Definition: walletdb.cpp:1248
bool WriteOrderPosNext(int64_t nOrderPosNext)
Definition: walletdb.cpp:197
bool WriteTx(const CWalletTx &wtx)
Definition: walletdb.cpp:92
bool ErasePurpose(const std::string &strAddress)
Definition: walletdb.cpp:87
bool EraseLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:287
bool WriteLockedUTXO(const COutPoint &output)
Definition: walletdb.cpp:282
bool WriteActiveScriptPubKeyMan(uint8_t type, const uint256 &id, bool internal)
Definition: walletdb.cpp:202
bool EraseTx(Txid hash)
Definition: walletdb.cpp:97
bool EraseActiveScriptPubKeyMan(uint8_t type, bool internal)
Definition: walletdb.cpp:208
bool WriteAddressReceiveRequest(const CTxDestination &dest, const std::string &id, const std::string &receive_request)
Definition: walletdb.cpp:1238
virtual void Close()=0
Flush to the database file and close the database.
virtual bool Backup(const std::string &strDest) const =0
Back up the entire database to a file.
virtual bool Rewrite()=0
Rewrite the entire database on disk.
Descriptor with some wallet metadata.
Definition: walletutil.h:64
std::shared_ptr< Descriptor > descriptor
Definition: walletutil.h:66
RAII object to check and reserve a wallet rescan.
Definition: wallet.h:1075
Clock::time_point now() const
Definition: wallet.h:1103
bool reserve(bool with_passphrase=false)
Definition: wallet.h:1085
void memory_cleanse(void *ptr, size_t len)
Secure overwrite a buffer (possibly containing secret data) with zero-bytes.
Definition: cleanse.cpp:14
static UniValue Parse(std::string_view raw)
Parse string to UniValue or throw runtime_error if string contains invalid JSON.
Definition: client.cpp:321
std::string ShellEscape(const std::string &arg)
Definition: system.cpp:37
static const int COINBASE_MATURITY
Coinbase transaction outputs can only be spent after this number of new blocks (network rule)
Definition: consensus.h:19
static path u8path(const std::string &utf8_str)
Definition: fs.h:75
static auto quoted(const std::string &s)
Definition: fs.h:95
static bool exists(const path &p)
Definition: fs.h:89
static bool copy_file(const path &from, const path &to, copy_options options)
Definition: fs.h:128
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:151
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:174
bool TryCreateDirectories(const fs::path &p)
Ignores exceptions thrown by create_directories if the requested directory exists.
Definition: fs_helpers.cpp:255
bool IsSpentKey(const CScript &scriptPubKey) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:966
int64_t IncOrderPosNext(WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Increment the next transaction order id.
Definition: wallet.cpp:894
void RecursiveUpdateTxState(const Txid &tx_hash, const TryUpdatingStateFn &try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Mark a transaction (and its in-wallet descendants) as a particular tx state.
Definition: wallet.cpp:1312
void MarkInputsDirty(const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Mark a transaction's inputs dirty, thus forcing the outputs to be recomputed.
Definition: wallet.cpp:1234
bool HasWalletSpend(const CTransactionRef &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Check if a given transaction has any of its outputs spent by another transaction in the wallet.
Definition: wallet.cpp:666
bool ChangeWalletPassphrase(const SecureString &strOldWalletPassphrase, const SecureString &strNewWalletPassphrase)
Definition: wallet.cpp:595
bool AbandonTransaction(const Txid &hashTx)
Definition: wallet.cpp:1244
void SyncMetaData(std::pair< TxSpends::iterator, TxSpends::iterator >) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:683
void SetWalletFlagWithDB(WalletBatch &batch, uint64_t flags)
Store wallet flags.
Definition: wallet.cpp:1686
static bool EncryptMasterKey(const SecureString &wallet_passphrase, const CKeyingMaterial &plain_master_key, CMasterKey &master_key)
Definition: wallet.cpp:534
uint64_t GetWalletFlags() const
Retrieve all of the wallet's flags.
Definition: wallet.cpp:1746
void updatedBlockTip() override
Definition: wallet.cpp:1556
bool TransactionCanBeAbandoned(const Txid &hashTx) const
Return whether transaction can be abandoned.
Definition: wallet.cpp:1210
void BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(void SetWalletFlag(uint64_t flags)
Blocks until the wallet state is up-to-date to /at least/ the current chain at the time this function...
Definition: wallet.cpp:1680
void blockConnected(ChainstateRole role, const interfaces::BlockInfo &block) override
Definition: wallet.cpp:1480
void MaybeUpdateBirthTime(int64_t time)
Updates wallet birth time if 'time' is below it.
Definition: wallet.cpp:1751
void blockDisconnected(const interfaces::BlockInfo &block) override
Definition: wallet.cpp:1509
std::set< Txid > GetConflicts(const Txid &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Get wallet transactions that conflict with given transaction (spend same outputs)
Definition: wallet.cpp:643
bool IsWalletFlagSet(uint64_t flag) const override
check if a certain wallet flag is set
Definition: wallet.cpp:1713
static bool DecryptMasterKey(const SecureString &wallet_passphrase, const CMasterKey &master_key, CKeyingMaterial &plain_master_key)
Definition: wallet.cpp:561
void AddToSpends(const COutPoint &outpoint, const Txid &txid) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:741
void SetLastBlockProcessedInMem(int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:627
void UnsetWalletFlagWithDB(WalletBatch &batch, uint64_t flag)
Unsets a wallet flag and saves it to disk.
Definition: wallet.cpp:1700
bool IsSpent(const COutPoint &outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Outpoint is spent if any non-conflicted transaction spends it:
Definition: wallet.cpp:724
std::set< Txid > GetTxConflicts(const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:1992
void UnsetBlankWalletFlag(WalletBatch &batch) override
Unset the blank wallet flag and saves it to disk.
Definition: wallet.cpp:1708
void ResubmitWalletTransactions(bool relay, bool force)
Definition: wallet.cpp:2045
CWalletTx * AddToWallet(CTransactionRef tx, const TxState &state, const UpdateWalletTxFn &update_wtx=nullptr, bool rescanning_old_block=false)
Add the transaction to the wallet, wrapping it up inside a CWalletTx.
Definition: wallet.cpp:979
bool MarkReplaced(const Txid &originalHash, const Txid &newHash)
Mark a transaction as replaced by another transaction.
Definition: wallet.cpp:915
bool CanGetAddresses(bool internal=false) const
Definition: wallet.cpp:1667
void MarkDirty()
Definition: wallet.cpp:906
void UpdateTrucSiblingConflicts(const CWalletTx &parent_wtx, const Txid &child_txid, bool add_conflict) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Update mempool conflicts for TRUC sibling transactions.
Definition: wallet.cpp:1217
ScanResult ScanForWalletTransactions(const uint256 &start_block, int start_height, std::optional< int > max_height, const WalletRescanReserver &reserver, bool fUpdate, const bool save_progress)
Scan the block chain (starting in start_block) for transactions from or to us.
Definition: wallet.cpp:1811
bool LoadWalletFlags(uint64_t flags)
Loads the flags into the wallet.
Definition: wallet.cpp:1718
bool IsHDEnabled() const
Definition: wallet.cpp:1656
void transactionRemovedFromMempool(const CTransactionRef &tx, MemPoolRemovalReason reason) override
Definition: wallet.cpp:1411
static NodeClock::time_point GetDefaultNextResend()
Definition: wallet.cpp:2019
bool ShouldResend() const
Return true if all conditions for periodically resending transactions are met.
Definition: wallet.cpp:2002
const CWalletTx * GetWalletTx(const Txid &hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:510
void InitWalletFlags(uint64_t flags)
overwrite all flags by the given uint64_t flags must be uninitialised (or 0) only known flags may be ...
Definition: wallet.cpp:1730
bool SyncTransaction(const CTransactionRef &tx, const SyncTxState &state, bool update_tx=true, bool rescanning_old_block=false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:1356
void UnsetWalletFlag(uint64_t flag)
Unsets a single wallet flag.
Definition: wallet.cpp:1694
bool EncryptWallet(const SecureString &strWalletPassphrase)
Definition: wallet.cpp:762
void SetLastBlockProcessed(int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Set last block processed height, and write to database.
Definition: wallet.cpp:635
bool LoadToWallet(const Txid &hash, const UpdateWalletTxFn &fill_wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:1110
int64_t RescanFromTime(int64_t startTime, const WalletRescanReserver &reserver, bool update)
Scan active chain for relevant transactions after importing keys.
Definition: wallet.cpp:1767
bool IsFromMe(const CTransaction &tx) const
should probably be renamed to IsRelevantToMe
Definition: wallet.cpp:1635
DBErrors ReorderTransactions()
Definition: wallet.cpp:837
bool AddToWalletIfInvolvingMe(const CTransactionRef &tx, const SyncTxState &state, bool fUpdate, bool rescanning_old_block) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Add a transaction to the wallet, or update it.
Definition: wallet.cpp:1144
bool IsMine(const CTxDestination &dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:1589
void UpgradeDescriptorCache() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Upgrade DescriptorCaches.
Definition: wallet.cpp:519
void SetSpentKeyState(WalletBatch &batch, const Txid &hash, unsigned int n, bool used, std::set< CTxDestination > &tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:947
CAmount GetDebit(const CTxIn &txin) const
Returns amount of debit, i.e.
Definition: wallet.cpp:1573
void MarkConflicted(const uint256 &hashBlock, int conflicting_height, const Txid &hashTx)
Mark a transaction (and its in-wallet descendants) as conflicting with a particular block.
Definition: wallet.cpp:1282
void transactionAddedToMempool(const CTransactionRef &tx) override
Definition: wallet.cpp:1368
void Close()
Close wallet database.
Definition: wallet.cpp:678
bool SubmitTxMemoryPoolAndRelay(CWalletTx &wtx, std::string &err_string, bool relay) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Pass this transaction to node for mempool insertion and relay to peers if flag set to true.
Definition: wallet.cpp:1962
@ SIGHASH_DEFAULT
Taproot only; implied when sighash byte is missing, and equivalent to SIGHASH_ALL.
Definition: interpreter.h:35
ChainstateRole
This enum describes the various roles a specific Chainstate instance can take.
Definition: chain.h:25
CKey GenerateRandomKey(bool compressed) noexcept
Definition: key.cpp:352
std::string EncodeDestination(const CTxDestination &dest)
Definition: key_io.cpp:294
#define LogDebug(category,...)
Definition: logging.h:381
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
@ BLOCK
Removed for block.
@ CONFLICT
Removed for conflict with in-block transaction.
is a home for simple string functions returning descriptive messages that are used in RPC and GUI int...
std::optional< CAmount > ParseMoney(const std::string &money_string)
Parse an amount denoted in full coins.
Definition: moneystr.cpp:45
static int sign(const secp256k1_context *ctx, struct signer_secrets *signer_secrets, struct signer *signer, const secp256k1_musig_keyagg_cache *cache, const unsigned char *msg32, unsigned char *sig64)
Definition: musig.c:106
@ SCAN
Definition: logging.h:95
PSBTError
Definition: types.h:17
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:107
bilingual_str AmountErrMsg(const std::string &optname, const std::string &strValue)
Definition: messages.cpp:167
bilingual_str AmountHighWarn(const std::string &optname)
Definition: messages.cpp:162
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
Definition: fs.cpp:36
std::unique_ptr< Handler > MakeCleanupHandler(std::function< void()> cleanup)
Return handler wrapping a cleanup function.
Definition: interfaces.cpp:42
std::unique_ptr< Wallet > MakeWallet(wallet::WalletContext &context, const std::shared_ptr< wallet::CWallet > &wallet)
Return implementation of Wallet interface.
Definition: interfaces.cpp:677
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
std::string_view RemoveSuffixView(std::string_view str, std::string_view suffix)
Definition: string.h:173
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:245
void ReplaceAll(std::string &in_out, const std::string &search, const std::string &substitute)
Definition: string.cpp:11
constexpr CAmount HIGH_APS_FEE
discourage APS fee higher than this amount
Definition: wallet.h:123
void ReadDatabaseArgs(const ArgsManager &args, DatabaseOptions &options)
Definition: db.cpp:153
std::shared_ptr< CWallet > LoadWallet(WalletContext &context, const std::string &name, std::optional< bool > load_on_start, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:363
static std::set< std::string > g_loading_wallet_set GUARDED_BY(g_loading_wallet_mutex)
std::unique_ptr< WalletDatabase > MakeDatabase(const fs::path &path, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error)
Definition: walletdb.cpp:1304
void MaybeResendWalletTxs(WalletContext &context)
Called periodically by the schedule thread.
Definition: wallet.cpp:2082
std::variant< TxStateConfirmed, TxStateInMempool, TxStateInactive > SyncTxState
Subset of states transaction sync logic is implemented to handle.
Definition: transaction.h:82
std::function< void(std::unique_ptr< interfaces::Wallet > wallet)> LoadWalletFn
Definition: context.h:24
std::vector< std::shared_ptr< CWallet > > GetWallets(WalletContext &context)
Definition: wallet.cpp:193
static bool RunWithinTxn(WalletBatch &batch, std::string_view process_desc, const std::function< bool(WalletBatch &)> &func)
Definition: walletdb.cpp:1203
std::variant< TxStateConfirmed, TxStateInMempool, TxStateBlockConflicted, TxStateInactive, TxStateUnrecognized > TxState
All possible CWalletTx states.
Definition: transaction.h:79
std::map< std::string, std::string > mapValue_t
Definition: transaction.h:167
std::vector< unsigned char, secure_allocator< unsigned char > > CKeyingMaterial
Definition: crypter.h:63
DBErrors
Overview of wallet database classes:
Definition: walletdb.h:41
@ EXTERNAL_SIGNER_SUPPORT_REQUIRED
util::Result< MigrationResult > MigrateLegacyToDescriptor(std::shared_ptr< CWallet > local_wallet, const SecureString &passphrase, WalletContext &context)
Requirement: The wallet provided to this function must be isolated, with no attachment to the node's ...
Definition: wallet.cpp:4220
static int TxStateSerializedIndex(const TxState &state)
Get TxState serialized block index. Inverse of TxStateInterpretSerialized.
Definition: transaction.h:112
bool AddWalletSetting(interfaces::Chain &chain, const std::string &wallet_name)
Add wallet name to persistent configuration so it will be loaded on startup.
Definition: wallet.cpp:95
static GlobalMutex g_wallet_release_mutex
Definition: wallet.cpp:231
bool RemoveWalletSetting(interfaces::Chain &chain, const std::string &wallet_name)
Remove wallet name from persistent configuration so it will not be loaded on startup.
Definition: wallet.cpp:108
const unsigned int WALLET_CRYPTO_KEY_SIZE
Definition: crypter.h:14
std::shared_ptr< CWallet > RestoreWallet(WalletContext &context, const fs::path &backup_file, const std::string &wallet_name, std::optional< bool > load_on_start, DatabaseStatus &status, bilingual_str &error, std::vector< bilingual_str > &warnings, bool load_after_restore)
Definition: wallet.cpp:463
static void RefreshMempoolStatus(CWalletTx &tx, interfaces::Chain &chain)
Refresh mempool status so the wallet is in an internally consistent state and immediately knows the t...
Definition: wallet.cpp:141
static const bool DEFAULT_WALLETCROSSCHAIN
Definition: wallet.h:136
std::unique_ptr< interfaces::Handler > HandleLoadWallet(WalletContext &context, LoadWalletFn load_wallet)
Definition: wallet.cpp:215
bool RemoveWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet, std::optional< bool > load_on_start)
Definition: wallet.cpp:187
bool HasLegacyRecords(CWallet &wallet)
Returns true if there are any DBKeys::LEGACY_TYPES record in the wallet db.
Definition: walletdb.cpp:509
fs::path GetWalletDir()
Get the path of the wallet directory.
Definition: walletutil.cpp:13
static const unsigned int DEFAULT_KEYPOOL_SIZE
Default for -keypool.
static const std::unordered_set< OutputType > LEGACY_OUTPUT_TYPES
OutputTypes supported by the LegacyScriptPubKeyMan.
static const bool DEFAULT_WALLET_RBF
-walletrbf default
Definition: wallet.h:133
constexpr CAmount HIGH_TX_FEE_PER_KB
Discourage users to set fees higher than this amount (in satoshis) per kB.
Definition: wallet.h:140
static std::condition_variable g_wallet_release_cv
Definition: wallet.cpp:232
std::unique_ptr< WalletDatabase > MakeWalletDatabase(const std::string &name, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error_string)
Definition: wallet.cpp:2832
bool IsBDBFile(const fs::path &path)
Definition: db.cpp:94
void NotifyWalletLoaded(WalletContext &context, const std::shared_ptr< CWallet > &wallet)
Definition: wallet.cpp:222
fs::path BDBDataFile(const fs::path &wallet_path)
Definition: db.cpp:75
constexpr CAmount HIGH_MAX_TX_FEE
-maxtxfee will warn if called with a higher fee than this amount (in satoshis)
Definition: wallet.h:142
static const unsigned int DEFAULT_TX_CONFIRM_TARGET
-txconfirmtarget default
Definition: wallet.h:131
std::string PurposeToString(AddressPurpose p)
Definition: wallet.h:281
static const bool DEFAULT_WALLETBROADCAST
Definition: wallet.h:134
bool AddWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet)
Definition: wallet.cpp:150
bool DoMigration(CWallet &wallet, WalletContext &context, bilingual_str &error, MigrationResult &res) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
Definition: wallet.cpp:4058
static uint256 TxStateSerializedBlockHash(const TxState &state)
Get TxState serialized block hash. Inverse of TxStateInterpretSerialized.
Definition: transaction.h:100
static constexpr uint64_t KNOWN_WALLET_FLAGS
Definition: wallet.h:151
static void UpdateWalletSetting(interfaces::Chain &chain, const std::string &wallet_name, std::optional< bool > load_on_startup, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:123
static GlobalMutex g_loading_wallet_mutex
Definition: wallet.cpp:230
const unsigned int WALLET_CRYPTO_SALT_SIZE
Definition: crypter.h:15
std::shared_ptr< CWallet > CreateWallet(WalletContext &context, const std::string &name, std::optional< bool > load_on_start, DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:376
static void FlushAndDeleteWallet(CWallet *wallet)
Definition: wallet.cpp:237
@ WALLET_FLAG_EXTERNAL_SIGNER
Indicates that the wallet needs an external signer.
Definition: walletutil.h:56
@ WALLET_FLAG_LAST_HARDENED_XPUB_CACHED
Definition: walletutil.h:27
@ WALLET_FLAG_KEY_ORIGIN_METADATA
Definition: walletutil.h:24
@ WALLET_FLAG_AVOID_REUSE
Definition: walletutil.h:21
@ WALLET_FLAG_DESCRIPTORS
Indicate that this wallet supports DescriptorScriptPubKeyMan.
Definition: walletutil.h:53
@ WALLET_FLAG_DISABLE_PRIVATE_KEYS
Definition: walletutil.h:30
@ WALLET_FLAG_BLANK_WALLET
Flag set when a wallet contains no HD seed and no private keys, scripts, addresses,...
Definition: walletutil.h:50
void WaitForDeleteWallet(std::shared_ptr< CWallet > &&wallet)
Explicitly delete the wallet.
Definition: wallet.cpp:253
std::string TxStateString(const T &state)
Return TxState or SyncTxState as a string for logging or debugging.
Definition: transaction.h:125
std::shared_ptr< CWallet > GetWallet(WalletContext &context, const std::string &name)
Definition: wallet.cpp:206
static const bool DEFAULT_SPEND_ZEROCONF_CHANGE
Default for -spendzeroconfchange.
Definition: wallet.h:127
static util::Result< fs::path > GetWalletPath(const std::string &name)
Definition: wallet.cpp:2810
DatabaseStatus
Definition: db.h:186
bool RemoveWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet, std::optional< bool > load_on_start, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:162
std::shared_ptr< CWallet > GetDefaultWallet(WalletContext &context, size_t &count)
Definition: wallet.cpp:199
is a home for public enum and struct type definitions that are used internally by node code,...
std::optional< OutputType > ParseOutputType(const std::string &type)
Definition: outputtype.cpp:23
const std::string & FormatOutputType(OutputType type)
Definition: outputtype.cpp:37
OutputType
Definition: outputtype.h:17
static constexpr auto OUTPUT_TYPES
Definition: outputtype.h:25
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:424
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
bool PSBTInputSignedAndVerified(const PartiallySignedTransaction psbt, unsigned int input_index, const PrecomputedTransactionData *txdata)
Checks whether a PSBTInput is already signed by doing script verification using final fields.
Definition: psbt.cpp:301
void RemoveUnnecessaryTransactions(PartiallySignedTransaction &psbtx)
Reduces the size of the PSBT by dropping unnecessary non_witness_utxos (i.e.
Definition: psbt.cpp:490
bool PSBTInputSigned(const PSBTInput &input)
Checks whether a PSBTInput is already signed by checking for non-null finalized fields.
Definition: psbt.cpp:296
PrecomputedTransactionData PrecomputePSBTData(const PartiallySignedTransaction &psbt)
Compute a PrecomputedTransactionData object from a psbt.
Definition: psbt.cpp:361
void GetStrongRandBytes(std::span< unsigned char > bytes) noexcept
Gather entropy from various sources, feed it into the internal PRNG, and generate random data using i...
Definition: random.cpp:607
const char * name
Definition: rest.cpp:50
static const int64_t values[]
A selection of numbers that do not trigger int64_t overflow when added/subtracted.
std::basic_string< char, std::char_traits< char >, secure_allocator< char > > SecureString
Definition: secure.h:58
SigningResult
Definition: signmessage.h:43
@ PRIVATE_KEY_NOT_AVAILABLE
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
std::vector< uint256 > vHave
Definition: block.h:134
bool IsNull() const
Definition: block.h:152
Definition: key.h:227
void SetSeed(std::span< const std::byte > seed)
Definition: key.cpp:368
A mutable version of CTransaction.
Definition: transaction.h:378
std::vector< CTxIn > vin
Definition: transaction.h:379
std::map< CKeyID, CKey > keys
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:26
std::chrono::time_point< NodeClock > time_point
Definition: time.h:19
A structure for PSBTs which contain per-input information.
Definition: psbt.h:248
CTransactionRef non_witness_utxo
Definition: psbt.h:249
A version of CTransaction with the PSBT format.
Definition: psbt.h:1119
std::vector< PSBTInput > inputs
Definition: psbt.h:1124
std::optional< CMutableTransaction > tx
Definition: psbt.h:1120
Bilingual messages:
Definition: translation.h:24
bool empty() const
Definition: translation.h:35
Block data sent with blockConnected, blockDisconnected notifications.
Definition: chain.h:79
const uint256 * prev_hash
Definition: chain.h:81
const CBlock * data
Definition: chain.h:85
const uint256 & hash
Definition: chain.h:80
unsigned int chain_time_max
Definition: chain.h:89
Definition: musig.c:31
Address book data.
Definition: wallet.h:240
std::optional< AddressPurpose > purpose
Address purpose which was originally recorded for payment protocol support but now serves as a cached...
Definition: wallet.h:255
void SetLabel(std::string name)
Definition: wallet.h:278
std::optional< std::string > m_op_label
Definition: wallet.h:758
std::optional< int > last_scanned_height
Definition: wallet.h:643
enum wallet::CWallet::ScanResult::@19 status
uint256 last_scanned_block
Hash and height of most recent block that was successfully scanned.
Definition: wallet.h:642
uint256 last_failed_block
Height of the most recent block that could not be scanned due to read errors or pruning.
Definition: wallet.h:649
bool require_existing
Definition: db.h:173
SecureString create_passphrase
Definition: db.h:177
std::optional< DatabaseFormat > require_format
Definition: db.h:175
uint64_t create_flags
Definition: db.h:176
struct containing information needed for migrating legacy wallets to descriptor wallets
std::shared_ptr< CWallet > watchonly_wallet
Definition: wallet.h:1125
std::string wallet_name
Definition: wallet.h:1123
std::shared_ptr< CWallet > solvables_wallet
Definition: wallet.h:1126
std::shared_ptr< CWallet > wallet
Definition: wallet.h:1124
State of rejected transaction that conflicts with a confirmed block.
Definition: transaction.h:47
State of transaction confirmed in a block.
Definition: transaction.h:32
State of transaction added to mempool.
Definition: transaction.h:42
State of transaction not confirmed or conflicting with a known block and not in the mempool.
Definition: transaction.h:59
WalletContext struct containing references to state shared between CWallet instances,...
Definition: context.h:36
interfaces::Chain * chain
Definition: context.h:37
ArgsManager * args
Definition: context.h:39
#define WAIT_LOCK(cs, name)
Definition: sync.h:265
#define AssertLockNotHeld(cs)
Definition: sync.h:142
#define LOCK2(cs1, cs2)
Definition: sync.h:260
#define LOCK(cs)
Definition: sync.h:259
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:290
static int count
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:51
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
consteval auto _(util::TranslatedLiteral str)
Definition: translation.h:79
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:82
static constexpr decltype(CTransaction::version) TRUC_VERSION
Definition: truc_policy.h:20
@ CT_UPDATED
@ CT_DELETED
@ CT_NEW
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition: time.cpp:77
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
Definition: time.h:88
AssertLockHeld(pool.cs)
assert(!tx.IsCoinBase())
is a home for public enum and struct type definitions that are used by internally by wallet code,...
GCSFilter::ElementSet m_filter_set
Definition: wallet.cpp:352
std::map< uint256, int32_t > m_last_range_ends
Map for keeping track of each range descriptor's last seen end range.
Definition: wallet.cpp:351
const CWallet & m_wallet
Definition: wallet.cpp:344
std::vector< std::byte, zero_after_free_allocator< std::byte > > SerializeData
Byte-vector that clears its contents before deletion.
Definition: zeroafterfree.h:49