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