Bitcoin Core  22.99.0
P2P Digital Currency
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
CWallet Class Referencefinalabstract

A CWallet maintains a set of transactions and balances, and provides the ability to create new transactions. More...

#include <wallet.h>

Inheritance diagram for CWallet:
[legend]
Collaboration diagram for CWallet:
[legend]

Classes

struct  ScanResult
 

Public Types

typedef std::map< unsigned int, CMasterKeyMasterKeyMap
 
typedef std::multimap< int64_t, CWalletTx * > TxItems
 
using UpdateWalletTxFn = std::function< bool(CWalletTx &wtx, bool new_tx)>
 Callback for updating transaction metadata in mapWallet. More...
 

Public Member Functions

WalletDatabaseGetDatabase () const override
 
const std::string & GetName () const
 Get a name for this wallet for logging/debugging purposes. More...
 
 CWallet (interfaces::Chain *chain, const std::string &name, const ArgsManager &args, std::unique_ptr< WalletDatabase > database)
 Construct wallet with specified name and database implementation. More...
 
 ~CWallet ()
 
bool IsCrypted () const
 
bool IsLocked () const override
 
bool Lock ()
 
bool HaveChain () const
 Interface to assert chain access. More...
 
std::map< uint256, CWalletTx > mapWallet GUARDED_BY (cs_wallet)
 Map from txid to CWalletTx for all transactions this wallet is interested in, including received and sent transactions. More...
 
int64_t nOrderPosNext GUARDED_BY (cs_wallet)=0
 
std::map< CTxDestination, CAddressBookData > m_address_book GUARDED_BY (cs_wallet)
 
const CAddressBookDataFindAddressBookEntry (const CTxDestination &, bool allow_change=false) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
std::set< COutPoint > setLockedCoins GUARDED_BY (cs_wallet)
 Set of Coins owned by this wallet that we won't try to spend from. More...
 
interfaces::Chainchain () const
 Interface for accessing chain state. More...
 
