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