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