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