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