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