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