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