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