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