Bitcoin Core  0.19.99
P2P Digital Currency
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | 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  Balance
 
struct  ScanResult
 

Public Types

typedef std::map< unsigned int, CMasterKeyMasterKeyMap
 
typedef std::multimap< int64_t, CWalletTx * > TxItems
 

Public Member Functions

WalletDatabaseGetDBHandle ()
 Get database handle used by this wallet. More...
 
WalletDatabaseGetDatabase () override
 
bool SelectCoins (const std::vector< COutput > &vAvailableCoins, const CAmount &nTargetValue, std::set< CInputCoin > &setCoinsRet, CAmount &nValueRet, const CCoinControl &coin_control, CoinSelectionParams &coin_selection_params, bool &bnb_used) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Select a set of coins such that nValueRet >= nTargetValue and at least all coins from coinControl are selected; Never select unconfirmed coins if they are not ours. More...
 
const WalletLocationGetLocation () const
 
const std::string & GetName () const
 Get a name for this wallet for logging/debugging purposes. More...
 
 CWallet (interfaces::Chain *chain, const WalletLocation &location, std::unique_ptr< WalletDatabase > database)
 Construct wallet with specified name and database implementation. More...
 
 ~CWallet ()
 
bool IsCrypted () const
 
bool IsLocked () const override
 
bool Lock ()
 
std::unique_ptr< interfaces::Chain::LockLockChain ()
 Interface to assert chain access and if successful lock it. More...
 
std::map< uint256, CWalletTx > mapWallet GUARDED_BY (cs_wallet)
 
int64_t nOrderPosNext GUARDED_BY (cs_wallet)=0
 
std::map< CTxDestination, CAddressBookData > mapAddressBook GUARDED_BY (cs_wallet)
 
std::set< COutPoint > setLockedCoins GUARDED_BY (cs_wallet)
 
void handleNotifications ()
 Register the wallet for chain notifications. More...
 
interfaces::Chainchain () const
 Interface for accessing chain state. More...
 
const CWalletTxGetWalletTx (const uint256 &hash) const
 
bool CanSupportFeature (enum WalletFeature wf) const override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 check whether we are allowed to upgrade (or already support) to the named feature More...
 
void AvailableCoins (interfaces::Chain::Lock &locked_chain, std::vector< COutput > &vCoins, bool fOnlySafe=true, const CCoinControl *coinControl=nullptr, const CAmount &nMinimumAmount=1, const CAmount &nMaximumAmount=MAX_MONEY, const CAmount &nMinimumSumAmount=MAX_MONEY, const uint64_t nMaximumCount=0) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 populate vCoins with vector of available COutputs. More...
 
std::map< CTxDestination, std::vector< COutput > > ListCoins (interfaces::Chain::Lock &locked_chain) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Return list of available coins and locked coins grouped by non-change output address. More...
 
const CTxOutFindNonChangeParentOutput (const CTransaction &tx, int output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Find non-change parent output. More...
 
bool SelectCoinsMinConf (const CAmount &nTargetValue, const CoinEligibilityFilter &eligibility_filter, std::vector< OutputGroup > groups, std::set< CInputCoin > &setCoinsRet, CAmount &nValueRet, const CoinSelectionParams &coin_selection_params, bool &bnb_used) const
 Shuffle and select coins until nTargetValue is reached while avoiding small change; This method is stochastic for some inputs and upon completion the coin set and corresponding actual target value is assembled. 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)
 
std::vector< OutputGroupGroupOutputs (const std::vector< COutput > &outputs, bool single_coin) const
 
