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