Bitcoin Core 29.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 return (GetDebit(tx) > 0);
1638}
1639
1641{
1642 CAmount nDebit = 0;
1643 for (const CTxIn& txin : tx.vin)
1644 {
1645 nDebit += GetDebit(txin);
1646 if (!MoneyRange(nDebit))
1647 throw std::runtime_error(std::string(__func__) + ": value out of range");
1648 }
1649 return nDebit;
1650}
1651
1653{
1654 // All Active ScriptPubKeyMans must be HD for this to be true
1655 bool result = false;
1656 for (const auto& spk_man : GetActiveScriptPubKeyMans()) {
1657 if (!spk_man->IsHDEnabled()) return false;
1658 result = true;
1659 }
1660 return result;
1661}
1662
1663bool CWallet::CanGetAddresses(bool internal) const
1664{
1665 LOCK(cs_wallet);
1666 if (m_spk_managers.empty()) return false;
1667 for (OutputType t : OUTPUT_TYPES) {
1668 auto spk_man = GetScriptPubKeyMan(t, internal);
1669 if (spk_man && spk_man->CanGetAddresses(internal)) {
1670 return true;
1671 }
1672 }
1673 return false;
1674}
1675
1677{
1678 WalletBatch batch(GetDatabase());
1679 return SetWalletFlagWithDB(batch, flags);
1680}
1681
1683{
1684 LOCK(cs_wallet);
1686 if (!batch.WriteWalletFlags(m_wallet_flags))
1687 throw std::runtime_error(std::string(__func__) + ": writing wallet flags failed");
1688}
1689
1690void CWallet::UnsetWalletFlag(uint64_t flag)
1691{
1692 WalletBatch batch(GetDatabase());
1693 UnsetWalletFlagWithDB(batch, flag);
1694}
1695
1697{
1698 LOCK(cs_wallet);
1699 m_wallet_flags &= ~flag;
1700 if (!batch.WriteWalletFlags(m_wallet_flags))
1701 throw std::runtime_error(std::string(__func__) + ": writing wallet flags failed");
1702}
1703
1705{
1707}
1708
1709bool CWallet::IsWalletFlagSet(uint64_t flag) const
1710{
1711 return (m_wallet_flags & flag);
1712}
1713
1715{
1716 LOCK(cs_wallet);
1717 if (((flags & KNOWN_WALLET_FLAGS) >> 32) ^ (flags >> 32)) {
1718 // contains unknown non-tolerable wallet flags
1719 return false;
1720 }
1722
1723 return true;
1724}
1725
1727{
1728 LOCK(cs_wallet);
1729
1730 // We should never be writing unknown non-tolerable wallet flags
1731 assert(((flags & KNOWN_WALLET_FLAGS) >> 32) == (flags >> 32));
1732 // This should only be used once, when creating a new wallet - so current flags are expected to be blank
1733 assert(m_wallet_flags == 0);
1734
1735 if (!WalletBatch(GetDatabase()).WriteWalletFlags(flags)) {
1736 throw std::runtime_error(std::string(__func__) + ": writing wallet flags failed");
1737 }
1738
1739 if (!LoadWalletFlags(flags)) assert(false);
1740}
1741
1743{
1744 return m_wallet_flags;
1745}
1746
1748{
1749 int64_t birthtime = m_birth_time.load();
1750 if (time < birthtime) {
1751 m_birth_time = time;
1752 }
1753}
1754
1763int64_t CWallet::RescanFromTime(int64_t startTime, const WalletRescanReserver& reserver, bool update)
1764{
1765 // Find starting block. May be null if nCreateTime is greater than the
1766 // highest blockchain timestamp, in which case there is nothing that needs
1767 // to be scanned.
1768 int start_height = 0;
1769 uint256 start_block;
1770 bool start = chain().findFirstBlockWithTimeAndHeight(startTime - TIMESTAMP_WINDOW, 0, FoundBlock().hash(start_block).height(start_height));
1771 WalletLogPrintf("%s: Rescanning last %i blocks\n", __func__, start ? WITH_LOCK(cs_wallet, return GetLastBlockHeight()) - start_height + 1 : 0);
1772
1773 if (start) {
1774 // TODO: this should take into account failure by ScanResult::USER_ABORT
1775 ScanResult result = ScanForWalletTransactions(start_block, start_height, /*max_height=*/{}, reserver, /*fUpdate=*/update, /*save_progress=*/false);
1776 if (result.status == ScanResult::FAILURE) {
1777 int64_t time_max;
1778 CHECK_NONFATAL(chain().findBlock(result.last_failed_block, FoundBlock().maxTime(time_max)));
1779 return time_max + TIMESTAMP_WINDOW + 1;
1780 }
1781 }
1782 return startTime;
1783}
1784
1807CWallet::ScanResult CWallet::ScanForWalletTransactions(const uint256& start_block, int start_height, std::optional<int> max_height, const WalletRescanReserver& reserver, bool fUpdate, const bool save_progress)
1808{
1809 constexpr auto INTERVAL_TIME{60s};
1810 auto current_time{reserver.now()};
1811 auto start_time{reserver.now()};
1812
1813 assert(reserver.isReserved());
1814
1815 uint256 block_hash = start_block;
1816 ScanResult result;
1817
1818 std::unique_ptr<FastWalletRescanFilter> fast_rescan_filter;
1819 if (chain().hasBlockFilterIndex(BlockFilterType::BASIC)) fast_rescan_filter = std::make_unique<FastWalletRescanFilter>(*this);
1820
1821 WalletLogPrintf("Rescan started from block %s... (%s)\n", start_block.ToString(),
1822 fast_rescan_filter ? "fast variant using block filters" : "slow variant inspecting all blocks");
1823
1824 fAbortRescan = false;
1825 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)
1826 uint256 tip_hash = WITH_LOCK(cs_wallet, return GetLastBlockHash());
1827 uint256 end_hash = tip_hash;
1828 if (max_height) chain().findAncestorByHeight(tip_hash, *max_height, FoundBlock().hash(end_hash));
1829 double progress_begin = chain().guessVerificationProgress(block_hash);
1830 double progress_end = chain().guessVerificationProgress(end_hash);
1831 double progress_current = progress_begin;
1832 int block_height = start_height;
1833 while (!fAbortRescan && !chain().shutdownRequested()) {
1834 if (progress_end - progress_begin > 0.0) {
1835 m_scanning_progress = (progress_current - progress_begin) / (progress_end - progress_begin);
1836 } else { // avoid divide-by-zero for single block scan range (i.e. start and stop hashes are equal)
1838 }
1839 if (block_height % 100 == 0 && progress_end - progress_begin > 0.0) {
1840 ShowProgress(strprintf("[%s] %s", DisplayName(), _("Rescanning…")), std::max(1, std::min(99, (int)(m_scanning_progress * 100))));
1841 }
1842
1843 bool next_interval = reserver.now() >= current_time + INTERVAL_TIME;
1844 if (next_interval) {
1845 current_time = reserver.now();
1846 WalletLogPrintf("Still rescanning. At block %d. Progress=%f\n", block_height, progress_current);
1847 }
1848
1849 bool fetch_block{true};
1850 if (fast_rescan_filter) {
1851 fast_rescan_filter->UpdateIfNeeded();
1852 auto matches_block{fast_rescan_filter->MatchesBlock(block_hash)};
1853 if (matches_block.has_value()) {
1854 if (*matches_block) {
1855 LogDebug(BCLog::SCAN, "Fast rescan: inspect block %d [%s] (filter matched)\n", block_height, block_hash.ToString());
1856 } else {
1857 result.last_scanned_block = block_hash;
1858 result.last_scanned_height = block_height;
1859 fetch_block = false;
1860 }
1861 } else {
1862 LogDebug(BCLog::SCAN, "Fast rescan: inspect block %d [%s] (WARNING: block filter not found!)\n", block_height, block_hash.ToString());
1863 }
1864 }
1865
1866 // Find next block separately from reading data above, because reading
1867 // is slow and there might be a reorg while it is read.
1868 bool block_still_active = false;
1869 bool next_block = false;
1870 uint256 next_block_hash;
1871 chain().findBlock(block_hash, FoundBlock().inActiveChain(block_still_active).nextBlock(FoundBlock().inActiveChain(next_block).hash(next_block_hash)));
1872
1873 if (fetch_block) {
1874 // Read block data and locator if needed (the locator is usually null unless we need to save progress)
1875 CBlock block;
1876 CBlockLocator loc;
1877 // Find block
1878 FoundBlock found_block{FoundBlock().data(block)};
1879 if (save_progress && next_interval) found_block.locator(loc);
1880 chain().findBlock(block_hash, found_block);
1881
1882 if (!block.IsNull()) {
1883 LOCK(cs_wallet);
1884 if (!block_still_active) {
1885 // Abort scan if current block is no longer active, to prevent
1886 // marking transactions as coming from the wrong block.
1887 result.last_failed_block = block_hash;
1888 result.status = ScanResult::FAILURE;
1889 break;
1890 }
1891 for (size_t posInBlock = 0; posInBlock < block.vtx.size(); ++posInBlock) {
1892 SyncTransaction(block.vtx[posInBlock], TxStateConfirmed{block_hash, block_height, static_cast<int>(posInBlock)}, fUpdate, /*rescanning_old_block=*/true);
1893 }
1894 // scan succeeded, record block as most recent successfully scanned
1895 result.last_scanned_block = block_hash;
1896 result.last_scanned_height = block_height;
1897
1898 if (!loc.IsNull()) {
1899 WalletLogPrintf("Saving scan progress %d.\n", block_height);
1900 WalletBatch batch(GetDatabase());
1901 batch.WriteBestBlock(loc);
1902 }
1903 } else {
1904 // could not scan block, keep scanning but record this block as the most recent failure
1905 result.last_failed_block = block_hash;
1906 result.status = ScanResult::FAILURE;
1907 }
1908 }
1909 if (max_height && block_height >= *max_height) {
1910 break;
1911 }
1912 // If rescanning was triggered with cs_wallet permanently locked (AttachChain), additional blocks that were connected during the rescan
1913 // aren't processed here but will be processed with the pending blockConnected notifications after the lock is released.
1914 // If rescanning without a permanent cs_wallet lock, additional blocks that were added during the rescan will be re-processed if
1915 // the notification was processed and the last block height was updated.
1916 if (block_height >= WITH_LOCK(cs_wallet, return GetLastBlockHeight())) {
1917 break;
1918 }
1919
1920 {
1921 if (!next_block) {
1922 // break successfully when rescan has reached the tip, or
1923 // previous block is no longer on the chain due to a reorg
1924 break;
1925 }
1926
1927 // increment block and verification progress
1928 block_hash = next_block_hash;
1929 ++block_height;
1930 progress_current = chain().guessVerificationProgress(block_hash);
1931
1932 // handle updated tip hash
1933 const uint256 prev_tip_hash = tip_hash;
1934 tip_hash = WITH_LOCK(cs_wallet, return GetLastBlockHash());
1935 if (!max_height && prev_tip_hash != tip_hash) {
1936 // in case the tip has changed, update progress max
1937 progress_end = chain().guessVerificationProgress(tip_hash);
1938 }
1939 }
1940 }
1941 if (!max_height) {
1942 WalletLogPrintf("Scanning current mempool transactions.\n");
1943 WITH_LOCK(cs_wallet, chain().requestMempoolTransactions(*this));
1944 }
1945 ShowProgress(strprintf("[%s] %s", DisplayName(), _("Rescanning…")), 100); // hide progress dialog in GUI
1946 if (block_height && fAbortRescan) {
1947 WalletLogPrintf("Rescan aborted at block %d. Progress=%f\n", block_height, progress_current);
1949 } else if (block_height && chain().shutdownRequested()) {
1950 WalletLogPrintf("Rescan interrupted by shutdown request at block %d. Progress=%f\n", block_height, progress_current);
1952 } else {
1953 WalletLogPrintf("Rescan completed in %15dms\n", Ticks<std::chrono::milliseconds>(reserver.now() - start_time));
1954 }
1955 return result;
1956}
1957
1958bool CWallet::SubmitTxMemoryPoolAndRelay(CWalletTx& wtx, std::string& err_string, bool relay) const
1959{
1961
1962 // Can't relay if wallet is not broadcasting
1963 if (!GetBroadcastTransactions()) return false;
1964 // Don't relay abandoned transactions
1965 if (wtx.isAbandoned()) return false;
1966 // Don't try to submit coinbase transactions. These would fail anyway but would
1967 // cause log spam.
1968 if (wtx.IsCoinBase()) return false;
1969 // Don't try to submit conflicted or confirmed transactions.
1970 if (GetTxDepthInMainChain(wtx) != 0) return false;
1971
1972 // Submit transaction to mempool for relay
1973 WalletLogPrintf("Submitting wtx %s to mempool for relay\n", wtx.GetHash().ToString());
1974 // We must set TxStateInMempool here. Even though it will also be set later by the
1975 // entered-mempool callback, if we did not there would be a race where a
1976 // user could call sendmoney in a loop and hit spurious out of funds errors
1977 // because we think that this newly generated transaction's change is
1978 // unavailable as we're not yet aware that it is in the mempool.
1979 //
1980 // If broadcast fails for any reason, trying to set wtx.m_state here would be incorrect.
1981 // If transaction was previously in the mempool, it should be updated when
1982 // TransactionRemovedFromMempool fires.
1983 bool ret = chain().broadcastTransaction(wtx.tx, m_default_max_tx_fee, relay, err_string);
1984 if (ret) wtx.m_state = TxStateInMempool{};
1985 return ret;
1986}
1987
1988std::set<Txid> CWallet::GetTxConflicts(const CWalletTx& wtx) const
1989{
1991
1992 const Txid myHash{wtx.GetHash()};
1993 std::set<Txid> result{GetConflicts(myHash)};
1994 result.erase(myHash);
1995 return result;
1996}
1997
1999{
2000 // Don't attempt to resubmit if the wallet is configured to not broadcast
2001 if (!fBroadcastTransactions) return false;
2002
2003 // During reindex, importing and IBD, old wallet transactions become
2004 // unconfirmed. Don't resend them as that would spam other nodes.
2005 // We only allow forcing mempool submission when not relaying to avoid this spam.
2006 if (!chain().isReadyToBroadcast()) return false;
2007
2008 // Do this infrequently and randomly to avoid giving away
2009 // that these are our transactions.
2010 if (NodeClock::now() < m_next_resend) return false;
2011
2012 return true;
2013}
2014
2016
2017// Resubmit transactions from the wallet to the mempool, optionally asking the
2018// mempool to relay them. On startup, we will do this for all unconfirmed
2019// transactions but will not ask the mempool to relay them. We do this on startup
2020// to ensure that our own mempool is aware of our transactions. There
2021// is a privacy side effect here as not broadcasting on startup also means that we won't
2022// inform the world of our wallet's state, particularly if the wallet (or node) is not
2023// yet synced.
2024//
2025// Otherwise this function is called periodically in order to relay our unconfirmed txs.
2026// We do this on a random timer to slightly obfuscate which transactions
2027// come from our wallet.
2028//
2029// TODO: Ideally, we'd only resend transactions that we think should have been
2030// mined in the most recent block. Any transaction that wasn't in the top
2031// blockweight of transactions in the mempool shouldn't have been mined,
2032// and so is probably just sitting in the mempool waiting to be confirmed.
2033// Rebroadcasting does nothing to speed up confirmation and only damages
2034// privacy.
2035//
2036// The `force` option results in all unconfirmed transactions being submitted to
2037// the mempool. This does not necessarily result in those transactions being relayed,
2038// that depends on the `relay` option. Periodic rebroadcast uses the pattern
2039// relay=true force=false, while loading into the mempool
2040// (on start, or after import) uses relay=false force=true.
2041void CWallet::ResubmitWalletTransactions(bool relay, bool force)
2042{
2043 // Don't attempt to resubmit if the wallet is configured to not broadcast,
2044 // even if forcing.
2045 if (!fBroadcastTransactions) return;
2046
2047 int submitted_tx_count = 0;
2048
2049 { // cs_wallet scope
2050 LOCK(cs_wallet);
2051
2052 // First filter for the transactions we want to rebroadcast.
2053 // We use a set with WalletTxOrderComparator so that rebroadcasting occurs in insertion order
2054 std::set<CWalletTx*, WalletTxOrderComparator> to_submit;
2055 for (auto& [txid, wtx] : mapWallet) {
2056 // Only rebroadcast unconfirmed txs
2057 if (!wtx.isUnconfirmed()) continue;
2058
2059 // Attempt to rebroadcast all txes more than 5 minutes older than
2060 // the last block, or all txs if forcing.
2061 if (!force && wtx.nTimeReceived > m_best_block_time - 5 * 60) continue;
2062 to_submit.insert(&wtx);
2063 }
2064 // Now try submitting the transactions to the memory pool and (optionally) relay them.
2065 for (auto wtx : to_submit) {
2066 std::string unused_err_string;
2067 if (SubmitTxMemoryPoolAndRelay(*wtx, unused_err_string, relay)) ++submitted_tx_count;
2068 }
2069 } // cs_wallet
2070
2071 if (submitted_tx_count > 0) {
2072 WalletLogPrintf("%s: resubmit %u unconfirmed transactions\n", __func__, submitted_tx_count);
2073 }
2074}
2075 // end of mapWallet
2077
2079{
2080 for (const std::shared_ptr<CWallet>& pwallet : GetWallets(context)) {
2081 if (!pwallet->ShouldResend()) continue;
2082 pwallet->ResubmitWalletTransactions(/*relay=*/true, /*force=*/false);
2083 pwallet->SetNextResend();
2084 }
2085}
2086
2087
2089{
2091
2092 // Build coins map
2093 std::map<COutPoint, Coin> coins;
2094 for (auto& input : tx.vin) {
2095 const auto mi = mapWallet.find(input.prevout.hash);
2096 if(mi == mapWallet.end() || input.prevout.n >= mi->second.tx->vout.size()) {
2097 return false;
2098 }
2099 const CWalletTx& wtx = mi->second;
2100 int prev_height = wtx.state<TxStateConfirmed>() ? wtx.state<TxStateConfirmed>()->confirmed_block_height : 0;
2101 coins[input.prevout] = Coin(wtx.tx->vout[input.prevout.n], prev_height, wtx.IsCoinBase());
2102 }
2103 std::map<int, bilingual_str> input_errors;
2104 return SignTransaction(tx, coins, SIGHASH_DEFAULT, input_errors);
2105}
2106
2107bool CWallet::SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, bilingual_str>& input_errors) const
2108{
2109 // Try to sign with all ScriptPubKeyMans
2110 for (ScriptPubKeyMan* spk_man : GetAllScriptPubKeyMans()) {
2111 // spk_man->SignTransaction will return true if the transaction is complete,
2112 // so we can exit early and return true if that happens
2113 if (spk_man->SignTransaction(tx, coins, sighash, input_errors)) {
2114 return true;
2115 }
2116 }
2117
2118 // At this point, one input was not fully signed otherwise we would have exited already
2119 return false;
2120}
2121
2122std::optional<PSBTError> CWallet::FillPSBT(PartiallySignedTransaction& psbtx, bool& complete, std::optional<int> sighash_type, bool sign, bool bip32derivs, size_t * n_signed, bool finalize) const
2123{
2124 if (n_signed) {
2125 *n_signed = 0;
2126 }
2127 LOCK(cs_wallet);
2128 // Get all of the previous transactions
2129 for (unsigned int i = 0; i < psbtx.tx->vin.size(); ++i) {
2130 const CTxIn& txin = psbtx.tx->vin[i];
2131 PSBTInput& input = psbtx.inputs.at(i);
2132
2133 if (PSBTInputSigned(input)) {
2134 continue;
2135 }
2136
2137 // If we have no utxo, grab it from the wallet.
2138 if (!input.non_witness_utxo) {
2139 const Txid& txhash = txin.prevout.hash;
2140 const auto it = mapWallet.find(txhash);
2141 if (it != mapWallet.end()) {
2142 const CWalletTx& wtx = it->second;
2143 // We only need the non_witness_utxo, which is a superset of the witness_utxo.
2144 // The signing code will switch to the smaller witness_utxo if this is ok.
2145 input.non_witness_utxo = wtx.tx;
2146 }
2147 }
2148 }
2149
2150 const PrecomputedTransactionData txdata = PrecomputePSBTData(psbtx);
2151
2152 // Fill in information from ScriptPubKeyMans
2153 for (ScriptPubKeyMan* spk_man : GetAllScriptPubKeyMans()) {
2154 int n_signed_this_spkm = 0;
2155 const auto error{spk_man->FillPSBT(psbtx, txdata, sighash_type, sign, bip32derivs, &n_signed_this_spkm, finalize)};
2156 if (error) {
2157 return error;
2158 }
2159
2160 if (n_signed) {
2161 (*n_signed) += n_signed_this_spkm;
2162 }
2163 }
2164
2166
2167 // Complete if every input is now signed
2168 complete = true;
2169 for (size_t i = 0; i < psbtx.inputs.size(); ++i) {
2170 complete &= PSBTInputSignedAndVerified(psbtx, i, &txdata);
2171 }
2172
2173 return {};
2174}
2175
2176SigningResult CWallet::SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const
2177{
2178 SignatureData sigdata;
2179 CScript script_pub_key = GetScriptForDestination(pkhash);
2180 for (const auto& spk_man_pair : m_spk_managers) {
2181 if (spk_man_pair.second->CanProvide(script_pub_key, sigdata)) {
2182 LOCK(cs_wallet); // DescriptorScriptPubKeyMan calls IsLocked which can lock cs_wallet in a deadlocking order
2183 return spk_man_pair.second->SignMessage(message, pkhash, str_sig);
2184 }
2185 }
2187}
2188
2189OutputType CWallet::TransactionChangeType(const std::optional<OutputType>& change_type, const std::vector<CRecipient>& vecSend) const
2190{
2191 // If -changetype is specified, always use that change type.
2192 if (change_type) {
2193 return *change_type;
2194 }
2195
2196 // if m_default_address_type is legacy, use legacy address as change.
2198 return OutputType::LEGACY;
2199 }
2200
2201 bool any_tr{false};
2202 bool any_wpkh{false};
2203 bool any_sh{false};
2204 bool any_pkh{false};
2205
2206 for (const auto& recipient : vecSend) {
2207 if (std::get_if<WitnessV1Taproot>(&recipient.dest)) {
2208 any_tr = true;
2209 } else if (std::get_if<WitnessV0KeyHash>(&recipient.dest)) {
2210 any_wpkh = true;
2211 } else if (std::get_if<ScriptHash>(&recipient.dest)) {
2212 any_sh = true;
2213 } else if (std::get_if<PKHash>(&recipient.dest)) {
2214 any_pkh = true;
2215 }
2216 }
2217
2218 const bool has_bech32m_spkman(GetScriptPubKeyMan(OutputType::BECH32M, /*internal=*/true));
2219 if (has_bech32m_spkman && any_tr) {
2220 // Currently tr is the only type supported by the BECH32M spkman
2221 return OutputType::BECH32M;
2222 }
2223 const bool has_bech32_spkman(GetScriptPubKeyMan(OutputType::BECH32, /*internal=*/true));
2224 if (has_bech32_spkman && any_wpkh) {
2225 // Currently wpkh is the only type supported by the BECH32 spkman
2226 return OutputType::BECH32;
2227 }
2228 const bool has_p2sh_segwit_spkman(GetScriptPubKeyMan(OutputType::P2SH_SEGWIT, /*internal=*/true));
2229 if (has_p2sh_segwit_spkman && any_sh) {
2230 // Currently sh_wpkh is the only type supported by the P2SH_SEGWIT spkman
2231 // As of 2021 about 80% of all SH are wrapping WPKH, so use that
2233 }
2234 const bool has_legacy_spkman(GetScriptPubKeyMan(OutputType::LEGACY, /*internal=*/true));
2235 if (has_legacy_spkman && any_pkh) {
2236 // Currently pkh is the only type supported by the LEGACY spkman
2237 return OutputType::LEGACY;
2238 }
2239
2240 if (has_bech32m_spkman) {
2241 return OutputType::BECH32M;
2242 }
2243 if (has_bech32_spkman) {
2244 return OutputType::BECH32;
2245 }
2246 // else use m_default_address_type for change
2248}
2249
2250void CWallet::CommitTransaction(CTransactionRef tx, mapValue_t mapValue, std::vector<std::pair<std::string, std::string>> orderForm)
2251{
2252 LOCK(cs_wallet);
2253 WalletLogPrintf("CommitTransaction:\n%s\n", util::RemoveSuffixView(tx->ToString(), "\n"));
2254
2255 // Add tx to wallet, because if it has change it's also ours,
2256 // otherwise just for transaction history.
2257 CWalletTx* wtx = AddToWallet(tx, TxStateInactive{}, [&](CWalletTx& wtx, bool new_tx) {
2258 CHECK_NONFATAL(wtx.mapValue.empty());
2259 CHECK_NONFATAL(wtx.vOrderForm.empty());
2260 wtx.mapValue = std::move(mapValue);
2261 wtx.vOrderForm = std::move(orderForm);
2262 return true;
2263 });
2264
2265 // wtx can only be null if the db write failed.
2266 if (!wtx) {
2267 throw std::runtime_error(std::string(__func__) + ": Wallet db error, transaction commit failed");
2268 }
2269
2270 // Notify that old coins are spent
2271 for (const CTxIn& txin : tx->vin) {
2272 CWalletTx &coin = mapWallet.at(txin.prevout.hash);
2273 coin.MarkDirty();
2275 }
2276
2278 // Don't submit tx to the mempool
2279 return;
2280 }
2281
2282 std::string err_string;
2283 if (!SubmitTxMemoryPoolAndRelay(*wtx, err_string, true)) {
2284 WalletLogPrintf("CommitTransaction(): Transaction cannot be broadcast immediately, %s\n", err_string);
2285 // TODO: if we expect the failure to be long term or permanent, instead delete wtx from the wallet and return failure.
2286 }
2287}
2288
2290{
2291 LOCK(cs_wallet);
2292
2293 Assert(m_spk_managers.empty());
2294 Assert(m_wallet_flags == 0);
2295 DBErrors nLoadWalletRet = WalletBatch(GetDatabase()).LoadWallet(this);
2296 if (nLoadWalletRet == DBErrors::NEED_REWRITE)
2297 {
2298 if (GetDatabase().Rewrite())
2299 {
2300 for (const auto& spk_man_pair : m_spk_managers) {
2301 spk_man_pair.second->RewriteDB();
2302 }
2303 }
2304 }
2305
2306 if (m_spk_managers.empty()) {
2309 }
2310
2311 return nLoadWalletRet;
2312}
2313
2314util::Result<void> CWallet::RemoveTxs(std::vector<Txid>& txs_to_remove)
2315{
2317 bilingual_str str_err; // future: make RunWithinTxn return a util::Result
2318 bool was_txn_committed = RunWithinTxn(GetDatabase(), /*process_desc=*/"remove transactions", [&](WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
2319 util::Result<void> result{RemoveTxs(batch, txs_to_remove)};
2320 if (!result) str_err = util::ErrorString(result);
2321 return result.has_value();
2322 });
2323 if (!str_err.empty()) return util::Error{str_err};
2324 if (!was_txn_committed) return util::Error{_("Error starting/committing db txn for wallet transactions removal process")};
2325 return {}; // all good
2326}
2327
2328util::Result<void> CWallet::RemoveTxs(WalletBatch& batch, std::vector<Txid>& txs_to_remove)
2329{
2331 if (!batch.HasActiveTxn()) return util::Error{strprintf(_("The transactions removal process can only be executed within a db txn"))};
2332
2333 // Check for transaction existence and remove entries from disk
2334 std::vector<decltype(mapWallet)::const_iterator> erased_txs;
2335 bilingual_str str_err;
2336 for (const Txid& hash : txs_to_remove) {
2337 auto it_wtx = mapWallet.find(hash);
2338 if (it_wtx == mapWallet.end()) {
2339 return util::Error{strprintf(_("Transaction %s does not belong to this wallet"), hash.GetHex())};
2340 }
2341 if (!batch.EraseTx(hash)) {
2342 return util::Error{strprintf(_("Failure removing transaction: %s"), hash.GetHex())};
2343 }
2344 erased_txs.emplace_back(it_wtx);
2345 }
2346
2347 // Register callback to update the memory state only when the db txn is actually dumped to disk
2348 batch.RegisterTxnListener({.on_commit=[&, erased_txs]() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) {
2349 // Update the in-memory state and notify upper layers about the removals
2350 for (const auto& it : erased_txs) {
2351 const Txid hash{it->first};
2352 wtxOrdered.erase(it->second.m_it_wtxOrdered);
2353 for (const auto& txin : it->second.tx->vin)
2354 mapTxSpends.erase(txin.prevout);
2355 for (unsigned int i = 0; i < it->second.tx->vout.size(); ++i) {
2356 m_txos.erase(COutPoint(hash, i));
2357 }
2358 mapWallet.erase(it);
2360 }
2361
2362 MarkDirty();
2363 }, .on_abort={}});
2364
2365 return {};
2366}
2367
2368bool CWallet::SetAddressBookWithDB(WalletBatch& batch, const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& new_purpose)
2369{
2370 bool fUpdated = false;
2371 bool is_mine;
2372 std::optional<AddressPurpose> purpose;
2373 {
2374 LOCK(cs_wallet);
2375 std::map<CTxDestination, CAddressBookData>::iterator mi = m_address_book.find(address);
2376 fUpdated = mi != m_address_book.end() && !mi->second.IsChange();
2377
2378 CAddressBookData& record = mi != m_address_book.end() ? mi->second : m_address_book[address];
2379 record.SetLabel(strName);
2380 is_mine = IsMine(address);
2381 if (new_purpose) { /* update purpose only if requested */
2382 record.purpose = new_purpose;
2383 }
2384 purpose = record.purpose;
2385 }
2386
2387 const std::string& encoded_dest = EncodeDestination(address);
2388 if (new_purpose && !batch.WritePurpose(encoded_dest, PurposeToString(*new_purpose))) {
2389 WalletLogPrintf("Error: fail to write address book 'purpose' entry\n");
2390 return false;
2391 }
2392 if (!batch.WriteName(encoded_dest, strName)) {
2393 WalletLogPrintf("Error: fail to write address book 'name' entry\n");
2394 return false;
2395 }
2396
2397 // In very old wallets, address purpose may not be recorded so we derive it from IsMine
2398 NotifyAddressBookChanged(address, strName, is_mine,
2399 purpose.value_or(is_mine ? AddressPurpose::RECEIVE : AddressPurpose::SEND),
2400 (fUpdated ? CT_UPDATED : CT_NEW));
2401 return true;
2402}
2403
2404bool CWallet::SetAddressBook(const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& purpose)
2405{
2406 WalletBatch batch(GetDatabase());
2407 return SetAddressBookWithDB(batch, address, strName, purpose);
2408}
2409
2411{
2412 return RunWithinTxn(GetDatabase(), /*process_desc=*/"address book entry removal", [&](WalletBatch& batch){
2413 return DelAddressBookWithDB(batch, address);
2414 });
2415}
2416
2418{
2419 const std::string& dest = EncodeDestination(address);
2420 {
2421 LOCK(cs_wallet);
2422 // 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.
2423 // NOTE: This isn't a problem for sending addresses because they don't have any data that needs to be kept.
2424 // When adding new address data, it should be considered here whether to retain or delete it.
2425 if (IsMine(address)) {
2426 WalletLogPrintf("%s called with IsMine address, NOT SUPPORTED. Please report this bug! %s\n", __func__, CLIENT_BUGREPORT);
2427 return false;
2428 }
2429 // Delete data rows associated with this address
2430 if (!batch.EraseAddressData(address)) {
2431 WalletLogPrintf("Error: cannot erase address book entry data\n");
2432 return false;
2433 }
2434
2435 // Delete purpose entry
2436 if (!batch.ErasePurpose(dest)) {
2437 WalletLogPrintf("Error: cannot erase address book entry purpose\n");
2438 return false;
2439 }
2440
2441 // Delete name entry
2442 if (!batch.EraseName(dest)) {
2443 WalletLogPrintf("Error: cannot erase address book entry name\n");
2444 return false;
2445 }
2446
2447 // finally, remove it from the map
2448 m_address_book.erase(address);
2449 }
2450
2451 // All good, signal changes
2452 NotifyAddressBookChanged(address, "", /*is_mine=*/false, AddressPurpose::SEND, CT_DELETED);
2453 return true;
2454}
2455
2457{
2459
2460 unsigned int count = 0;
2461 for (auto spk_man : m_external_spk_managers) {
2462 count += spk_man.second->GetKeyPoolSize();
2463 }
2464
2465 return count;
2466}
2467
2468unsigned int CWallet::GetKeyPoolSize() const
2469{
2471
2472 unsigned int count = 0;
2473 for (auto spk_man : GetActiveScriptPubKeyMans()) {
2474 count += spk_man->GetKeyPoolSize();
2475 }
2476 return count;
2477}
2478
2479bool CWallet::TopUpKeyPool(unsigned int kpSize)
2480{
2481 LOCK(cs_wallet);
2482 bool res = true;
2483 for (auto spk_man : GetActiveScriptPubKeyMans()) {
2484 res &= spk_man->TopUp(kpSize);
2485 }
2486 return res;
2487}
2488
2490{
2491 LOCK(cs_wallet);
2492 auto spk_man = GetScriptPubKeyMan(type, /*internal=*/false);
2493 if (!spk_man) {
2494 return util::Error{strprintf(_("Error: No %s addresses available."), FormatOutputType(type))};
2495 }
2496
2497 auto op_dest = spk_man->GetNewDestination(type);
2498 if (op_dest) {
2499 SetAddressBook(*op_dest, label, AddressPurpose::RECEIVE);
2500 }
2501
2502 return op_dest;
2503}
2504
2506{
2507 LOCK(cs_wallet);
2508
2509 ReserveDestination reservedest(this, type);
2510 auto op_dest = reservedest.GetReservedDestination(true);
2511 if (op_dest) reservedest.KeepDestination();
2512
2513 return op_dest;
2514}
2515
2516void CWallet::MarkDestinationsDirty(const std::set<CTxDestination>& destinations) {
2517 for (auto& entry : mapWallet) {
2518 CWalletTx& wtx = entry.second;
2519 if (wtx.m_is_cache_empty) continue;
2520 for (unsigned int i = 0; i < wtx.tx->vout.size(); i++) {
2521 CTxDestination dst;
2522 if (ExtractDestination(wtx.tx->vout[i].scriptPubKey, dst) && destinations.count(dst)) {
2523 wtx.MarkDirty();
2524 break;
2525 }
2526 }
2527 }
2528}
2529
2531{
2533 for (const std::pair<const CTxDestination, CAddressBookData>& item : m_address_book) {
2534 const auto& entry = item.second;
2535 func(item.first, entry.GetLabel(), entry.IsChange(), entry.purpose);
2536 }
2537}
2538
2539std::vector<CTxDestination> CWallet::ListAddrBookAddresses(const std::optional<AddrBookFilter>& _filter) const
2540{
2542 std::vector<CTxDestination> result;
2543 AddrBookFilter filter = _filter ? *_filter : AddrBookFilter();
2544 ForEachAddrBookEntry([&result, &filter](const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose>& purpose) {
2545 // Filter by change
2546 if (filter.ignore_change && is_change) return;
2547 // Filter by label
2548 if (filter.m_op_label && *filter.m_op_label != label) return;
2549 // All good
2550 result.emplace_back(dest);
2551 });
2552 return result;
2553}
2554
2555std::set<std::string> CWallet::ListAddrBookLabels(const std::optional<AddressPurpose> purpose) const
2556{
2558 std::set<std::string> label_set;
2559 ForEachAddrBookEntry([&](const CTxDestination& _dest, const std::string& _label,
2560 bool _is_change, const std::optional<AddressPurpose>& _purpose) {
2561 if (_is_change) return;
2562 if (!purpose || purpose == _purpose) {
2563 label_set.insert(_label);
2564 }
2565 });
2566 return label_set;
2567}
2568
2570{
2572 if (!m_spk_man) {
2573 return util::Error{strprintf(_("Error: No %s addresses available."), FormatOutputType(type))};
2574 }
2575
2576 if (nIndex == -1) {
2577 int64_t index;
2578 auto op_address = m_spk_man->GetReservedDestination(type, internal, index);
2579 if (!op_address) return op_address;
2580 nIndex = index;
2581 address = *op_address;
2582 }
2583 return address;
2584}
2585
2587{
2588 if (nIndex != -1) {
2590 }
2591 nIndex = -1;
2593}
2594
2596{
2597 if (nIndex != -1) {
2599 }
2600 nIndex = -1;
2602}
2603
2605{
2606 CScript scriptPubKey = GetScriptForDestination(dest);
2607 for (const auto& spk_man : GetScriptPubKeyMans(scriptPubKey)) {
2608 auto signer_spk_man = dynamic_cast<ExternalSignerScriptPubKeyMan *>(spk_man);
2609 if (signer_spk_man == nullptr) {
2610 continue;
2611 }
2613 if (!signer) throw std::runtime_error(util::ErrorString(signer).original);
2614 return signer_spk_man->DisplayAddress(dest, *signer);
2615 }
2616 return util::Error{_("There is no ScriptPubKeyManager for this address")};
2617}
2618
2619void CWallet::LoadLockedCoin(const COutPoint& coin, bool persistent)
2620{
2622 m_locked_coins.emplace(coin, persistent);
2623}
2624
2625bool CWallet::LockCoin(const COutPoint& output, bool persist)
2626{
2628 LoadLockedCoin(output, persist);
2629 if (persist) {
2630 WalletBatch batch(GetDatabase());
2631 return batch.WriteLockedUTXO(output);
2632 }
2633 return true;
2634}
2635
2637{
2639 auto locked_coin_it = m_locked_coins.find(output);
2640 if (locked_coin_it != m_locked_coins.end()) {
2641 bool persisted = locked_coin_it->second;
2642 m_locked_coins.erase(locked_coin_it);
2643 if (persisted) {
2644 WalletBatch batch(GetDatabase());
2645 return batch.EraseLockedUTXO(output);
2646 }
2647 }
2648 return true;
2649}
2650
2652{
2654 bool success = true;
2655 WalletBatch batch(GetDatabase());
2656 for (const auto& [coin, persistent] : m_locked_coins) {
2657 if (persistent) success = success && batch.EraseLockedUTXO(coin);
2658 }
2659 m_locked_coins.clear();
2660 return success;
2661}
2662
2663bool CWallet::IsLockedCoin(const COutPoint& output) const
2664{
2666 return m_locked_coins.count(output) > 0;
2667}
2668
2669void CWallet::ListLockedCoins(std::vector<COutPoint>& vOutpts) const
2670{
2672 for (const auto& [coin, _] : m_locked_coins) {
2673 vOutpts.push_back(coin);
2674 }
2675}
2676
2700unsigned int CWallet::ComputeTimeSmart(const CWalletTx& wtx, bool rescanning_old_block) const
2701{
2702 std::optional<uint256> block_hash;
2703 if (auto* conf = wtx.state<TxStateConfirmed>()) {
2704 block_hash = conf->confirmed_block_hash;
2705 } else if (auto* conf = wtx.state<TxStateBlockConflicted>()) {
2706 block_hash = conf->conflicting_block_hash;
2707 }
2708
2709 unsigned int nTimeSmart = wtx.nTimeReceived;
2710 if (block_hash) {
2711 int64_t blocktime;
2712 int64_t block_max_time;
2713 if (chain().findBlock(*block_hash, FoundBlock().time(blocktime).maxTime(block_max_time))) {
2714 if (rescanning_old_block) {
2715 nTimeSmart = block_max_time;
2716 } else {
2717 int64_t latestNow = wtx.nTimeReceived;
2718 int64_t latestEntry = 0;
2719
2720 // Tolerate times up to the last timestamp in the wallet not more than 5 minutes into the future
2721 int64_t latestTolerated = latestNow + 300;
2722 const TxItems& txOrdered = wtxOrdered;
2723 for (auto it = txOrdered.rbegin(); it != txOrdered.rend(); ++it) {
2724 CWalletTx* const pwtx = it->second;
2725 if (pwtx == &wtx) {
2726 continue;
2727 }
2728 int64_t nSmartTime;
2729 nSmartTime = pwtx->nTimeSmart;
2730 if (!nSmartTime) {
2731 nSmartTime = pwtx->nTimeReceived;
2732 }
2733 if (nSmartTime <= latestTolerated) {
2734 latestEntry = nSmartTime;
2735 if (nSmartTime > latestNow) {
2736 latestNow = nSmartTime;
2737 }
2738 break;
2739 }
2740 }
2741
2742 nTimeSmart = std::max(latestEntry, std::min(blocktime, latestNow));
2743 }
2744 } else {
2745 WalletLogPrintf("%s: found %s in block %s not in index\n", __func__, wtx.GetHash().ToString(), block_hash->ToString());
2746 }
2747 }
2748 return nTimeSmart;
2749}
2750
2752{
2753 if (std::get_if<CNoDestination>(&dest))
2754 return false;
2755
2756 if (!used) {
2757 if (auto* data{common::FindKey(m_address_book, dest)}) data->previously_spent = false;
2758 return batch.WriteAddressPreviouslySpent(dest, false);
2759 }
2760
2762 return batch.WriteAddressPreviouslySpent(dest, true);
2763}
2764
2766{
2767 m_address_book[dest].previously_spent = true;
2768}
2769
2770void CWallet::LoadAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& request)
2771{
2772 m_address_book[dest].receive_requests[id] = request;
2773}
2774
2776{
2777 if (auto* data{common::FindKey(m_address_book, dest)}) return data->previously_spent;
2778 return false;
2779}
2780
2781std::vector<std::string> CWallet::GetAddressReceiveRequests() const
2782{
2783 std::vector<std::string> values;
2784 for (const auto& [dest, entry] : m_address_book) {
2785 for (const auto& [id, request] : entry.receive_requests) {
2786 values.emplace_back(request);
2787 }
2788 }
2789 return values;
2790}
2791
2792bool CWallet::SetAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id, const std::string& value)
2793{
2794 if (!batch.WriteAddressReceiveRequest(dest, id, value)) return false;
2795 m_address_book[dest].receive_requests[id] = value;
2796 return true;
2797}
2798
2799bool CWallet::EraseAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id)
2800{
2801 if (!batch.EraseAddressReceiveRequest(dest, id)) return false;
2802 m_address_book[dest].receive_requests.erase(id);
2803 return true;
2804}
2805
2807{
2808 // Do some checking on wallet path. It should be either a:
2809 //
2810 // 1. Path where a directory can be created.
2811 // 2. Path to an existing directory.
2812 // 3. Path to a symlink to a directory.
2813 // 4. For backwards compatibility, the name of a data file in -walletdir.
2814 const fs::path wallet_path = fsbridge::AbsPathJoin(GetWalletDir(), fs::PathFromString(name));
2815 fs::file_type path_type = fs::symlink_status(wallet_path).type();
2816 if (!(path_type == fs::file_type::not_found || path_type == fs::file_type::directory ||
2817 (path_type == fs::file_type::symlink && fs::is_directory(wallet_path)) ||
2818 (path_type == fs::file_type::regular && fs::PathFromString(name).filename() == fs::PathFromString(name)))) {
2820 "Invalid -wallet path '%s'. -wallet path should point to a directory where wallet.dat and "
2821 "database/log.?????????? files can be stored, a location where such a directory could be created, "
2822 "or (for backwards compatibility) the name of an existing data file in -walletdir (%s)",
2824 }
2825 return wallet_path;
2826}
2827
2828std::unique_ptr<WalletDatabase> MakeWalletDatabase(const std::string& name, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error_string)
2829{
2830 const auto& wallet_path = GetWalletPath(name);
2831 if (!wallet_path) {
2832 error_string = util::ErrorString(wallet_path);
2834 return nullptr;
2835 }
2836 return MakeDatabase(*wallet_path, options, status, error_string);
2837}
2838
2839std::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)
2840{
2841 interfaces::Chain* chain = context.chain;
2842 ArgsManager& args = *Assert(context.args);
2843 const std::string& walletFile = database->Filename();
2844
2845 const auto start{SteadyClock::now()};
2846 // TODO: Can't use std::make_shared because we need a custom deleter but
2847 // should be possible to use std::allocate_shared.
2848 std::shared_ptr<CWallet> walletInstance(new CWallet(chain, name, std::move(database)), FlushAndDeleteWallet);
2849 walletInstance->m_keypool_size = std::max(args.GetIntArg("-keypool", DEFAULT_KEYPOOL_SIZE), int64_t{1});
2850 walletInstance->m_notify_tx_changed_script = args.GetArg("-walletnotify", "");
2851
2852 // Load wallet
2853 bool rescan_required = false;
2854 DBErrors nLoadWalletRet = walletInstance->LoadWallet();
2855 if (nLoadWalletRet != DBErrors::LOAD_OK) {
2856 if (nLoadWalletRet == DBErrors::CORRUPT) {
2857 error = strprintf(_("Error loading %s: Wallet corrupted"), walletFile);
2858 return nullptr;
2859 }
2860 else if (nLoadWalletRet == DBErrors::NONCRITICAL_ERROR)
2861 {
2862 warnings.push_back(strprintf(_("Error reading %s! All keys read correctly, but transaction data"
2863 " or address metadata may be missing or incorrect."),
2864 walletFile));
2865 }
2866 else if (nLoadWalletRet == DBErrors::TOO_NEW) {
2867 error = strprintf(_("Error loading %s: Wallet requires newer version of %s"), walletFile, CLIENT_NAME);
2868 return nullptr;
2869 }
2870 else if (nLoadWalletRet == DBErrors::EXTERNAL_SIGNER_SUPPORT_REQUIRED) {
2871 error = strprintf(_("Error loading %s: External signer wallet being loaded without external signer support compiled"), walletFile);
2872 return nullptr;
2873 }
2874 else if (nLoadWalletRet == DBErrors::NEED_REWRITE)
2875 {
2876 error = strprintf(_("Wallet needed to be rewritten: restart %s to complete"), CLIENT_NAME);
2877 return nullptr;
2878 } else if (nLoadWalletRet == DBErrors::NEED_RESCAN) {
2879 warnings.push_back(strprintf(_("Error reading %s! Transaction data may be missing or incorrect."
2880 " Rescanning wallet."), walletFile));
2881 rescan_required = true;
2882 } else if (nLoadWalletRet == DBErrors::UNKNOWN_DESCRIPTOR) {
2883 error = strprintf(_("Unrecognized descriptor found. Loading wallet %s\n\n"
2884 "The wallet might have been created on a newer version.\n"
2885 "Please try running the latest software version.\n"), walletFile);
2886 return nullptr;
2887 } else if (nLoadWalletRet == DBErrors::UNEXPECTED_LEGACY_ENTRY) {
2888 error = strprintf(_("Unexpected legacy entry in descriptor wallet found. Loading wallet %s\n\n"
2889 "The wallet might have been tampered with or created with malicious intent.\n"), walletFile);
2890 return nullptr;
2891 } else if (nLoadWalletRet == DBErrors::LEGACY_WALLET) {
2892 error = strprintf(_("Error loading %s: Wallet is a legacy wallet. Please migrate to a descriptor wallet using the migration tool (migratewallet RPC)."), walletFile);
2893 return nullptr;
2894 } else {
2895 error = strprintf(_("Error loading %s"), walletFile);
2896 return nullptr;
2897 }
2898 }
2899
2900 // This wallet is in its first run if there are no ScriptPubKeyMans and it isn't blank or no privkeys
2901 const bool fFirstRun = walletInstance->m_spk_managers.empty() &&
2902 !walletInstance->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) &&
2903 !walletInstance->IsWalletFlagSet(WALLET_FLAG_BLANK_WALLET);
2904 if (fFirstRun)
2905 {
2906 LOCK(walletInstance->cs_wallet);
2907
2908 // Init with passed flags.
2909 // Always set the cache upgrade flag as this feature is supported from the beginning.
2910 walletInstance->InitWalletFlags(wallet_creation_flags | WALLET_FLAG_LAST_HARDENED_XPUB_CACHED);
2911
2912 // Only descriptor wallets can be created
2913 assert(walletInstance->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
2914
2915 if ((wallet_creation_flags & WALLET_FLAG_EXTERNAL_SIGNER) || !(wallet_creation_flags & (WALLET_FLAG_DISABLE_PRIVATE_KEYS | WALLET_FLAG_BLANK_WALLET))) {
2916 walletInstance->SetupDescriptorScriptPubKeyMans();
2917 }
2918
2919 if (chain) {
2920 std::optional<int> tip_height = chain->getHeight();
2921 if (tip_height) {
2922 walletInstance->SetLastBlockProcessed(*tip_height, chain->getBlockHash(*tip_height));
2923 }
2924 }
2925 } else if (wallet_creation_flags & WALLET_FLAG_DISABLE_PRIVATE_KEYS) {
2926 // Make it impossible to disable private keys after creation
2927 error = strprintf(_("Error loading %s: Private keys can only be disabled during creation"), walletFile);
2928 return nullptr;
2929 } else if (walletInstance->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
2930 for (auto spk_man : walletInstance->GetActiveScriptPubKeyMans()) {
2931 if (spk_man->HavePrivateKeys()) {
2932 warnings.push_back(strprintf(_("Warning: Private keys detected in wallet {%s} with disabled private keys"), walletFile));
2933 break;
2934 }
2935 }
2936 }
2937
2938 if (!args.GetArg("-addresstype", "").empty()) {
2939 std::optional<OutputType> parsed = ParseOutputType(args.GetArg("-addresstype", ""));
2940 if (!parsed) {
2941 error = strprintf(_("Unknown address type '%s'"), args.GetArg("-addresstype", ""));
2942 return nullptr;
2943 }
2944 walletInstance->m_default_address_type = parsed.value();
2945 }
2946
2947 if (!args.GetArg("-changetype", "").empty()) {
2948 std::optional<OutputType> parsed = ParseOutputType(args.GetArg("-changetype", ""));
2949 if (!parsed) {
2950 error = strprintf(_("Unknown change type '%s'"), args.GetArg("-changetype", ""));
2951 return nullptr;
2952 }
2953 walletInstance->m_default_change_type = parsed.value();
2954 }
2955
2956 if (const auto arg{args.GetArg("-mintxfee")}) {
2957 std::optional<CAmount> min_tx_fee = ParseMoney(*arg);
2958 if (!min_tx_fee) {
2959 error = AmountErrMsg("mintxfee", *arg);
2960 return nullptr;
2961 } else if (min_tx_fee.value() > HIGH_TX_FEE_PER_KB) {
2962 warnings.push_back(AmountHighWarn("-mintxfee") + Untranslated(" ") +
2963 _("This is the minimum transaction fee you pay on every transaction."));
2964 }
2965
2966 walletInstance->m_min_fee = CFeeRate{min_tx_fee.value()};
2967 }
2968
2969 if (const auto arg{args.GetArg("-maxapsfee")}) {
2970 const std::string& max_aps_fee{*arg};
2971 if (max_aps_fee == "-1") {
2972 walletInstance->m_max_aps_fee = -1;
2973 } else if (std::optional<CAmount> max_fee = ParseMoney(max_aps_fee)) {
2974 if (max_fee.value() > HIGH_APS_FEE) {
2975 warnings.push_back(AmountHighWarn("-maxapsfee") + Untranslated(" ") +
2976 _("This is the maximum transaction fee you pay (in addition to the normal fee) to prioritize partial spend avoidance over regular coin selection."));
2977 }
2978 walletInstance->m_max_aps_fee = max_fee.value();
2979 } else {
2980 error = AmountErrMsg("maxapsfee", max_aps_fee);
2981 return nullptr;
2982 }
2983 }
2984
2985 if (const auto arg{args.GetArg("-fallbackfee")}) {
2986 std::optional<CAmount> fallback_fee = ParseMoney(*arg);
2987 if (!fallback_fee) {
2988 error = strprintf(_("Invalid amount for %s=<amount>: '%s'"), "-fallbackfee", *arg);
2989 return nullptr;
2990 } else if (fallback_fee.value() > HIGH_TX_FEE_PER_KB) {
2991 warnings.push_back(AmountHighWarn("-fallbackfee") + Untranslated(" ") +
2992 _("This is the transaction fee you may pay when fee estimates are not available."));
2993 }
2994 walletInstance->m_fallback_fee = CFeeRate{fallback_fee.value()};
2995 }
2996
2997 // Disable fallback fee in case value was set to 0, enable if non-null value
2998 walletInstance->m_allow_fallback_fee = walletInstance->m_fallback_fee.GetFeePerK() != 0;
2999
3000 if (const auto arg{args.GetArg("-discardfee")}) {
3001 std::optional<CAmount> discard_fee = ParseMoney(*arg);
3002 if (!discard_fee) {
3003 error = strprintf(_("Invalid amount for %s=<amount>: '%s'"), "-discardfee", *arg);
3004 return nullptr;
3005 } else if (discard_fee.value() > HIGH_TX_FEE_PER_KB) {
3006 warnings.push_back(AmountHighWarn("-discardfee") + Untranslated(" ") +
3007 _("This is the transaction fee you may discard if change is smaller than dust at this level"));
3008 }
3009 walletInstance->m_discard_rate = CFeeRate{discard_fee.value()};
3010 }
3011
3012 if (const auto arg{args.GetArg("-paytxfee")}) {
3013 warnings.push_back(_("-paytxfee is deprecated and will be fully removed in v31.0."));
3014
3015 std::optional<CAmount> pay_tx_fee = ParseMoney(*arg);
3016 if (!pay_tx_fee) {
3017 error = AmountErrMsg("paytxfee", *arg);
3018 return nullptr;
3019 } else if (pay_tx_fee.value() > HIGH_TX_FEE_PER_KB) {
3020 warnings.push_back(AmountHighWarn("-paytxfee") + Untranslated(" ") +
3021 _("This is the transaction fee you will pay if you send a transaction."));
3022 }
3023
3024 walletInstance->m_pay_tx_fee = CFeeRate{pay_tx_fee.value(), 1000};
3025
3026 if (chain && walletInstance->m_pay_tx_fee < chain->relayMinFee()) {
3027 error = strprintf(_("Invalid amount for %s=<amount>: '%s' (must be at least %s)"),
3028 "-paytxfee", *arg, chain->relayMinFee().ToString());
3029 return nullptr;
3030 }
3031 }
3032
3033 if (const auto arg{args.GetArg("-maxtxfee")}) {
3034 std::optional<CAmount> max_fee = ParseMoney(*arg);
3035 if (!max_fee) {
3036 error = AmountErrMsg("maxtxfee", *arg);
3037 return nullptr;
3038 } else if (max_fee.value() > HIGH_MAX_TX_FEE) {
3039 warnings.push_back(strprintf(_("%s is set very high! Fees this large could be paid on a single transaction."), "-maxtxfee"));
3040 }
3041
3042 if (chain && CFeeRate{max_fee.value(), 1000} < chain->relayMinFee()) {
3043 error = strprintf(_("Invalid amount for %s=<amount>: '%s' (must be at least the minrelay fee of %s to prevent stuck transactions)"),
3044 "-maxtxfee", *arg, chain->relayMinFee().ToString());
3045 return nullptr;
3046 }
3047
3048 walletInstance->m_default_max_tx_fee = max_fee.value();
3049 }
3050
3051 if (const auto arg{args.GetArg("-consolidatefeerate")}) {
3052 if (std::optional<CAmount> consolidate_feerate = ParseMoney(*arg)) {
3053 walletInstance->m_consolidate_feerate = CFeeRate(*consolidate_feerate);
3054 } else {
3055 error = AmountErrMsg("consolidatefeerate", *arg);
3056 return nullptr;
3057 }
3058 }
3059
3061 warnings.push_back(AmountHighWarn("-minrelaytxfee") + Untranslated(" ") +
3062 _("The wallet will avoid paying less than the minimum relay fee."));
3063 }
3064
3065 walletInstance->m_confirm_target = args.GetIntArg("-txconfirmtarget", DEFAULT_TX_CONFIRM_TARGET);
3066 walletInstance->m_spend_zero_conf_change = args.GetBoolArg("-spendzeroconfchange", DEFAULT_SPEND_ZEROCONF_CHANGE);
3067 walletInstance->m_signal_rbf = args.GetBoolArg("-walletrbf", DEFAULT_WALLET_RBF);
3068
3069 walletInstance->WalletLogPrintf("Wallet completed loading in %15dms\n", Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
3070
3071 // Try to top up keypool. No-op if the wallet is locked.
3072 walletInstance->TopUpKeyPool();
3073
3074 // Cache the first key time
3075 std::optional<int64_t> time_first_key;
3076 for (auto spk_man : walletInstance->GetAllScriptPubKeyMans()) {
3077 int64_t time = spk_man->GetTimeFirstKey();
3078 if (!time_first_key || time < *time_first_key) time_first_key = time;
3079 }
3080 if (time_first_key) walletInstance->MaybeUpdateBirthTime(*time_first_key);
3081
3082 if (chain && !AttachChain(walletInstance, *chain, rescan_required, error, warnings)) {
3083 walletInstance->m_chain_notifications_handler.reset(); // Reset this pointer so that the wallet will actually be unloaded
3084 return nullptr;
3085 }
3086
3087 {
3088 LOCK(walletInstance->cs_wallet);
3089 walletInstance->SetBroadcastTransactions(args.GetBoolArg("-walletbroadcast", DEFAULT_WALLETBROADCAST));
3090 walletInstance->WalletLogPrintf("setKeyPool.size() = %u\n", walletInstance->GetKeyPoolSize());
3091 walletInstance->WalletLogPrintf("mapWallet.size() = %u\n", walletInstance->mapWallet.size());
3092 walletInstance->WalletLogPrintf("m_address_book.size() = %u\n", walletInstance->m_address_book.size());
3093 }
3094
3095 return walletInstance;
3096}
3097
3098bool CWallet::AttachChain(const std::shared_ptr<CWallet>& walletInstance, interfaces::Chain& chain, const bool rescan_required, bilingual_str& error, std::vector<bilingual_str>& warnings)
3099{
3100 LOCK(walletInstance->cs_wallet);
3101 // allow setting the chain if it hasn't been set already but prevent changing it
3102 assert(!walletInstance->m_chain || walletInstance->m_chain == &chain);
3103 walletInstance->m_chain = &chain;
3104
3105 // Unless allowed, ensure wallet files are not reused across chains:
3106 if (!gArgs.GetBoolArg("-walletcrosschain", DEFAULT_WALLETCROSSCHAIN)) {
3107 WalletBatch batch(walletInstance->GetDatabase());
3108 CBlockLocator locator;
3109 if (batch.ReadBestBlock(locator) && locator.vHave.size() > 0 && chain.getHeight()) {
3110 // Wallet is assumed to be from another chain, if genesis block in the active
3111 // chain differs from the genesis block known to the wallet.
3112 if (chain.getBlockHash(0) != locator.vHave.back()) {
3113 error = Untranslated("Wallet files should not be reused across chains. Restart bitcoind with -walletcrosschain to override.");
3114 return false;
3115 }
3116 }
3117 }
3118
3119 // Register wallet with validationinterface. It's done before rescan to avoid
3120 // missing block connections during the rescan.
3121 // Because of the wallet lock being held, block connection notifications are going to
3122 // be pending on the validation-side until lock release. Blocks that are connected while the
3123 // rescan is ongoing will not be processed in the rescan but with the block connected notifications,
3124 // so the wallet will only be completeley synced after the notifications delivery.
3125 walletInstance->m_chain_notifications_handler = walletInstance->chain().handleNotifications(walletInstance);
3126
3127 // If rescan_required = true, rescan_height remains equal to 0
3128 int rescan_height = 0;
3129 if (!rescan_required)
3130 {
3131 WalletBatch batch(walletInstance->GetDatabase());
3132 CBlockLocator locator;
3133 if (batch.ReadBestBlock(locator)) {
3134 if (const std::optional<int> fork_height = chain.findLocatorFork(locator)) {
3135 rescan_height = *fork_height;
3136 }
3137 }
3138 }
3139
3140 const std::optional<int> tip_height = chain.getHeight();
3141 if (tip_height) {
3142 walletInstance->SetLastBlockProcessedInMem(*tip_height, chain.getBlockHash(*tip_height));
3143 } else {
3144 walletInstance->SetLastBlockProcessedInMem(-1, uint256());
3145 }
3146
3147 if (tip_height && *tip_height != rescan_height)
3148 {
3149 // No need to read and scan block if block was created before
3150 // our wallet birthday (as adjusted for block time variability)
3151 std::optional<int64_t> time_first_key = walletInstance->m_birth_time.load();
3152 if (time_first_key) {
3153 FoundBlock found = FoundBlock().height(rescan_height);
3154 chain.findFirstBlockWithTimeAndHeight(*time_first_key - TIMESTAMP_WINDOW, rescan_height, found);
3155 if (!found.found) {
3156 // We were unable to find a block that had a time more recent than our earliest timestamp
3157 // or a height higher than the wallet was synced to, indicating that the wallet is newer than the
3158 // current chain tip. Skip rescanning in this case.
3159 rescan_height = *tip_height;
3160 }
3161 }
3162
3163 // Technically we could execute the code below in any case, but performing the
3164 // `while` loop below can make startup very slow, so only check blocks on disk
3165 // if necessary.
3167 int block_height = *tip_height;
3168 while (block_height > 0 && chain.haveBlockOnDisk(block_height - 1) && rescan_height != block_height) {
3169 --block_height;
3170 }
3171
3172 if (rescan_height != block_height) {
3173 // We can't rescan beyond blocks we don't have data for, stop and throw an error.
3174 // This might happen if a user uses an old wallet within a pruned node
3175 // or if they ran -disablewallet for a longer time, then decided to re-enable
3176 // Exit early and print an error.
3177 // It also may happen if an assumed-valid chain is in use and therefore not
3178 // all block data is available.
3179 // If a block is pruned after this check, we will load the wallet,
3180 // but fail the rescan with a generic error.
3181
3182 error = chain.havePruned() ?
3183 _("Prune: last wallet synchronisation goes beyond pruned data. You need to -reindex (download the whole blockchain again in case of a pruned node)") :
3184 strprintf(_(
3185 "Error loading wallet. Wallet requires blocks to be downloaded, "
3186 "and software does not currently support loading wallets while "
3187 "blocks are being downloaded out of order when using assumeutxo "
3188 "snapshots. Wallet should be able to load successfully after "
3189 "node sync reaches height %s"), block_height);
3190 return false;
3191 }
3192 }
3193
3194 chain.initMessage(_("Rescanning…"));
3195 walletInstance->WalletLogPrintf("Rescanning last %i blocks (from block %i)...\n", *tip_height - rescan_height, rescan_height);
3196
3197 {
3198 WalletRescanReserver reserver(*walletInstance);
3199 if (!reserver.reserve()) {
3200 error = _("Failed to acquire rescan reserver during wallet initialization");
3201 return false;
3202 }
3203 ScanResult scan_res = walletInstance->ScanForWalletTransactions(chain.getBlockHash(rescan_height), rescan_height, /*max_height=*/{}, reserver, /*fUpdate=*/true, /*save_progress=*/true);
3204 if (ScanResult::SUCCESS != scan_res.status) {
3205 error = _("Failed to rescan the wallet during initialization");
3206 return false;
3207 }
3208 // Set and update the best block record
3209 // Set last block scanned as the last block processed as it may be different in case of a reorg.
3210 // Also save the best block locator because rescanning only updates it intermittently.
3211 walletInstance->SetLastBlockProcessed(*scan_res.last_scanned_height, scan_res.last_scanned_block);
3212 }
3213 }
3214
3215 return true;
3216}
3217
3218const CAddressBookData* CWallet::FindAddressBookEntry(const CTxDestination& dest, bool allow_change) const
3219{
3220 const auto& address_book_it = m_address_book.find(dest);
3221 if (address_book_it == m_address_book.end()) return nullptr;
3222 if ((!allow_change) && address_book_it->second.IsChange()) {
3223 return nullptr;
3224 }
3225 return &address_book_it->second;
3226}
3227
3229{
3230 // Add wallet transactions that aren't already in a block to mempool
3231 // Do this here as mempool requires genesis block to be loaded
3232 ResubmitWalletTransactions(/*relay=*/false, /*force=*/true);
3233
3234 // Update wallet transactions with current mempool transactions.
3235 WITH_LOCK(cs_wallet, chain().requestMempoolTransactions(*this));
3236}
3237
3238bool CWallet::BackupWallet(const std::string& strDest) const
3239{
3241 return GetDatabase().Backup(strDest);
3242}
3243
3245{
3247 if (auto* conf = wtx.state<TxStateConfirmed>()) {
3248 assert(conf->confirmed_block_height >= 0);
3249 return GetLastBlockHeight() - conf->confirmed_block_height + 1;
3250 } else if (auto* conf = wtx.state<TxStateBlockConflicted>()) {
3251 assert(conf->conflicting_block_height >= 0);
3252 return -1 * (GetLastBlockHeight() - conf->conflicting_block_height + 1);
3253 } else {
3254 return 0;
3255 }
3256}
3257
3259{
3261
3262 if (!wtx.IsCoinBase()) {
3263 return 0;
3264 }
3265 int chain_depth = GetTxDepthInMainChain(wtx);
3266 assert(chain_depth >= 0); // coinbase tx should not be conflicted
3267 return std::max(0, (COINBASE_MATURITY+1) - chain_depth);
3268}
3269
3271{
3273
3274 // note GetBlocksToMaturity is 0 for non-coinbase tx
3275 return GetTxBlocksToMaturity(wtx) > 0;
3276}
3277
3279{
3280 return HasEncryptionKeys();
3281}
3282
3284{
3285 if (!IsCrypted()) {
3286 return false;
3287 }
3288 LOCK(cs_wallet);
3289 return vMasterKey.empty();
3290}
3291
3293{
3294 if (!IsCrypted())
3295 return false;
3296
3297 {
3299 if (!vMasterKey.empty()) {
3300 memory_cleanse(vMasterKey.data(), vMasterKey.size() * sizeof(decltype(vMasterKey)::value_type));
3301 vMasterKey.clear();
3302 }
3303 }
3304
3305 NotifyStatusChanged(this);
3306 return true;
3307}
3308
3309bool CWallet::Unlock(const CKeyingMaterial& vMasterKeyIn)
3310{
3311 {
3312 LOCK(cs_wallet);
3313 for (const auto& spk_man_pair : m_spk_managers) {
3314 if (!spk_man_pair.second->CheckDecryptionKey(vMasterKeyIn)) {
3315 return false;
3316 }
3317 }
3318 vMasterKey = vMasterKeyIn;
3319 }
3320 NotifyStatusChanged(this);
3321 return true;
3322}
3323
3324std::set<ScriptPubKeyMan*> CWallet::GetActiveScriptPubKeyMans() const
3325{
3326 std::set<ScriptPubKeyMan*> spk_mans;
3327 for (bool internal : {false, true}) {
3328 for (OutputType t : OUTPUT_TYPES) {
3329 auto spk_man = GetScriptPubKeyMan(t, internal);
3330 if (spk_man) {
3331 spk_mans.insert(spk_man);
3332 }
3333 }
3334 }
3335 return spk_mans;
3336}
3337
3339{
3340 for (const auto& [_, ext_spkm] : m_external_spk_managers) {
3341 if (ext_spkm == &spkm) return true;
3342 }
3343 for (const auto& [_, int_spkm] : m_internal_spk_managers) {
3344 if (int_spkm == &spkm) return true;
3345 }
3346 return false;
3347}
3348
3349std::set<ScriptPubKeyMan*> CWallet::GetAllScriptPubKeyMans() const
3350{
3351 std::set<ScriptPubKeyMan*> spk_mans;
3352 for (const auto& spk_man_pair : m_spk_managers) {
3353 spk_mans.insert(spk_man_pair.second.get());
3354 }
3355 return spk_mans;
3356}
3357
3359{
3360 const std::map<OutputType, ScriptPubKeyMan*>& spk_managers = internal ? m_internal_spk_managers : m_external_spk_managers;
3361 std::map<OutputType, ScriptPubKeyMan*>::const_iterator it = spk_managers.find(type);
3362 if (it == spk_managers.end()) {
3363 return nullptr;
3364 }
3365 return it->second;
3366}
3367
3368std::set<ScriptPubKeyMan*> CWallet::GetScriptPubKeyMans(const CScript& script) const
3369{
3370 std::set<ScriptPubKeyMan*> spk_mans;
3371
3372 // Search the cache for relevant SPKMs instead of iterating m_spk_managers
3373 const auto& it = m_cached_spks.find(script);
3374 if (it != m_cached_spks.end()) {
3375 spk_mans.insert(it->second.begin(), it->second.end());
3376 }
3377 SignatureData sigdata;
3378 Assume(std::all_of(spk_mans.begin(), spk_mans.end(), [&script, &sigdata](ScriptPubKeyMan* spkm) { return spkm->CanProvide(script, sigdata); }));
3379
3380 return spk_mans;
3381}
3382
3384{
3385 if (m_spk_managers.count(id) > 0) {
3386 return m_spk_managers.at(id).get();
3387 }
3388 return nullptr;
3389}
3390
3391std::unique_ptr<SigningProvider> CWallet::GetSolvingProvider(const CScript& script) const
3392{
3393 SignatureData sigdata;
3394 return GetSolvingProvider(script, sigdata);
3395}
3396
3397std::unique_ptr<SigningProvider> CWallet::GetSolvingProvider(const CScript& script, SignatureData& sigdata) const
3398{
3399 // Search the cache for relevant SPKMs instead of iterating m_spk_managers
3400 const auto& it = m_cached_spks.find(script);
3401 if (it != m_cached_spks.end()) {
3402 // All spkms for a given script must already be able to make a SigningProvider for the script, so just return the first one.
3403 Assume(it->second.at(0)->CanProvide(script, sigdata));
3404 return it->second.at(0)->GetSolvingProvider(script);
3405 }
3406
3407 return nullptr;
3408}
3409
3410std::vector<WalletDescriptor> CWallet::GetWalletDescriptors(const CScript& script) const
3411{
3412 std::vector<WalletDescriptor> descs;
3413 for (const auto spk_man: GetScriptPubKeyMans(script)) {
3414 if (const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man)) {
3415 LOCK(desc_spk_man->cs_desc_man);
3416 descs.push_back(desc_spk_man->GetWalletDescriptor());
3417 }
3418 }
3419 return descs;
3420}
3421
3423{
3425 return nullptr;
3426 }
3428 if (it == m_internal_spk_managers.end()) return nullptr;
3429 return dynamic_cast<LegacyDataSPKM*>(it->second);
3430}
3431
3432void CWallet::AddScriptPubKeyMan(const uint256& id, std::unique_ptr<ScriptPubKeyMan> spkm_man)
3433{
3434 // Add spkm_man to m_spk_managers before calling any method
3435 // that might access it.
3436 const auto& spkm = m_spk_managers[id] = std::move(spkm_man);
3437
3438 // Update birth time if needed
3439 MaybeUpdateBirthTime(spkm->GetTimeFirstKey());
3440}
3441
3443{
3445 return GetLegacyDataSPKM();
3446}
3447
3449{
3451 return;
3452 }
3453
3454 Assert(m_database->Format() == "bdb_ro" || m_database->Format() == "mock");
3455 std::unique_ptr<ScriptPubKeyMan> spk_manager = std::make_unique<LegacyDataSPKM>(*this);
3456
3457 for (const auto& type : LEGACY_OUTPUT_TYPES) {
3458 m_internal_spk_managers[type] = spk_manager.get();
3459 m_external_spk_managers[type] = spk_manager.get();
3460 }
3461 uint256 id = spk_manager->GetID();
3462 AddScriptPubKeyMan(id, std::move(spk_manager));
3463}
3464
3465bool CWallet::WithEncryptionKey(std::function<bool (const CKeyingMaterial&)> cb) const
3466{
3467 LOCK(cs_wallet);
3468 return cb(vMasterKey);
3469}
3470
3472{
3473 return !mapMasterKeys.empty();
3474}
3475
3477{
3478 for (const auto& spkm : GetAllScriptPubKeyMans()) {
3479 if (spkm->HaveCryptedKeys()) return true;
3480 }
3481 return false;
3482}
3483
3485{
3486 for (const auto& spk_man : GetActiveScriptPubKeyMans()) {
3487 spk_man->NotifyCanGetAddressesChanged.connect(NotifyCanGetAddressesChanged);
3488 spk_man->NotifyFirstKeyTimeChanged.connect(std::bind(&CWallet::MaybeUpdateBirthTime, this, std::placeholders::_2));
3489 }
3490}
3491
3493{
3494 DescriptorScriptPubKeyMan* spk_manager;
3496 spk_manager = new ExternalSignerScriptPubKeyMan(*this, desc, m_keypool_size);
3497 } else {
3498 spk_manager = new DescriptorScriptPubKeyMan(*this, desc, m_keypool_size);
3499 }
3500 AddScriptPubKeyMan(id, std::unique_ptr<ScriptPubKeyMan>(spk_manager));
3501 return *spk_manager;
3502}
3503
3504DescriptorScriptPubKeyMan& CWallet::SetupDescriptorScriptPubKeyMan(WalletBatch& batch, const CExtKey& master_key, const OutputType& output_type, bool internal)
3505{
3507 auto spk_manager = std::unique_ptr<DescriptorScriptPubKeyMan>(new DescriptorScriptPubKeyMan(*this, m_keypool_size));
3508 if (IsCrypted()) {
3509 if (IsLocked()) {
3510 throw std::runtime_error(std::string(__func__) + ": Wallet is locked, cannot setup new descriptors");
3511 }
3512 if (!spk_manager->CheckDecryptionKey(vMasterKey) && !spk_manager->Encrypt(vMasterKey, &batch)) {
3513 throw std::runtime_error(std::string(__func__) + ": Could not encrypt new descriptors");
3514 }
3515 }
3516 spk_manager->SetupDescriptorGeneration(batch, master_key, output_type, internal);
3517 DescriptorScriptPubKeyMan* out = spk_manager.get();
3518 uint256 id = spk_manager->GetID();
3519 AddScriptPubKeyMan(id, std::move(spk_manager));
3520 AddActiveScriptPubKeyManWithDb(batch, id, output_type, internal);
3521 return *out;
3522}
3523
3525{
3527 for (bool internal : {false, true}) {
3528 for (OutputType t : OUTPUT_TYPES) {
3529 SetupDescriptorScriptPubKeyMan(batch, master_key, t, internal);
3530 }
3531 }
3532}
3533
3535{
3538 // Make a seed
3539 CKey seed_key = GenerateRandomKey();
3540 CPubKey seed = seed_key.GetPubKey();
3541 assert(seed_key.VerifyPubKey(seed));
3542
3543 // Get the extended key
3544 CExtKey master_key;
3545 master_key.SetSeed(seed_key);
3546
3547 SetupDescriptorScriptPubKeyMans(batch, master_key);
3548}
3549
3551{
3553
3555 if (!RunWithinTxn(GetDatabase(), /*process_desc=*/"setup descriptors", [&](WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet){
3557 return true;
3558 })) throw std::runtime_error("Error: cannot process db transaction for descriptors setup");
3559 } else {
3561 if (!signer) throw std::runtime_error(util::ErrorString(signer).original);
3562
3563 // TODO: add account parameter
3564 int account = 0;
3565 UniValue signer_res = signer->GetDescriptors(account);
3566
3567 if (!signer_res.isObject()) throw std::runtime_error(std::string(__func__) + ": Unexpected result");
3568
3569 WalletBatch batch(GetDatabase());
3570 if (!batch.TxnBegin()) throw std::runtime_error("Error: cannot create db transaction for descriptors import");
3571
3572 for (bool internal : {false, true}) {
3573 const UniValue& descriptor_vals = signer_res.find_value(internal ? "internal" : "receive");
3574 if (!descriptor_vals.isArray()) throw std::runtime_error(std::string(__func__) + ": Unexpected result");
3575 for (const UniValue& desc_val : descriptor_vals.get_array().getValues()) {
3576 const std::string& desc_str = desc_val.getValStr();
3578 std::string desc_error;
3579 auto descs = Parse(desc_str, keys, desc_error, false);
3580 if (descs.empty()) {
3581 throw std::runtime_error(std::string(__func__) + ": Invalid descriptor \"" + desc_str + "\" (" + desc_error + ")");
3582 }
3583 auto& desc = descs.at(0);
3584 if (!desc->GetOutputType()) {
3585 continue;
3586 }
3587 OutputType t = *desc->GetOutputType();
3588 auto spk_manager = std::unique_ptr<ExternalSignerScriptPubKeyMan>(new ExternalSignerScriptPubKeyMan(*this, m_keypool_size));
3589 spk_manager->SetupDescriptor(batch, std::move(desc));
3590 uint256 id = spk_manager->GetID();
3591 AddScriptPubKeyMan(id, std::move(spk_manager));
3592 AddActiveScriptPubKeyManWithDb(batch, id, t, internal);
3593 }
3594 }
3595
3596 // Ensure imported descriptors are committed to disk
3597 if (!batch.TxnCommit()) throw std::runtime_error("Error: cannot commit db transaction for descriptors import");
3598 }
3599}
3600
3602{
3603 WalletBatch batch(GetDatabase());
3604 return AddActiveScriptPubKeyManWithDb(batch, id, type, internal);
3605}
3606
3608{
3609 if (!batch.WriteActiveScriptPubKeyMan(static_cast<uint8_t>(type), id, internal)) {
3610 throw std::runtime_error(std::string(__func__) + ": writing active ScriptPubKeyMan id failed");
3611 }
3612 LoadActiveScriptPubKeyMan(id, type, internal);
3613}
3614
3616{
3617 // Activating ScriptPubKeyManager for a given output and change type is incompatible with legacy wallets.
3618 // Legacy wallets have only one ScriptPubKeyManager and it's active for all output and change types.
3620
3621 WalletLogPrintf("Setting spkMan to active: id = %s, type = %s, internal = %s\n", id.ToString(), FormatOutputType(type), internal ? "true" : "false");
3622 auto& spk_mans = internal ? m_internal_spk_managers : m_external_spk_managers;
3623 auto& spk_mans_other = internal ? m_external_spk_managers : m_internal_spk_managers;
3624 auto spk_man = m_spk_managers.at(id).get();
3625 spk_mans[type] = spk_man;
3626
3627 const auto it = spk_mans_other.find(type);
3628 if (it != spk_mans_other.end() && it->second == spk_man) {
3629 spk_mans_other.erase(type);
3630 }
3631
3633}
3634
3636{
3637 auto spk_man = GetScriptPubKeyMan(type, internal);
3638 if (spk_man != nullptr && spk_man->GetID() == id) {
3639 WalletLogPrintf("Deactivate spkMan: id = %s, type = %s, internal = %s\n", id.ToString(), FormatOutputType(type), internal ? "true" : "false");
3640 WalletBatch batch(GetDatabase());
3641 if (!batch.EraseActiveScriptPubKeyMan(static_cast<uint8_t>(type), internal)) {
3642 throw std::runtime_error(std::string(__func__) + ": erasing active ScriptPubKeyMan id failed");
3643 }
3644
3645 auto& spk_mans = internal ? m_internal_spk_managers : m_external_spk_managers;
3646 spk_mans.erase(type);
3647 }
3648
3650}
3651
3653{
3654 auto spk_man_pair = m_spk_managers.find(desc.id);
3655
3656 if (spk_man_pair != m_spk_managers.end()) {
3657 // Try to downcast to DescriptorScriptPubKeyMan then check if the descriptors match
3658 DescriptorScriptPubKeyMan* spk_manager = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man_pair->second.get());
3659 if (spk_manager != nullptr && spk_manager->HasWalletDescriptor(desc)) {
3660 return spk_manager;
3661 }
3662 }
3663
3664 return nullptr;
3665}
3666
3667std::optional<bool> CWallet::IsInternalScriptPubKeyMan(ScriptPubKeyMan* spk_man) const
3668{
3669 // only active ScriptPubKeyMan can be internal
3670 if (!GetActiveScriptPubKeyMans().count(spk_man)) {
3671 return std::nullopt;
3672 }
3673
3674 const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man);
3675 if (!desc_spk_man) {
3676 throw std::runtime_error(std::string(__func__) + ": unexpected ScriptPubKeyMan type.");
3677 }
3678
3679 LOCK(desc_spk_man->cs_desc_man);
3680 const auto& type = desc_spk_man->GetWalletDescriptor().descriptor->GetOutputType();
3681 assert(type.has_value());
3682
3683 return GetScriptPubKeyMan(*type, /* internal= */ true) == desc_spk_man;
3684}
3685
3687{
3689
3691 return util::Error{_("Cannot add WalletDescriptor to a non-descriptor wallet")};
3692 }
3693
3694 auto spk_man = GetDescriptorScriptPubKeyMan(desc);
3695 if (spk_man) {
3696 WalletLogPrintf("Update existing descriptor: %s\n", desc.descriptor->ToString());
3697 if (auto spkm_res = spk_man->UpdateWalletDescriptor(desc); !spkm_res) {
3698 return util::Error{util::ErrorString(spkm_res)};
3699 }
3700 } else {
3701 auto new_spk_man = std::unique_ptr<DescriptorScriptPubKeyMan>(new DescriptorScriptPubKeyMan(*this, desc, m_keypool_size));
3702 spk_man = new_spk_man.get();
3703
3704 // Save the descriptor to memory
3705 uint256 id = new_spk_man->GetID();
3706 AddScriptPubKeyMan(id, std::move(new_spk_man));
3707 }
3708
3709 // Add the private keys to the descriptor
3710 for (const auto& entry : signing_provider.keys) {
3711 const CKey& key = entry.second;
3712 spk_man->AddDescriptorKey(key, key.GetPubKey());
3713 }
3714
3715 // Top up key pool, the manager will generate new scriptPubKeys internally
3716 if (!spk_man->TopUp()) {
3717 return util::Error{_("Could not top up scriptPubKeys")};
3718 }
3719
3720 // Apply the label if necessary
3721 // Note: we disable labels for ranged descriptors
3722 if (!desc.descriptor->IsRange()) {
3723 auto script_pub_keys = spk_man->GetScriptPubKeys();
3724 if (script_pub_keys.empty()) {
3725 return util::Error{_("Could not generate scriptPubKeys (cache is empty)")};
3726 }
3727
3728 if (!internal) {
3729 for (const auto& script : script_pub_keys) {
3730 CTxDestination dest;
3731 if (ExtractDestination(script, dest)) {
3733 }
3734 }
3735 }
3736 }
3737
3738 // Save the descriptor to DB
3739 spk_man->WriteDescriptor();
3740
3741 // Break balance caches so that outputs that are now IsMine in already known txs will be included in the balance
3742 MarkDirty();
3743
3744 return std::reference_wrapper(*spk_man);
3745}
3746
3748{
3750
3751 WalletLogPrintf("Migrating wallet storage database from BerkeleyDB to SQLite.\n");
3752
3753 if (m_database->Format() == "sqlite") {
3754 error = _("Error: This wallet already uses SQLite");
3755 return false;
3756 }
3757
3758 // Get all of the records for DB type migration
3759 std::unique_ptr<DatabaseBatch> batch = m_database->MakeBatch();
3760 std::unique_ptr<DatabaseCursor> cursor = batch->GetNewCursor();
3761 std::vector<std::pair<SerializeData, SerializeData>> records;
3762 if (!cursor) {
3763 error = _("Error: Unable to begin reading all records in the database");
3764 return false;
3765 }
3767 while (true) {
3768 DataStream ss_key{};
3769 DataStream ss_value{};
3770 status = cursor->Next(ss_key, ss_value);
3771 if (status != DatabaseCursor::Status::MORE) {
3772 break;
3773 }
3774 SerializeData key(ss_key.begin(), ss_key.end());
3775 SerializeData value(ss_value.begin(), ss_value.end());
3776 records.emplace_back(key, value);
3777 }
3778 cursor.reset();
3779 batch.reset();
3780 if (status != DatabaseCursor::Status::DONE) {
3781 error = _("Error: Unable to read all records in the database");
3782 return false;
3783 }
3784
3785 // Close this database and delete the file
3786 fs::path db_path = fs::PathFromString(m_database->Filename());
3787 m_database->Close();
3788 fs::remove(db_path);
3789
3790 // Generate the path for the location of the migrated wallet
3791 // Wallets that are plain files rather than wallet directories will be migrated to be wallet directories.
3792 const fs::path wallet_path = fsbridge::AbsPathJoin(GetWalletDir(), fs::PathFromString(m_name));
3793
3794 // Make new DB
3795 DatabaseOptions opts;
3796 opts.require_create = true;
3798 DatabaseStatus db_status;
3799 std::unique_ptr<WalletDatabase> new_db = MakeDatabase(wallet_path, opts, db_status, error);
3800 assert(new_db); // This is to prevent doing anything further with this wallet. The original file was deleted, but a backup exists.
3801 m_database.reset();
3802 m_database = std::move(new_db);
3803
3804 // Write existing records into the new DB
3805 batch = m_database->MakeBatch();
3806 bool began = batch->TxnBegin();
3807 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.
3808 for (const auto& [key, value] : records) {
3809 if (!batch->Write(std::span{key}, std::span{value})) {
3810 batch->TxnAbort();
3811 m_database->Close();
3812 fs::remove(m_database->Filename());
3813 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.
3814 }
3815 }
3816 bool committed = batch->TxnCommit();
3817 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.
3818 return true;
3819}
3820
3821std::optional<MigrationData> CWallet::GetDescriptorsForLegacy(bilingual_str& error) const
3822{
3824
3825 LegacyDataSPKM* legacy_spkm = GetLegacyDataSPKM();
3826 if (!Assume(legacy_spkm)) {
3827 // This shouldn't happen
3828 error = Untranslated(STR_INTERNAL_BUG("Error: Legacy wallet data missing"));
3829 return std::nullopt;
3830 }
3831
3832 std::optional<MigrationData> res = legacy_spkm->MigrateToDescriptor();
3833 if (res == std::nullopt) {
3834 error = _("Error: Unable to produce descriptors for this legacy wallet. Make sure to provide the wallet's passphrase if it is encrypted.");
3835 return std::nullopt;
3836 }
3837 return res;
3838}
3839
3841{
3843
3844 LegacyDataSPKM* legacy_spkm = GetLegacyDataSPKM();
3845 if (!Assume(legacy_spkm)) {
3846 // This shouldn't happen
3847 return util::Error{Untranslated(STR_INTERNAL_BUG("Error: Legacy wallet data missing"))};
3848 }
3849
3850 // Note: when the legacy wallet has no spendable scripts, it must be empty at the end of the process.
3851 bool has_spendable_material = !data.desc_spkms.empty() || data.master_key.key.IsValid();
3852
3853 // Get all invalid or non-watched scripts that will not be migrated
3854 std::set<CTxDestination> not_migrated_dests;
3855 for (const auto& script : legacy_spkm->GetNotMineScriptPubKeys()) {
3856 CTxDestination dest;
3857 if (ExtractDestination(script, dest)) not_migrated_dests.emplace(dest);
3858 }
3859
3860 // When the legacy wallet has no spendable scripts, the main wallet will be empty, leaving its script cache empty as well.
3861 // The watch-only and/or solvable wallet(s) will contain the scripts in their respective caches.
3862 if (!data.desc_spkms.empty()) Assume(!m_cached_spks.empty());
3863 if (!data.watch_descs.empty()) Assume(!data.watchonly_wallet->m_cached_spks.empty());
3864 if (!data.solvable_descs.empty()) Assume(!data.solvable_wallet->m_cached_spks.empty());
3865
3866 for (auto& desc_spkm : data.desc_spkms) {
3867 if (m_spk_managers.count(desc_spkm->GetID()) > 0) {
3868 return util::Error{_("Error: Duplicate descriptors created during migration. Your wallet may be corrupted.")};
3869 }
3870 uint256 id = desc_spkm->GetID();
3871 AddScriptPubKeyMan(id, std::move(desc_spkm));
3872 }
3873
3874 // Remove the LegacyScriptPubKeyMan from disk
3875 if (!legacy_spkm->DeleteRecordsWithDB(local_wallet_batch)) {
3876 return util::Error{_("Error: cannot remove legacy wallet records")};
3877 }
3878
3879 // Remove the LegacyScriptPubKeyMan from memory
3880 m_spk_managers.erase(legacy_spkm->GetID());
3883
3884 // Setup new descriptors (only if we are migrating any key material)
3885 SetWalletFlagWithDB(local_wallet_batch, WALLET_FLAG_DESCRIPTORS);
3886 if (has_spendable_material && !IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
3887 // Use the existing master key if we have it
3888 if (data.master_key.key.IsValid()) {
3889 SetupDescriptorScriptPubKeyMans(local_wallet_batch, data.master_key);
3890 } else {
3891 // Setup with a new seed if we don't.
3892 SetupOwnDescriptorScriptPubKeyMans(local_wallet_batch);
3893 }
3894 }
3895
3896 // Get best block locator so that we can copy it to the watchonly and solvables
3897 CBlockLocator best_block_locator;
3898 if (!local_wallet_batch.ReadBestBlock(best_block_locator)) {
3899 return util::Error{_("Error: Unable to read wallet's best block locator record")};
3900 }
3901
3902 // Update m_txos to match the descriptors remaining in this wallet
3903 m_txos.clear();
3905
3906 // Check if the transactions in the wallet are still ours. Either they belong here, or they belong in the watchonly wallet.
3907 // We need to go through these in the tx insertion order so that lookups to spends works.
3908 std::vector<Txid> txids_to_delete;
3909 std::unique_ptr<WalletBatch> watchonly_batch;
3910 if (data.watchonly_wallet) {
3911 watchonly_batch = std::make_unique<WalletBatch>(data.watchonly_wallet->GetDatabase());
3912 if (!watchonly_batch->TxnBegin()) return util::Error{strprintf(_("Error: database transaction cannot be executed for wallet %s"), data.watchonly_wallet->GetName())};
3913 // Copy the next tx order pos to the watchonly wallet
3914 LOCK(data.watchonly_wallet->cs_wallet);
3915 data.watchonly_wallet->nOrderPosNext = nOrderPosNext;
3916 watchonly_batch->WriteOrderPosNext(data.watchonly_wallet->nOrderPosNext);
3917 // Write the best block locator to avoid rescanning on reload
3918 if (!watchonly_batch->WriteBestBlock(best_block_locator)) {
3919 return util::Error{_("Error: Unable to write watchonly wallet best block locator record")};
3920 }
3921 }
3922 std::unique_ptr<WalletBatch> solvables_batch;
3923 if (data.solvable_wallet) {
3924 solvables_batch = std::make_unique<WalletBatch>(data.solvable_wallet->GetDatabase());
3925 if (!solvables_batch->TxnBegin()) return util::Error{strprintf(_("Error: database transaction cannot be executed for wallet %s"), data.solvable_wallet->GetName())};
3926 // Write the best block locator to avoid rescanning on reload
3927 if (!solvables_batch->WriteBestBlock(best_block_locator)) {
3928 return util::Error{_("Error: Unable to write solvable wallet best block locator record")};
3929 }
3930 }
3931 for (const auto& [_pos, wtx] : wtxOrdered) {
3932 // Check it is the watchonly wallet's
3933 // solvable_wallet doesn't need to be checked because transactions for those scripts weren't being watched for
3934 bool is_mine = IsMine(*wtx->tx) || IsFromMe(*wtx->tx);
3935 if (data.watchonly_wallet) {
3936 LOCK(data.watchonly_wallet->cs_wallet);
3937 if (data.watchonly_wallet->IsMine(*wtx->tx) || data.watchonly_wallet->IsFromMe(*wtx->tx)) {
3938 // Add to watchonly wallet
3939 const Txid& hash = wtx->GetHash();
3940 const CWalletTx& to_copy_wtx = *wtx;
3941 if (!data.watchonly_wallet->LoadToWallet(hash, [&](CWalletTx& ins_wtx, bool new_tx) EXCLUSIVE_LOCKS_REQUIRED(data.watchonly_wallet->cs_wallet) {
3942 if (!new_tx) return false;
3943 ins_wtx.SetTx(to_copy_wtx.tx);
3944 ins_wtx.CopyFrom(to_copy_wtx);
3945 return true;
3946 })) {
3947 return util::Error{strprintf(_("Error: Could not add watchonly tx %s to watchonly wallet"), wtx->GetHash().GetHex())};
3948 }
3949 watchonly_batch->WriteTx(data.watchonly_wallet->mapWallet.at(hash));
3950 // Mark as to remove from the migrated wallet only if it does not also belong to it
3951 if (!is_mine) {
3952 txids_to_delete.push_back(hash);
3953 }
3954 continue;
3955 }
3956 }
3957 if (!is_mine) {
3958 // Both not ours and not in the watchonly wallet
3959 return util::Error{strprintf(_("Error: Transaction %s in wallet cannot be identified to belong to migrated wallets"), wtx->GetHash().GetHex())};
3960 }
3961 }
3962
3963 // Do the removes
3964 if (txids_to_delete.size() > 0) {
3965 if (auto res = RemoveTxs(local_wallet_batch, txids_to_delete); !res) {
3966 return util::Error{_("Error: Could not delete watchonly transactions. ") + util::ErrorString(res)};
3967 }
3968 }
3969
3970 // Pair external wallets with their corresponding db handler
3971 std::vector<std::pair<std::shared_ptr<CWallet>, std::unique_ptr<WalletBatch>>> wallets_vec;
3972 if (data.watchonly_wallet) wallets_vec.emplace_back(data.watchonly_wallet, std::move(watchonly_batch));
3973 if (data.solvable_wallet) wallets_vec.emplace_back(data.solvable_wallet, std::move(solvables_batch));
3974
3975 // Write address book entry to disk
3976 auto func_store_addr = [](WalletBatch& batch, const CTxDestination& dest, const CAddressBookData& entry) {
3977 auto address{EncodeDestination(dest)};
3978 if (entry.purpose) batch.WritePurpose(address, PurposeToString(*entry.purpose));
3979 if (entry.label) batch.WriteName(address, *entry.label);
3980 for (const auto& [id, request] : entry.receive_requests) {
3981 batch.WriteAddressReceiveRequest(dest, id, request);
3982 }
3983 if (entry.previously_spent) batch.WriteAddressPreviouslySpent(dest, true);
3984 };
3985
3986 // Check the address book data in the same way we did for transactions
3987 std::vector<CTxDestination> dests_to_delete;
3988 for (const auto& [dest, record] : m_address_book) {
3989 // Ensure "receive" entries that are no longer part of the original wallet are transferred to another wallet
3990 // Entries for everything else ("send") will be cloned to all wallets.
3991 bool require_transfer = record.purpose == AddressPurpose::RECEIVE && !IsMine(dest);
3992 bool copied = false;
3993 for (auto& [wallet, batch] : wallets_vec) {
3994 LOCK(wallet->cs_wallet);
3995 if (require_transfer && !wallet->IsMine(dest)) continue;
3996
3997 // Copy the entire address book entry
3998 wallet->m_address_book[dest] = record;
3999 func_store_addr(*batch, dest, record);
4000
4001 copied = true;
4002 // Only delete 'receive' records that are no longer part of the original wallet
4003 if (require_transfer) {
4004 dests_to_delete.push_back(dest);
4005 break;
4006 }
4007 }
4008
4009 // Fail immediately if we ever found an entry that was ours and cannot be transferred
4010 // to any of the created wallets (watch-only, solvable).
4011 // Means that no inferred descriptor maps to the stored entry. Which mustn't happen.
4012 if (require_transfer && !copied) {
4013
4014 // Skip invalid/non-watched scripts that will not be migrated
4015 if (not_migrated_dests.count(dest) > 0) {
4016 dests_to_delete.push_back(dest);
4017 continue;
4018 }
4019
4020 return util::Error{_("Error: Address book data in wallet cannot be identified to belong to migrated wallets")};
4021 }
4022 }
4023
4024 // Persist external wallets address book entries
4025 for (auto& [wallet, batch] : wallets_vec) {
4026 if (!batch->TxnCommit()) {
4027 return util::Error{strprintf(_("Error: Unable to write data to disk for wallet %s"), wallet->GetName())};
4028 }
4029 }
4030
4031 // Remove the things to delete in this wallet
4032 if (dests_to_delete.size() > 0) {
4033 for (const auto& dest : dests_to_delete) {
4034 if (!DelAddressBookWithDB(local_wallet_batch, dest)) {
4035 return util::Error{_("Error: Unable to remove watchonly address book data")};
4036 }
4037 }
4038 }
4039
4040 // If there was no key material in the main wallet, there should be no records on it anymore.
4041 // This wallet will be discarded at the end of the process. Only wallets that contain the
4042 // migrated records will be presented to the user.
4043 if (!has_spendable_material) {
4044 if (!m_address_book.empty()) return util::Error{_("Error: Not all address book records were migrated")};
4045 if (!mapWallet.empty()) return util::Error{_("Error: Not all transaction records were migrated")};
4046 }
4047
4048 return {}; // all good
4049}
4050
4052{
4054}
4055
4057{
4058 AssertLockHeld(wallet.cs_wallet);
4059
4060 // Get all of the descriptors from the legacy wallet
4061 std::optional<MigrationData> data = wallet.GetDescriptorsForLegacy(error);
4062 if (data == std::nullopt) return false;
4063
4064 // Create the watchonly and solvable wallets if necessary
4065 if (data->watch_descs.size() > 0 || data->solvable_descs.size() > 0) {
4066 DatabaseOptions options;
4067 options.require_existing = false;
4068 options.require_create = true;
4070
4071 WalletContext empty_context;
4072 empty_context.args = context.args;
4073
4074 // Make the wallets
4076 if (wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE)) {
4078 }
4079 if (wallet.IsWalletFlagSet(WALLET_FLAG_KEY_ORIGIN_METADATA)) {
4081 }
4082 if (data->watch_descs.size() > 0) {
4083 wallet.WalletLogPrintf("Making a new watchonly wallet containing the watched scripts\n");
4084
4085 DatabaseStatus status;
4086 std::vector<bilingual_str> warnings;
4087 std::string wallet_name = wallet.GetName() + "_watchonly";
4088 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(wallet_name, options, status, error);
4089 if (!database) {
4090 error = strprintf(_("Wallet file creation failed: %s"), error);
4091 return false;
4092 }
4093
4094 data->watchonly_wallet = CWallet::Create(empty_context, wallet_name, std::move(database), options.create_flags, error, warnings);
4095 if (!data->watchonly_wallet) {
4096 error = _("Error: Failed to create new watchonly wallet");
4097 return false;
4098 }
4099 res.watchonly_wallet = data->watchonly_wallet;
4100 LOCK(data->watchonly_wallet->cs_wallet);
4101
4102 // Parse the descriptors and add them to the new wallet
4103 for (const auto& [desc_str, creation_time] : data->watch_descs) {
4104 // Parse the descriptor
4106 std::string parse_err;
4107 std::vector<std::unique_ptr<Descriptor>> descs = Parse(desc_str, keys, parse_err, /* require_checksum */ true);
4108 assert(descs.size() == 1); // It shouldn't be possible to have the LegacyScriptPubKeyMan make an invalid descriptor or a multipath descriptors
4109 assert(!descs.at(0)->IsRange()); // It shouldn't be possible to have LegacyScriptPubKeyMan make a ranged watchonly descriptor
4110
4111 // Add to the wallet
4112 WalletDescriptor w_desc(std::move(descs.at(0)), creation_time, 0, 0, 0);
4113 if (auto spkm_res = data->watchonly_wallet->AddWalletDescriptor(w_desc, keys, "", false); !spkm_res) {
4114 throw std::runtime_error(util::ErrorString(spkm_res).original);
4115 }
4116 }
4117
4118 // Add the wallet to settings
4119 UpdateWalletSetting(*context.chain, wallet_name, /*load_on_startup=*/true, warnings);
4120 }
4121 if (data->solvable_descs.size() > 0) {
4122 wallet.WalletLogPrintf("Making a new watchonly wallet containing the unwatched solvable scripts\n");
4123
4124 DatabaseStatus status;
4125 std::vector<bilingual_str> warnings;
4126 std::string wallet_name = wallet.GetName() + "_solvables";
4127 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(wallet_name, options, status, error);
4128 if (!database) {
4129 error = strprintf(_("Wallet file creation failed: %s"), error);
4130 return false;
4131 }
4132
4133 data->solvable_wallet = CWallet::Create(empty_context, wallet_name, std::move(database), options.create_flags, error, warnings);
4134 if (!data->solvable_wallet) {
4135 error = _("Error: Failed to create new watchonly wallet");
4136 return false;
4137 }
4138 res.solvables_wallet = data->solvable_wallet;
4139 LOCK(data->solvable_wallet->cs_wallet);
4140
4141 // Parse the descriptors and add them to the new wallet
4142 for (const auto& [desc_str, creation_time] : data->solvable_descs) {
4143 // Parse the descriptor
4145 std::string parse_err;
4146 std::vector<std::unique_ptr<Descriptor>> descs = Parse(desc_str, keys, parse_err, /* require_checksum */ true);
4147 assert(descs.size() == 1); // It shouldn't be possible to have the LegacyScriptPubKeyMan make an invalid descriptor or a multipath descriptors
4148 assert(!descs.at(0)->IsRange()); // It shouldn't be possible to have LegacyScriptPubKeyMan make a ranged watchonly descriptor
4149
4150 // Add to the wallet
4151 WalletDescriptor w_desc(std::move(descs.at(0)), creation_time, 0, 0, 0);
4152 if (auto spkm_res = data->solvable_wallet->AddWalletDescriptor(w_desc, keys, "", false); !spkm_res) {
4153 throw std::runtime_error(util::ErrorString(spkm_res).original);
4154 }
4155 }
4156
4157 // Add the wallet to settings
4158 UpdateWalletSetting(*context.chain, wallet_name, /*load_on_startup=*/true, warnings);
4159 }
4160 }
4161
4162 // Add the descriptors to wallet, remove LegacyScriptPubKeyMan, and cleanup txs and address book data
4163 return RunWithinTxn(wallet.GetDatabase(), /*process_desc=*/"apply migration process", [&](WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet){
4164 if (auto res_migration = wallet.ApplyMigrationData(batch, *data); !res_migration) {
4165 error = util::ErrorString(res_migration);
4166 return false;
4167 }
4168 wallet.WalletLogPrintf("Wallet migration complete.\n");
4169 return true;
4170 });
4171}
4172
4173util::Result<MigrationResult> MigrateLegacyToDescriptor(const std::string& wallet_name, const SecureString& passphrase, WalletContext& context)
4174{
4175 std::vector<bilingual_str> warnings;
4176 bilingual_str error;
4177
4178 // The only kind of wallets that could be loaded are descriptor ones, which don't need to be migrated.
4179 if (auto wallet = GetWallet(context, wallet_name)) {
4180 assert(wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
4181 return util::Error{_("Error: This wallet is already a descriptor wallet")};
4182 } else {
4183 // Check if the wallet is BDB
4184 const auto& wallet_path = GetWalletPath(wallet_name);
4185 if (!wallet_path) {
4186 return util::Error{util::ErrorString(wallet_path)};
4187 }
4188 if (!fs::exists(*wallet_path)) {
4189 return util::Error{_("Error: Wallet does not exist")};
4190 }
4191 if (!IsBDBFile(BDBDataFile(*wallet_path))) {
4192 return util::Error{_("Error: This wallet is already a descriptor wallet")};
4193 }
4194 }
4195
4196 // Load the wallet but only in the context of this function.
4197 // No signals should be connected nor should anything else be aware of this wallet
4198 WalletContext empty_context;
4199 empty_context.args = context.args;
4200 DatabaseOptions options;
4201 options.require_existing = true;
4202 options.require_format = DatabaseFormat::BERKELEY_RO;
4203 DatabaseStatus status;
4204 std::unique_ptr<WalletDatabase> database = MakeWalletDatabase(wallet_name, options, status, error);
4205 if (!database) {
4206 return util::Error{Untranslated("Wallet file verification failed.") + Untranslated(" ") + error};
4207 }
4208
4209 // Make the local wallet
4210 std::shared_ptr<CWallet> local_wallet = CWallet::Create(empty_context, wallet_name, std::move(database), options.create_flags, error, warnings);
4211 if (!local_wallet) {
4212 return util::Error{Untranslated("Wallet loading failed.") + Untranslated(" ") + error};
4213 }
4214
4215 return MigrateLegacyToDescriptor(std::move(local_wallet), passphrase, context);
4216}
4217
4218util::Result<MigrationResult> MigrateLegacyToDescriptor(std::shared_ptr<CWallet> local_wallet, const SecureString& passphrase, WalletContext& context)
4219{
4220 MigrationResult res;
4221 bilingual_str error;
4222 std::vector<bilingual_str> warnings;
4223
4224 DatabaseOptions options;
4225 options.require_existing = true;
4226 DatabaseStatus status;
4227
4228 const std::string wallet_name = local_wallet->GetName();
4229
4230 // Before anything else, check if there is something to migrate.
4231 if (local_wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
4232 return util::Error{_("Error: This wallet is already a descriptor wallet")};
4233 }
4234
4235 // Make a backup of the DB in the wallet's directory with a unique filename
4236 // using the wallet name and current timestamp. The backup filename is based
4237 // on the name of the parent directory containing the wallet data in most
4238 // cases, but in the case where the wallet name is a path to a data file,
4239 // the name of the data file is used, and in the case where the wallet name
4240 // is blank, "default_wallet" is used.
4241 const std::string backup_prefix = wallet_name.empty() ? "default_wallet" : [&] {
4242 // fs::weakly_canonical resolves relative specifiers and remove trailing slashes.
4243 const auto legacy_wallet_path = fs::weakly_canonical(GetWalletDir() / fs::PathFromString(wallet_name));
4244 return fs::PathToString(legacy_wallet_path.filename());
4245 }();
4246
4247 fs::path backup_filename = fs::PathFromString(strprintf("%s_%d.legacy.bak", backup_prefix, GetTime()));
4248 fs::path backup_path = fsbridge::AbsPathJoin(GetWalletDir(), backup_filename);
4249 if (!local_wallet->BackupWallet(fs::PathToString(backup_path))) {
4250 return util::Error{_("Error: Unable to make a backup of your wallet")};
4251 }
4252 res.backup_path = backup_path;
4253
4254 bool success = false;
4255
4256 // Unlock the wallet if needed
4257 if (local_wallet->IsLocked() && !local_wallet->Unlock(passphrase)) {
4258 if (passphrase.find('\0') == std::string::npos) {
4259 return util::Error{Untranslated("Error: Wallet decryption failed, the wallet passphrase was not provided or was incorrect.")};
4260 } else {
4261 return util::Error{Untranslated("Error: Wallet decryption failed, the wallet passphrase entered was incorrect. "
4262 "The passphrase contains a null character (ie - a zero byte). "
4263 "If this passphrase was set with a version of this software prior to 25.0, "
4264 "please try again with only the characters up to — but not including — "
4265 "the first null character.")};
4266 }
4267 }
4268
4269 // Indicates whether the current wallet is empty after migration.
4270 // Notes:
4271 // When non-empty: the local wallet becomes the main spendable wallet.
4272 // When empty: The local wallet is excluded from the result, as the
4273 // user does not expect an empty spendable wallet after
4274 // migrating only watch-only scripts.
4275 bool empty_local_wallet = false;
4276
4277 {
4278 LOCK(local_wallet->cs_wallet);
4279 // First change to using SQLite
4280 if (!local_wallet->MigrateToSQLite(error)) return util::Error{error};
4281
4282 // Do the migration of keys and scripts for non-empty wallets, and cleanup if it fails
4283 if (HasLegacyRecords(*local_wallet)) {
4284 success = DoMigration(*local_wallet, context, error, res);
4285 // No scripts mean empty wallet after migration
4286 empty_local_wallet = local_wallet->GetAllScriptPubKeyMans().empty();
4287 } else {
4288 // Make sure that descriptors flag is actually set
4289 local_wallet->SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
4290 success = true;
4291 }
4292 }
4293
4294 // In case of loading failure, we need to remember the wallet dirs to remove.
4295 // A `set` is used as it may be populated with the same wallet directory paths multiple times,
4296 // both before and after loading. This ensures the set is complete even if one of the wallets
4297 // fails to load.
4298 std::set<fs::path> wallet_dirs;
4299 if (success) {
4300 Assume(!res.wallet); // We will set it here.
4301 // Check if the local wallet is empty after migration
4302 if (empty_local_wallet) {
4303 // This wallet has no records. We can safely remove it.
4304 std::vector<fs::path> paths_to_remove = local_wallet->GetDatabase().Files();
4305 local_wallet.reset();
4306 for (const auto& path_to_remove : paths_to_remove) fs::remove_all(path_to_remove);
4307 }
4308
4309 // Migration successful, load all the migrated wallets.
4310 for (std::shared_ptr<CWallet>* wallet_ptr : {&local_wallet, &res.watchonly_wallet, &res.solvables_wallet}) {
4311 if (success && *wallet_ptr) {
4312 std::shared_ptr<CWallet>& wallet = *wallet_ptr;
4313 // Save db path and load wallet
4314 wallet_dirs.insert(fs::PathFromString(wallet->GetDatabase().Filename()).parent_path());
4315 assert(wallet.use_count() == 1);
4316 std::string wallet_name = wallet->GetName();
4317 wallet.reset();
4318 wallet = LoadWallet(context, wallet_name, /*load_on_start=*/std::nullopt, options, status, error, warnings);
4319 success = (wallet != nullptr);
4320
4321 // When no wallet is set, set the main wallet.
4322 if (success && !res.wallet) {
4323 res.wallet_name = wallet->GetName();
4324 res.wallet = std::move(wallet);
4325 }
4326 }
4327 }
4328 }
4329 if (!success) {
4330 // Make list of wallets to cleanup
4331 std::vector<std::shared_ptr<CWallet>> created_wallets;
4332 if (local_wallet) created_wallets.push_back(std::move(local_wallet));
4333 if (res.watchonly_wallet) created_wallets.push_back(std::move(res.watchonly_wallet));
4334 if (res.solvables_wallet) created_wallets.push_back(std::move(res.solvables_wallet));
4335
4336 // Get the directories to remove after unloading
4337 for (std::shared_ptr<CWallet>& w : created_wallets) {
4338 wallet_dirs.emplace(fs::PathFromString(w->GetDatabase().Filename()).parent_path());
4339 }
4340
4341 // Unload the wallets
4342 for (std::shared_ptr<CWallet>& w : created_wallets) {
4343 if (w->HaveChain()) {
4344 // Unloading for wallets that were loaded for normal use
4345 if (!RemoveWallet(context, w, /*load_on_start=*/false)) {
4346 error += _("\nUnable to cleanup failed migration");
4347 return util::Error{error};
4348 }
4349 WaitForDeleteWallet(std::move(w));
4350 } else {
4351 // Unloading for wallets in local context
4352 assert(w.use_count() == 1);
4353 w.reset();
4354 }
4355 }
4356
4357 // Delete the wallet directories
4358 for (const fs::path& dir : wallet_dirs) {
4359 fs::remove_all(dir);
4360 }
4361
4362 // Restore the backup
4363 // Convert the backup file to the wallet db file by renaming it and moving it into the wallet's directory.
4364 bilingual_str restore_error;
4365 const auto& ptr_wallet = RestoreWallet(context, backup_path, wallet_name, /*load_on_start=*/std::nullopt, status, restore_error, warnings, /*load_after_restore=*/false);
4366 if (!restore_error.empty()) {
4367 error += restore_error + _("\nUnable to restore backup of wallet.");
4368 return util::Error{error};
4369 }
4370 // Verify that the legacy wallet is not loaded after restoring from the backup.
4371 assert(!ptr_wallet);
4372
4373 return util::Error{error};
4374 }
4375 return res;
4376}
4377
4378void CWallet::CacheNewScriptPubKeys(const std::set<CScript>& spks, ScriptPubKeyMan* spkm)
4379{
4380 for (const auto& script : spks) {
4381 m_cached_spks[script].push_back(spkm);
4382 }
4383}
4384
4385void CWallet::TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm)
4386{
4387 // Update scriptPubKey cache
4388 CacheNewScriptPubKeys(spks, spkm);
4389}
4390
4391std::set<CExtPubKey> CWallet::GetActiveHDPubKeys() const
4392{
4393 AssertLockHeld(cs_wallet);
4394
4395 Assert(IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
4396
4397 std::set<CExtPubKey> active_xpubs;
4398 for (const auto& spkm : GetActiveScriptPubKeyMans()) {
4399 const DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
4400 assert(desc_spkm);
4401 LOCK(desc_spkm->cs_desc_man);
4402 WalletDescriptor w_desc = desc_spkm->GetWalletDescriptor();
4403
4404 std::set<CPubKey> desc_pubkeys;
4405 std::set<CExtPubKey> desc_xpubs;
4406 w_desc.descriptor->GetPubKeys(desc_pubkeys, desc_xpubs);
4407 active_xpubs.merge(std::move(desc_xpubs));
4408 }
4409 return active_xpubs;
4410}
4411
4412std::optional<CKey> CWallet::GetKey(const CKeyID& keyid) const
4413{
4414 Assert(IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
4415
4416 for (const auto& spkm : GetAllScriptPubKeyMans()) {
4417 const DescriptorScriptPubKeyMan* desc_spkm = dynamic_cast<DescriptorScriptPubKeyMan*>(spkm);
4418 assert(desc_spkm);
4419 LOCK(desc_spkm->cs_desc_man);
4420 if (std::optional<CKey> key = desc_spkm->GetKey(keyid)) {
4421 return key;
4422 }
4423 }
4424 return std::nullopt;
4425}
4426
4427void CWallet::WriteBestBlock() const
4428{
4429 AssertLockHeld(cs_wallet);
4430
4431 if (!m_last_block_processed.IsNull()) {
4432 CBlockLocator loc;
4433 chain().findBlock(m_last_block_processed, FoundBlock().locator(loc));
4434
4435 if (!loc.IsNull()) {
4436 WalletBatch batch(GetDatabase());
4437 batch.WriteBestBlock(loc);
4438 }
4439 }
4440}
4441
4442void CWallet::RefreshTXOsFromTx(const CWalletTx& wtx)
4443{
4444 AssertLockHeld(cs_wallet);
4445 for (uint32_t i = 0; i < wtx.tx->vout.size(); ++i) {
4446 const CTxOut& txout = wtx.tx->vout.at(i);
4447 if (!IsMine(txout)) continue;
4448 COutPoint outpoint(wtx.GetHash(), i);
4449 if (m_txos.contains(outpoint)) {
4450 } else {
4451 m_txos.emplace(outpoint, WalletTXO{wtx, txout});
4452 }
4453 }
4454}
4455
4456void CWallet::RefreshAllTXOs()
4457{
4458 AssertLockHeld(cs_wallet);
4459 for (const auto& [_, wtx] : mapWallet) {
4460 RefreshTXOsFromTx(wtx);
4461 }
4462}
4463
4464std::optional<WalletTXO> CWallet::GetTXO(const COutPoint& outpoint) const
4465{
4466 AssertLockHeld(cs_wallet);
4467 const auto& it = m_txos.find(outpoint);
4468 if (it == m_txos.end()) {
4469 return std::nullopt;
4470 }
4471 return it->second;
4472}
4473} // 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:2516
bool SetAddressBook(const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &purpose)
Definition: wallet.cpp:2404
std::atomic< bool > fAbortRescan
Definition: wallet.h:317
bool TopUpKeyPool(unsigned int kpSize=0)
Definition: wallet.cpp:2479
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:3278
unsigned int GetKeyPoolSize() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2468
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:4464
bool IsActiveScriptPubKeyMan(const ScriptPubKeyMan &spkm) const
Definition: wallet.cpp:3338
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:3601
void LoadActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal)
Loads an active ScriptPubKeyMan for the specified type and internal.
Definition: wallet.cpp:3615
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:2663
bool SignTransaction(CMutableTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Fetch the inputs and sign with SIGHASH_ALL.
Definition: wallet.cpp:2088
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:3391
bool IsTxImmatureCoinBase(const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3270
void RefreshAllTXOs() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Cache outputs that belong to the wallet for all transactions in the wallet.
Definition: wallet.cpp:4456
void AddActiveScriptPubKeyManWithDb(WalletBatch &batch, uint256 id, OutputType type, bool internal)
Definition: wallet.cpp:3607
DBErrors LoadWallet()
Definition: wallet.cpp:2289
std::set< ScriptPubKeyMan * > GetActiveScriptPubKeyMans() const
Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers.
Definition: wallet.cpp:3324
const CAddressBookData * FindAddressBookEntry(const CTxDestination &, bool allow_change=false) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3218
void postInitProcess()
Wallet post-init setup Gives the wallet a chance to register repetitive tasks and complete post-init ...
Definition: wallet.cpp:3228
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:3244
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:2122
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:2792
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:3422
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:2539
DescriptorScriptPubKeyMan * GetDescriptorScriptPubKeyMan(const WalletDescriptor &desc) const
Return the DescriptorScriptPubKeyMan for a WalletDescriptor if it is already in the wallet.
Definition: wallet.cpp:3652
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:3492
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:3821
bool HaveCryptedKeys() const
Definition: wallet.cpp:3476
LegacyDataSPKM * GetOrCreateLegacyDataSPKM()
Definition: wallet.cpp:3442
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:3309
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:3747
bool BackupWallet(const std::string &strDest) const
Definition: wallet.cpp:3238
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:2751
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:2314
util::Result< CTxDestination > GetNewDestination(const OutputType type, const std::string label)
Definition: wallet.cpp:2489
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:2781
std::vector< WalletDescriptor > GetWalletDescriptors(const CScript &script) const
Get the wallet descriptors for a script.
Definition: wallet.cpp:3410
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:2456
int GetTxBlocksToMaturity(const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:3258
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:3471
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:2839
bool CanGrindR() const
Whether the (external) signer performs R-value signature grinding.
Definition: wallet.cpp:4051
std::optional< bool > IsInternalScriptPubKeyMan(ScriptPubKeyMan *spk_man) const
Returns whether the provided ScriptPubKeyMan is internal.
Definition: wallet.cpp:3667
void LoadLockedCoin(const COutPoint &coin, bool persistent) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2619
TxItems wtxOrdered
Definition: wallet.h:503
SigningResult SignMessage(const std::string &message, const PKHash &pkhash, std::string &str_sig) const
Definition: wallet.cpp:2176
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:3840
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:2799
bool SetAddressBookWithDB(WalletBatch &batch, const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &strPurpose)
Definition: wallet.cpp:2368
void WriteBestBlock() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Write the current best block to database.
Definition: wallet.cpp:4427
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:2417
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:2770
void AddScriptPubKeyMan(const uint256 &id, std::unique_ptr< ScriptPubKeyMan > spkm_man)
Definition: wallet.cpp:3432
void DeactivateScriptPubKeyMan(uint256 id, OutputType type, bool internal)
Remove specified ScriptPubKeyMan from set of active SPK managers.
Definition: wallet.cpp:3635
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:2625
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:2555
bool IsLocked() const override
Definition: wallet.cpp:3283
OutputType TransactionChangeType(const std::optional< OutputType > &change_type, const std::vector< CRecipient > &vecSend) const
Definition: wallet.cpp:2189
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:3349
void RefreshTXOsFromTx(const CWalletTx &wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Cache outputs that belong to the wallet from a single transaction.
Definition: wallet.cpp:4442
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:2700
void ListLockedCoins(std::vector< COutPoint > &vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2669
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:2250
bool UnlockAllCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2651
util::Result< CTxDestination > GetNewChangeDestination(const OutputType type)
Definition: wallet.cpp:2505
ScriptPubKeyMan * GetScriptPubKeyMan(const OutputType &type, bool internal) const
Get the ScriptPubKeyMan for the given OutputType and internal/external chain.
Definition: wallet.cpp:3358
bool IsAddressPreviouslySpent(const CTxDestination &dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.cpp:2775
bool WithEncryptionKey(std::function< bool(const CKeyingMaterial &)> cb) const override
Pass the encryption key to cb().
Definition: wallet.cpp:3465
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:2530
void ConnectScriptPubKeyManNotifiers()
Connect the signals from ScriptPubKeyMans to the signals in CWallet.
Definition: wallet.cpp:3484
bool DelAddressBook(const CTxDestination &address)
Definition: wallet.cpp:2410
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:3448
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:3098
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:3534
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:3550
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:3504
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:2636
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:2765
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:3686
std::set< ScriptPubKeyMan * > GetScriptPubKeyMans(const CScript &script) const
Get all the ScriptPubKeyMans for a script.
Definition: wallet.cpp:3368
util::Result< void > DisplayAddress(const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Display address on an external signer.
Definition: wallet.cpp:2604
A transaction with a bunch of additional info that only the owner cares about.
Definition: transaction.h:195
bool isBlockConflicted() const
Definition: transaction.h:360
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:364
const T * state() const
Definition: transaction.h:351
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:276
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:235
bool isUnconfirmed() const
Definition: transaction.h:362
unsigned int nTimeReceived
time received by this node
Definition: transaction.h:224
CTransactionRef tx
Definition: transaction.h:267
void SetTx(CTransactionRef arg)
Definition: transaction.h:330
bool IsCoinBase() const
Definition: transaction.h:366
bool InMempool() const
Definition: transaction.cpp:27
bool isAbandoned() const
Definition: transaction.h:358
std::optional< Txid > truc_child_in_mempool
Definition: transaction.h:280
bool isInactive() const
Definition: transaction.h:361
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:247
std::multimap< int64_t, CWalletTx * >::const_iterator m_it_wtxOrdered
Definition: transaction.h:236
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:336
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:2586
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:2595
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:2569
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:1682
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:1742
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:1676
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:1747
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:1709
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:1696
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:1988
void UnsetBlankWalletFlag(WalletBatch &batch) override
Unset the blank wallet flag and saves it to disk.
Definition: wallet.cpp:1704
void ResubmitWalletTransactions(bool relay, bool force)
Definition: wallet.cpp:2041
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:1663
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:1807
bool LoadWalletFlags(uint64_t flags)
Loads the flags into the wallet.
Definition: wallet.cpp:1714
bool IsHDEnabled() const
Definition: wallet.cpp:1652
void transactionRemovedFromMempool(const CTransactionRef &tx, MemPoolRemovalReason reason) override
Definition: wallet.cpp:1411
static NodeClock::time_point GetDefaultNextResend()
Definition: wallet.cpp:2015
bool ShouldResend() const
Return true if all conditions for periodically resending transactions are met.
Definition: wallet.cpp:1998
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:1726
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:1690
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:1763
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:1958
@ 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:2078
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:4218
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:2828
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:4056
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:2806
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