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