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