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