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