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