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