Bitcoin Core  27.99.0
P2P Digital Currency
wallet.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2022 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_WALLET_WALLET_H
7 #define BITCOIN_WALLET_WALLET_H
8 
9 #include <addresstype.h>
10 #include <consensus/amount.h>
11 #include <interfaces/chain.h>
12 #include <interfaces/handler.h>
13 #include <kernel/cs_main.h>
14 #include <logging.h>
15 #include <outputtype.h>
16 #include <policy/feerate.h>
17 #include <primitives/transaction.h>
18 #include <script/interpreter.h>
19 #include <script/script.h>
21 #include <sync.h>
22 #include <tinyformat.h>
23 #include <uint256.h>
24 #include <util/fs.h>
25 #include <util/hasher.h>
26 #include <util/result.h>
27 #include <util/string.h>
28 #include <util/time.h>
29 #include <util/ui_change_type.h>
30 #include <wallet/crypter.h>
31 #include <wallet/db.h>
32 #include <wallet/scriptpubkeyman.h>
33 #include <wallet/transaction.h>
34 #include <wallet/types.h>
35 #include <wallet/walletutil.h>
36 
37 #include <atomic>
38 #include <cassert>
39 #include <cstddef>
40 #include <cstdint>
41 #include <functional>
42 #include <limits>
43 #include <map>
44 #include <memory>
45 #include <optional>
46 #include <set>
47 #include <string>
48 #include <unordered_map>
49 #include <utility>
50 #include <vector>
51 
52 #include <boost/signals2/signal.hpp>
53 
54 class CKey;
55 class CKeyID;
56 class CPubKey;
57 class Coin;
58 class SigningProvider;
59 enum class MemPoolRemovalReason;
60 enum class SigningResult;
61 enum class TransactionError;
62 namespace interfaces {
63 class Wallet;
64 }
65 namespace wallet {
66 class CWallet;
67 class WalletBatch;
68 enum class DBErrors : int;
69 } // namespace wallet
70 struct CBlockLocator;
71 struct CExtKey;
72 struct FlatSigningProvider;
73 struct KeyOriginInfo;
75 struct SignatureData;
76 
77 using LoadWalletFn = std::function<void(std::unique_ptr<interfaces::Wallet> wallet)>;
78 
79 struct bilingual_str;
80 
81 namespace wallet {
82 struct WalletContext;
83 
89 void UnloadWallet(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);
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 
107 static const CAmount DEFAULT_FALLBACK_FEE = 0;
109 static const CAmount DEFAULT_DISCARD_FEE = 10000;
113 static const CAmount DEFAULT_CONSOLIDATE_FEERATE{10000}; // 10 sat/vbyte
123 constexpr CAmount HIGH_APS_FEE{COIN / 10000};
127 static const bool DEFAULT_SPEND_ZEROCONF_CHANGE = true;
129 static const bool DEFAULT_WALLET_REJECT_LONG_CHAINS{true};
131 static const unsigned int DEFAULT_TX_CONFIRM_TARGET = 6;
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;
140 constexpr CAmount HIGH_TX_FEE_PER_KB{COIN / 100};
144 static constexpr size_t DUMMY_NESTED_P2WPKH_INPUT_SIZE = 91;
145 
146 class CCoinControl;
147 
150 
151 static constexpr uint64_t KNOWN_WALLET_FLAGS =
159 
160 static constexpr uint64_t MUTABLE_WALLET_FLAGS =
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 
189 {
190 protected:
192  const CWallet* const pwallet;
194  ScriptPubKeyMan* m_spk_man{nullptr};
197  int64_t nIndex{-1};
201  bool fInternal{false};
202 
203 public:
205  explicit ReserveDestination(CWallet* pwallet, OutputType type)
206  : pwallet(pwallet)
207  , type(type) { }
208 
211 
214  {
215  ReturnDestination();
216  }
217 
219  util::Result<CTxDestination> GetReservedDestination(bool internal);
221  void ReturnDestination();
223  void KeepDestination();
224 };
225 
230 {
238  std::optional<std::string> label;
239 
245  std::optional<AddressPurpose> purpose;
246 
254  bool previously_spent{false};
255 
263  std::map<std::string, std::string> receive_requests{};
264 
266  bool IsChange() const { return !label.has_value(); }
267  std::string GetLabel() const { return label ? *label : std::string{}; }
268  void SetLabel(std::string name) { label = std::move(name); }
269 };
270 
271 inline std::string PurposeToString(AddressPurpose p)
272 {
273  switch(p) {
274  case AddressPurpose::RECEIVE: return "receive";
275  case AddressPurpose::SEND: return "send";
276  case AddressPurpose::REFUND: return "refund";
277  } // no default case so the compiler will warn when a new enum as added
278  assert(false);
279 }
280 
281 inline std::optional<AddressPurpose> PurposeFromString(std::string_view s)
282 {
283  if (s == "receive") return AddressPurpose::RECEIVE;
284  else if (s == "send") return AddressPurpose::SEND;
285  else if (s == "refund") return AddressPurpose::REFUND;
286  return {};
287 }
288 
290 {
294 };
295 
296 class WalletRescanReserver; //forward declarations for ScanForWalletTransactions/RescanFromTime
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_attaching_chain{false};
310  std::atomic<bool> m_scanning_with_passphrase{false};
311  std::atomic<SteadyClock::time_point> m_scanning_start{SteadyClock::time_point{}};
312  std::atomic<double> m_scanning_progress{0};
313  friend class WalletRescanReserver;
314 
316  int nWalletVersion GUARDED_BY(cs_wallet){FEATURE_BASE};
317 
319  NodeClock::time_point m_next_resend{GetDefaultNextResend()};
322  bool fBroadcastTransactions = false;
323  // Local time that the tip block was received. Used to schedule wallet rebroadcasts.
324  std::atomic<int64_t> m_best_block_time {0};
325 
326  // First created key time. Used to skip blocks prior to this time.
327  // 'std::numeric_limits<int64_t>::max()' if wallet is blank.
328  std::atomic<int64_t> m_birth_time{std::numeric_limits<int64_t>::max()};
329 
335  typedef std::unordered_multimap<COutPoint, uint256, SaltedOutpointHasher> TxSpends;
336  TxSpends mapTxSpends GUARDED_BY(cs_wallet);
337  void AddToSpends(const COutPoint& outpoint, const uint256& wtxid, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
338  void AddToSpends(const CWalletTx& wtx, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
339 
356  bool AddToWalletIfInvolvingMe(const CTransactionRef& tx, const SyncTxState& state, bool fUpdate, bool rescanning_old_block) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
357 
359  void MarkConflicted(const uint256& hashBlock, int conflicting_height, const uint256& hashTx);
360 
361  enum class TxUpdate { UNCHANGED, CHANGED, NOTIFY_CHANGED };
362 
363  using TryUpdatingStateFn = std::function<TxUpdate(CWalletTx& wtx)>;
364 
366  void RecursiveUpdateTxState(const uint256& tx_hash, const TryUpdatingStateFn& try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
367  void RecursiveUpdateTxState(WalletBatch* batch, const uint256& tx_hash, const TryUpdatingStateFn& try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
368 
370  void MarkInputsDirty(const CTransactionRef& tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
371 
372  void SyncMetaData(std::pair<TxSpends::iterator, TxSpends::iterator>) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
373 
374  void SyncTransaction(const CTransactionRef& tx, const SyncTxState& state, bool update_tx = true, bool rescanning_old_block = false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
375 
377  std::atomic<uint64_t> m_wallet_flags{0};
378 
379  bool SetAddressBookWithDB(WalletBatch& batch, const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& strPurpose);
380 
382  void UnsetWalletFlagWithDB(WalletBatch& batch, uint64_t flag);
383 
385  void UnsetBlankWalletFlag(WalletBatch& batch) override;
386 
389 
391  std::string m_name;
392 
394  std::unique_ptr<WalletDatabase> m_database;
395 
403  uint256 m_last_block_processed GUARDED_BY(cs_wallet);
404 
410  int m_last_block_processed_height GUARDED_BY(cs_wallet) = -1;
411 
412  std::map<OutputType, ScriptPubKeyMan*> m_external_spk_managers;
413  std::map<OutputType, ScriptPubKeyMan*> m_internal_spk_managers;
414 
415  // Indexed by a unique identifier produced by each ScriptPubKeyMan using
416  // ScriptPubKeyMan::GetID. In many cases it will be the hash of an internal structure
417  std::map<uint256, std::unique_ptr<ScriptPubKeyMan>> m_spk_managers;
418 
419  // Appends spk managers into the main 'm_spk_managers'.
420  // Must be the only method adding data to it.
421  void AddScriptPubKeyMan(const uint256& id, std::unique_ptr<ScriptPubKeyMan> spkm_man);
422 
423  // Same as 'AddActiveScriptPubKeyMan' but designed for use within a batch transaction context
424  void AddActiveScriptPubKeyManWithDb(WalletBatch& batch, uint256 id, OutputType type, bool internal);
425 
427  std::unordered_map<CScript, std::vector<ScriptPubKeyMan*>, SaltedSipHasher> m_cached_spks;
428 
434  static bool AttachChain(const std::shared_ptr<CWallet>& wallet, interfaces::Chain& chain, const bool rescan_required, bilingual_str& error, std::vector<bilingual_str>& warnings);
435 
436  static NodeClock::time_point GetDefaultNextResend();
437 
438 public:
444 
445  WalletDatabase& GetDatabase() const override
446  {
447  assert(static_cast<bool>(m_database));
448  return *m_database;
449  }
450 
453  const std::string& GetName() const { return m_name; }
454 
455  typedef std::map<unsigned int, CMasterKey> MasterKeyMap;
457  unsigned int nMasterKeyMaxID = 0;
458 
460  CWallet(interfaces::Chain* chain, const std::string& name, std::unique_ptr<WalletDatabase> database)
461  : m_chain(chain),
462  m_name(name),
463  m_database(std::move(database))
464  {
465  }
466 
468  {
469  // Should not have slots connected at this point.
470  assert(NotifyUnload.empty());
471  }
472 
473  bool IsCrypted() const;
474  bool IsLocked() const override;
475  bool Lock();
476 
478  bool HaveChain() const { return m_chain ? true : false; }
479 
482  std::unordered_map<uint256, CWalletTx, SaltedTxidHasher> mapWallet GUARDED_BY(cs_wallet);
483 
484  typedef std::multimap<int64_t, CWalletTx*> TxItems;
486 
487  int64_t nOrderPosNext GUARDED_BY(cs_wallet) = 0;
488 
489  std::map<CTxDestination, CAddressBookData> m_address_book GUARDED_BY(cs_wallet);
490  const CAddressBookData* FindAddressBookEntry(const CTxDestination&, bool allow_change = false) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
491 
496  std::set<COutPoint> setLockedCoins GUARDED_BY(cs_wallet);
497 
499  std::unique_ptr<interfaces::Handler> m_chain_notifications_handler;
500 
502  interfaces::Chain& chain() const { assert(m_chain); return *m_chain; }
503 
504  const CWalletTx* GetWalletTx(const uint256& hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
505 
506  std::set<uint256> GetTxConflicts(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
507 
521  int GetTxDepthInMainChain(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
522 
528  int GetTxBlocksToMaturity(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
529  bool IsTxImmatureCoinBase(const CWalletTx& wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
530 
532  bool CanSupportFeature(enum WalletFeature wf) const override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) { AssertLockHeld(cs_wallet); return IsFeatureSupported(nWalletVersion, wf); }
533 
534  bool IsSpent(const COutPoint& outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
535 
536  // Whether this or any known scriptPubKey with the same single key has been spent.
537  bool IsSpentKey(const CScript& scriptPubKey) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
538  void SetSpentKeyState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
539 
541  util::Result<void> DisplayAddress(const CTxDestination& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
542 
543  bool IsLockedCoin(const COutPoint& output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
544  bool LockCoin(const COutPoint& output, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
545  bool UnlockCoin(const COutPoint& output, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
546  bool UnlockAllCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
547  void ListLockedCoins(std::vector<COutPoint>& vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
548 
549  /*
550  * Rescan abort properties
551  */
552  void AbortRescan() { fAbortRescan = true; }
553  bool IsAbortingRescan() const { return fAbortRescan; }
554  bool IsScanning() const { return fScanningWallet; }
555  bool IsScanningWithPassphrase() const { return m_scanning_with_passphrase; }
556  SteadyClock::duration ScanningDuration() const { return fScanningWallet ? SteadyClock::now() - m_scanning_start.load() : SteadyClock::duration{}; }
557  double ScanningProgress() const { return fScanningWallet ? (double) m_scanning_progress : 0; }
558 
560  void UpgradeKeyMetadata() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
561 
563  void UpgradeDescriptorCache() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
564 
565  bool LoadMinVersion(int nVersion) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet) { AssertLockHeld(cs_wallet); nWalletVersion = nVersion; return true; }
566 
568  void LoadAddressPreviouslySpent(const CTxDestination& dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
570  void LoadAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& request) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
571 
573  int64_t nRelockTime GUARDED_BY(cs_wallet){0};
574 
575  // Used to prevent concurrent calls to walletpassphrase RPC.
577  // Used to prevent deleting the passphrase from memory when it is still in use.
579 
580  bool Unlock(const SecureString& strWalletPassphrase);
581  bool ChangeWalletPassphrase(const SecureString& strOldWalletPassphrase, const SecureString& strNewWalletPassphrase);
582  bool EncryptWallet(const SecureString& strWalletPassphrase);
583 
584  void GetKeyBirthTimes(std::map<CKeyID, int64_t> &mapKeyBirth) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
585  unsigned int ComputeTimeSmart(const CWalletTx& wtx, bool rescanning_old_block) const;
586 
591  int64_t IncOrderPosNext(WalletBatch *batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
592  DBErrors ReorderTransactions();
593 
594  void MarkDirty();
595 
602  using UpdateWalletTxFn = std::function<bool(CWalletTx& wtx, bool new_tx)>;
603 
608  CWalletTx* AddToWallet(CTransactionRef tx, const TxState& state, const UpdateWalletTxFn& update_wtx=nullptr, bool fFlushOnClose=true, bool rescanning_old_block = false);
609  bool LoadToWallet(const uint256& hash, const UpdateWalletTxFn& fill_wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
610  void transactionAddedToMempool(const CTransactionRef& tx) override;
611  void blockConnected(ChainstateRole role, const interfaces::BlockInfo& block) override;
612  void blockDisconnected(const interfaces::BlockInfo& block) override;
613  void updatedBlockTip() override;
614  int64_t RescanFromTime(int64_t startTime, const WalletRescanReserver& reserver, bool update);
615 
616  struct ScanResult {
617  enum { SUCCESS, FAILURE, USER_ABORT } status = SUCCESS;
618 
623  std::optional<int> last_scanned_height;
624 
630  };
631  ScanResult ScanForWalletTransactions(const uint256& start_block, int start_height, std::optional<int> max_height, const WalletRescanReserver& reserver, bool fUpdate, const bool save_progress);
632  void transactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason reason) override;
634  void SetNextResend() { m_next_resend = GetDefaultNextResend(); }
636  bool ShouldResend() const;
637  void ResubmitWalletTransactions(bool relay, bool force);
638 
639  OutputType TransactionChangeType(const std::optional<OutputType>& change_type, const std::vector<CRecipient>& vecSend) const;
640 
644  bool SignTransaction(CMutableTransaction& tx, const std::map<COutPoint, Coin>& coins, int sighash, std::map<int, bilingual_str>& input_errors) const;
645  SigningResult SignMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) const;
646 
663  bool& complete,
664  int sighash_type = SIGHASH_DEFAULT,
665  bool sign = true,
666  bool bip32derivs = true,
667  size_t* n_signed = nullptr,
668  bool finalize = true) const;
669 
679  void CommitTransaction(CTransactionRef tx, mapValue_t mapValue, std::vector<std::pair<std::string, std::string>> orderForm);
680 
682  bool SubmitTxMemoryPoolAndRelay(CWalletTx& wtx, std::string& err_string, bool relay) const
683  EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
684 
685  bool ImportScripts(const std::set<CScript> scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
686  bool ImportPrivKeys(const std::map<CKeyID, CKey>& privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
687  bool ImportPubKeys(const std::vector<CKeyID>& ordered_pubkeys, const std::map<CKeyID, CPubKey>& pubkey_map, const std::map<CKeyID, std::pair<CPubKey, KeyOriginInfo>>& key_origins, const bool add_keypool, const bool internal, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
688  bool ImportScriptPubKeys(const std::string& label, const std::set<CScript>& script_pub_keys, const bool have_solving_data, const bool apply_label, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
689 
691  void MaybeUpdateBirthTime(int64_t time);
692 
694  unsigned int m_confirm_target{DEFAULT_TX_CONFIRM_TARGET};
697  bool m_spend_zero_conf_change{DEFAULT_SPEND_ZEROCONF_CHANGE};
698  bool m_signal_rbf{DEFAULT_WALLET_RBF};
699  bool m_allow_fallback_fee{true};
707 
710  CFeeRate m_discard_rate{DEFAULT_DISCARD_FEE};
711 
716  CFeeRate m_consolidate_feerate{DEFAULT_CONSOLIDATE_FEERATE};
717 
720  OutputType m_default_address_type{DEFAULT_ADDRESS_TYPE};
727  std::optional<OutputType> m_default_change_type{};
729  CAmount m_default_max_tx_fee{DEFAULT_TRANSACTION_MAXFEE};
730 
732  int64_t m_keypool_size{DEFAULT_KEYPOOL_SIZE};
733 
736 
737  size_t KeypoolCountExternalKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
738  bool TopUpKeyPool(unsigned int kpSize = 0);
739 
740  std::optional<int64_t> GetOldestKeyPoolTime() const;
741 
742  // Filter struct for 'ListAddrBookAddresses'
743  struct AddrBookFilter {
744  // Fetch addresses with the provided label
745  std::optional<std::string> m_op_label{std::nullopt};
746  // Don't include change addresses by default
747  bool ignore_change{true};
748  };
749 
753  std::vector<CTxDestination> ListAddrBookAddresses(const std::optional<AddrBookFilter>& filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
754 
758  std::set<std::string> ListAddrBookLabels(const std::optional<AddressPurpose> purpose) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
759 
764  using ListAddrBookFunc = std::function<void(const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose> purpose)>;
765  void ForEachAddrBookEntry(const ListAddrBookFunc& func) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
766 
771  void MarkDestinationsDirty(const std::set<CTxDestination>& destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
772 
773  util::Result<CTxDestination> GetNewDestination(const OutputType type, const std::string label);
774  util::Result<CTxDestination> GetNewChangeDestination(const OutputType type);
775 
776  isminetype IsMine(const CTxDestination& dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
777  isminetype IsMine(const CScript& script) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
782  CAmount GetDebit(const CTxIn& txin, const isminefilter& filter) const;
783  isminetype IsMine(const CTxOut& txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
784  bool IsMine(const CTransaction& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
785  isminetype IsMine(const COutPoint& outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
787  bool IsFromMe(const CTransaction& tx) const;
788  CAmount GetDebit(const CTransaction& tx, const isminefilter& filter) const;
789  void chainStateFlushed(ChainstateRole role, const CBlockLocator& loc) override;
790 
792 
794  util::Result<void> RemoveTxs(std::vector<uint256>& txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
795 
796  bool SetAddressBook(const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& purpose);
797 
798  bool DelAddressBook(const CTxDestination& address);
799  bool DelAddressBookWithDB(WalletBatch& batch, const CTxDestination& address);
800 
801  bool IsAddressPreviouslySpent(const CTxDestination& dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
802  bool SetAddressPreviouslySpent(WalletBatch& batch, const CTxDestination& dest, bool used) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
803 
804  std::vector<std::string> GetAddressReceiveRequests() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
805  bool SetAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id, const std::string& value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
806  bool EraseAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
807 
808  unsigned int GetKeyPoolSize() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
809 
811  void SetMinVersion(enum WalletFeature, WalletBatch* batch_in = nullptr) override;
812 
814  int GetVersion() const { LOCK(cs_wallet); return nWalletVersion; }
815 
817  std::set<uint256> GetConflicts(const uint256& txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
818 
820  bool HasWalletSpend(const CTransactionRef& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
821 
823  void Flush();
824 
826  void Close();
827 
829  boost::signals2::signal<void ()> NotifyUnload;
830 
835  boost::signals2::signal<void(const CTxDestination& address,
836  const std::string& label, bool isMine,
837  AddressPurpose purpose, ChangeType status)>
839 
844  boost::signals2::signal<void(const uint256& hashTx, ChangeType status)> NotifyTransactionChanged;
845 
847  boost::signals2::signal<void (const std::string &title, int nProgress)> ShowProgress;
848 
850  boost::signals2::signal<void (bool fHaveWatchOnly)> NotifyWatchonlyChanged;
851 
853  boost::signals2::signal<void ()> NotifyCanGetAddressesChanged;
854 
859  boost::signals2::signal<void (CWallet* wallet)> NotifyStatusChanged;
860 
862  bool GetBroadcastTransactions() const { return fBroadcastTransactions; }
864  void SetBroadcastTransactions(bool broadcast) { fBroadcastTransactions = broadcast; }
865 
867  bool TransactionCanBeAbandoned(const uint256& hashTx) const;
868 
869  /* Mark a transaction (and it in-wallet descendants) as abandoned so its inputs may be respent. */
870  bool AbandonTransaction(const uint256& hashTx);
871 
873  bool MarkReplaced(const uint256& originalHash, const uint256& newHash);
874 
875  /* Initializes the wallet, returns a new CWallet instance or a null pointer in case of an error */
876  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);
877 
882  void postInitProcess();
883 
884  bool BackupWallet(const std::string& strDest) const;
885 
886  /* Returns true if HD is enabled */
887  bool IsHDEnabled() const;
888 
889  /* Returns true if the wallet can give out new addresses. This means it has keys in the keypool or can generate new keys */
890  bool CanGetAddresses(bool internal = false) const;
891 
892  /* Returns the time of the first created key or, in case of an import, it could be the time of the first received transaction */
893  int64_t GetBirthTime() const { return m_birth_time; }
894 
901  void BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(::cs_main) EXCLUSIVE_LOCKS_REQUIRED(!cs_wallet);
902 
904  void SetWalletFlag(uint64_t flags);
905 
907  void UnsetWalletFlag(uint64_t flag);
908 
910  bool IsWalletFlagSet(uint64_t flag) const override;
911 
915  void InitWalletFlags(uint64_t flags);
917  bool LoadWalletFlags(uint64_t flags);
918 
920  bool IsLegacy() const;
921 
923  std::string GetDisplayName() const override
924  {
925  std::string wallet_name = GetName().length() == 0 ? "default wallet" : GetName();
926  return strprintf("[%s]", wallet_name);
927  };
928 
930  template <typename... Params>
931  void WalletLogPrintf(const char* fmt, Params... parameters) const
932  {
933  LogPrintf(("%s " + std::string{fmt}).c_str(), GetDisplayName(), parameters...);
934  };
935 
937  bool UpgradeWallet(int version, bilingual_str& error);
938 
940  std::set<ScriptPubKeyMan*> GetActiveScriptPubKeyMans() const;
941  bool IsActiveScriptPubKeyMan(const ScriptPubKeyMan& spkm) const;
942 
944  std::set<ScriptPubKeyMan*> GetAllScriptPubKeyMans() const;
945 
947  ScriptPubKeyMan* GetScriptPubKeyMan(const OutputType& type, bool internal) const;
948 
950  std::set<ScriptPubKeyMan*> GetScriptPubKeyMans(const CScript& script) const;
952  ScriptPubKeyMan* GetScriptPubKeyMan(const uint256& id) const;
953 
955  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const;
956  std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script, SignatureData& sigdata) const;
957 
959  std::vector<WalletDescriptor> GetWalletDescriptors(const CScript& script) const;
960 
962  LegacyScriptPubKeyMan* GetLegacyScriptPubKeyMan() const;
963  LegacyScriptPubKeyMan* GetOrCreateLegacyScriptPubKeyMan();
964 
966  void SetupLegacyScriptPubKeyMan();
967 
968  bool WithEncryptionKey(std::function<bool (const CKeyingMaterial&)> cb) const override;
969 
970  bool HasEncryptionKeys() const override;
971 
974  {
975  AssertLockHeld(cs_wallet);
976  assert(m_last_block_processed_height >= 0);
977  return m_last_block_processed_height;
978  };
980  {
981  AssertLockHeld(cs_wallet);
982  assert(m_last_block_processed_height >= 0);
983  return m_last_block_processed;
984  }
986  void SetLastBlockProcessed(int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
987  {
988  AssertLockHeld(cs_wallet);
989  m_last_block_processed_height = block_height;
990  m_last_block_processed = block_hash;
991  };
992 
994  void ConnectScriptPubKeyManNotifiers();
995 
997  DescriptorScriptPubKeyMan& LoadDescriptorScriptPubKeyMan(uint256 id, WalletDescriptor& desc);
998 
1003  void AddActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal);
1004 
1009  void LoadActiveScriptPubKeyMan(uint256 id, OutputType type, bool internal);
1010 
1015  void DeactivateScriptPubKeyMan(uint256 id, OutputType type, bool internal);
1016 
1018  DescriptorScriptPubKeyMan& SetupDescriptorScriptPubKeyMan(WalletBatch& batch, const CExtKey& master_key, const OutputType& output_type, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1020  void SetupDescriptorScriptPubKeyMans(const CExtKey& master_key) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1021  void SetupDescriptorScriptPubKeyMans() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1022 
1024  DescriptorScriptPubKeyMan* GetDescriptorScriptPubKeyMan(const WalletDescriptor& desc) const;
1025 
1029  std::optional<bool> IsInternalScriptPubKeyMan(ScriptPubKeyMan* spk_man) const;
1030 
1032  ScriptPubKeyMan* AddWalletDescriptor(WalletDescriptor& desc, const FlatSigningProvider& signing_provider, const std::string& label, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1033 
1039  bool MigrateToSQLite(bilingual_str& error) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1040 
1042  std::optional<MigrationData> GetDescriptorsForLegacy(bilingual_str& error) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1043 
1046  bool ApplyMigrationData(MigrationData& data, bilingual_str& error) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1047 
1049  bool CanGrindR() const;
1050 
1052  void CacheNewScriptPubKeys(const std::set<CScript>& spks, ScriptPubKeyMan* spkm);
1053 
1054  void TopUpCallback(const std::set<CScript>& spks, ScriptPubKeyMan* spkm) override;
1055 
1057  std::set<CExtPubKey> GetActiveHDPubKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
1058 
1061  std::optional<CKey> GetKey(const CKeyID& keyid) const;
1062 };
1063 
1068 void MaybeResendWalletTxs(WalletContext& context);
1069 
1072 {
1073 private:
1074  using Clock = std::chrono::steady_clock;
1075  using NowFn = std::function<Clock::time_point()>;
1077  bool m_could_reserve{false};
1079 public:
1081 
1082  bool reserve(bool with_passphrase = false)
1083  {
1084  assert(!m_could_reserve);
1085  if (m_wallet.fScanningWallet.exchange(true)) {
1086  return false;
1087  }
1088  m_wallet.m_scanning_with_passphrase.exchange(with_passphrase);
1089  m_wallet.m_scanning_start = SteadyClock::now();
1090  m_wallet.m_scanning_progress = 0;
1091  m_could_reserve = true;
1092  return true;
1093  }
1094 
1095  bool isReserved() const
1096  {
1097  return (m_could_reserve && m_wallet.fScanningWallet);
1098  }
1099 
1100  Clock::time_point now() const { return m_now ? m_now() : Clock::now(); };
1101 
1102  void setNow(NowFn now) { m_now = std::move(now); }
1103 
1105  {
1106  if (m_could_reserve) {
1107  m_wallet.fScanningWallet = false;
1108  m_wallet.m_scanning_with_passphrase = false;
1109  }
1110  }
1111 };
1112 
1114 bool AddWalletSetting(interfaces::Chain& chain, const std::string& wallet_name);
1115 
1117 bool RemoveWalletSetting(interfaces::Chain& chain, const std::string& wallet_name);
1118 
1120  std::string wallet_name;
1121  std::shared_ptr<CWallet> wallet;
1122  std::shared_ptr<CWallet> watchonly_wallet;
1123  std::shared_ptr<CWallet> solvables_wallet;
1125 };
1126 
1128 [[nodiscard]] util::Result<MigrationResult> MigrateLegacyToDescriptor(const std::string& wallet_name, const SecureString& passphrase, WalletContext& context);
1129 } // namespace wallet
1130 
1131 #endif // BITCOIN_WALLET_WALLET_H
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
Definition: addresstype.h:131
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
static constexpr CAmount COIN
The amount of satoshis in one BTC.
Definition: amount.h:15
int flags
Definition: bitcoin-tx.cpp:528
const CChainParams & Params()
Return the currently selected parameters.
Fee rate in satoshis per kilovirtualbyte: CAmount / kvB.
Definition: feerate.h:33
An encapsulated private key.
Definition: key.h:33
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:24
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
An encapsulated public key.
Definition: pubkey.h:34
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:414
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:296
An input of a transaction.
Definition: transaction.h:67
An output of a transaction.
Definition: transaction.h:150
A UTXO entry.
Definition: coins.h:32
An interface to be implemented by keystores that support signing.
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:33
Chain notifications.
Definition: chain.h:310
Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to acce...
Definition: chain.h:124
256-bit opaque blob.
Definition: uint256.h:106
Coin Control Features.
Definition: coincontrol.h:81
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
Definition: wallet.h:301
const std::string & GetName() const
Get a name for this wallet for logging/debugging purposes.
Definition: wallet.h:453
bool HaveChain() const
Interface to assert chain access.
Definition: wallet.h:478
bool GetBroadcastTransactions() const
Inquire whether this wallet broadcasts transactions.
Definition: wallet.h:862
int64_t GetBirthTime() const
Definition: wallet.h:893
std::function< bool(CWalletTx &wtx, bool new_tx)> UpdateWalletTxFn
Callback for updating transaction metadata in mapWallet.
Definition: wallet.h:602
boost::signals2::signal< void()> NotifyUnload
Wallet is about to be unloaded.
Definition: wallet.h:829
int m_last_block_processed_height GUARDED_BY(cs_wallet)
Height of last block processed is used by wallet to know depth of transactions without relying on Cha...
std::unique_ptr< WalletDatabase > m_database
Internal database handle.
Definition: wallet.h:394
CWallet(interfaces::Chain *chain, const std::string &name, std::unique_ptr< WalletDatabase > database)
Construct wallet with specified name and database implementation.
Definition: wallet.h:460
std::function< void(const CTxDestination &dest, const std::string &label, bool is_change, const std::optional< AddressPurpose > purpose)> ListAddrBookFunc
Walk-through the address book entries.
Definition: wallet.h:764
bool IsScanning() const
Definition: wallet.h:554
std::map< CTxDestination, CAddressBookData > m_address_book GUARDED_BY(cs_wallet)
int GetLastBlockHeight() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Get last block processed height.
Definition: wallet.h:973
boost::signals2::signal< void(bool fHaveWatchOnly)> NotifyWatchonlyChanged
Watch-only address added.
Definition: wallet.h:850
WalletDatabase & GetDatabase() const override
Definition: wallet.h:445
std::map< OutputType, ScriptPubKeyMan * > m_external_spk_managers
Definition: wallet.h:412
uint256 m_last_block_processed GUARDED_BY(cs_wallet)
The following is used to keep track of how far behind the wallet is from the chain sync,...
CKeyingMaterial vMasterKey GUARDED_BY(cs_wallet)
void SetBroadcastTransactions(bool broadcast)
Set whether this wallet broadcasts transactions.
Definition: wallet.h:864
int64_t nOrderPosNext GUARDED_BY(cs_wallet)=0
std::map< OutputType, ScriptPubKeyMan * > m_internal_spk_managers
Definition: wallet.h:413
std::string m_name
Wallet name: relative directory name or "" for default wallet.
Definition: wallet.h:391
double ScanningProgress() const
Definition: wallet.h:557
SteadyClock::duration ScanningDuration() const
Definition: wallet.h:556
RecursiveMutex m_relock_mutex
Definition: wallet.h:578
std::string m_notify_tx_changed_script
Notify external script when a wallet transaction comes in or is updated (handled by -walletnotify)
Definition: wallet.h:735
void SetNextResend()
Set the next time this wallet should resend transactions to 12-36 hours from now, ~1 day on average.
Definition: wallet.h:634
TxItems wtxOrdered
Definition: wallet.h:485
bool CanSupportFeature(enum WalletFeature wf) const override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
check whether we support the named feature
Definition: wallet.h:532
MasterKeyMap mapMasterKeys
Definition: wallet.h:456
void WalletLogPrintf(const char *fmt, Params... parameters) const
Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.
Definition: wallet.h:931
int64_t nRelockTime GUARDED_BY(cs_wallet)
Holds a timestamp at which point the wallet is scheduled (externally) to be relocked....
Definition: wallet.h:573
std::unordered_multimap< COutPoint, uint256, SaltedOutpointHasher > TxSpends
Used to keep track of spent outpoints, and detect and report conflicts (double-spends or mutated tran...
Definition: wallet.h:335
boost::signals2::signal< void(const std::string &title, int nProgress)> ShowProgress
Show progress e.g.
Definition: wallet.h:847
Mutex m_unlock_mutex
Definition: wallet.h:573
interfaces::Chain * m_chain
Interface for accessing chain state.
Definition: wallet.h:388
boost::signals2::signal< void(const uint256 &hashTx, ChangeType status)> NotifyTransactionChanged
Wallet transaction added, removed or updated.
Definition: wallet.h:844
std::map< unsigned int, CMasterKey > MasterKeyMap
Definition: wallet.h:455
boost::signals2::signal< void()> NotifyCanGetAddressesChanged
Keypool has new keys.
Definition: wallet.h:853
TxSpends mapTxSpends GUARDED_BY(cs_wallet)
int nWalletVersion GUARDED_BY(cs_wallet)
the current wallet version: clients below this version are not able to load the wallet
Definition: wallet.h:316
bool IsAbortingRescan() const
Definition: wallet.h:553
void SetLastBlockProcessed(int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Set last block processed height, currently only use in unit test.
Definition: wallet.h:986
uint256 GetLastBlockHash() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
Definition: wallet.h:979
RecursiveMutex cs_wallet
Main wallet lock.
Definition: wallet.h:443
std::unordered_map< CScript, std::vector< ScriptPubKeyMan * >, SaltedSipHasher > m_cached_spks
Cache of descriptor ScriptPubKeys used for IsMine. Maps ScriptPubKey to set of spkms.
Definition: wallet.h:427
boost::signals2::signal< void(const CTxDestination &address, const std::string &label, bool isMine, AddressPurpose purpose, ChangeType status)> NotifyAddressBookChanged
Address book entry changed.
Definition: wallet.h:838
std::multimap< int64_t, CWalletTx * > TxItems
Definition: wallet.h:484
boost::signals2::signal< void(CWallet *wallet)> NotifyStatusChanged
Wallet status (encrypted, locked) changed.
Definition: wallet.h:859
std::map< uint256, std::unique_ptr< ScriptPubKeyMan > > m_spk_managers
Definition: wallet.h:417
std::function< TxUpdate(CWalletTx &wtx)> TryUpdatingStateFn
Definition: wallet.h:363
std::unordered_map< uint256, CWalletTx, SaltedTxidHasher > mapWallet GUARDED_BY(cs_wallet)
Map from txid to CWalletTx for all transactions this wallet is interested in, including received and ...
bool IsScanningWithPassphrase() const
Definition: wallet.h:555
A transaction with a bunch of additional info that only the owner cares about.
Definition: transaction.h:177
A wrapper to reserve an address from a wallet.
Definition: wallet.h:189
const CWallet *const pwallet
The wallet to reserve from.
Definition: wallet.h:192
CTxDestination address
The destination.
Definition: wallet.h:199
ReserveDestination & operator=(const ReserveDestination &)=delete
~ReserveDestination()
Destructor. If a key has been reserved and not KeepKey'ed, it will be returned to the keypool.
Definition: wallet.h:213
ReserveDestination(CWallet *pwallet, OutputType type)
Construct a ReserveDestination object. This does NOT reserve an address yet.
Definition: wallet.h:205
OutputType const type
Definition: wallet.h:195
ReserveDestination(const ReserveDestination &)=delete
Access to the wallet database.
Definition: walletdb.h:191
An instance of this class represents one database.
Definition: db.h:130
Descriptor with some wallet metadata.
Definition: walletutil.h:85
RAII object to check and reserve a wallet rescan.
Definition: wallet.h:1072
std::function< Clock::time_point()> NowFn
Definition: wallet.h:1075
std::chrono::steady_clock Clock
Definition: wallet.h:1074
WalletRescanReserver(CWallet &w)
Definition: wallet.h:1080
Clock::time_point now() const
Definition: wallet.h:1100
void setNow(NowFn now)
Definition: wallet.h:1102
bool reserve(bool with_passphrase=false)
Definition: wallet.h:1082
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
TransactionError
Definition: error.h:22
@ SIGHASH_DEFAULT
Taproot only; implied when sighash byte is missing, and equivalent to SIGHASH_ALL.
Definition: interpreter.h:35
ChainstateRole
This enum describes the various roles a specific Chainstate instance can take.
Definition: chain.h:25
#define LogPrintf(...)
Definition: logging.h:244
MemPoolRemovalReason
Reason why a transaction was removed from the mempool, this is passed to the notification signal.
SigningResult
Definition: message.h:43
Result CommitTransaction(CWallet &wallet, const uint256 &txid, CMutableTransaction &&mtx, std::vector< bilingual_str > &errors, uint256 &bumped_txid)
Commit the bumpfee transaction.
Definition: feebumper.cpp:355
static constexpr size_t DUMMY_NESTED_P2WPKH_INPUT_SIZE
Pre-calculated constants for input size estimation in virtual size
Definition: wallet.h:144
void UnloadWallet(std::shared_ptr< CWallet > &&wallet)
Explicitly unload and delete the wallet.
Definition: wallet.cpp:237
constexpr CAmount HIGH_APS_FEE
discourage APS fee higher than this amount
Definition: wallet.h:123
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)
Definition: wallet.cpp:358
static const CAmount DEFAULT_FALLBACK_FEE
-fallbackfee default
Definition: wallet.h:107
void MaybeResendWalletTxs(WalletContext &context)
Called periodically by the schedule thread.
Definition: wallet.cpp:2126
std::variant< TxStateConfirmed, TxStateInMempool, TxStateInactive > SyncTxState
Subset of states transaction sync logic is implemented to handle.
Definition: transaction.h:81
std::vector< std::shared_ptr< CWallet > > GetWallets(WalletContext &context)
Definition: wallet.cpp:176
constexpr CAmount DEFAULT_TRANSACTION_MAXFEE
-maxtxfee default
Definition: wallet.h:138
std::variant< TxStateConfirmed, TxStateInMempool, TxStateBlockConflicted, TxStateInactive, TxStateUnrecognized > TxState
All possible CWalletTx states.
Definition: transaction.h:78
std::map< std::string, std::string > mapValue_t
Definition: transaction.h:149
std::vector< unsigned char, secure_allocator< unsigned char > > CKeyingMaterial
Definition: crypter.h:62
static const CAmount DEFAULT_DISCARD_FEE
-discardfee default
Definition: wallet.h:109
DBErrors
Error statuses for the wallet database.
Definition: walletdb.h:48
bool AddWalletSetting(interfaces::Chain &chain, const std::string &wallet_name)
Add wallet name to persistent configuration so it will be loaded on startup.
Definition: wallet.cpp:88
bool RemoveWalletSetting(interfaces::Chain &chain, const std::string &wallet_name)
Remove wallet name from persistent configuration so it will not be loaded on startup.
Definition: wallet.cpp:99
static DBErrors LoadWalletFlags(CWallet *pwallet, DatabaseBatch &batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet -> cs_wallet)
Definition: walletdb.cpp:465
static std::set< std::string > g_loading_wallet_set GUARDED_BY(g_loading_wallet_mutex)
static const bool DEFAULT_WALLETCROSSCHAIN
Definition: wallet.h:136
std::unique_ptr< interfaces::Handler > HandleLoadWallet(WalletContext &context, LoadWalletFn load_wallet)
Definition: wallet.cpp:198
std::underlying_type< isminetype >::type isminefilter
used for bitflags of isminetype
Definition: wallet.h:43
static const CAmount DEFAULT_TRANSACTION_MINFEE
-mintxfee default
Definition: wallet.h:111
static const unsigned int DEFAULT_KEYPOOL_SIZE
Default for -keypool.
util::Result< MigrationResult > MigrateLegacyToDescriptor(const std::string &wallet_name, const SecureString &passphrase, WalletContext &context)
Do all steps to migrate a legacy wallet to a descriptor wallet.
Definition: wallet.cpp:4340
static const bool DEFAULT_WALLET_RBF
-walletrbf default
Definition: wallet.h:133
constexpr CAmount HIGH_TX_FEE_PER_KB
Discourage users to set fees higher than this amount (in satoshis) per kB.
Definition: wallet.h:140
constexpr OutputType DEFAULT_ADDRESS_TYPE
Default for -addresstype.
Definition: wallet.h:149
std::unique_ptr< WalletDatabase > MakeWalletDatabase(const std::string &name, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error_string)
Definition: wallet.cpp:2926
void NotifyWalletLoaded(WalletContext &context, const std::shared_ptr< CWallet > &wallet)
Definition: wallet.cpp:205
constexpr CAmount HIGH_MAX_TX_FEE
-maxtxfee will warn if called with a higher fee than this amount (in satoshis)
Definition: wallet.h:142
constexpr CAmount DEFAULT_PAY_TX_FEE
-paytxfee default
Definition: wallet.h:105
static const bool DEFAULT_DISABLE_WALLET
Definition: wallet.h:135
static const std::map< std::string, WalletFlags > WALLET_FLAG_MAP
Definition: wallet.h:163
static const CAmount DEFAULT_MAX_AVOIDPARTIALSPEND_FEE
maximum fee increase allowed to do partial spend avoidance, even for nodes with this feature disabled...
Definition: wallet.h:121
static const unsigned int DEFAULT_TX_CONFIRM_TARGET
-txconfirmtarget default
Definition: wallet.h:131
isminetype
IsMine() return codes, which depend on ScriptPubKeyMan implementation.
Definition: types.h:40
std::string PurposeToString(AddressPurpose p)
Definition: wallet.h:271
AddressPurpose
Address purpose field that has been been stored with wallet sending and receiving addresses since BIP...
Definition: types.h:60
@ REFUND
Never set in current code may be present in older wallet databases.
static const bool DEFAULT_WALLETBROADCAST
Definition: wallet.h:134
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)
Definition: wallet.cpp:481
bool AddWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet)
Definition: wallet.cpp:138
static const CAmount WALLET_INCREMENTAL_RELAY_FEE
minimum recommended increment for replacement txs
Definition: wallet.h:125
WalletFeature
(client) version numbers for particular wallet features
Definition: walletutil.h:16
@ FEATURE_BASE
Definition: walletutil.h:17
static constexpr uint64_t KNOWN_WALLET_FLAGS
Definition: wallet.h:151
static const CAmount DEFAULT_CONSOLIDATE_FEERATE
-consolidatefeerate default
Definition: wallet.h:113
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)
Definition: wallet.cpp:371
bool IsFeatureSupported(int wallet_version, int feature_version)
Definition: walletutil.cpp:35
@ WALLET_FLAG_EXTERNAL_SIGNER
Indicates that the wallet needs an external signer.
Definition: walletutil.h:77
@ WALLET_FLAG_LAST_HARDENED_XPUB_CACHED
Definition: walletutil.h:48
@ WALLET_FLAG_KEY_ORIGIN_METADATA
Definition: walletutil.h:45
@ WALLET_FLAG_AVOID_REUSE
Definition: walletutil.h:42
@ WALLET_FLAG_DESCRIPTORS
Indicate that this wallet supports DescriptorScriptPubKeyMan.
Definition: walletutil.h:74
@ WALLET_FLAG_DISABLE_PRIVATE_KEYS
Definition: walletutil.h:51
@ WALLET_FLAG_BLANK_WALLET
Flag set when a wallet contains no HD seed and no private keys, scripts, addresses,...
Definition: walletutil.h:71
static constexpr uint64_t MUTABLE_WALLET_FLAGS
Definition: wallet.h:160
std::shared_ptr< CWallet > GetWallet(WalletContext &context, const std::string &name)
Definition: wallet.cpp:189
static const bool DEFAULT_SPEND_ZEROCONF_CHANGE
Default for -spendzeroconfchange.
Definition: wallet.h:127
std::optional< AddressPurpose > PurposeFromString(std::string_view s)
Definition: wallet.h:281
static const bool DEFAULT_WALLET_REJECT_LONG_CHAINS
Default for -walletrejectlongchains.
Definition: wallet.h:129
DatabaseStatus
Definition: db.h:204
static DBErrors LoadMinVersion(CWallet *pwallet, DatabaseBatch &batch) EXCLUSIVE_LOCKS_REQUIRED(pwallet -> cs_wallet)
Definition: walletdb.cpp:453
bool RemoveWallet(WalletContext &context, const std::shared_ptr< CWallet > &wallet, std::optional< bool > load_on_start, std::vector< bilingual_str > &warnings)
Definition: wallet.cpp:150
std::shared_ptr< CWallet > GetDefaultWallet(WalletContext &context, size_t &count)
Definition: wallet.cpp:182
OutputType
Definition: outputtype.h:17
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
void SignTransaction(CMutableTransaction &mtx, const SigningProvider *keystore, const std::map< COutPoint, Coin > &coins, const UniValue &hashType, UniValue &result)
Sign a transaction with the given keystore and previous transactions.
const char * name
Definition: rest.cpp:48
std::basic_string< char, std::char_traits< char >, secure_allocator< char > > SecureString
Definition: secure.h:58
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:124
Definition: key.h:207
A mutable version of CTransaction.
Definition: transaction.h:378
std::chrono::time_point< NodeClock > time_point
Definition: time.h:17
A version of CTransaction with the PSBT format.
Definition: psbt.h:947
Bilingual messages:
Definition: translation.h:18
Address book data.
Definition: wallet.h:230
std::optional< AddressPurpose > purpose
Address purpose which was originally recorded for payment protocol support but now serves as a cached...
Definition: wallet.h:245
void SetLabel(std::string name)
Definition: wallet.h:268
std::string GetLabel() const
Definition: wallet.h:267
std::optional< std::string > label
Address label which is always nullopt for change addresses.
Definition: wallet.h:238
bool IsChange() const
Accessor methods.
Definition: wallet.h:266
CAmount nAmount
Definition: wallet.h:292
bool fSubtractFeeFromAmount
Definition: wallet.h:293
CTxDestination dest
Definition: wallet.h:291
std::optional< int > last_scanned_height
Definition: wallet.h:623
uint256 last_scanned_block
Hash and height of most recent block that was successfully scanned.
Definition: wallet.h:622
uint256 last_failed_block
Height of the most recent block that could not be scanned due to read errors or pruning.
Definition: wallet.h:629
struct containing information needed for migrating legacy wallets to descriptor wallets
std::shared_ptr< CWallet > watchonly_wallet
Definition: wallet.h:1122
std::string wallet_name
Definition: wallet.h:1120
std::shared_ptr< CWallet > solvables_wallet
Definition: wallet.h:1123
std::shared_ptr< CWallet > wallet
Definition: wallet.h:1121
WalletContext struct containing references to state shared between CWallet instances,...
Definition: context.h:36
#define LOCK(cs)
Definition: sync.h:257
static int count
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:48
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1162
ChangeType
General change type (added, updated, removed).
Definition: ui_change_type.h:9
AssertLockHeld(pool.cs)
assert(!tx.IsCoinBase())
std::shared_ptr< CWallet > m_wallet
Definition: interfaces.cpp:562
std::function< void(std::unique_ptr< interfaces::Wallet > wallet)> LoadWalletFn
Definition: wallet.h:77
static void NotifyUnload(WalletModel *walletModel)