bool IsLockedCoin (uint256 hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void LockCoin (const COutPoint &output) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void UnlockCoin (const COutPoint &output) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void UnlockAllCoins () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void ListLockedCoins (std::vector< COutPoint > &vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void AbortRescan ()
 
bool IsAbortingRescan ()
 
bool IsScanning ()
 
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...
 
bool LoadMinVersion (int nVersion) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool AddDestData (WalletBatch &batch, const CTxDestination &dest, const std::string &key, const std::string &value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Adds a destination data tuple to the store, and saves it to disk. More...
 
bool EraseDestData (WalletBatch &batch, const CTxDestination &dest, const std::string &key) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Erases a destination data tuple in the store and on disk. More...
 
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...
 
bool GetDestData (const CTxDestination &dest, const std::string &key, std::string *value) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Look up a destination data tuple in the store, return true if found false otherwise. More...
 
std::vector< std::string > GetDestValues (const std::string &prefix) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Get all destination values matching a prefix. 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 (interfaces::Chain::Lock &locked_chain, std::map< CKeyID, int64_t > &mapKeyBirth) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
unsigned int ComputeTimeSmart (const CWalletTx &wtx) 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 ()
 
bool AddToWallet (const CWalletTx &wtxIn, bool fFlushOnClose=true)
 
void LoadToWallet (CWalletTx &wtxIn) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void TransactionAddedToMempool (const CTransactionRef &tx) override
 
void BlockConnected (const CBlock &block, const std::vector< CTransactionRef > &vtxConflicted, 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 &first_block, const uint256 &last_block, const WalletRescanReserver &reserver, bool fUpdate)
 Scan the block chain (starting in start_block) for transactions from or to us. More...
 
void TransactionRemovedFromMempool (const CTransactionRef &ptx) override
 
void ReacceptWalletTransactions () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void ResendWalletTransactions ()
 
Balance GetBalance (int min_depth=0, bool avoid_reuse=true) const
 
CAmount GetAvailableBalance (const CCoinControl *coinControl=nullptr) const
 
OutputType TransactionChangeType (OutputType change_type, const std::vector< CRecipient > &vecSend)
 
bool FundTransaction (CMutableTransaction &tx, CAmount &nFeeRet, int &nChangePosInOut, std::string &strFailReason, bool lockUnspents, const std::set< int > &setSubtractFeeFromOutputs, CCoinControl)
 Insert additional inputs into the transaction by calling CreateTransaction();. More...
 
bool SignTransaction (CMutableTransaction &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool CreateTransaction (interfaces::Chain::Lock &locked_chain, const std::vector< CRecipient > &vecSend, CTransactionRef &tx, CAmount &nFeeRet, int &nChangePosInOut, std::string &strFailReason, const CCoinControl &coin_control, bool sign=true)
 Create a new transaction paying the recipients with a set of coins selected by SelectCoins(); Also create the change output, when needed. 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 DummySignTx (CMutableTransaction &txNew, const std::set< CTxOut > &txouts, bool use_max_sig=false) const
 
bool DummySignTx (CMutableTransaction &txNew, const std::vector< CTxOut > &txouts, bool use_max_sig=false) const
 
bool DummySignInput (CTxIn &tx_in, const CTxOut &txout, bool use_max_sig=false) 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 () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool TopUpKeyPool (unsigned int kpSize=0)
 
int64_t GetOldestKeyPoolTime ()
 
std::set< std::set< CTxDestination > > GetAddressGroupings () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
std::map< CTxDestination, CAmountGetAddressBalances (interfaces::Chain::Lock &locked_chain)
 
std::set< CTxDestinationGetLabelAddresses (const std::string &label) const
 
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, std::string &error)
 
bool GetNewChangeDestination (const OutputType type, CTxDestination &dest, std::string &error)
 
isminetype IsMine (const CTxDestination &dest) const
 
isminetype IsMine (const CScript &script) const
 
isminetype IsMine (const CTxIn &txin) const
 
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
 
CAmount GetCredit (const CTxOut &txout, const isminefilter &filter) const
 
bool IsChange (const CTxOut &txout) const
 
bool IsChange (const CScript &script) const
 
CAmount GetChange (const CTxOut &txout) const
 
bool IsMine (const CTransaction &tx) const
 
bool IsFromMe (const CTransaction &tx) const
 should probably be renamed to IsRelevantToMe More...
 
CAmount GetDebit (const CTransaction &tx, const isminefilter &filter) const
 
bool IsAllFromMe (const CTransaction &tx, const isminefilter &filter) const
 Returns whether all of the inputs match the filter. More...
 
CAmount GetCredit (const CTransaction &tx, const isminefilter &filter) const
 
CAmount GetChange (const CTransaction &tx) const
 
void ChainStateFlushed (const CBlockLocator &loc) override
 
DBErrors LoadWallet (bool &fFirstRunRet)
 
DBErrors ZapWalletTx (std::vector< CWalletTx > &vWtx)
 
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)
 
unsigned int GetKeyPoolSize () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SetMinVersion (enum WalletFeature, WalletBatch *batch_in=nullptr, bool fExplicit=false) override
 signify that a particular wallet feature is now used. this may change nWalletVersion and nWalletMaxVersion if those are lower More...
 
bool SetMaxVersion (int nVersion)
 change which version we're allowed to upgrade to (note that this does not immediately imply upgrading to that format) More...
 
int GetVersion ()
 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 (bool shutdown=false)
 Flush wallet (bitdb flush) 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)
 
bool IsHDEnabled () const
 
bool CanGetAddresses (bool internal=false)
 
void BlockUntilSyncedToCurrentChain () LOCKS_EXCLUDED(cs_main
 Blocks until the wallet state is up-to-date to /at least/ the current chain at the time this function is entered Obviously holding cs_main/cs_wallet when going into this call may cause deadlock. More...
 
void SetWalletFlag (uint64_t flags)
 set a single wallet flag More...
 
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 SetWalletFlags (uint64_t overwriteFlags, bool memOnly)
 overwrite all flags by the given uint64_t returns false if unknown, non-tolerable flags are present 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...
 
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::unique_ptr< SigningProviderGetSigningProvider (const CScript &script) const
 Get the SigningProvider for a script. More...
 
std::unique_ptr< SigningProviderGetSigningProvider (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...
 
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...
 
- Public Member Functions inherited from WalletStorage
virtual ~WalletStorage ()=default
 

Static Public Member Functions

static bool Verify (interfaces::Chain &chain, const WalletLocation &location, bool salvage_wallet, std::string &error_string, std::vector< std::string > &warnings)
 Verify wallet naming and perform salvage on the wallet if required. More...
 
static std::shared_ptr< CWalletCreateWalletFromFile (interfaces::Chain &chain, const WalletLocation &location, std::string &error, std::vector< std::string > &warnings, uint64_t wallet_creation_flags=0)
 

Public Attributes

RecursiveMutex cs_wallet
 
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...
 
int64_t nRelockTime = 0
 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...
 
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}
 
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}
 
OutputType m_default_address_type {DEFAULT_ADDRESS_TYPE}
 
OutputType m_default_change_type {DEFAULT_CHANGE_TYPE}
 
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(CWallet *wallet, 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(CWallet *wallet, 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...
 
void cs_wallet
 

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...
 
int nWalletMaxVersion GUARDED_BY (cs_wallet)
 the maximum wallet format version: memory-only variable that specifies to what version this wallet may be upgraded More...
 
TxSpends mapTxSpends GUARDED_BY (cs_wallet)
 
void AddToSpends (const COutPoint &outpoint, const uint256 &wtxid) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void AddToSpends (const uint256 &wtxid) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool AddToWalletIfInvolvingMe (const CTransactionRef &tx, CWalletTx::Confirmation confirm, bool fUpdate) 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)
 
void MarkInputsDirty (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SyncMetaData (std::pair< TxSpends::iterator, TxSpends::iterator >) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SyncTransaction (const CTransactionRef &tx, CWalletTx::Confirmation confirm, bool update_tx=true) 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)
 
- Private Member Functions inherited from interfaces::Chain::Notifications
virtual ~Notifications ()
 

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}
 
std::mutex mutexScanning
 
int64_t nNextResend = 0
 
int64_t nLastResend = 0
 
bool fBroadcastTransactions = false
 
std::atomic< int64_t > m_best_block_time {0}
 
std::atomic< uint64_t > m_wallet_flags {0}
 
interfaces::Chainm_chain
 Interface for accessing chain state. More...
 
WalletLocation m_location
 Wallet location which includes wallet name (see WalletLocation). More...
 
std::unique_ptr< WalletDatabasedatabase
 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 606 of file wallet.h.

Member Typedef Documentation

◆ MasterKeyMap

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

Definition at line 742 of file wallet.h.

◆ TxItems

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

Definition at line 769 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 638 of file wallet.h.

Constructor & Destructor Documentation

◆ CWallet()

CWallet::CWallet ( interfaces::Chain chain,
const WalletLocation location,
std::unique_ptr< WalletDatabase database 
)
inline

Construct wallet with specified name and database implementation.

Definition at line 747 of file wallet.h.

◆ ~CWallet()

CWallet::~CWallet ( )
inline

Definition at line 754 of file wallet.h.

Here is the call graph for this function:

Member Function Documentation

◆ AbortRescan()

void CWallet::AbortRescan ( )
inline

Definition at line 834 of file wallet.h.

Here is the caller graph for this function:

◆ AddDestData()

bool CWallet::AddDestData ( WalletBatch batch,
const CTxDestination dest,
const std::string &  key,
const std::string &  value 
)

Adds a destination data tuple to the store, and saves it to disk.

Definition at line 3542 of file wallet.cpp.

Here is the call graph for this function:

◆ BackupWallet()

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

Definition at line 4008 of file wallet.cpp.

Here is the caller graph for this function:

◆ CanSupportFeature()

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

check whether we are allowed to upgrade (or already support) to the named feature

Implements WalletStorage.

Definition at line 791 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 786 of file wallet.h.

◆ ComputeTimeSmart()

unsigned int CWallet::ComputeTimeSmart ( const CWalletTx wtx) 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 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 3503 of file wallet.cpp.

Here is the call graph for this function:

◆ ConnectScriptPubKeyManNotifiers()

void CWallet::ConnectScriptPubKeyManNotifiers ( )

Connect the signals from ScriptPubKeyMans to the signals in CWallet.

Definition at line 4233 of file wallet.cpp.

Here is the call graph for this function:

◆ CreateWalletFromFile()

std::shared_ptr< CWallet > CWallet::CreateWalletFromFile ( interfaces::Chain chain,
const WalletLocation location,
std::string &  error,
std::vector< std::string > &  warnings,
uint64_t  wallet_creation_flags = 0 
)
static

Definition at line 3649 of file wallet.cpp.

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

◆ DummySignTx()

bool CWallet::DummySignTx ( CMutableTransaction txNew,
const std::set< CTxOut > &  txouts,
bool  use_max_sig = false 
) const
inline

Definition at line 939 of file wallet.h.

Here is the caller graph for this function:

◆ EraseDestData()

bool CWallet::EraseDestData ( WalletBatch batch,
const CTxDestination dest,
const std::string &  key 
)

Erases a destination data tuple in the store and on disk.

Definition at line 3551 of file wallet.cpp.

Here is the call graph for this function:

◆ GetActiveScriptPubKeyMans()

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

Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers.

Definition at line 4125 of file wallet.cpp.

◆ GetAllScriptPubKeyMans()

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

Returns all unique ScriptPubKeyMans.

Definition at line 4139 of file wallet.cpp.

◆ GetBroadcastTransactions()

bool CWallet::GetBroadcastTransactions ( ) const
inline

Inquire whether this wallet broadcasts transactions.

Definition at line 1076 of file wallet.h.

◆ GetDatabase()

WalletDatabase& CWallet::GetDatabase ( )
inlineoverridevirtual

Implements WalletStorage.

Definition at line 726 of file wallet.h.

◆ GetDBHandle()

WalletDatabase& CWallet::GetDBHandle ( )
inline

Get database handle used by this wallet.

Ideally this function would not be necessary.

Definition at line 722 of file wallet.h.

◆ GetDestData()

bool CWallet::GetDestData ( const CTxDestination dest,
const std::string &  key,
std::string *  value 
) const

Look up a destination data tuple in the store, return true if found false otherwise.

Definition at line 3563 of file wallet.cpp.

◆ GetDestValues()

std::vector< std::string > CWallet::GetDestValues ( const std::string &  prefix) const

Get all destination values matching a prefix.

Definition at line 3579 of file wallet.cpp.

◆ 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 1131 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 4223 of file wallet.cpp.

◆ GetKeyBirthTimes()

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

Definition at line 3431 of file wallet.cpp.

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 1171 of file wallet.h.

Here is the call graph for this function:

◆ GetLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan * CWallet::GetLegacyScriptPubKeyMan ( ) const

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

Definition at line 4194 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetLocation()

const WalletLocation& CWallet::GetLocation ( ) const
inline

Definition at line 736 of file wallet.h.

◆ GetName()

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

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

Definition at line 740 of file wallet.h.

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

◆ GetOrCreateLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan * CWallet::GetOrCreateLegacyScriptPubKeyMan ( )

Definition at line 4203 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [1/3]

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

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

Definition at line 4148 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [2/3]

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

Get the ScriptPubKeyMan for a script.

Definition at line 4159 of file wallet.cpp.

◆ GetScriptPubKeyMan() [3/3]

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

Get the ScriptPubKeyMan by id.

Definition at line 4170 of file wallet.cpp.

◆ GetSigningProvider() [1/2]

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

Get the SigningProvider for a script.

Definition at line 4178 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetSigningProvider() [2/2]

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

Definition at line 4184 of file wallet.cpp.

◆ GetVersion()

int CWallet::GetVersion ( )
inline

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

Definition at line 1030 of file wallet.h.

Here is the caller graph for this function:

◆ GroupOutputs()

std::vector< OutputGroup > CWallet::GroupOutputs ( const std::vector< COutput > &  outputs,
bool  single_coin 
) const

Definition at line 4052 of file wallet.cpp.

Here is the call 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 622 of file wallet.h.

◆ GUARDED_BY() [3/10]

int nWalletMaxVersion CWallet::GUARDED_BY ( cs_wallet  )
private

the maximum wallet format version: memory-only variable that specifies to what version this wallet may be upgraded

◆ GUARDED_BY() [4/10]

TxSpends mapTxSpends CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [5/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() [6/10]

int m_last_block_processed_height CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [7/10]

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

◆ GUARDED_BY() [8/10]

int64_t nOrderPosNext CWallet::GUARDED_BY ( cs_wallet  )
pure virtual

◆ GUARDED_BY() [9/10]

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

◆ GUARDED_BY() [10/10]

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

◆ handleNotifications()

void CWallet::handleNotifications ( )

Register the wallet for chain notifications.

Definition at line 3990 of file wallet.cpp.

Here is the caller graph for this function:

◆ HasEncryptionKeys()

bool CWallet::HasEncryptionKeys ( ) const
overridevirtual

Implements WalletStorage.

Definition at line 4228 of file wallet.cpp.

◆ IsAbortingRescan()

bool CWallet::IsAbortingRescan ( )
inline

Definition at line 835 of file wallet.h.

Here is the caller graph for this function:

◆ IsCrypted()

bool CWallet::IsCrypted ( ) const

Definition at line 4082 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsLocked()

bool CWallet::IsLocked ( ) const
overridevirtual

Implements WalletStorage.

Definition at line 4087 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsScanning()

bool CWallet::IsScanning ( )
inline

Definition at line 836 of file wallet.h.

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 3558 of file wallet.cpp.

◆ LoadMinVersion()

bool CWallet::LoadMinVersion ( int  nVersion)
inline

Definition at line 843 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 4096 of file wallet.cpp.

Here is the caller graph for this function:

◆ LockChain()

std::unique_ptr<interfaces::Chain::Lock> CWallet::LockChain ( )
inline

Interface to assert chain access and if successful lock it.

Definition at line 765 of file wallet.h.

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 3995 of file wallet.cpp.

◆ ScanningDuration()

int64_t CWallet::ScanningDuration ( ) const
inline

Definition at line 837 of file wallet.h.

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

◆ ScanningProgress()

double CWallet::ScanningProgress ( ) const
inline

Definition at line 838 of file wallet.h.

Here is the caller graph for this function:

◆ SetBroadcastTransactions()

void CWallet::SetBroadcastTransactions ( bool  broadcast)
inline

Set whether this wallet broadcasts transactions.

Definition at line 1078 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 1178 of file wallet.h.

Here is the call graph for this function:

◆ SetupLegacyScriptPubKeyMan()

void CWallet::SetupLegacyScriptPubKeyMan ( )

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

Definition at line 4209 of file wallet.cpp.

Here is the caller graph for this function:

◆ Unlock()

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

Definition at line 4110 of file wallet.cpp.

Here is the caller graph for this function:

◆ Verify()

bool CWallet::Verify ( interfaces::Chain chain,
const WalletLocation location,
bool  salvage_wallet,
std::string &  error_string,
std::vector< std::string > &  warnings 
)
static

Verify wallet naming and perform salvage on the wallet if required.

Definition at line 3592 of file wallet.cpp.

Here is the call graph for this function:
Here is the caller 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 1138 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 619 of file wallet.h.

Member Data Documentation

◆ cs_wallet [1/2]

RecursiveMutex CWallet::cs_wallet
mutable

Definition at line 717 of file wallet.h.

◆ cs_wallet [2/2]

void CWallet::cs_wallet

Definition at line 1115 of file wallet.h.

◆ database

std::unique_ptr<WalletDatabase> CWallet::database
private

Internal database handle.

Definition at line 687 of file wallet.h.

◆ fAbortRescan

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

Definition at line 614 of file wallet.h.

◆ fBroadcastTransactions

bool CWallet::fBroadcastTransactions = false
private

Definition at line 629 of file wallet.h.

◆ fScanningWallet

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

Definition at line 615 of file wallet.h.

◆ m_allow_fallback_fee

bool CWallet::m_allow_fallback_fee {true}

will be false if -fallbackfee=0

Definition at line 957 of file wallet.h.

◆ m_best_block_time

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

Definition at line 631 of file wallet.h.

◆ m_chain

interfaces::Chain* CWallet::m_chain
private

Interface for accessing chain state.

Definition at line 681 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 780 of file wallet.h.

◆ m_confirm_target

unsigned int CWallet::m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}

Definition at line 954 of file wallet.h.

◆ m_default_address_type

OutputType CWallet::m_default_address_type {DEFAULT_ADDRESS_TYPE}

Definition at line 966 of file wallet.h.

◆ m_default_change_type

OutputType CWallet::m_default_change_type {DEFAULT_CHANGE_TYPE}

Definition at line 967 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 969 of file wallet.h.

◆ m_discard_rate

CFeeRate CWallet::m_discard_rate {DEFAULT_DISCARD_FEE}

Definition at line 965 of file wallet.h.

◆ m_external_spk_managers

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

Definition at line 705 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 964 of file wallet.h.

◆ m_internal_spk_managers

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

Definition at line 706 of file wallet.h.

◆ m_location

WalletLocation CWallet::m_location
private

Wallet location which includes wallet name (see WalletLocation).

Definition at line 684 of file wallet.h.

◆ m_min_fee

CFeeRate CWallet::m_min_fee {DEFAULT_TRANSACTION_MINFEE}

Override with -mintxfee.

Definition at line 958 of file wallet.h.

◆ m_pay_tx_fee

CFeeRate CWallet::m_pay_tx_fee {DEFAULT_PAY_TX_FEE}

Definition at line 953 of file wallet.h.

◆ m_scanning_progress

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

Definition at line 617 of file wallet.h.

◆ m_scanning_start

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

Definition at line 616 of file wallet.h.

◆ m_signal_rbf

bool CWallet::m_signal_rbf {DEFAULT_WALLET_RBF}

Definition at line 956 of file wallet.h.

◆ m_spend_zero_conf_change

bool CWallet::m_spend_zero_conf_change {DEFAULT_SPEND_ZEROCONF_CHANGE}

Definition at line 955 of file wallet.h.

◆ m_spk_managers

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

Definition at line 710 of file wallet.h.

◆ m_wallet_flags

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

Definition at line 670 of file wallet.h.

◆ mapMasterKeys

MasterKeyMap CWallet::mapMasterKeys

Definition at line 743 of file wallet.h.

◆ mutexScanning

std::mutex CWallet::mutexScanning
private

Definition at line 618 of file wallet.h.

◆ nAccountingEntryNumber

uint64_t CWallet::nAccountingEntryNumber = 0

Definition at line 773 of file wallet.h.

◆ nLastResend

int64_t CWallet::nLastResend = 0
private

Definition at line 628 of file wallet.h.

◆ nMasterKeyMaxID

unsigned int CWallet::nMasterKeyMaxID = 0

Definition at line 744 of file wallet.h.

◆ nNextResend

int64_t CWallet::nNextResend = 0
private

Definition at line 627 of file wallet.h.

◆ NotifyAddressBookChanged

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

Address book entry changed.

Note
called with lock cs_wallet held.

Definition at line 1051 of file wallet.h.

◆ NotifyCanGetAddressesChanged

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

Keypool has new keys.

Definition at line 1067 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 1073 of file wallet.h.

◆ NotifyTransactionChanged

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

Wallet transaction added, removed or updated.

Note
called with lock cs_wallet held.

Definition at line 1058 of file wallet.h.

◆ NotifyUnload

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

Wallet is about to be unloaded.

Definition at line 1042 of file wallet.h.

◆ NotifyWatchonlyChanged

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

Watch-only address added.

Definition at line 1064 of file wallet.h.

◆ nRelockTime

int64_t CWallet::nRelockTime = 0

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 857 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 1061 of file wallet.h.

◆ wtxOrdered

TxItems CWallet::wtxOrdered

Definition at line 770 of file wallet.h.


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