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