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