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