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