Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #ifndef BITCOIN_WALLET_WALLET_H
7 : : #define BITCOIN_WALLET_WALLET_H
8 : :
9 : : #include <addresstype.h>
10 : : #include <consensus/amount.h>
11 : : #include <interfaces/chain.h>
12 : : #include <interfaces/handler.h>
13 : : #include <kernel/cs_main.h>
14 : : #include <logging.h>
15 : : #include <outputtype.h>
16 : : #include <policy/feerate.h>
17 : : #include <primitives/transaction.h>
18 : : #include <script/interpreter.h>
19 : : #include <script/script.h>
20 : : #include <support/allocators/secure.h>
21 : : #include <sync.h>
22 : : #include <tinyformat.h>
23 : : #include <uint256.h>
24 : : #include <util/fs.h>
25 : : #include <util/hasher.h>
26 : : #include <util/result.h>
27 : : #include <util/string.h>
28 : : #include <util/time.h>
29 : : #include <util/ui_change_type.h>
30 : : #include <wallet/crypter.h>
31 : : #include <wallet/db.h>
32 : : #include <wallet/scriptpubkeyman.h>
33 : : #include <wallet/transaction.h>
34 : : #include <wallet/types.h>
35 : : #include <wallet/walletutil.h>
36 : :
37 : : #include <atomic>
38 : : #include <cassert>
39 : : #include <cstddef>
40 : : #include <cstdint>
41 : : #include <functional>
42 : : #include <limits>
43 : : #include <map>
44 : : #include <memory>
45 : : #include <optional>
46 : : #include <set>
47 : : #include <string>
48 : : #include <unordered_map>
49 : : #include <utility>
50 : : #include <vector>
51 : :
52 : : #include <boost/signals2/signal.hpp>
53 : :
54 : : class CKey;
55 : : class CKeyID;
56 : : class CPubKey;
57 : : class Coin;
58 : : class SigningProvider;
59 : : enum class MemPoolRemovalReason;
60 : : enum class SigningResult;
61 : : namespace common {
62 : : enum class PSBTError;
63 : : } // namespace common
64 : : namespace interfaces {
65 : : class Wallet;
66 : : }
67 : : namespace wallet {
68 : : class CWallet;
69 : : class WalletBatch;
70 : : enum class DBErrors : int;
71 : : } // namespace wallet
72 : : struct CBlockLocator;
73 : : struct CExtKey;
74 : : struct FlatSigningProvider;
75 : : struct KeyOriginInfo;
76 : : struct PartiallySignedTransaction;
77 : : struct SignatureData;
78 : :
79 : : using LoadWalletFn = std::function<void(std::unique_ptr<interfaces::Wallet> wallet)>;
80 : :
81 : : struct bilingual_str;
82 : :
83 : : namespace wallet {
84 : : struct WalletContext;
85 : :
86 : : //! Explicitly delete the wallet.
87 : : //! Blocks the current thread until the wallet is destructed.
88 : : void WaitForDeleteWallet(std::shared_ptr<CWallet>&& wallet);
89 : :
90 : : bool AddWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet);
91 : : bool RemoveWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet, std::optional<bool> load_on_start, std::vector<bilingual_str>& warnings);
92 : : bool RemoveWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet, std::optional<bool> load_on_start);
93 : : std::vector<std::shared_ptr<CWallet>> GetWallets(WalletContext& context);
94 : : std::shared_ptr<CWallet> GetDefaultWallet(WalletContext& context, size_t& count);
95 : : std::shared_ptr<CWallet> GetWallet(WalletContext& context, const std::string& name);
96 : : 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);
97 : : 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);
98 : : 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 = true);
99 : : std::unique_ptr<interfaces::Handler> HandleLoadWallet(WalletContext& context, LoadWalletFn load_wallet);
100 : : void NotifyWalletLoaded(WalletContext& context, const std::shared_ptr<CWallet>& wallet);
101 : : std::unique_ptr<WalletDatabase> MakeWalletDatabase(const std::string& name, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);
102 : :
103 : : //! -paytxfee default
104 : : constexpr CAmount DEFAULT_PAY_TX_FEE = 0;
105 : : //! -fallbackfee default
106 : : static const CAmount DEFAULT_FALLBACK_FEE = 0;
107 : : //! -discardfee default
108 : : static const CAmount DEFAULT_DISCARD_FEE = 10000;
109 : : //! -mintxfee default
110 : : static const CAmount DEFAULT_TRANSACTION_MINFEE = 1000;
111 : : //! -consolidatefeerate default
112 : : static const CAmount DEFAULT_CONSOLIDATE_FEERATE{10000}; // 10 sat/vbyte
113 : : /**
114 : : * maximum fee increase allowed to do partial spend avoidance, even for nodes with this feature disabled by default
115 : : *
116 : : * A value of -1 disables this feature completely.
117 : : * A value of 0 (current default) means to attempt to do partial spend avoidance, and use its results if the fees remain *unchanged*
118 : : * A value > 0 means to do partial spend avoidance if the fee difference against a regular coin selection instance is in the range [0..value].
119 : : */
120 : : static const CAmount DEFAULT_MAX_AVOIDPARTIALSPEND_FEE = 0;
121 : : //! discourage APS fee higher than this amount
122 : : constexpr CAmount HIGH_APS_FEE{COIN / 10000};
123 : : //! minimum recommended increment for replacement txs
124 : : static const CAmount WALLET_INCREMENTAL_RELAY_FEE = 5000;
125 : : //! Default for -spendzeroconfchange
126 : : static const bool DEFAULT_SPEND_ZEROCONF_CHANGE = true;
127 : : //! Default for -walletrejectlongchains
128 : : static const bool DEFAULT_WALLET_REJECT_LONG_CHAINS{true};
129 : : //! -txconfirmtarget default
130 : : static const unsigned int DEFAULT_TX_CONFIRM_TARGET = 6;
131 : : //! -walletrbf default
132 : : static const bool DEFAULT_WALLET_RBF = true;
133 : : static const bool DEFAULT_WALLETBROADCAST = true;
134 : : static const bool DEFAULT_DISABLE_WALLET = false;
135 : : static const bool DEFAULT_WALLETCROSSCHAIN = false;
136 : : //! -maxtxfee default
137 : : constexpr CAmount DEFAULT_TRANSACTION_MAXFEE{COIN / 10};
138 : : //! Discourage users to set fees higher than this amount (in satoshis) per kB
139 : : constexpr CAmount HIGH_TX_FEE_PER_KB{COIN / 100};
140 : : //! -maxtxfee will warn if called with a higher fee than this amount (in satoshis)
141 : : constexpr CAmount HIGH_MAX_TX_FEE{100 * HIGH_TX_FEE_PER_KB};
142 : : //! Pre-calculated constants for input size estimation in *virtual size*
143 : : static constexpr size_t DUMMY_NESTED_P2WPKH_INPUT_SIZE = 91;
144 : :
145 : : class CCoinControl;
146 : :
147 : : //! Default for -addresstype
148 : : constexpr OutputType DEFAULT_ADDRESS_TYPE{OutputType::BECH32};
149 : :
150 : : static constexpr uint64_t KNOWN_WALLET_FLAGS =
151 : : WALLET_FLAG_AVOID_REUSE
152 : : | WALLET_FLAG_BLANK_WALLET
153 : : | WALLET_FLAG_KEY_ORIGIN_METADATA
154 : : | WALLET_FLAG_LAST_HARDENED_XPUB_CACHED
155 : : | WALLET_FLAG_DISABLE_PRIVATE_KEYS
156 : : | WALLET_FLAG_DESCRIPTORS
157 : : | WALLET_FLAG_EXTERNAL_SIGNER;
158 : :
159 : : static constexpr uint64_t MUTABLE_WALLET_FLAGS =
160 : : WALLET_FLAG_AVOID_REUSE;
161 : :
162 : : static const std::map<std::string,WalletFlags> WALLET_FLAG_MAP{
163 : : {"avoid_reuse", WALLET_FLAG_AVOID_REUSE},
164 : : {"blank", WALLET_FLAG_BLANK_WALLET},
165 : : {"key_origin_metadata", WALLET_FLAG_KEY_ORIGIN_METADATA},
166 : : {"last_hardened_xpub_cached", WALLET_FLAG_LAST_HARDENED_XPUB_CACHED},
167 : : {"disable_private_keys", WALLET_FLAG_DISABLE_PRIVATE_KEYS},
168 : : {"descriptor_wallet", WALLET_FLAG_DESCRIPTORS},
169 : : {"external_signer", WALLET_FLAG_EXTERNAL_SIGNER}
170 : : };
171 : :
172 : : /** A wrapper to reserve an address from a wallet
173 : : *
174 : : * ReserveDestination is used to reserve an address.
175 : : * It is currently only used inside of CreateTransaction.
176 : : *
177 : : * Instantiating a ReserveDestination does not reserve an address. To do so,
178 : : * GetReservedDestination() needs to be called on the object. Once an address has been
179 : : * reserved, call KeepDestination() on the ReserveDestination object to make sure it is not
180 : : * returned. Call ReturnDestination() to return the address so it can be reused (for
181 : : * example, if the address was used in a new transaction
182 : : * and that transaction was not completed and needed to be aborted).
183 : : *
184 : : * If an address is reserved and KeepDestination() is not called, then the address will be
185 : : * returned when the ReserveDestination goes out of scope.
186 : : */
187 : : class ReserveDestination
188 : : {
189 : : protected:
190 : : //! The wallet to reserve from
191 : : const CWallet* const pwallet;
192 : : //! The ScriptPubKeyMan to reserve from. Based on type when GetReservedDestination is called
193 : : ScriptPubKeyMan* m_spk_man{nullptr};
194 : : OutputType const type;
195 : : //! The index of the address's key in the keypool
196 : : int64_t nIndex{-1};
197 : : //! The destination
198 : : CTxDestination address;
199 : : //! Whether this is from the internal (change output) keypool
200 : : bool fInternal{false};
201 : :
202 : : public:
203 : : //! Construct a ReserveDestination object. This does NOT reserve an address yet
204 : 3618 : explicit ReserveDestination(CWallet* pwallet, OutputType type)
205 : 3618 : : pwallet(pwallet)
206 [ + - ]: 3618 : , type(type) { }
207 : :
208 : : ReserveDestination(const ReserveDestination&) = delete;
209 : : ReserveDestination& operator=(const ReserveDestination&) = delete;
210 : :
211 : : //! Destructor. If a key has been reserved and not KeepKey'ed, it will be returned to the keypool
212 : 3618 : ~ReserveDestination()
213 : : {
214 : 3618 : ReturnDestination();
215 [ + - ]: 3618 : }
216 : :
217 : : //! Reserve an address
218 : : util::Result<CTxDestination> GetReservedDestination(bool internal);
219 : : //! Return reserved address
220 : : void ReturnDestination();
221 : : //! Keep the address. Do not return its key to the keypool when this object goes out of scope
222 : : void KeepDestination();
223 : : };
224 : :
225 : : /**
226 : : * Address book data.
227 : : */
228 : 31192 : struct CAddressBookData
229 : : {
230 : : /**
231 : : * Address label which is always nullopt for change addresses. For sending
232 : : * and receiving addresses, it will be set to an arbitrary label string
233 : : * provided by the user, or to "", which is the default label. The presence
234 : : * or absence of a label is used to distinguish change addresses from
235 : : * non-change addresses by wallet transaction listing and fee bumping code.
236 : : */
237 : : std::optional<std::string> label;
238 : :
239 : : /**
240 : : * Address purpose which was originally recorded for payment protocol
241 : : * support but now serves as a cached IsMine value. Wallet code should
242 : : * not rely on this field being set.
243 : : */
244 : : std::optional<AddressPurpose> purpose;
245 : :
246 : : /**
247 : : * Whether coins with this address have previously been spent. Set when the
248 : : * the wallet avoid_reuse option is enabled and this is an IsMine address
249 : : * that has already received funds and spent them. This is used during coin
250 : : * selection to increase privacy by not creating different transactions
251 : : * that spend from the same addresses.
252 : : */
253 : : bool previously_spent{false};
254 : :
255 : : /**
256 : : * Map containing data about previously generated receive requests
257 : : * requesting funds to be sent to this address. Only present for IsMine
258 : : * addresses. Map keys are decimal numbers uniquely identifying each
259 : : * request, and map values are serialized RecentRequestEntry objects
260 : : * containing BIP21 URI information including message and amount.
261 : : */
262 : : std::map<std::string, std::string> receive_requests{};
263 : :
264 : : /** Accessor methods. */
265 [ + + + - : 37949 : bool IsChange() const { return !label.has_value(); }
- + ][ + -
# # # # ]
266 [ + - + - ]: 37216 : std::string GetLabel() const { return label ? *label : std::string{}; }
[ + - # #
# # # # #
# # # # #
# # # # #
# ][ + - +
- + - +
- ][ + - +
- + - + -
+ - + - +
- + - + -
+ - ]
267 : 31169 : void SetLabel(std::string name) { label = std::move(name); }
268 : : };
269 : :
270 : 28395 : inline std::string PurposeToString(AddressPurpose p)
271 : : {
272 [ + + - - ]: 28395 : switch(p) {
273 : 28384 : case AddressPurpose::RECEIVE: return "receive";
274 : 11 : case AddressPurpose::SEND: return "send";
275 : 0 : case AddressPurpose::REFUND: return "refund";
276 : : } // no default case so the compiler will warn when a new enum as added
277 : 0 : assert(false);
278 : : }
279 : :
280 : 2896 : inline std::optional<AddressPurpose> PurposeFromString(std::string_view s)
281 : : {
282 [ + + ]: 2896 : if (s == "receive") return AddressPurpose::RECEIVE;
283 [ + + ]: 38 : else if (s == "send") return AddressPurpose::SEND;
284 [ - + ]: 2 : else if (s == "refund") return AddressPurpose::REFUND;
285 : 2 : return {};
286 : : }
287 : :
288 [ + - ][ - - : 93857 : struct CRecipient
+ - + - +
- + - ][ +
- + - + -
# # # # ]
289 : : {
290 : : CTxDestination dest;
291 : : CAmount nAmount;
292 : : bool fSubtractFeeFromAmount;
293 : : };
294 : :
295 : : class WalletRescanReserver; //forward declarations for ScanForWalletTransactions/RescanFromTime
296 : : /**
297 : : * A CWallet maintains a set of transactions and balances, and provides the ability to create new transactions.
298 : : */
299 : : class CWallet final : public WalletStorage, public interfaces::Chain::Notifications
300 : : {
301 : : private:
302 : : CKeyingMaterial vMasterKey GUARDED_BY(cs_wallet);
303 : :
304 : : bool Unlock(const CKeyingMaterial& vMasterKeyIn);
305 : :
306 : : std::atomic<bool> fAbortRescan{false};
307 : : std::atomic<bool> fScanningWallet{false}; // controlled by WalletRescanReserver
308 : : std::atomic<bool> m_attaching_chain{false};
309 : : std::atomic<bool> m_scanning_with_passphrase{false};
310 : : std::atomic<SteadyClock::time_point> m_scanning_start{SteadyClock::time_point{}};
311 : : std::atomic<double> m_scanning_progress{0};
312 : : friend class WalletRescanReserver;
313 : :
314 : : //! the current wallet version: clients below this version are not able to load the wallet
315 : : int nWalletVersion GUARDED_BY(cs_wallet){FEATURE_BASE};
316 : :
317 : : /** The next scheduled rebroadcast of wallet transactions. */
318 : : NodeClock::time_point m_next_resend{GetDefaultNextResend()};
319 : : /** Whether this wallet will submit newly created transactions to the node's mempool and
320 : : * prompt rebroadcasts (see ResendWalletTransactions()). */
321 : : bool fBroadcastTransactions = false;
322 : : // Local time that the tip block was received. Used to schedule wallet rebroadcasts.
323 : : std::atomic<int64_t> m_best_block_time {0};
324 : :
325 : : // First created key time. Used to skip blocks prior to this time.
326 : : // 'std::numeric_limits<int64_t>::max()' if wallet is blank.
327 : : std::atomic<int64_t> m_birth_time{std::numeric_limits<int64_t>::max()};
328 : :
329 : : /**
330 : : * Used to keep track of spent outpoints, and
331 : : * detect and report conflicts (double-spends or
332 : : * mutated transactions where the mutant gets mined).
333 : : */
334 : : typedef std::unordered_multimap<COutPoint, uint256, SaltedOutpointHasher> TxSpends;
335 : : TxSpends mapTxSpends GUARDED_BY(cs_wallet);
336 : : void AddToSpends(const COutPoint& outpoint, const uint256& wtxid, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
337 : : void AddToSpends(const CWalletTx& wtx, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
338 : :
339 : : /**
340 : : * Add a transaction to the wallet, or update it. confirm.block_* should
341 : : * be set when the transaction was known to be included in a block. When
342 : : * block_hash.IsNull(), then wallet state is not updated in AddToWallet, but
343 : : * notifications happen and cached balances are marked dirty.
344 : : *
345 : : * If fUpdate is true, existing transactions will be updated.
346 : : * TODO: One exception to this is that the abandoned state is cleared under the
347 : : * assumption that any further notification of a transaction that was considered
348 : : * abandoned is an indication that it is not safe to be considered abandoned.
349 : : * Abandoned state should probably be more carefully tracked via different
350 : : * chain notifications or by checking mempool presence when necessary.
351 : : *
352 : : * Should be called with rescanning_old_block set to true, if the transaction is
353 : : * not discovered in real time, but during a rescan of old blocks.
354 : : */
355 : : bool AddToWalletIfInvolvingMe(const CTransactionRef& tx, const SyncTxState& state, bool fUpdate, bool rescanning_old_block) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
356 : :
357 : : /** Mark a transaction (and its in-wallet descendants) as conflicting with a particular block. */
358 : : void MarkConflicted(const uint256& hashBlock, int conflicting_height, const uint256& hashTx);
359 : :
360 : : enum class TxUpdate { UNCHANGED, CHANGED, NOTIFY_CHANGED };
361 : :
362 : : using TryUpdatingStateFn = std::function<TxUpdate(CWalletTx& wtx)>;
363 : :
364 : : /** Mark a transaction (and its in-wallet descendants) as a particular tx state. */
365 : : void RecursiveUpdateTxState(const uint256& tx_hash, const TryUpdatingStateFn& try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
366 : : void RecursiveUpdateTxState(WalletBatch* batch, const uint256& tx_hash, const TryUpdatingStateFn& try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
367 : :
368 : : /** Mark a transaction's inputs dirty, thus forcing the outputs to be recomputed */
369 : : void MarkInputsDirty(const CTransactionRef& tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
370 : :
371 : : void SyncMetaData(std::pair<TxSpends::iterator, TxSpends::iterator>) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
372 : :
373 : : void SyncTransaction(const CTransactionRef& tx, const SyncTxState& state, bool update_tx = true, bool rescanning_old_block = false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
374 : :
375 : : /** WalletFlags set on this wallet. */
376 : : std::atomic<uint64_t> m_wallet_flags{0};
377 : :
378 : : bool SetAddressBookWithDB(WalletBatch& batch, const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& strPurpose);
379 : :
380 : : //! Unsets a wallet flag and saves it to disk
381 : : void UnsetWalletFlagWithDB(WalletBatch& batch, uint64_t flag);
382 : :
383 : : //! Unset the blank wallet flag and saves it to disk
384 : : void UnsetBlankWalletFlag(WalletBatch& batch) override;
385 : :
386 : : /** Interface for accessing chain state. */
387 : : interfaces::Chain* m_chain;
388 : :
389 : : /** Wallet name: relative directory name or "" for default wallet. */
390 : : std::string m_name;
391 : :
392 : : /** Internal database handle. */
393 : : std::unique_ptr<WalletDatabase> m_database;
394 : :
395 : : /**
396 : : * The following is used to keep track of how far behind the wallet is
397 : : * from the chain sync, and to allow clients to block on us being caught up.
398 : : *
399 : : * Processed hash is a pointer on node's tip and doesn't imply that the wallet
400 : : * has scanned sequentially all blocks up to this one.
401 : : */
402 : : uint256 m_last_block_processed GUARDED_BY(cs_wallet);
403 : :
404 : : /** Height of last block processed is used by wallet to know depth of transactions
405 : : * without relying on Chain interface beyond asynchronous updates. For safety, we
406 : : * initialize it to -1. Height is a pointer on node's tip and doesn't imply
407 : : * that the wallet has scanned sequentially all blocks up to this one.
408 : : */
409 : : int m_last_block_processed_height GUARDED_BY(cs_wallet) = -1;
410 : :
411 : : std::map<OutputType, ScriptPubKeyMan*> m_external_spk_managers;
412 : : std::map<OutputType, ScriptPubKeyMan*> m_internal_spk_managers;
413 : :
414 : : // Indexed by a unique identifier produced by each ScriptPubKeyMan using
415 : : // ScriptPubKeyMan::GetID. In many cases it will be the hash of an internal structure
416 : : std::map<uint256, std::unique_ptr<ScriptPubKeyMan>> m_spk_managers;
417 : :
418 : : // Appends spk managers into the main 'm_spk_managers'.
419 : : // Must be the only method adding data to it.
420 : : void AddScriptPubKeyMan(const uint256& id, std::unique_ptr<ScriptPubKeyMan> spkm_man);
421 : :
422 : : // Same as 'AddActiveScriptPubKeyMan' but designed for use within a batch transaction context
423 : : void AddActiveScriptPubKeyManWithDb(WalletBatch& batch, uint256 id, OutputType type, bool internal);
424 : :
425 : : /** Store wallet flags */
426 : : void SetWalletFlagWithDB(WalletBatch& batch, uint64_t flags);
427 : :
428 : : //! Cache of descriptor ScriptPubKeys used for IsMine. Maps ScriptPubKey to set of spkms
429 : : std::unordered_map<CScript, std::vector<ScriptPubKeyMan*>, SaltedSipHasher> m_cached_spks;
430 : :
431 : : /**
432 : : * Catch wallet up to current chain, scanning new blocks, updating the best
433 : : * block locator and m_last_block_processed, and registering for
434 : : * notifications about new blocks and transactions.
435 : : */
436 : : static bool AttachChain(const std::shared_ptr<CWallet>& wallet, interfaces::Chain& chain, const bool rescan_required, bilingual_str& error, std::vector<bilingual_str>& warnings);
437 : :
438 : : static NodeClock::time_point GetDefaultNextResend();
439 : :
440 : : public:
441 : : /**
442 : : * Main wallet lock.
443 : : * This lock protects all the fields added by CWallet.
444 : : */
445 : : mutable RecursiveMutex cs_wallet;
446 : :
447 : 153495 : WalletDatabase& GetDatabase() const override
448 : : {
449 [ - + ]: 153495 : assert(static_cast<bool>(m_database));
450 : 153495 : return *m_database;
451 : : }
452 : :
453 : : /** Get a name for this wallet for logging/debugging purposes.
454 : : */
455 [ + - # # : 100414 : const std::string& GetName() const { return m_name; }
# # ][ - -
- - - - -
- - - - -
- - - - ]
[ + - + -
+ - - - -
- - - + -
+ + ][ + -
+ - # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + + -
+ - + - +
- + - + -
+ + - + -
- - + - +
- + - +
- ]
456 : :
457 : : typedef std::map<unsigned int, CMasterKey> MasterKeyMap;
458 : : MasterKeyMap mapMasterKeys;
459 : : unsigned int nMasterKeyMaxID = 0;
460 : :
461 : : /** Construct wallet with specified name and database implementation. */
462 : 918 : CWallet(interfaces::Chain* chain, const std::string& name, std::unique_ptr<WalletDatabase> database)
463 : 1836 : : m_chain(chain),
464 [ + - ]: 918 : m_name(name),
465 [ + - + - : 918 : m_database(std::move(database))
+ - + - +
- + - + -
+ - + - +
- + - ]
466 : : {
467 : 918 : }
468 : :
469 : 1790 : ~CWallet()
470 : 918 : {
471 : : // Should not have slots connected at this point.
472 [ - + ]: 918 : assert(NotifyUnload.empty());
473 : 1790 : }
474 : :
475 : : bool IsCrypted() const;
476 : : bool IsLocked() const override;
477 : : bool Lock();
478 : :
479 : : /** Interface to assert chain access */
480 [ - + + + ]: 7623 : bool HaveChain() const { return m_chain ? true : false; }
481 : :
482 : : /** Map from txid to CWalletTx for all transactions this wallet is
483 : : * interested in, including received and sent transactions. */
484 : : std::unordered_map<uint256, CWalletTx, SaltedTxidHasher> mapWallet GUARDED_BY(cs_wallet);
485 : :
486 : : typedef std::multimap<int64_t, CWalletTx*> TxItems;
487 : : TxItems wtxOrdered;
488 : :
489 : : int64_t nOrderPosNext GUARDED_BY(cs_wallet) = 0;
490 : :
491 : : std::map<CTxDestination, CAddressBookData> m_address_book GUARDED_BY(cs_wallet);
492 : : const CAddressBookData* FindAddressBookEntry(const CTxDestination&, bool allow_change = false) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
493 : :
494 : : /** Set of Coins owned by this wallet that we won't try to spend from. A
495 : : * Coin may be locked if it has already been used to fund a transaction
496 : : * that hasn't confirmed yet. We wouldn't consider the Coin spent already,
497 : : * but also shouldn't try to use it again. */
498 : : std::set<COutPoint> setLockedCoins GUARDED_BY(cs_wallet);
499 : :
500 : : /** Registered interfaces::Chain::Notifications handler. */
501 : : std::unique_ptr<interfaces::Handler> m_chain_notifications_handler;
502 : :
503 : : /** Interface for accessing chain state. */
504 [ - + ]: 978265 : interfaces::Chain& chain() const { assert(m_chain); return *m_chain; }
505 : :
506 : : const CWalletTx* GetWalletTx(const uint256& hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
507 : :
508 : : std::set<uint256> GetTxConflicts(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
509 : :
510 : : /**
511 : : * Return depth of transaction in blockchain:
512 : : * <0 : conflicts with a transaction this deep in the blockchain
513 : : * 0 : in memory pool, waiting to be included in a block
514 : : * >=1 : this many blocks deep in the main chain
515 : : *
516 : : * Preconditions: it is only valid to call this function when the wallet is
517 : : * online and the block index is loaded. So this cannot be called by
518 : : * bitcoin-wallet tool code or by wallet migration code. If this is called
519 : : * without the wallet being online, it won't be able able to determine the
520 : : * the height of the last block processed, or the heights of blocks
521 : : * referenced in transaction, and might cause assert failures.
522 : : */
523 : : int GetTxDepthInMainChain(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
524 : :
525 : : /**
526 : : * @return number of blocks to maturity for this transaction:
527 : : * 0 : is not a coinbase transaction, or is a mature coinbase transaction
528 : : * >0 : is a coinbase transaction which matures in this many blocks
529 : : */
530 : : int GetTxBlocksToMaturity(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
531 : : bool IsTxImmatureCoinBase(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
532 : :
533 : : //! check whether we support the named feature
534 [ + - ]: 555 : bool CanSupportFeature(enum WalletFeature wf) const override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) { AssertLockHeld(cs_wallet); return IsFeatureSupported(nWalletVersion, wf); }
535 : :
536 : : bool IsSpent(const COutPoint& outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
537 : :
538 : : // Whether this or any known scriptPubKey with the same single key has been spent.
539 : : bool IsSpentKey(const CScript& scriptPubKey) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
540 : : void SetSpentKeyState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
541 : :
542 : : /** Display address on an external signer. */
543 : : util::Result<void> DisplayAddress(const CTxDestination& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
544 : :
545 : : bool IsLockedCoin(const COutPoint& output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
546 : : bool LockCoin(const COutPoint& output, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
547 : : bool UnlockCoin(const COutPoint& output, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
548 : : bool UnlockAllCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
549 : : void ListLockedCoins(std::vector<COutPoint>& vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
550 : :
551 : : /*
552 : : * Rescan abort properties
553 : : */
554 [ # # ]: 0 : void AbortRescan() { fAbortRescan = true; }
555 [ - + ]: 535 : bool IsAbortingRescan() const { return fAbortRescan; }
556 [ - + ]: 528 : bool IsScanning() const { return fScanningWallet; }
557 [ - + + + : 46 : bool IsScanningWithPassphrase() const { return m_scanning_with_passphrase; }
+ + ]
558 [ # # ]: 0 : SteadyClock::duration ScanningDuration() const { return fScanningWallet ? SteadyClock::now() - m_scanning_start.load() : SteadyClock::duration{}; }
559 [ # # ]: 0 : double ScanningProgress() const { return fScanningWallet ? (double) m_scanning_progress : 0; }
560 : :
561 : : //! Upgrade DescriptorCaches
562 : : void UpgradeDescriptorCache() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
563 : :
564 : 325 : bool LoadMinVersion(int nVersion) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) { AssertLockHeld(cs_wallet); nWalletVersion = nVersion; return true; }
565 : :
566 : : //! Marks destination as previously spent.
567 : : void LoadAddressPreviouslySpent(const CTxDestination& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
568 : : //! Appends payment request to destination.
569 : : void LoadAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& request) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
570 : :
571 : : //! Holds a timestamp at which point the wallet is scheduled (externally) to be relocked. Caller must arrange for actual relocking to occur via Lock().
572 : : int64_t nRelockTime GUARDED_BY(cs_wallet){0};
573 : :
574 : : // Used to prevent concurrent calls to walletpassphrase RPC.
575 : : Mutex m_unlock_mutex;
576 : : // Used to prevent deleting the passphrase from memory when it is still in use.
577 : : RecursiveMutex m_relock_mutex;
578 : :
579 : : bool Unlock(const SecureString& strWalletPassphrase);
580 : : bool ChangeWalletPassphrase(const SecureString& strOldWalletPassphrase, const SecureString& strNewWalletPassphrase);
581 : : bool EncryptWallet(const SecureString& strWalletPassphrase);
582 : :
583 : : unsigned int ComputeTimeSmart(const CWalletTx& wtx, bool rescanning_old_block) const;
584 : :
585 : : /**
586 : : * Increment the next transaction order id
587 : : * @return next transaction order id
588 : : */
589 : : int64_t IncOrderPosNext(WalletBatch *batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
590 : : DBErrors ReorderTransactions();
591 : :
592 : : void MarkDirty();
593 : :
594 : : //! Callback for updating transaction metadata in mapWallet.
595 : : //!
596 : : //! @param wtx - reference to mapWallet transaction to update
597 : : //! @param new_tx - true if wtx is newly inserted, false if it previously existed
598 : : //!
599 : : //! @return true if wtx is changed and needs to be saved to disk, otherwise false
600 : : using UpdateWalletTxFn = std::function<bool(CWalletTx& wtx, bool new_tx)>;
601 : :
602 : : /**
603 : : * Add the transaction to the wallet, wrapping it up inside a CWalletTx
604 : : * @return the recently added wtx pointer or nullptr if there was a db write error.
605 : : */
606 : : CWalletTx* AddToWallet(CTransactionRef tx, const TxState& state, const UpdateWalletTxFn& update_wtx=nullptr, bool rescanning_old_block = false);
607 : : bool LoadToWallet(const uint256& hash, const UpdateWalletTxFn& fill_wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
608 : : void transactionAddedToMempool(const CTransactionRef& tx) override;
609 : : void blockConnected(ChainstateRole role, const interfaces::BlockInfo& block) override;
610 : : void blockDisconnected(const interfaces::BlockInfo& block) override;
611 : : void updatedBlockTip() override;
612 : : int64_t RescanFromTime(int64_t startTime, const WalletRescanReserver& reserver, bool update);
613 : :
614 : : struct ScanResult {
615 : : enum { SUCCESS, FAILURE, USER_ABORT } status = SUCCESS;
616 : :
617 : : //! Hash and height of most recent block that was successfully scanned.
618 : : //! Unset if no blocks were scanned due to read errors or the chain
619 : : //! being empty.
620 : : uint256 last_scanned_block;
621 : : std::optional<int> last_scanned_height;
622 : :
623 : : //! Height of the most recent block that could not be scanned due to
624 : : //! read errors or pruning. Will be set if status is FAILURE, unset if
625 : : //! status is SUCCESS, and may or may not be set if status is
626 : : //! USER_ABORT.
627 : : uint256 last_failed_block;
628 : : };
629 : : ScanResult ScanForWalletTransactions(const uint256& start_block, int start_height, std::optional<int> max_height, const WalletRescanReserver& reserver, bool fUpdate, const bool save_progress);
630 : : void transactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason) override;
631 : : /** Set the next time this wallet should resend transactions to 12-36 hours from now, ~1 day on average. */
632 [ + - ]: 3 : void SetNextResend() { m_next_resend = GetDefaultNextResend(); }
633 : : /** Return true if all conditions for periodically resending transactions are met. */
634 : : bool ShouldResend() const;
635 : : void ResubmitWalletTransactions(bool relay, bool force);
636 : :
637 : : OutputType TransactionChangeType(const std::optional<OutputType>& change_type, const std::vector<CRecipient>& vecSend) const;
638 : :
639 : : /** Fetch the inputs and sign with SIGHASH_ALL. */
640 : : bool SignTransaction(CMutableTransaction& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
641 : : /** Sign the tx given the input coins and sighash. */
642 : : bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, bilingual_str>& input_errors) const;
643 : : SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const;
644 : :
645 : : /**
646 : : * Fills out a PSBT with information from the wallet. Fills in UTXOs if we have
647 : : * them. Tries to sign if sign=true. Sets `complete` if the PSBT is now complete
648 : : * (i.e. has all required signatures or signature-parts, and is ready to
649 : : * finalize.) Sets `error` and returns false if something goes wrong.
650 : : *
651 : : * @param[in] psbtx PartiallySignedTransaction to fill in
652 : : * @param[out] complete indicates whether the PSBT is now complete
653 : : * @param[in] sighash_type the sighash type to use when signing (if PSBT does not specify)
654 : : * @param[in] sign whether to sign or not
655 : : * @param[in] bip32derivs whether to fill in bip32 derivation information if available
656 : : * @param[out] n_signed the number of inputs signed by this wallet
657 : : * @param[in] finalize whether to create the final scriptSig or scriptWitness if possible
658 : : * return error
659 : : */
660 : : std::optional<common::PSBTError> FillPSBT(PartiallySignedTransaction& psbtx,
661 : : bool& complete,
662 : : int sighash_type = SIGHASH_DEFAULT,
663 : : bool sign = true,
664 : : bool bip32derivs = true,
665 : : size_t* n_signed = nullptr,
666 : : bool finalize = true) const;
667 : :
668 : : /**
669 : : * Submit the transaction to the node's mempool and then relay to peers.
670 : : * Should be called after CreateTransaction unless you want to abort
671 : : * broadcasting the transaction.
672 : : *
673 : : * @param[in] tx The transaction to be broadcast.
674 : : * @param[in] mapValue key-values to be set on the transaction.
675 : : * @param[in] orderForm BIP 70 / BIP 21 order form details to be set on the transaction.
676 : : */
677 : : void CommitTransaction(CTransactionRef tx, mapValue_t mapValue, std::vector<std::pair<std::string, std::string>> orderForm);
678 : :
679 : : /** Pass this transaction to node for mempool insertion and relay to peers if flag set to true */
680 : : bool SubmitTxMemoryPoolAndRelay(CWalletTx& wtx, std::string& err_string, bool relay) const
681 : : EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
682 : :
683 : : bool ImportScripts(const std::set<CScript> scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
684 : : bool ImportPrivKeys(const std::map<CKeyID, CKey>& privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
685 : : bool ImportPubKeys(const std::vector<std::pair<CKeyID, bool>>& ordered_pubkeys, const std::map<CKeyID, CPubKey>& pubkey_map, const std::map<CKeyID, std::pair<CPubKey, KeyOriginInfo>>& key_origins, const bool add_keypool, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
686 : : bool ImportScriptPubKeys(const std::string& label, const std::set<CScript>& script_pub_keys, const bool have_solving_data, const bool apply_label, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
687 : :
688 : : /** Updates wallet birth time if 'time' is below it */
689 : : void MaybeUpdateBirthTime(int64_t time);
690 : :
691 : : CFeeRate m_pay_tx_fee{DEFAULT_PAY_TX_FEE};
692 : : unsigned int m_confirm_target{DEFAULT_TX_CONFIRM_TARGET};
693 : : /** Allow Coin Selection to pick unconfirmed UTXOs that were sent from our own wallet if it
694 : : * cannot fund the transaction otherwise. */
695 : : bool m_spend_zero_conf_change{DEFAULT_SPEND_ZEROCONF_CHANGE};
696 : : bool m_signal_rbf{DEFAULT_WALLET_RBF};
697 : : bool m_allow_fallback_fee{true}; //!< will be false if -fallbackfee=0
698 : : CFeeRate m_min_fee{DEFAULT_TRANSACTION_MINFEE}; //!< Override with -mintxfee
699 : : /**
700 : : * If fee estimation does not have enough data to provide estimates, use this fee instead.
701 : : * Has no effect if not using fee estimation
702 : : * Override with -fallbackfee
703 : : */
704 : : CFeeRate m_fallback_fee{DEFAULT_FALLBACK_FEE};
705 : :
706 : : /** If the cost to spend a change output at this feerate is greater than the value of the
707 : : * output itself, just drop it to fees. */
708 : : CFeeRate m_discard_rate{DEFAULT_DISCARD_FEE};
709 : :
710 : : /** When the actual feerate is less than the consolidate feerate, we will tend to make transactions which
711 : : * consolidate inputs. When the actual feerate is greater than the consolidate feerate, we will tend to make
712 : : * transactions which have the lowest fees.
713 : : */
714 : : CFeeRate m_consolidate_feerate{DEFAULT_CONSOLIDATE_FEERATE};
715 : :
716 : : /** The maximum fee amount we're willing to pay to prioritize partial spend avoidance. */
717 : : CAmount m_max_aps_fee{DEFAULT_MAX_AVOIDPARTIALSPEND_FEE}; //!< note: this is absolute fee, not fee rate
718 : : OutputType m_default_address_type{DEFAULT_ADDRESS_TYPE};
719 : : /**
720 : : * Default output type for change outputs. When unset, automatically choose type
721 : : * based on address type setting and the types other of non-change outputs
722 : : * (see -changetype option documentation and implementation in
723 : : * CWallet::TransactionChangeType for details).
724 : : */
725 : : std::optional<OutputType> m_default_change_type{};
726 : : /** Absolute maximum transaction fee (in satoshis) used by default for the wallet */
727 : : CAmount m_default_max_tx_fee{DEFAULT_TRANSACTION_MAXFEE};
728 : :
729 : : /** Number of pre-generated keys/scripts by each spkm (part of the look-ahead process, used to detect payments) */
730 : : int64_t m_keypool_size{DEFAULT_KEYPOOL_SIZE};
731 : :
732 : : /** Notify external script when a wallet transaction comes in or is updated (handled by -walletnotify) */
733 : : std::string m_notify_tx_changed_script;
734 : :
735 : : size_t KeypoolCountExternalKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
736 : : bool TopUpKeyPool(unsigned int kpSize = 0);
737 : :
738 : : std::optional<int64_t> GetOldestKeyPoolTime() const;
739 : :
740 : : // Filter struct for 'ListAddrBookAddresses'
741 [ + - ]: 120 : struct AddrBookFilter {
742 : : // Fetch addresses with the provided label
743 : : std::optional<std::string> m_op_label{std::nullopt};
744 : : // Don't include change addresses by default
745 : : bool ignore_change{true};
746 : : };
747 : :
748 : : /**
749 : : * Filter and retrieve destinations stored in the addressbook
750 : : */
751 : : std::vector<CTxDestination> ListAddrBookAddresses(const std::optional<AddrBookFilter>& filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
752 : :
753 : : /**
754 : : * Retrieve all the known labels in the address book
755 : : */
756 : : std::set<std::string> ListAddrBookLabels(const std::optional<AddressPurpose> purpose) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
757 : :
758 : : /**
759 : : * Walk-through the address book entries.
760 : : * Stops when the provided 'ListAddrBookFunc' returns false.
761 : : */
762 : : using ListAddrBookFunc = std::function<void(const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose> purpose)>;
763 : : void ForEachAddrBookEntry(const ListAddrBookFunc& func) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
764 : :
765 : : /**
766 : : * Marks all outputs in each one of the destinations dirty, so their cache is
767 : : * reset and does not return outdated information.
768 : : */
769 : : void MarkDestinationsDirty(const std::set<CTxDestination>& destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
770 : :
771 : : util::Result<CTxDestination> GetNewDestination(const OutputType type, const std::string label);
772 : : util::Result<CTxDestination> GetNewChangeDestination(const OutputType type);
773 : :
774 : : isminetype IsMine(const CTxDestination& dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
775 : : isminetype IsMine(const CScript& script) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
776 : : /**
777 : : * Returns amount of debit if the input matches the
778 : : * filter, otherwise returns 0
779 : : */
780 : : CAmount GetDebit(const CTxIn& txin, const isminefilter& filter) const;
781 : : isminetype IsMine(const CTxOut& txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
782 : : bool IsMine(const CTransaction& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
783 : : isminetype IsMine(const COutPoint& outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
784 : : /** should probably be renamed to IsRelevantToMe */
785 : : bool IsFromMe(const CTransaction& tx) const;
786 : : CAmount GetDebit(const CTransaction& tx, const isminefilter& filter) const;
787 : : void chainStateFlushed(ChainstateRole role, const CBlockLocator& loc) override;
788 : :
789 : : DBErrors LoadWallet();
790 : :
791 : : /** Erases the provided transactions from the wallet. */
792 : : util::Result<void> RemoveTxs(std::vector<uint256>& txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
793 : : util::Result<void> RemoveTxs(WalletBatch& batch, std::vector<uint256>& txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
794 : :
795 : : bool SetAddressBook(const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& purpose);
796 : :
797 : : bool DelAddressBook(const CTxDestination& address);
798 : : bool DelAddressBookWithDB(WalletBatch& batch, const CTxDestination& address);
799 : :
800 : : bool IsAddressPreviouslySpent(const CTxDestination& dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
801 : : bool SetAddressPreviouslySpent(WalletBatch& batch, const CTxDestination& dest, bool used) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
802 : :
803 : : std::vector<std::string> GetAddressReceiveRequests() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
804 : : bool SetAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id, const std::string& value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
805 : : bool EraseAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
806 : :
807 : : unsigned int GetKeyPoolSize() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
808 : :
809 : : //! signify that a particular wallet feature is now used.
810 : : void SetMinVersion(enum WalletFeature, WalletBatch* batch_in = nullptr) override;
811 : :
812 : : //! get the current wallet format (the oldest client version guaranteed to understand this wallet)
813 [ + - ]: 1416 : int GetVersion() const { LOCK(cs_wallet); return nWalletVersion; }
814 : :
815 : : //! Get wallet transactions that conflict with given transaction (spend same outputs)
816 : : std::set<uint256> GetConflicts(const uint256& txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
817 : :
818 : : //! Check if a given transaction has any of its outputs spent by another transaction in the wallet
819 : : bool HasWalletSpend(const CTransactionRef& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
820 : :
821 : : //! Close wallet database
822 : : void Close();
823 : :
824 : : /** Wallet is about to be unloaded */
825 : : boost::signals2::signal<void ()> NotifyUnload;
826 : :
827 : : /**
828 : : * Address book entry changed.
829 : : * @note called without lock cs_wallet held.
830 : : */
831 : : boost::signals2::signal<void(const CTxDestination& address,
832 : : const std::string& label, bool isMine,
833 : : AddressPurpose purpose, ChangeType status)>
834 : : NotifyAddressBookChanged;
835 : :
836 : : /**
837 : : * Wallet transaction added, removed or updated.
838 : : * @note called with lock cs_wallet held.
839 : : */
840 : : boost::signals2::signal<void(const uint256& hashTx, ChangeType status)> NotifyTransactionChanged;
841 : :
842 : : /** Show progress e.g. for rescan */
843 : : boost::signals2::signal<void (const std::string &title, int nProgress)> ShowProgress;
844 : :
845 : : /** Keypool has new keys */
846 : : boost::signals2::signal<void ()> NotifyCanGetAddressesChanged;
847 : :
848 : : /**
849 : : * Wallet status (encrypted, locked) changed.
850 : : * Note: Called without locks held.
851 : : */
852 : : boost::signals2::signal<void (CWallet* wallet)> NotifyStatusChanged;
853 : :
854 : : /** Inquire whether this wallet broadcasts transactions. */
855 [ + - ]: 1584 : bool GetBroadcastTransactions() const { return fBroadcastTransactions; }
856 : : /** Set whether this wallet broadcasts transactions. */
857 : 827 : void SetBroadcastTransactions(bool broadcast) { fBroadcastTransactions = broadcast; }
858 : :
859 : : /** Return whether transaction can be abandoned */
860 : : bool TransactionCanBeAbandoned(const uint256& hashTx) const;
861 : :
862 : : /* Mark a transaction (and it in-wallet descendants) as abandoned so its inputs may be respent. */
863 : : bool AbandonTransaction(const uint256& hashTx);
864 : : bool AbandonTransaction(CWalletTx& tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
865 : :
866 : : /** Mark a transaction as replaced by another transaction. */
867 : : bool MarkReplaced(const uint256& originalHash, const uint256& newHash);
868 : :
869 : : /* Initializes the wallet, returns a new CWallet instance or a null pointer in case of an error */
870 : : static std::shared_ptr<CWallet> Create(WalletContext& context, const std::string& name, std::unique_ptr<WalletDatabase> database, uint64_t wallet_creation_flags, bilingual_str& error, std::vector<bilingual_str>& warnings);
871 : :
872 : : /**
873 : : * Wallet post-init setup
874 : : * Gives the wallet a chance to register repetitive tasks and complete post-init tasks
875 : : */
876 : : void postInitProcess();
877 : :
878 : : bool BackupWallet(const std::string& strDest) const;
879 : :
880 : : /* Returns true if HD is enabled */
881 : : bool IsHDEnabled() const;
882 : :
883 : : /* Returns true if the wallet can give out new addresses. This means it has keys in the keypool or can generate new keys */
884 : : bool CanGetAddresses(bool internal = false) const;
885 : :
886 : : /* Returns the time of the first created key or, in case of an import, it could be the time of the first received transaction */
887 [ + + ]: 528 : int64_t GetBirthTime() const { return m_birth_time; }
888 : :
889 : : /**
890 : : * Blocks until the wallet state is up-to-date to /at least/ the current
891 : : * chain at the time this function is entered
892 : : * Obviously holding cs_main/cs_wallet when going into this call may cause
893 : : * deadlock
894 : : */
895 : : void BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(::cs_main) EXCLUSIVE_LOCKS_REQUIRED(!cs_wallet);
896 : :
897 : : /** set a single wallet flag */
898 : : void SetWalletFlag(uint64_t flags);
899 : :
900 : : /** Unsets a single wallet flag */
901 : : void UnsetWalletFlag(uint64_t flag);
902 : :
903 : : /** check if a certain wallet flag is set */
904 : : bool IsWalletFlagSet(uint64_t flag) const override;
905 : :
906 : : /** overwrite all flags by the given uint64_t
907 : : flags must be uninitialised (or 0)
908 : : only known flags may be present */
909 : : void InitWalletFlags(uint64_t flags);
910 : : /** Loads the flags into the wallet. (used by LoadWallet) */
911 : : bool LoadWalletFlags(uint64_t flags);
912 : :
913 : : /** Returns a bracketed wallet name for displaying in logs, will return [default wallet] if the wallet has no name */
914 : 53245 : std::string GetDisplayName() const override
915 : : {
916 [ + + ]: 53245 : std::string wallet_name = GetName().length() == 0 ? "default wallet" : GetName();
917 [ + - ]: 53245 : return strprintf("[%s]", wallet_name);
918 : 53245 : };
919 : :
920 : : /** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */
921 : : template <typename... Params>
922 : 51531 : void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const
923 : : {
924 [ + - + - ]: 103062 : LogInfo("%s %s", GetDisplayName(), tfm::format(wallet_fmt, params...));
925 : 51531 : };
926 : :
927 : : /** Upgrade the wallet */
928 : : bool UpgradeWallet(int version, bilingual_str& error);
929 : :
930 : : //! Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers
931 : : std::set<ScriptPubKeyMan*> GetActiveScriptPubKeyMans() const;
932 : : bool IsActiveScriptPubKeyMan(const ScriptPubKeyMan& spkm) const;
933 : :
934 : : //! Returns all unique ScriptPubKeyMans
935 : : std::set<ScriptPubKeyMan*> GetAllScriptPubKeyMans() const;
936 : :
937 : : //! Get the ScriptPubKeyMan for the given OutputType and internal/external chain.
938 : : ScriptPubKeyMan* GetScriptPubKeyMan(const OutputType& type, bool internal) const;
939 : :
940 : : //! Get all the ScriptPubKeyMans for a script
941 : : std::set<ScriptPubKeyMan*> GetScriptPubKeyMans(const CScript& script) const;
942 : : //! Get the ScriptPubKeyMan by id
943 : : ScriptPubKeyMan* GetScriptPubKeyMan(const uint256& id) const;
944 : :
945 : : //! Get the SigningProvider for a script
946 : : std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const;
947 : : std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script, SignatureData& sigdata) const;
948 : :
949 : : //! Get the wallet descriptors for a script.
950 : : std::vector<WalletDescriptor> GetWalletDescriptors(const CScript& script) const;
951 : :
952 : : //! Get the LegacyScriptPubKeyMan which is used for all types, internal, and external.
953 : : LegacyDataSPKM* GetLegacyDataSPKM() const;
954 : : LegacyDataSPKM* GetOrCreateLegacyDataSPKM();
955 : :
956 : : //! Make a Legacy(Data)SPKM and set it for all types, internal, and external.
957 : : void SetupLegacyScriptPubKeyMan();
958 : :
959 : : bool WithEncryptionKey(std::function<bool (const CKeyingMaterial&)> cb) const override;
960 : :
961 : : bool HasEncryptionKeys() const override;
962 : : bool HaveCryptedKeys() const;
963 : :
964 : : /** Get last block processed height */
965 : 1161791 : int GetLastBlockHeight() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
966 : : {
967 : 1161791 : AssertLockHeld(cs_wallet);
968 [ - + ]: 1161791 : assert(m_last_block_processed_height >= 0);
969 : 1161791 : return m_last_block_processed_height;
970 : : };
971 : 72022 : uint256 GetLastBlockHash() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
972 : : {
973 : 72022 : AssertLockHeld(cs_wallet);
974 [ - + ]: 72022 : assert(m_last_block_processed_height >= 0);
975 : 72022 : return m_last_block_processed;
976 : : }
977 : : /** Set last block processed height, currently only use in unit test */
978 : 15 : void SetLastBlockProcessed(int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
979 : : {
980 : 15 : AssertLockHeld(cs_wallet);
981 : 15 : m_last_block_processed_height = block_height;
982 [ + - + - : 15 : m_last_block_processed = block_hash;
+ - + - +
- + - ]
[ + - ]
983 : : };
984 : :
985 : : //! Connect the signals from ScriptPubKeyMans to the signals in CWallet
986 : : void ConnectScriptPubKeyManNotifiers();
987 : :
988 : : //! Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it
989 : : DescriptorScriptPubKeyMan& LoadDescriptorScriptPubKeyMan(uint256 id, WalletDescriptor& desc);
990 : :
991 : : //! Adds the active ScriptPubKeyMan for the specified type and internal. Writes it to the wallet file
992 : : //! @param[in] id The unique id for the ScriptPubKeyMan
993 : : //! @param[in] type The OutputType this ScriptPubKeyMan provides addresses for
994 : : //! @param[in] internal Whether this ScriptPubKeyMan provides change addresses
995 : : void AddActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal);
996 : :
997 : : //! Loads an active ScriptPubKeyMan for the specified type and internal. (used by LoadWallet)
998 : : //! @param[in] id The unique id for the ScriptPubKeyMan
999 : : //! @param[in] type The OutputType this ScriptPubKeyMan provides addresses for
1000 : : //! @param[in] internal Whether this ScriptPubKeyMan provides change addresses
1001 : : void LoadActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal);
1002 : :
1003 : : //! Remove specified ScriptPubKeyMan from set of active SPK managers. Writes the change to the wallet file.
1004 : : //! @param[in] id The unique id for the ScriptPubKeyMan
1005 : : //! @param[in] type The OutputType this ScriptPubKeyMan provides addresses for
1006 : : //! @param[in] internal Whether this ScriptPubKeyMan provides change addresses
1007 : : void DeactivateScriptPubKeyMan(uint256 id, OutputType type, bool internal);
1008 : :
1009 : : //! Create new DescriptorScriptPubKeyMan and add it to the wallet
1010 : : DescriptorScriptPubKeyMan& SetupDescriptorScriptPubKeyMan(WalletBatch& batch, const CExtKey& master_key, const OutputType& output_type, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1011 : : //! Create new DescriptorScriptPubKeyMans and add them to the wallet
1012 : : void SetupDescriptorScriptPubKeyMans(WalletBatch& batch, const CExtKey& master_key) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1013 : : void SetupDescriptorScriptPubKeyMans() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1014 : :
1015 : : //! Create new seed and default DescriptorScriptPubKeyMans for this wallet
1016 : : void SetupOwnDescriptorScriptPubKeyMans(WalletBatch& batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1017 : :
1018 : : //! Return the DescriptorScriptPubKeyMan for a WalletDescriptor if it is already in the wallet
1019 : : DescriptorScriptPubKeyMan* GetDescriptorScriptPubKeyMan(const WalletDescriptor& desc) const;
1020 : :
1021 : : //! Returns whether the provided ScriptPubKeyMan is internal
1022 : : //! @param[in] spk_man The ScriptPubKeyMan to test
1023 : : //! @return contains value only for active DescriptorScriptPubKeyMan, otherwise undefined
1024 : : std::optional<bool> IsInternalScriptPubKeyMan(ScriptPubKeyMan* spk_man) const;
1025 : :
1026 : : //! Add a descriptor to the wallet, return a ScriptPubKeyMan & associated output type
1027 : : util::Result<ScriptPubKeyMan*> AddWalletDescriptor(WalletDescriptor& desc, const FlatSigningProvider& signing_provider, const std::string& label, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1028 : :
1029 : : /** Move all records from the BDB database to a new SQLite database for storage.
1030 : : * The original BDB file will be deleted and replaced with a new SQLite file.
1031 : : * A backup is not created.
1032 : : * May crash if something unexpected happens in the filesystem.
1033 : : */
1034 : : bool MigrateToSQLite(bilingual_str& error) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1035 : :
1036 : : //! Get all of the descriptors from a legacy wallet
1037 : : std::optional<MigrationData> GetDescriptorsForLegacy(bilingual_str& error) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1038 : :
1039 : : //! Adds the ScriptPubKeyMans given in MigrationData to this wallet, removes LegacyScriptPubKeyMan,
1040 : : //! and where needed, moves tx and address book entries to watchonly_wallet or solvable_wallet
1041 : : util::Result<void> ApplyMigrationData(WalletBatch& local_wallet_batch, MigrationData& data) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1042 : :
1043 : : //! Whether the (external) signer performs R-value signature grinding
1044 : : bool CanGrindR() const;
1045 : :
1046 : : //! Add scriptPubKeys for this ScriptPubKeyMan into the scriptPubKey cache
1047 : : void CacheNewScriptPubKeys(const std::set<CScript>& spks, ScriptPubKeyMan* spkm);
1048 : :
1049 : : void TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm) override;
1050 : :
1051 : : //! Retrieve the xpubs in use by the active descriptors
1052 : : std::set<CExtPubKey> GetActiveHDPubKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1053 : :
1054 : : //! Find the private key for the given key id from the wallet's descriptors, if available
1055 : : //! Returns nullopt when no descriptor has the key or if the wallet is locked.
1056 : : std::optional<CKey> GetKey(const CKeyID& keyid) const;
1057 : : };
1058 : :
1059 : : /**
1060 : : * Called periodically by the schedule thread. Prompts individual wallets to resend
1061 : : * their transactions. Actual rebroadcast schedule is managed by the wallets themselves.
1062 : : */
1063 : : void MaybeResendWalletTxs(WalletContext& context);
1064 : :
1065 : : /** RAII object to check and reserve a wallet rescan */
1066 : : class WalletRescanReserver
1067 : : {
1068 : : private:
1069 : : using Clock = std::chrono::steady_clock;
1070 : : using NowFn = std::function<Clock::time_point()>;
1071 : : CWallet& m_wallet;
1072 : : bool m_could_reserve{false};
1073 : : NowFn m_now;
1074 : : public:
1075 : 920 : explicit WalletRescanReserver(CWallet& w) : m_wallet(w) {}
1076 : :
1077 : 920 : bool reserve(bool with_passphrase = false)
1078 : : {
1079 [ - + ]: 920 : assert(!m_could_reserve);
1080 [ + - ]: 920 : if (m_wallet.fScanningWallet.exchange(true)) {
1081 : : return false;
1082 : : }
1083 : 920 : m_wallet.m_scanning_with_passphrase.exchange(with_passphrase);
1084 : 920 : m_wallet.m_scanning_start = SteadyClock::now();
1085 : 920 : m_wallet.m_scanning_progress = 0;
1086 : 920 : m_could_reserve = true;
1087 : 920 : return true;
1088 : : }
1089 : :
1090 : 607 : bool isReserved() const
1091 : : {
1092 [ + - - + ]: 607 : return (m_could_reserve && m_wallet.fScanningWallet);
1093 : : }
1094 : :
1095 [ + + ]: 69094 : Clock::time_point now() const { return m_now ? m_now() : Clock::now(); };
1096 : :
1097 : 1 : void setNow(NowFn now) { m_now = std::move(now); }
1098 : :
1099 : 920 : ~WalletRescanReserver()
1100 : : {
1101 [ + - ]: 920 : if (m_could_reserve) {
1102 : 920 : m_wallet.fScanningWallet = false;
1103 : 920 : m_wallet.m_scanning_with_passphrase = false;
1104 : : }
1105 : 920 : }
1106 : : };
1107 : :
1108 : : //! Add wallet name to persistent configuration so it will be loaded on startup.
1109 : : bool AddWalletSetting(interfaces::Chain& chain, const std::string& wallet_name);
1110 : :
1111 : : //! Remove wallet name from persistent configuration so it will not be loaded on startup.
1112 : : bool RemoveWalletSetting(interfaces::Chain& chain, const std::string& wallet_name);
1113 : :
1114 : : struct MigrationResult {
1115 : : std::string wallet_name;
1116 : : std::shared_ptr<CWallet> wallet;
1117 : : std::shared_ptr<CWallet> watchonly_wallet;
1118 : : std::shared_ptr<CWallet> solvables_wallet;
1119 : : fs::path backup_path;
1120 : : };
1121 : :
1122 : : //! Do all steps to migrate a legacy wallet to a descriptor wallet
1123 : : [[nodiscard]] util::Result<MigrationResult> MigrateLegacyToDescriptor(const std::string& wallet_name, const SecureString& passphrase, WalletContext& context);
1124 : : //! Requirement: The wallet provided to this function must be isolated, with no attachment to the node's context.
1125 : : [[nodiscard]] util::Result<MigrationResult> MigrateLegacyToDescriptor(std::shared_ptr<CWallet> local_wallet, const SecureString& passphrase, WalletContext& context, bool was_loaded);
1126 : : } // namespace wallet
1127 : :
1128 : : #endif // BITCOIN_WALLET_WALLET_H
|