const CWalletTxGetWalletTx (const uint256 &hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
std::set< uint256GetTxConflicts (const CWalletTx &wtx) const NO_THREAD_SAFETY_ANALYSIS
 
int GetTxDepthInMainChain (const CWalletTx &wtx) const NO_THREAD_SAFETY_ANALYSIS
 Return depth of transaction in blockchain: <0 : conflicts with a transaction this deep in the blockchain 0 : in memory pool, waiting to be included in a block >=1 : this many blocks deep in the main chain. More...
 
bool IsTxInMainChain (const CWalletTx &wtx) const
 
int GetTxBlocksToMaturity (const CWalletTx &wtx) const
 
bool IsTxImmatureCoinBase (const CWalletTx &wtx) const
 
bool CanSupportFeature (enum WalletFeature wf) const override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 check whether we support the named feature More...
 
bool IsSpent (const uint256 &hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Outpoint is spent if any non-conflicted transaction spends it: More...
 
bool IsSpentKey (const uint256 &hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SetSpentKeyState (WalletBatch &batch, const uint256 &hash, unsigned int n, bool used, std::set< CTxDestination > &tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool DisplayAddress (const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Display address on an external signer. More...
 
bool IsLockedCoin (uint256 hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool LockCoin (const COutPoint &output, WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool UnlockCoin (const COutPoint &output, WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool UnlockAllCoins () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void ListLockedCoins (std::vector< COutPoint > &vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void AbortRescan ()
 
bool IsAbortingRescan () const
 
bool IsScanning () const
 
int64_t ScanningDuration () const
 
double ScanningProgress () const
 
void UpgradeKeyMetadata () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Upgrade stored CKeyMetadata objects to store key origin info as KeyOriginInfo. More...
 
void UpgradeDescriptorCache () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Upgrade DescriptorCaches. More...
 
bool LoadMinVersion (int nVersion) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void LoadDestData (const CTxDestination &dest, const std::string &key, const std::string &value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Adds a destination data tuple to the store, without saving it to disk. More...
 
int64_t nRelockTime GUARDED_BY (cs_wallet)
 Holds a timestamp at which point the wallet is scheduled (externally) to be relocked. Caller must arrange for actual relocking to occur via Lock(). More...
 
bool Unlock (const SecureString &strWalletPassphrase, bool accept_no_keys=false)
 
bool ChangeWalletPassphrase (const SecureString &strOldWalletPassphrase, const SecureString &strNewWalletPassphrase)
 
bool EncryptWallet (const SecureString &strWalletPassphrase)
 
void GetKeyBirthTimes (std::map< CKeyID, int64_t > &mapKeyBirth) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
unsigned int ComputeTimeSmart (const CWalletTx &wtx, bool rescanning_old_block) const
 Compute smart timestamp for a transaction being added to the wallet. More...
 
int64_t IncOrderPosNext (WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Increment the next transaction order id. More...
 
DBErrors ReorderTransactions ()
 
void MarkDirty ()
 
CWalletTxAddToWallet (CTransactionRef tx, const TxState &state, const UpdateWalletTxFn &update_wtx=nullptr, bool fFlushOnClose=true, bool rescanning_old_block=false)
 
bool LoadToWallet (const uint256 &hash, const UpdateWalletTxFn &fill_wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void transactionAddedToMempool (const CTransactionRef &tx, uint64_t mempool_sequence) override
 
void blockConnected (const CBlock &block, int height) override
 
void blockDisconnected (const CBlock &block, int height) override
 
void updatedBlockTip () override
 
int64_t RescanFromTime (int64_t startTime, const WalletRescanReserver &reserver, bool update)
 Scan active chain for relevant transactions after importing keys. More...
 
ScanResult ScanForWalletTransactions (const uint256 &start_block, int start_height, std::optional< int > max_height, const WalletRescanReserver &reserver, bool fUpdate)
 Scan the block chain (starting in start_block) for transactions from or to us. More...
 
void transactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) override
 
void ReacceptWalletTransactions () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void ResendWalletTransactions ()
 
OutputType TransactionChangeType (const std::optional< OutputType > &change_type, const std::vector< CRecipient > &vecSend) const
 
bool SignTransaction (CMutableTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Fetch the inputs and sign with SIGHASH_ALL. More...
 
bool SignTransaction (CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, bilingual_str > &input_errors) const
 Sign the tx given the input coins and sighash. More...
 
SigningResult SignMessage (const std::string &message, const PKHash &pkhash, std::string &str_sig) const
 
TransactionError FillPSBT (PartiallySignedTransaction &psbtx, bool &complete, int sighash_type=1, bool sign=true, bool bip32derivs=true, size_t *n_signed=nullptr) const
 Fills out a PSBT with information from the wallet. More...
 
void CommitTransaction (CTransactionRef tx, mapValue_t mapValue, std::vector< std::pair< std::string, std::string >> orderForm)
 Submit the transaction to the node's mempool and then relay to peers. More...
 
bool SubmitTxMemoryPoolAndRelay (CWalletTx &wtx, std::string &err_string, bool relay) const
 Pass this transaction to node for mempool insertion and relay to peers if flag set to true. More...
 
bool DummySignTx (CMutableTransaction &txNew, const std::set< CTxOut > &txouts, const CCoinControl *coin_control=nullptr) const
 
bool DummySignTx (CMutableTransaction &txNew, const std::vector< CTxOut > &txouts, const CCoinControl *coin_control=nullptr) const
 
bool ImportScripts (const std::set< CScript > scripts, int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool ImportPrivKeys (const std::map< CKeyID, CKey > &privkey_map, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
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)
 
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)
 
size_t KeypoolCountExternalKeys () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool TopUpKeyPool (unsigned int kpSize=0)
 
std::optional< int64_t > GetOldestKeyPoolTime () const
 
std::set< CTxDestinationGetLabelAddresses (const std::string &label) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void MarkDestinationsDirty (const std::set< CTxDestination > &destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Marks all outputs in each one of the destinations dirty, so their cache is reset and does not return outdated information. More...
 
bool GetNewDestination (const OutputType type, const std::string label, CTxDestination &dest, bilingual_str &error)
 
bool GetNewChangeDestination (const OutputType type, CTxDestination &dest, bilingual_str &error)
 
isminetype IsMine (const CTxDestination &dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
isminetype IsMine (const CScript &script) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
CAmount GetDebit (const CTxIn &txin, const isminefilter &filter) const
 Returns amount of debit if the input matches the filter, otherwise returns 0. More...
 
isminetype IsMine (const CTxOut &txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool IsMine (const CTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool IsFromMe (const CTransaction &tx) const
 should probably be renamed to IsRelevantToMe More...
 
CAmount GetDebit (const CTransaction &tx, const isminefilter &filter) const
 
void chainStateFlushed (const CBlockLocator &loc) override
 
DBErrors LoadWallet ()
 
DBErrors ZapSelectTx (std::vector< uint256 > &vHashIn, std::vector< uint256 > &vHashOut) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool SetAddressBook (const CTxDestination &address, const std::string &strName, const std::string &purpose)
 
bool DelAddressBook (const CTxDestination &address)
 
bool IsAddressUsed (const CTxDestination &dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool SetAddressUsed (WalletBatch &batch, const CTxDestination &dest, bool used) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
std::vector< std::string > GetAddressReceiveRequests () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool SetAddressReceiveRequest (WalletBatch &batch, const CTxDestination &dest, const std::string &id, const std::string &value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
unsigned int GetKeyPoolSize () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SetMinVersion (enum WalletFeature, WalletBatch *batch_in=nullptr) override
 signify that a particular wallet feature is now used. More...
 
int GetVersion () const
 get the current wallet format (the oldest client version guaranteed to understand this wallet) More...
 
std::set< uint256GetConflicts (const uint256 &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Get wallet transactions that conflict with given transaction (spend same outputs) More...
 
bool HasWalletSpend (const uint256 &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Check if a given transaction has any of its outputs spent by another transaction in the wallet. More...
 
void Flush ()
 Flush wallet (bitdb flush) More...
 
void Close ()
 Close wallet database. More...
 
bool GetBroadcastTransactions () const
 Inquire whether this wallet broadcasts transactions. More...
 
void SetBroadcastTransactions (bool broadcast)
 Set whether this wallet broadcasts transactions. More...
 
bool TransactionCanBeAbandoned (const uint256 &hashTx) const
 Return whether transaction can be abandoned. More...
 
bool AbandonTransaction (const uint256 &hashTx)
 
bool MarkReplaced (const uint256 &originalHash, const uint256 &newHash)
 Mark a transaction as replaced by another transaction (e.g., BIP 125). More...
 
void postInitProcess ()
 Wallet post-init setup Gives the wallet a chance to register repetitive tasks and complete post-init tasks. More...
 
bool BackupWallet (const std::string &strDest) const
 
bool IsHDEnabled () const
 
bool CanGetAddresses (bool internal=false) const
 
void UnsetWalletFlag (uint64_t flag)
 Unsets a single wallet flag. More...
 
bool IsWalletFlagSet (uint64_t flag) const override
 check if a certain wallet flag is set More...
 
bool AddWalletFlags (uint64_t flags)
 overwrite all flags by the given uint64_t returns false if unknown, non-tolerable flags are present More...
 
bool LoadWalletFlags (uint64_t flags)
 Loads the flags into the wallet. More...
 
bool IsLegacy () const
 Determine if we are a legacy wallet. More...
 
const std::string GetDisplayName () const override
 Returns a bracketed wallet name for displaying in logs, will return [default wallet] if the wallet has no name. More...
 
template<typename... Params>
void WalletLogPrintf (std::string fmt, Params... parameters) const
 Prepends the wallet name in logging output to ease debugging in multi-wallet use cases. More...
 
bool UpgradeWallet (int version, bilingual_str &error)
 Upgrade the wallet. More...
 
std::set< ScriptPubKeyMan * > GetActiveScriptPubKeyMans () const
 Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers. More...
 
std::set< ScriptPubKeyMan * > GetAllScriptPubKeyMans () const
 Returns all unique ScriptPubKeyMans. More...
 
ScriptPubKeyManGetScriptPubKeyMan (const OutputType &type, bool internal) const
 Get the ScriptPubKeyMan for the given OutputType and internal/external chain. More...
 
ScriptPubKeyManGetScriptPubKeyMan (const CScript &script) const
 Get the ScriptPubKeyMan for a script. More...
 
ScriptPubKeyManGetScriptPubKeyMan (const uint256 &id) const
 Get the ScriptPubKeyMan by id. More...
 
std::set< ScriptPubKeyMan * > GetScriptPubKeyMans (const CScript &script, SignatureData &sigdata) const
 Get all of the ScriptPubKeyMans for a script given additional information in sigdata (populated by e.g. a psbt) More...
 
std::unique_ptr< SigningProviderGetSolvingProvider (const CScript &script) const
 Get the SigningProvider for a script. More...
 
std::unique_ptr< SigningProviderGetSolvingProvider (const CScript &script, SignatureData &sigdata) const
 
LegacyScriptPubKeyManGetLegacyScriptPubKeyMan () const
 Get the LegacyScriptPubKeyMan which is used for all types, internal, and external. More...
 
LegacyScriptPubKeyManGetOrCreateLegacyScriptPubKeyMan ()
 
void SetupLegacyScriptPubKeyMan ()
 Make a LegacyScriptPubKeyMan and set it for all types, internal, and external. More...
 
const CKeyingMaterialGetEncryptionKey () const override
 
bool HasEncryptionKeys () const override
 
int GetLastBlockHeight () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Get last block processed height. More...
 
uint256 GetLastBlockHash () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SetLastBlockProcessed (int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Set last block processed height, currently only use in unit test. More...
 
void ConnectScriptPubKeyManNotifiers ()
 Connect the signals from ScriptPubKeyMans to the signals in CWallet. More...
 
void LoadDescriptorScriptPubKeyMan (uint256 id, WalletDescriptor &desc)
 Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it. More...
 
void AddActiveScriptPubKeyMan (uint256 id, OutputType type, bool internal)
 Adds the active ScriptPubKeyMan for the specified type and internal. More...
 
void LoadActiveScriptPubKeyMan (uint256 id, OutputType type, bool internal)
 Loads an active ScriptPubKeyMan for the specified type and internal. More...
 
void DeactivateScriptPubKeyMan (uint256 id, OutputType type, bool internal)
 Remove specified ScriptPubKeyMan from set of active SPK managers. More...
 
void SetupDescriptorScriptPubKeyMans () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Create new DescriptorScriptPubKeyMans and add them to the wallet. More...
 
DescriptorScriptPubKeyManGetDescriptorScriptPubKeyMan (const WalletDescriptor &desc) const
 Return the DescriptorScriptPubKeyMan for a WalletDescriptor if it is already in the wallet. More...
 
ScriptPubKeyManAddWalletDescriptor (WalletDescriptor &desc, const FlatSigningProvider &signing_provider, const std::string &label, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Add a descriptor to the wallet, return a ScriptPubKeyMan & associated output type. More...
 
- Public Member Functions inherited from WalletStorage
virtual ~WalletStorage ()=default
 
- Public Member Functions inherited from interfaces::Chain::Notifications
virtual ~Notifications ()
 

Static Public Member Functions

static std::shared_ptr< CWalletCreate (WalletContext &context, const std::string &name, std::unique_ptr< WalletDatabase > database, uint64_t wallet_creation_flags, bilingual_str &error, std::vector< bilingual_str > &warnings)
 

Public Attributes

RecursiveMutex cs_wallet
 Main wallet lock. More...
 
MasterKeyMap mapMasterKeys
 
unsigned int nMasterKeyMaxID = 0
 
TxItems wtxOrdered
 
uint64_t nAccountingEntryNumber = 0
 
std::unique_ptr< interfaces::Handlerm_chain_notifications_handler
 Registered interfaces::Chain::Notifications handler. More...
 
Mutex m_unlock_mutex
 
CFeeRate m_pay_tx_fee {DEFAULT_PAY_TX_FEE}
 
unsigned int m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}
 
bool m_spend_zero_conf_change {DEFAULT_SPEND_ZEROCONF_CHANGE}
 Allow Coin Selection to pick unconfirmed UTXOs that were sent from our own wallet if it cannot fund the transaction otherwise. More...
 
bool m_signal_rbf {DEFAULT_WALLET_RBF}
 
bool m_allow_fallback_fee {true}
 will be false if -fallbackfee=0 More...
 
CFeeRate m_min_fee {DEFAULT_TRANSACTION_MINFEE}
 Override with -mintxfee. More...
 
CFeeRate m_fallback_fee {DEFAULT_FALLBACK_FEE}
 If fee estimation does not have enough data to provide estimates, use this fee instead. More...
 
CFeeRate m_discard_rate {DEFAULT_DISCARD_FEE}
 If the cost to spend a change output at this feerate is greater than the value of the output itself, just drop it to fees. More...
 
CFeeRate m_consolidate_feerate {DEFAULT_CONSOLIDATE_FEERATE}
 When the actual feerate is less than the consolidate feerate, we will tend to make transactions which consolidate inputs. More...
 
CAmount m_max_aps_fee {DEFAULT_MAX_AVOIDPARTIALSPEND_FEE}
 The maximum fee amount we're willing to pay to prioritize partial spend avoidance. More...
 
OutputType m_default_address_type {DEFAULT_ADDRESS_TYPE}
 
std::optional< OutputTypem_default_change_type {}
 Default output type for change outputs. More...
 
CAmount m_default_max_tx_fee {DEFAULT_TRANSACTION_MAXFEE}
 Absolute maximum transaction fee (in satoshis) used by default for the wallet. More...
 
boost::signals2::signal< void()> NotifyUnload
 Wallet is about to be unloaded. More...
 
boost::signals2::signal< void(const CTxDestination &address, const std::string &label, bool isMine, const std::string &purpose, ChangeType status)> NotifyAddressBookChanged
 Address book entry changed. More...
 
boost::signals2::signal< void(const uint256 &hashTx, ChangeType status)> NotifyTransactionChanged
 Wallet transaction added, removed or updated. More...
 
boost::signals2::signal< void(const std::string &title, int nProgress)> ShowProgress
 Show progress e.g. More...
 
boost::signals2::signal< void(bool fHaveWatchOnly)> NotifyWatchonlyChanged
 Watch-only address added. More...
 
boost::signals2::signal< void()> NotifyCanGetAddressesChanged
 Keypool has new keys. More...
 
boost::signals2::signal< void(CWallet *wallet)> NotifyStatusChanged
 Wallet status (encrypted, locked) changed. More...
 

Private Types

typedef std::multimap< COutPoint, uint256TxSpends
 Used to keep track of spent outpoints, and detect and report conflicts (double-spends or mutated transactions where the mutant gets mined). More...
 

Private Member Functions

CKeyingMaterial vMasterKey GUARDED_BY (cs_wallet)
 
bool Unlock (const CKeyingMaterial &vMasterKeyIn, bool accept_no_keys=false)
 
int nWalletVersion GUARDED_BY (cs_wallet)
 the current wallet version: clients below this version are not able to load the wallet More...
 
TxSpends mapTxSpends GUARDED_BY (cs_wallet)
 
void AddToSpends (const COutPoint &outpoint, const uint256 &wtxid, WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void AddToSpends (const uint256 &wtxid, WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool AddToWalletIfInvolvingMe (const CTransactionRef &tx, const SyncTxState &state, bool fUpdate, bool rescanning_old_block) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Add a transaction to the wallet, or update it. More...
 
void MarkConflicted (const uint256 &hashBlock, int conflicting_height, const uint256 &hashTx)
 Mark a transaction (and its in-wallet descendants) as conflicting with a particular block. More...
 
void MarkInputsDirty (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Mark a transaction's inputs dirty, thus forcing the outputs to be recomputed. More...
 
void SyncMetaData (std::pair< TxSpends::iterator, TxSpends::iterator >) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SyncTransaction (const CTransactionRef &tx, const SyncTxState &state, bool update_tx=true, bool rescanning_old_block=false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool SetAddressBookWithDB (WalletBatch &batch, const CTxDestination &address, const std::string &strName, const std::string &strPurpose)
 
void UnsetWalletFlagWithDB (WalletBatch &batch, uint64_t flag)
 Unsets a wallet flag and saves it to disk. More...
 
void UnsetBlankWalletFlag (WalletBatch &batch) override
 Unset the blank wallet flag and saves it to disk. More...
 
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, and to allow clients to block on us being caught up. More...
 
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 Chain interface beyond asynchronous updates. More...
 

Static Private Member Functions

static bool AttachChain (const std::shared_ptr< CWallet > &wallet, interfaces::Chain &chain, const bool rescan_required, bilingual_str &error, std::vector< bilingual_str > &warnings)
 Catch wallet up to current chain, scanning new blocks, updating the best block locator and m_last_block_processed, and registering for notifications about new blocks and transactions. More...
 

Private Attributes

std::atomic< bool > fAbortRescan {false}
 
std::atomic< bool > fScanningWallet {false}
 
std::atomic< int64_t > m_scanning_start {0}
 
std::atomic< double > m_scanning_progress {0}
 
int64_t nNextResend = 0
 The next scheduled rebroadcast of wallet transactions. More...
 
bool fBroadcastTransactions = false
 Whether this wallet will submit newly created transactions to the node's mempool and prompt rebroadcasts (see ResendWalletTransactions()). More...
 
std::atomic< int64_t > m_best_block_time {0}
 
std::atomic< uint64_t > m_wallet_flags {0}
 WalletFlags set on this wallet. More...
 
const ArgsManagerm_args
 Provider of aplication-wide arguments. More...
 
interfaces::Chainm_chain
 Interface for accessing chain state. More...
 
std::string m_name
 Wallet name: relative directory name or "" for default wallet. More...
 
const std::unique_ptr< WalletDatabasem_database
 Internal database handle. More...
 
std::map< OutputType, ScriptPubKeyMan * > m_external_spk_managers
 
std::map< OutputType, ScriptPubKeyMan * > m_internal_spk_managers
 
std::map< uint256, std::unique_ptr< ScriptPubKeyMan > > m_spk_managers
 

Friends

class WalletRescanReserver
 

Detailed Description

A CWallet maintains a set of transactions and balances, and provides the ability to create new transactions.

Definition at line 228 of file wallet.h.

Member Typedef Documentation

◆ MasterKeyMap

typedef std::map<unsigned int, CMasterKey> CWallet::MasterKeyMap

Definition at line 360 of file wallet.h.

◆ TxItems

typedef std::multimap<int64_t, CWalletTx*> CWallet::TxItems

Definition at line 390 of file wallet.h.

◆ TxSpends

typedef std::multimap<COutPoint, uint256> CWallet::TxSpends
private

Used to keep track of spent outpoints, and detect and report conflicts (double-spends or mutated transactions where the mutant gets mined).

Definition at line 257 of file wallet.h.

◆ UpdateWalletTxFn

using CWallet::UpdateWalletTxFn = std::function<bool(CWalletTx& wtx, bool new_tx)>

Callback for updating transaction metadata in mapWallet.

Parameters
wtx- reference to mapWallet transaction to update
new_tx- true if wtx is newly inserted, false if it previously existed
Returns
true if wtx is changed and needs to be saved to disk, otherwise false

Definition at line 509 of file wallet.h.

Constructor & Destructor Documentation

◆ CWallet()

CWallet::CWallet ( interfaces::Chain chain,
const std::string &  name,
const ArgsManager args,
std::unique_ptr< WalletDatabase database 
)
inline

Construct wallet with specified name and database implementation.

Definition at line 365 of file wallet.h.

Here is the caller graph for this function:

◆ ~CWallet()

CWallet::~CWallet ( )
inline

Definition at line 373 of file wallet.h.

Here is the call graph for this function:

Member Function Documentation

◆ AbortRescan()

void CWallet::AbortRescan ( )
inline

Definition at line 465 of file wallet.h.

◆ AddActiveScriptPubKeyMan()

void CWallet::AddActiveScriptPubKeyMan ( uint256  id,
OutputType  type,
bool  internal 
)

Adds the active ScriptPubKeyMan for the specified type and internal.

Writes it to the wallet file

Parameters
[in]idThe unique id for the ScriptPubKeyMan
[in]typeThe OutputType this ScriptPubKeyMan provides addresses for
[in]internalWhether this ScriptPubKeyMan provides change addresses

Definition at line 3224 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddWalletDescriptor()

ScriptPubKeyMan * CWallet::AddWalletDescriptor ( WalletDescriptor desc,
const FlatSigningProvider signing_provider,
const std::string &  label,
bool  internal 
)

Add a descriptor to the wallet, return a ScriptPubKeyMan & associated output type.

Definition at line 3292 of file wallet.cpp.

Here is the call graph for this function:

◆ AttachChain()

bool CWallet::AttachChain ( const std::shared_ptr< CWallet > &  wallet,
interfaces::Chain chain,
const bool  rescan_required,
bilingual_str error,
std::vector< bilingual_str > &  warnings 
)
staticprivate

Catch wallet up to current chain, scanning new blocks, updating the best block locator and m_last_block_processed, and registering for notifications about new blocks and transactions.

Definition at line 2790 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ BackupWallet()

bool CWallet::BackupWallet ( const std::string &  strDest) const

Definition at line 2932 of file wallet.cpp.

Here is the call graph for this function:

◆ CanSupportFeature()

bool CWallet::CanSupportFeature ( enum WalletFeature  wf) const
inlineoverridevirtual

check whether we support the named feature

Implements WalletStorage.

Definition at line 445 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ chain()

interfaces::Chain& CWallet::chain ( ) const
inline

Interface for accessing chain state.

Definition at line 409 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ComputeTimeSmart()

unsigned int CWallet::ComputeTimeSmart ( const CWalletTx wtx,
bool  rescanning_old_block 
) const

Compute smart timestamp for a transaction being added to the wallet.

Logic:

  • If sending a transaction, assign its timestamp to the current time.
  • If receiving a transaction outside a block, assign its timestamp to the current time.
  • If receiving a transaction during a rescanning process, assign all its (not already known) transactions' timestamps to the block time.
  • If receiving a block with a future timestamp, assign all its (not already known) transactions' timestamps to the current time.
  • If receiving a block with a past timestamp, before the most recent known transaction (that we care about), assign all its (not already known) transactions' timestamps to the same timestamp as that most-recent-known transaction.
  • If receiving a block with a past timestamp, but after the most recent known transaction, assign all its (not already known) transactions' timestamps to the block time.

For more information see CWalletTx::nTimeSmart, https://bitcointalk.org/?topic=54527, or https://github.com/bitcoin/bitcoin/pull/1393.

Definition at line 2403 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConnectScriptPubKeyManNotifiers()

void CWallet::ConnectScriptPubKeyManNotifiers ( )

Connect the signals from ScriptPubKeyMans to the signals in CWallet.

Definition at line 3143 of file wallet.cpp.

Here is the call graph for this function:

◆ Create()

std::shared_ptr< CWallet > 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 
)
static

Definition at line 2542 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DeactivateScriptPubKeyMan()

void CWallet::DeactivateScriptPubKeyMan ( uint256  id,
OutputType  type,
bool  internal 
)

Remove specified ScriptPubKeyMan from set of active SPK managers.

Writes the change to the wallet file.

Parameters
[in]idThe unique id for the ScriptPubKeyMan
[in]typeThe OutputType this ScriptPubKeyMan provides addresses for
[in]internalWhether this ScriptPubKeyMan provides change addresses

Definition at line 3253 of file wallet.cpp.

Here is the call graph for this function:

◆ DummySignTx()

bool CWallet::DummySignTx ( CMutableTransaction txNew,
const std::set< CTxOut > &  txouts,
const CCoinControl coin_control = nullptr 
) const
inline

Definition at line 581 of file wallet.h.

◆ FindAddressBookEntry()

const CAddressBookData * CWallet::FindAddressBookEntry ( const CTxDestination dest,
bool  allow_change = false 
) const

Definition at line 2877 of file wallet.cpp.

◆ GetActiveScriptPubKeyMans()

std::set< ScriptPubKeyMan * > CWallet::GetActiveScriptPubKeyMans ( ) const

Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers.

Definition at line 3022 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetAddressReceiveRequests()

std::vector< std::string > CWallet::GetAddressReceiveRequests ( ) const

Definition at line 2490 of file wallet.cpp.

◆ GetAllScriptPubKeyMans()

std::set< ScriptPubKeyMan * > CWallet::GetAllScriptPubKeyMans ( ) const

Returns all unique ScriptPubKeyMans.

Definition at line 3036 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetBroadcastTransactions()

bool CWallet::GetBroadcastTransactions ( ) const
inline

Inquire whether this wallet broadcasts transactions.

Definition at line 729 of file wallet.h.

Here is the caller graph for this function:

◆ GetDatabase()

WalletDatabase& CWallet::GetDatabase ( ) const
inlineoverridevirtual

Implements WalletStorage.

Definition at line 350 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetDescriptorScriptPubKeyMan()

DescriptorScriptPubKeyMan * CWallet::GetDescriptorScriptPubKeyMan ( const WalletDescriptor desc) const

Return the DescriptorScriptPubKeyMan for a WalletDescriptor if it is already in the wallet.

Definition at line 3279 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetDisplayName()

const std::string CWallet::GetDisplayName ( ) const
inlineoverridevirtual

Returns a bracketed wallet name for displaying in logs, will return [default wallet] if the wallet has no name.

Implements WalletStorage.

Definition at line 786 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetEncryptionKey()

const CKeyingMaterial & CWallet::GetEncryptionKey ( ) const
overridevirtual

Implements WalletStorage.

Definition at line 3133 of file wallet.cpp.

◆ GetKeyBirthTimes()

void CWallet::GetKeyBirthTimes ( std::map< CKeyID, int64_t > &  mapKeyBirth) const

Definition at line 2320 of file wallet.cpp.

Here is the call graph for this function:

◆ GetLastBlockHash()

uint256 CWallet::GetLastBlockHash ( ) const
inline

Definition at line 838 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetLastBlockHeight()

int CWallet::GetLastBlockHeight ( ) const
inline

Get last block processed height.

Definition at line 832 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan * CWallet::GetLegacyScriptPubKeyMan ( ) const

Get the LegacyScriptPubKeyMan which is used for all types, internal, and external.

Definition at line 3101 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetName()

const std::string& CWallet::GetName ( ) const
inline

Get a name for this wallet for logging/debugging purposes.

Definition at line 358 of file wallet.h.

Here is the caller graph for this function:

◆ GetOrCreateLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan * CWallet::GetOrCreateLegacyScriptPubKeyMan ( )

Definition at line 3113 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [1/3]

ScriptPubKeyMan * CWallet::GetScriptPubKeyMan ( const CScript script) const

Get the ScriptPubKeyMan for a script.

Definition at line 3066 of file wallet.cpp.

◆ GetScriptPubKeyMan() [2/3]

ScriptPubKeyMan * CWallet::GetScriptPubKeyMan ( const OutputType type,
bool  internal 
) const

Get the ScriptPubKeyMan for the given OutputType and internal/external chain.

Definition at line 3045 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [3/3]

ScriptPubKeyMan * CWallet::GetScriptPubKeyMan ( const uint256 id) const

Get the ScriptPubKeyMan by id.

Definition at line 3077 of file wallet.cpp.

◆ GetScriptPubKeyMans()

std::set< ScriptPubKeyMan * > CWallet::GetScriptPubKeyMans ( const CScript script,
SignatureData sigdata 
) const

Get all of the ScriptPubKeyMans for a script given additional information in sigdata (populated by e.g. a psbt)

Definition at line 3055 of file wallet.cpp.

◆ GetSolvingProvider() [1/2]

std::unique_ptr< SigningProvider > CWallet::GetSolvingProvider ( const CScript script) const

Get the SigningProvider for a script.

Definition at line 3085 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetSolvingProvider() [2/2]

std::unique_ptr< SigningProvider > CWallet::GetSolvingProvider ( const CScript script,
SignatureData sigdata 
) const

Definition at line 3091 of file wallet.cpp.

◆ GetTxBlocksToMaturity()

int CWallet::GetTxBlocksToMaturity ( const CWalletTx wtx) const
Returns
number of blocks to maturity for this transaction: 0 : is not a coinbase transaction, or is a mature coinbase transaction >0 : is a coinbase transaction which matures in this many blocks

Definition at line 2964 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetTxDepthInMainChain()

int CWallet::GetTxDepthInMainChain ( const CWalletTx wtx) const

Return depth of transaction in blockchain: <0 : conflicts with a transaction this deep in the blockchain 0 : in memory pool, waiting to be included in a block >=1 : this many blocks deep in the main chain.

Definition at line 2952 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetVersion()

int CWallet::GetVersion ( ) const
inline

get the current wallet format (the oldest client version guaranteed to understand this wallet)

Definition at line 681 of file wallet.h.

Here is the caller graph for this function:

◆ GUARDED_BY() [1/10]

CKeyingMaterial vMasterKey CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [2/10]

int nWalletVersion CWallet::GUARDED_BY ( cs_wallet  )
inlineprivate

the current wallet version: clients below this version are not able to load the wallet

Definition at line 242 of file wallet.h.

◆ GUARDED_BY() [3/10]

TxSpends mapTxSpends CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [4/10]

uint256 m_last_block_processed CWallet::GUARDED_BY ( cs_wallet  )
private

The following is used to keep track of how far behind the wallet is from the chain sync, and to allow clients to block on us being caught up.

Processed hash is a pointer on node's tip and doesn't imply that the wallet has scanned sequentially all blocks up to this one.

◆ GUARDED_BY() [5/10]

int m_last_block_processed_height CWallet::GUARDED_BY ( cs_wallet  )
private

Height of last block processed is used by wallet to know depth of transactions without relying on Chain interface beyond asynchronous updates.

For safety, we initialize it to -1. Height is a pointer on node's tip and doesn't imply that the wallet has scanned sequentially all blocks up to this one.

◆ GUARDED_BY() [6/10]

std::map<uint256, CWalletTx> mapWallet CWallet::GUARDED_BY ( cs_wallet  )

Map from txid to CWalletTx for all transactions this wallet is interested in, including received and sent transactions.

◆ GUARDED_BY() [7/10]

std::map<CTxDestination, CAddressBookData> m_address_book CWallet::GUARDED_BY ( cs_wallet  )

◆ GUARDED_BY() [8/10]

std::set<COutPoint> setLockedCoins CWallet::GUARDED_BY ( cs_wallet  )

Set of Coins owned by this wallet that we won't try to spend from.

A Coin may be locked if it has already been used to fund a transaction that hasn't confirmed yet. We wouldn't consider the Coin spent already, but also shouldn't try to use it again.

◆ GUARDED_BY() [9/10]

int64_t nRelockTime CWallet::GUARDED_BY ( cs_wallet  )
inline

Holds a timestamp at which point the wallet is scheduled (externally) to be relocked. Caller must arrange for actual relocking to occur via Lock().

Definition at line 483 of file wallet.h.

◆ GUARDED_BY() [10/10]

int64_t nOrderPosNext CWallet::GUARDED_BY ( cs_wallet  )
pure virtual

◆ HasEncryptionKeys()

bool CWallet::HasEncryptionKeys ( ) const
overridevirtual

Implements WalletStorage.

Definition at line 3138 of file wallet.cpp.

Here is the caller graph for this function:

◆ HaveChain()

bool CWallet::HaveChain ( ) const
inline

Interface to assert chain access.

Definition at line 384 of file wallet.h.

Here is the caller graph for this function:

◆ IsAbortingRescan()

bool CWallet::IsAbortingRescan ( ) const
inline

Definition at line 466 of file wallet.h.

◆ IsAddressUsed()

bool CWallet::IsAddressUsed ( const CTxDestination dest) const

Definition at line 2475 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsCrypted()

bool CWallet::IsCrypted ( ) const

Definition at line 2979 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsLegacy()

bool CWallet::IsLegacy ( ) const

Determine if we are a legacy wallet.

Definition at line 3270 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsLocked()

bool CWallet::IsLocked ( ) const
overridevirtual

Implements WalletStorage.

Definition at line 2984 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsScanning()

bool CWallet::IsScanning ( ) const
inline

Definition at line 467 of file wallet.h.

◆ IsTxImmatureCoinBase()

bool CWallet::IsTxImmatureCoinBase ( const CWalletTx wtx) const

Definition at line 2973 of file wallet.cpp.

Here is the call graph for this function:

◆ IsTxInMainChain()

bool CWallet::IsTxInMainChain ( const CWalletTx wtx) const
inline

Definition at line 434 of file wallet.h.

Here is the call graph for this function:

◆ LoadActiveScriptPubKeyMan()

void CWallet::LoadActiveScriptPubKeyMan ( uint256  id,
OutputType  type,
bool  internal 
)

Loads an active ScriptPubKeyMan for the specified type and internal.

(used by LoadWallet)

Parameters
[in]idThe unique id for the ScriptPubKeyMan
[in]typeThe OutputType this ScriptPubKeyMan provides addresses for
[in]internalWhether this ScriptPubKeyMan provides change addresses

Definition at line 3233 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LoadDescriptorScriptPubKeyMan()

void CWallet::LoadDescriptorScriptPubKeyMan ( uint256  id,
WalletDescriptor desc 
)

Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it.

Definition at line 3151 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LoadDestData()

void CWallet::LoadDestData ( const CTxDestination dest,
const std::string &  key,
const std::string &  value 
)

Adds a destination data tuple to the store, without saving it to disk.

Definition at line 2470 of file wallet.cpp.

Here is the caller graph for this function:

◆ LoadMinVersion()

bool CWallet::LoadMinVersion ( int  nVersion)
inline

Definition at line 477 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Lock()

bool CWallet::Lock ( )

Definition at line 2993 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ postInitProcess()

void CWallet::postInitProcess ( )

Wallet post-init setup Gives the wallet a chance to register repetitive tasks and complete post-init tasks.

Definition at line 2920 of file wallet.cpp.

Here is the call graph for this function:

◆ ScanningDuration()

int64_t CWallet::ScanningDuration ( ) const
inline

Definition at line 468 of file wallet.h.

Here is the call graph for this function:

◆ ScanningProgress()

double CWallet::ScanningProgress ( ) const
inline

Definition at line 469 of file wallet.h.

◆ SetAddressReceiveRequest()

bool CWallet::SetAddressReceiveRequest ( WalletBatch batch,
const CTxDestination dest,
const std::string &  id,
const std::string &  value 
)

Definition at line 2504 of file wallet.cpp.

Here is the call graph for this function:

◆ SetAddressUsed()

bool CWallet::SetAddressUsed ( WalletBatch batch,
const CTxDestination dest,
bool  used 
)

Definition at line 2454 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetBroadcastTransactions()

void CWallet::SetBroadcastTransactions ( bool  broadcast)
inline

Set whether this wallet broadcasts transactions.

Definition at line 731 of file wallet.h.

◆ SetLastBlockProcessed()

void CWallet::SetLastBlockProcessed ( int  block_height,
uint256  block_hash 
)
inline

Set last block processed height, currently only use in unit test.

Definition at line 845 of file wallet.h.

Here is the call graph for this function:

◆ SetupDescriptorScriptPubKeyMans()

void CWallet::SetupDescriptorScriptPubKeyMans ( )

Create new DescriptorScriptPubKeyMans and add them to the wallet.

Definition at line 3162 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetupLegacyScriptPubKeyMan()

void CWallet::SetupLegacyScriptPubKeyMan ( )

Make a LegacyScriptPubKeyMan and set it for all types, internal, and external.

Definition at line 3119 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Unlock()

bool CWallet::Unlock ( const CKeyingMaterial vMasterKeyIn,
bool  accept_no_keys = false 
)
private

Definition at line 3007 of file wallet.cpp.

Here is the caller graph for this function:

◆ UpgradeWallet()

bool CWallet::UpgradeWallet ( int  version,
bilingual_str error 
)

Upgrade the wallet.

Definition at line 2887 of file wallet.cpp.

Here is the call graph for this function:

◆ WalletLogPrintf()

template<typename... Params>
void CWallet::WalletLogPrintf ( std::string  fmt,
Params...  parameters 
) const
inline

Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.

Definition at line 793 of file wallet.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ WalletRescanReserver

friend class WalletRescanReserver
friend

Definition at line 239 of file wallet.h.

Member Data Documentation

◆ cs_wallet

RecursiveMutex CWallet::cs_wallet
mutable

Main wallet lock.

This lock protects all the fields added by CWallet.

Definition at line 348 of file wallet.h.

◆ fAbortRescan

std::atomic<bool> CWallet::fAbortRescan {false}
private

Definition at line 235 of file wallet.h.

◆ fBroadcastTransactions

bool CWallet::fBroadcastTransactions = false
private

Whether this wallet will submit newly created transactions to the node's mempool and prompt rebroadcasts (see ResendWalletTransactions()).

Definition at line 248 of file wallet.h.

◆ fScanningWallet

std::atomic<bool> CWallet::fScanningWallet {false}
private

Definition at line 236 of file wallet.h.

◆ m_allow_fallback_fee

bool CWallet::m_allow_fallback_fee {true}

will be false if -fallbackfee=0

Definition at line 600 of file wallet.h.

◆ m_args

const ArgsManager& CWallet::m_args
private

Provider of aplication-wide arguments.

Definition at line 302 of file wallet.h.

◆ m_best_block_time

std::atomic<int64_t> CWallet::m_best_block_time {0}
private

Definition at line 250 of file wallet.h.

◆ m_chain

interfaces::Chain* CWallet::m_chain
private

Interface for accessing chain state.

Definition at line 305 of file wallet.h.

◆ m_chain_notifications_handler

std::unique_ptr<interfaces::Handler> CWallet::m_chain_notifications_handler

Registered interfaces::Chain::Notifications handler.

Definition at line 406 of file wallet.h.

◆ m_confirm_target

unsigned int CWallet::m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}

Definition at line 595 of file wallet.h.

◆ m_consolidate_feerate

CFeeRate CWallet::m_consolidate_feerate {DEFAULT_CONSOLIDATE_FEERATE}

When the actual feerate is less than the consolidate feerate, we will tend to make transactions which consolidate inputs.

When the actual feerate is greater than the consolidate feerate, we will tend to make transactions which have the lowest fees.

Definition at line 617 of file wallet.h.

◆ m_database

const std::unique_ptr<WalletDatabase> CWallet::m_database
private

Internal database handle.

Definition at line 311 of file wallet.h.

◆ m_default_address_type

OutputType CWallet::m_default_address_type {DEFAULT_ADDRESS_TYPE}

Definition at line 621 of file wallet.h.

◆ m_default_change_type

std::optional<OutputType> CWallet::m_default_change_type {}

Default output type for change outputs.

When unset, automatically choose type based on address type setting and the types other of non-change outputs (see -changetype option documentation and implementation in CWallet::TransactionChangeType for details).

Definition at line 628 of file wallet.h.

◆ m_default_max_tx_fee

CAmount CWallet::m_default_max_tx_fee {DEFAULT_TRANSACTION_MAXFEE}

Absolute maximum transaction fee (in satoshis) used by default for the wallet.

Definition at line 630 of file wallet.h.

◆ m_discard_rate

CFeeRate CWallet::m_discard_rate {DEFAULT_DISCARD_FEE}

If the cost to spend a change output at this feerate is greater than the value of the output itself, just drop it to fees.

Definition at line 611 of file wallet.h.

◆ m_external_spk_managers

std::map<OutputType, ScriptPubKeyMan*> CWallet::m_external_spk_managers
private

Definition at line 329 of file wallet.h.

◆ m_fallback_fee

CFeeRate CWallet::m_fallback_fee {DEFAULT_FALLBACK_FEE}

If fee estimation does not have enough data to provide estimates, use this fee instead.

Has no effect if not using fee estimation Override with -fallbackfee

Definition at line 607 of file wallet.h.

◆ m_internal_spk_managers

std::map<OutputType, ScriptPubKeyMan*> CWallet::m_internal_spk_managers
private

Definition at line 330 of file wallet.h.

◆ m_max_aps_fee

CAmount CWallet::m_max_aps_fee {DEFAULT_MAX_AVOIDPARTIALSPEND_FEE}

The maximum fee amount we're willing to pay to prioritize partial spend avoidance.

note: this is absolute fee, not fee rate

Definition at line 620 of file wallet.h.

◆ m_min_fee

CFeeRate CWallet::m_min_fee {DEFAULT_TRANSACTION_MINFEE}

Override with -mintxfee.

Definition at line 601 of file wallet.h.

◆ m_name

std::string CWallet::m_name
private

Wallet name: relative directory name or "" for default wallet.

Definition at line 308 of file wallet.h.

◆ m_pay_tx_fee

CFeeRate CWallet::m_pay_tx_fee {DEFAULT_PAY_TX_FEE}

Definition at line 594 of file wallet.h.

◆ m_scanning_progress

std::atomic<double> CWallet::m_scanning_progress {0}
private

Definition at line 238 of file wallet.h.

◆ m_scanning_start

std::atomic<int64_t> CWallet::m_scanning_start {0}
private

Definition at line 237 of file wallet.h.

◆ m_signal_rbf

bool CWallet::m_signal_rbf {DEFAULT_WALLET_RBF}

Definition at line 599 of file wallet.h.

◆ m_spend_zero_conf_change

bool CWallet::m_spend_zero_conf_change {DEFAULT_SPEND_ZEROCONF_CHANGE}

Allow Coin Selection to pick unconfirmed UTXOs that were sent from our own wallet if it cannot fund the transaction otherwise.

Definition at line 598 of file wallet.h.

◆ m_spk_managers

std::map<uint256, std::unique_ptr<ScriptPubKeyMan> > CWallet::m_spk_managers
private

Definition at line 334 of file wallet.h.

◆ m_unlock_mutex

Mutex CWallet::m_unlock_mutex

Definition at line 483 of file wallet.h.

◆ m_wallet_flags

std::atomic<uint64_t> CWallet::m_wallet_flags {0}
private

WalletFlags set on this wallet.

Definition at line 291 of file wallet.h.

◆ mapMasterKeys

MasterKeyMap CWallet::mapMasterKeys

Definition at line 361 of file wallet.h.

◆ nAccountingEntryNumber

uint64_t CWallet::nAccountingEntryNumber = 0

Definition at line 394 of file wallet.h.

◆ nMasterKeyMaxID

unsigned int CWallet::nMasterKeyMaxID = 0

Definition at line 362 of file wallet.h.

◆ nNextResend

int64_t CWallet::nNextResend = 0
private

The next scheduled rebroadcast of wallet transactions.

Definition at line 245 of file wallet.h.

◆ NotifyAddressBookChanged

boost::signals2::signal<void(const CTxDestination& address, const std::string& label, bool isMine, const std::string& purpose, ChangeType status)> CWallet::NotifyAddressBookChanged

Address book entry changed.

Note
called without lock cs_wallet held.

Definition at line 705 of file wallet.h.

◆ NotifyCanGetAddressesChanged

boost::signals2::signal<void ()> CWallet::NotifyCanGetAddressesChanged

Keypool has new keys.

Definition at line 720 of file wallet.h.

◆ NotifyStatusChanged

boost::signals2::signal<void (CWallet* wallet)> CWallet::NotifyStatusChanged

Wallet status (encrypted, locked) changed.

Note: Called without locks held.

Definition at line 726 of file wallet.h.

◆ NotifyTransactionChanged

boost::signals2::signal<void(const uint256& hashTx, ChangeType status)> CWallet::NotifyTransactionChanged

Wallet transaction added, removed or updated.

Note
called with lock cs_wallet held.

Definition at line 711 of file wallet.h.

◆ NotifyUnload

boost::signals2::signal<void ()> CWallet::NotifyUnload

Wallet is about to be unloaded.

Definition at line 696 of file wallet.h.

◆ NotifyWatchonlyChanged

boost::signals2::signal<void (bool fHaveWatchOnly)> CWallet::NotifyWatchonlyChanged

Watch-only address added.

Definition at line 717 of file wallet.h.

◆ ShowProgress

boost::signals2::signal<void (const std::string &title, int nProgress)> CWallet::ShowProgress

Show progress e.g.

for rescan

Definition at line 714 of file wallet.h.

◆ wtxOrdered

TxItems CWallet::wtxOrdered

Definition at line 391 of file wallet.h.


The documentation for this class was generated from the following files: