Bitcoin Core  0.18.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 is an extension of a keystore, which also 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...
 
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...
 
void LoadKeyPool (int64_t nIndex, const CKeyPool &keypool) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void MarkPreSplitKeys () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
std::map< CKeyID, CKeyMetadata > mapKeyMetadata GUARDED_BY (cs_wallet)
 
std::map< CScriptID, CKeyMetadata > m_script_metadata GUARDED_BY (cs_wallet)
 
 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
 
bool Lock ()
 
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 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 (interfaces::Chain::Lock &locked_chain, const uint256 &hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Outpoint is spent if any non-conflicted transaction spends it: More...
 
bool IsUsedDestination (const CTxDestination &dst) const
 
bool IsUsedDestination (const uint256 &hash, unsigned int n) const
 
void SetUsedDestinationState (const uint256 &hash, unsigned int n, bool used)
 
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
 
CPubKey GenerateNewKey (WalletBatch &batch, bool internal=false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 keystore implementation Generate a new key More...
 
bool AddKeyPubKey (const CKey &key, const CPubKey &pubkey) override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Adds a key to the store, and saves it to disk. More...
 
bool LoadKey (const CKey &key, const CPubKey &pubkey)
 Adds a key to the store, without saving it to disk (used by LoadWallet) More...
 
void LoadKeyMetadata (const CKeyID &keyID, const CKeyMetadata &metadata) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Load metadata (used by LoadWallet) More...
 
void LoadScriptMetadata (const CScriptID &script_id, const CKeyMetadata &metadata) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
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)
 
void UpdateTimeFirstKey (int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Update wallet first key creation time. More...
 
bool AddCryptedKey (const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)
 Adds an encrypted key to the store, and saves it to disk. More...
 
bool LoadCryptedKey (const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)
 Adds an encrypted key to the store, without saving it to disk (used by LoadWallet) More...
 
bool GetKey (const CKeyID &address, CKey &keyOut) const override
 
bool GetPubKey (const CKeyID &address, CPubKey &vchPubKeyOut) const override
 
bool HaveKey (const CKeyID &address) const override
 
std::set< CKeyIDGetKeys () const override
 
bool AddCScript (const CScript &redeemScript) override
 
bool LoadCScript (const CScript &redeemScript)
 
bool AddDestData (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 (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 AddWatchOnly (const CScript &dest, int64_t nCreateTime) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Adds a watch-only address to the store, and saves it to disk. More...
 
bool RemoveWatchOnly (const CScript &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool LoadWatchOnly (const CScript &dest)
 Adds a watch-only address to the store, without saving it to disk (used by LoadWallet) More...
 
bool HaveWatchOnly (const CScript &dest) const
 Returns whether the watch-only script is in the wallet. More...
 
bool HaveWatchOnly () const
 Returns whether there are any watch-only things in the wallet. More...
 
bool GetWatchPubKey (const CKeyID &address, CPubKey &pubkey_out) const
 Fetches a pubkey from mapWatchKeys if it exists there. 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 (const CWalletTx &wtxIn) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void TransactionAddedToMempool (const CTransactionRef &tx) override
 
void BlockConnected (const CBlock &block, const std::vector< CTransactionRef > &vtxConflicted) override
 
void BlockDisconnected (const CBlock &block) 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 (interfaces::Chain::Lock &locked_chain) 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...
 
bool CommitTransaction (CTransactionRef tx, mapValue_t mapValue, std::vector< std::pair< std::string, std::string >> orderForm, CValidationState &state)
 Call after CreateTransaction unless you want to abort. 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)
 
bool NewKeyPool ()
 Mark old keypool keys as used, and generate all new keys. More...
 
size_t KeypoolCountExternalKeys () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool TopUpKeyPool (unsigned int kpSize=0)
 
bool ReserveKeyFromKeyPool (int64_t &nIndex, CKeyPool &keypool, bool fRequestedInternal)
 Reserves a key from the keypool and sets nIndex to its index. More...
 
void KeepKey (int64_t nIndex)
 
void ReturnKey (int64_t nIndex, bool fInternal, const CPubKey &pubkey)
 
int64_t GetOldestKeyPoolTime ()
 
void MarkReserveKeysAsUsed (int64_t keypool_id) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Marks all keys in the keypool up to and including reserve_key as used. More...
 
const std::map< CKeyID, int64_t > & GetAllReserveKeys () const
 
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
 
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 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)
 
const std::string & GetLabelName (const CScript &scriptPubKey) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
unsigned int GetKeyPoolSize () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void SetMinVersion (enum WalletFeature, WalletBatch *batch_in=nullptr, bool fExplicit=false)
 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 (interfaces::Chain::Lock &locked_chain, 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)
 
void SetHDChain (const CHDChain &chain, bool memonly)
 
const CHDChainGetHDChain () const
 
bool IsHDEnabled () const
 
bool CanGenerateKeys ()
 
bool CanGetAddresses (bool internal=false)
 
CPubKey GenerateNewSeed ()
 
CPubKey DeriveNewSeed (const CKey &key)
 
void SetHDSeed (const CPubKey &key)
 
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 LearnRelatedScripts (const CPubKey &key, OutputType)
 Explicitly make the wallet learn the related scripts for outputs to the given key. More...
 
void LearnAllRelatedScripts (const CPubKey &key)
 Same as LearnRelatedScripts, but when the OutputType is not known (and could be anything). 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
 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
 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 GetKeyOrigin (const CKeyID &keyid, KeyOriginInfo &info) const override
 Implement lookup of key origin information through wallet key metadata. More...
 
- Public Member Functions inherited from FillableSigningProvider
virtual bool AddKey (const CKey &key)
 
virtual bool HaveCScript (const CScriptID &hash) const override
 
virtual std::set< CScriptIDGetCScripts () const
 
virtual bool GetCScript (const CScriptID &hash, CScript &redeemScriptOut) const override
 
- Public Member Functions inherited from SigningProvider
virtual ~SigningProvider ()
 

Static Public Member Functions

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

Public Attributes

CCriticalSection 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 defined via chainparams 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

using CryptedKeyMap = std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >>
 
using WatchOnlySet = std::set< CScript >
 
using WatchKeyMap = std::map< CKeyID, CPubKey >
 
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_KeyStore)
 
bool SetCrypted ()
 
bool EncryptKeys (CKeyingMaterial &vMasterKeyIn)
 will encrypt previously unencrypted keys More...
 
bool Unlock (const CKeyingMaterial &vMasterKeyIn, bool accept_no_keys=false)
 
CryptedKeyMap mapCryptedKeys GUARDED_BY (cs_KeyStore)
 
WatchOnlySet setWatchOnly GUARDED_BY (cs_KeyStore)
 
WatchKeyMap mapWatchKeys GUARDED_BY (cs_KeyStore)
 
bool AddCryptedKeyInner (const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)
 
bool AddKeyPubKeyInner (const CKey &key, const CPubKey &pubkey)
 
WalletBatch *encrypted_batch GUARDED_BY (cs_wallet)
 
int nWalletVersion GUARDED_BY (cs_wallet)
 the current wallet version: clients below this version are not able to load the wallet 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, const uint256 &block_hash, int posInBlock, bool fUpdate) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Add a transaction to the wallet, or update it. More...
 
void MarkConflicted (const uint256 &hashBlock, 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, const uint256 &block_hash, int posInBlock=0, bool update_tx=true) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
void DeriveNewChildKey (WalletBatch &batch, CKeyMetadata &metadata, CKey &secret, bool internal=false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
std::set< int64_t > setInternalKeyPool GUARDED_BY (cs_wallet)
 
std::set< int64_t > setExternalKeyPool GUARDED_BY (cs_wallet)
 
std::set< int64_t > set_pre_split_keypool GUARDED_BY (cs_wallet)
 
int64_t m_max_keypool_index GUARDED_BY (cs_wallet)=0
 
int64_t nTimeFirstKey GUARDED_BY (cs_wallet)=0
 
bool AddWatchOnly (const CScript &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Private version of AddWatchOnly method which does not accept a timestamp, and which will reset the wallet's nTimeFirstKey value to 1 if the watch key did not previously have a timestamp associated with it. More...
 
bool AddWatchOnlyWithDB (WalletBatch &batch, const CScript &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 
bool AddWatchOnlyInMem (const CScript &dest)
 
bool AddKeyOriginWithDB (WalletBatch &batch, const CPubKey &pubkey, const KeyOriginInfo &info)
 Add a KeyOriginInfo to the wallet. More...
 
bool AddKeyPubKeyWithDB (WalletBatch &batch, const CKey &key, const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Adds a key to the store, and saves it to disk. More...
 
bool AddWatchOnlyWithDB (WalletBatch &batch, const CScript &dest, int64_t create_time) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
 Adds a watch-only address to the store, and saves it to disk. More...
 
void AddKeypoolPubkeyWithDB (const CPubKey &pubkey, const bool internal, WalletBatch &batch)
 
bool SetAddressBookWithDB (WalletBatch &batch, const CTxDestination &address, const std::string &strName, const std::string &strPurpose)
 
bool AddCScriptWithDB (WalletBatch &batch, const CScript &script)
 Adds a script to the store and saves it to disk. More...
 
void UnsetWalletFlagWithDB (WalletBatch &batch, uint64_t flag)
 Unsets a 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...
 
bool GetKeyFromPool (CPubKey &key, bool internal=false)
 Fetches a key from the keypool. More...
 
- Private Member Functions inherited from interfaces::Chain::Notifications
virtual ~Notifications ()
 

Private Attributes

std::atomic< bool > fUseCrypto
 if fUseCrypto is true, mapKeys must be empty if fUseCrypto is false, vMasterKey must be empty More...
 
bool fDecryptionThoroughlyChecked
 keeps track of whether Unlock has run a thorough check before More...
 
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}
 
CHDChain hdChain
 
std::map< CKeyID, int64_t > m_pool_key_to_index
 
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...
 

Friends

class WalletRescanReserver
 

Additional Inherited Members

- Protected Types inherited from FillableSigningProvider
using KeyMap = std::map< CKeyID, CKey >
 
using ScriptMap = std::map< CScriptID, CScript >
 
- Protected Member Functions inherited from FillableSigningProvider
KeyMap mapKeys GUARDED_BY (cs_KeyStore)
 
ScriptMap mapScripts GUARDED_BY (cs_KeyStore)
 
void ImplicitlyLearnRelatedKeyScripts (const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
 
- Protected Attributes inherited from FillableSigningProvider
CCriticalSection cs_KeyStore
 

Detailed Description

A CWallet is an extension of a keystore, which also maintains a set of transactions and balances, and provides the ability to create new transactions.

Definition at line 680 of file wallet.h.

Member Typedef Documentation

◆ CryptedKeyMap

using CWallet::CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> >>
private

Definition at line 692 of file wallet.h.

◆ MasterKeyMap

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

Definition at line 874 of file wallet.h.

◆ TxItems

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

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

◆ WatchKeyMap

using CWallet::WatchKeyMap = std::map<CKeyID, CPubKey>
private

Definition at line 694 of file wallet.h.

◆ WatchOnlySet

using CWallet::WatchOnlySet = std::set<CScript>
private

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

◆ ~CWallet()

CWallet::~CWallet ( )
inline

Definition at line 888 of file wallet.h.

Here is the call graph for this function:

Member Function Documentation

◆ AbortRescan()

void CWallet::AbortRescan ( )
inline

Definition at line 968 of file wallet.h.

Here is the caller graph for this function:

◆ AddCryptedKeyInner()

bool CWallet::AddCryptedKeyInner ( const CPubKey vchPubKey,
const std::vector< unsigned char > &  vchCryptedSecret 
)
private

Definition at line 4933 of file wallet.cpp.

Here is the call graph for this function:

◆ AddDestData()

bool CWallet::AddDestData ( 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 4132 of file wallet.cpp.

Here is the call graph for this function:

◆ AddKeyOriginWithDB()

bool CWallet::AddKeyOriginWithDB ( WalletBatch batch,
const CPubKey pubkey,
const KeyOriginInfo info 
)
private

Add a KeyOriginInfo to the wallet.

Definition at line 4735 of file wallet.cpp.

Here is the call graph for this function:

◆ AddKeyPubKeyInner()

bool CWallet::AddKeyPubKeyInner ( const CKey key,
const CPubKey pubkey 
)
private

Definition at line 4909 of file wallet.cpp.

Here is the call graph for this function:

◆ BackupWallet()

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

Definition at line 4617 of file wallet.cpp.

Here is the caller graph for this function:

◆ CanSupportFeature()

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

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

Definition at line 924 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 919 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 4093 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,
uint64_t  wallet_creation_flags = 0 
)
static

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

Here is the caller graph for this function:

◆ EncryptKeys()

bool CWallet::EncryptKeys ( CKeyingMaterial vMasterKeyIn)
private

will encrypt previously unencrypted keys

Definition at line 4887 of file wallet.cpp.

Here is the call graph for this function:

◆ EraseDestData()

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

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

Definition at line 4141 of file wallet.cpp.

Here is the call graph for this function:

◆ GetAllReserveKeys()

const std::map<CKeyID, int64_t>& CWallet::GetAllReserveKeys ( ) const
inline

Definition at line 1158 of file wallet.h.

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

◆ GetBroadcastTransactions()

bool CWallet::GetBroadcastTransactions ( ) const
inline

Inquire whether this wallet broadcasts transactions.

Definition at line 1258 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 846 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 4153 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 4169 of file wallet.cpp.

◆ GetDisplayName()

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

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

Definition at line 1346 of file wallet.h.

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

◆ GetHDChain()

const CHDChain& CWallet::GetHDChain ( ) const
inline

Definition at line 1287 of file wallet.h.

Here is the caller graph for this function:

◆ GetKey()

bool CWallet::GetKey ( const CKeyID address,
CKey keyOut 
) const
overridevirtual

Reimplemented from FillableSigningProvider.

Definition at line 4826 of file wallet.cpp.

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

◆ GetKeyBirthTimes()

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

Definition at line 4025 of file wallet.cpp.

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

◆ GetKeyOrigin()

bool CWallet::GetKeyOrigin ( const CKeyID keyid,
KeyOriginInfo info 
) const
overridevirtual

Implement lookup of key origin information through wallet key metadata.

Reimplemented from SigningProvider.

Definition at line 4716 of file wallet.cpp.

Here is the call graph for this function:

◆ GetKeyPoolSize()

unsigned int CWallet::GetKeyPoolSize ( )
inline

Definition at line 1199 of file wallet.h.

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

◆ GetKeys()

std::set< CKeyID > CWallet::GetKeys ( ) const
overridevirtual

Reimplemented from FillableSigningProvider.

Definition at line 4874 of file wallet.cpp.

Here is the call graph for this function:

◆ GetLocation()

const WalletLocation& CWallet::GetLocation ( ) const
inline

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

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

◆ GetPubKey()

bool CWallet::GetPubKey ( const CKeyID address,
CPubKey vchPubKeyOut 
) const
overridevirtual

Reimplemented from FillableSigningProvider.

Definition at line 4854 of file wallet.cpp.

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

◆ GetVersion()

int CWallet::GetVersion ( )
inline

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

Definition at line 1212 of file wallet.h.

Here is the caller graph for this function:

◆ GetWatchPubKey()

bool CWallet::GetWatchPubKey ( const CKeyID address,
CPubKey pubkey_out 
) const

Fetches a pubkey from mapWatchKeys if it exists there.

Definition at line 4843 of file wallet.cpp.

◆ GroupOutputs()

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

Definition at line 4686 of file wallet.cpp.

Here is the call graph for this function:

◆ GUARDED_BY() [1/20]

CKeyingMaterial vMasterKey CWallet::GUARDED_BY ( cs_KeyStore  )
private

◆ GUARDED_BY() [2/20]

CryptedKeyMap mapCryptedKeys CWallet::GUARDED_BY ( cs_KeyStore  )
private

◆ GUARDED_BY() [3/20]

WatchOnlySet setWatchOnly CWallet::GUARDED_BY ( cs_KeyStore  )
private

◆ GUARDED_BY() [4/20]

WatchKeyMap mapWatchKeys CWallet::GUARDED_BY ( cs_KeyStore  )
private

◆ GUARDED_BY() [5/20]

WalletBatch* encrypted_batch CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [6/20]

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

◆ GUARDED_BY() [7/20]

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() [8/20]

TxSpends mapTxSpends CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [9/20]

std::set<int64_t> setInternalKeyPool CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [10/20]

std::set<int64_t> setExternalKeyPool CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [11/20]

std::set<int64_t> set_pre_split_keypool CWallet::GUARDED_BY ( cs_wallet  )
private

◆ GUARDED_BY() [12/20]

int64_t m_max_keypool_index CWallet::GUARDED_BY ( cs_wallet  )
privatepure virtual

◆ GUARDED_BY() [13/20]

int64_t nTimeFirstKey CWallet::GUARDED_BY ( cs_wallet  )
privatepure virtual

◆ GUARDED_BY() [14/20]

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.

Note that this is not how far we've processed, we may need some rescan to have seen all transactions in the chain, but is only used to track live BlockConnected callbacks.

◆ GUARDED_BY() [15/20]

std::map<CKeyID, CKeyMetadata> mapKeyMetadata CWallet::GUARDED_BY ( cs_wallet  )

◆ GUARDED_BY() [16/20]

std::map<CScriptID, CKeyMetadata> m_script_metadata CWallet::GUARDED_BY ( cs_wallet  )

◆ GUARDED_BY() [17/20]

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

◆ GUARDED_BY() [18/20]

int64_t nOrderPosNext CWallet::GUARDED_BY ( cs_wallet  )
pure virtual

◆ GUARDED_BY() [19/20]

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

◆ GUARDED_BY() [20/20]

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

◆ handleNotifications()

void CWallet::handleNotifications ( )

Register the wallet for chain notifications.

Definition at line 4599 of file wallet.cpp.

Here is the caller graph for this function:

◆ HaveKey()

bool CWallet::HaveKey ( const CKeyID address) const
overridevirtual

Reimplemented from FillableSigningProvider.

Definition at line 4817 of file wallet.cpp.

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

◆ IsAbortingRescan()

bool CWallet::IsAbortingRescan ( )
inline

Definition at line 969 of file wallet.h.

Here is the caller graph for this function:

◆ IsCrypted()

bool CWallet::IsCrypted ( ) const
inline

Definition at line 896 of file wallet.h.

Here is the caller graph for this function:

◆ IsLocked()

bool CWallet::IsLocked ( ) const

Definition at line 4756 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsScanning()

bool CWallet::IsScanning ( )
inline

Definition at line 970 of file wallet.h.

Here is the caller graph for this function:

◆ LearnAllRelatedScripts()

void CWallet::LearnAllRelatedScripts ( const CPubKey key)

Same as LearnRelatedScripts, but when the OutputType is not known (and could be anything).

Definition at line 4680 of file wallet.cpp.

◆ LearnRelatedScripts()

void CWallet::LearnRelatedScripts ( const CPubKey key,
OutputType  type 
)

Explicitly make the wallet learn the related scripts for outputs to the given key.

This is purely to make the wallet file compatible with older software, as FillableSigningProvider automatically does this implicitly for all keys now.

Definition at line 4669 of file wallet.cpp.

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

◆ LoadKey()

bool CWallet::LoadKey ( const CKey key,
const CPubKey pubkey 
)
inline

Adds a key to the store, without saving it to disk (used by LoadWallet)

Definition at line 982 of file wallet.h.

◆ LoadMinVersion()

bool CWallet::LoadMinVersion ( int  nVersion)
inline

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

Here is the caller graph for this function:

◆ MarkPreSplitKeys()

void CWallet::MarkPreSplitKeys ( )

Definition at line 4182 of file wallet.cpp.

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

◆ ScanningDuration()

int64_t CWallet::ScanningDuration ( ) const
inline

Definition at line 971 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 972 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 1260 of file wallet.h.

◆ SetCrypted()

bool CWallet::SetCrypted ( )
private

Definition at line 4745 of file wallet.cpp.

◆ Unlock()

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

Definition at line 4779 of file wallet.cpp.

Here is the call graph for this function:
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::string &  warning_string 
)
static

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

Definition at line 4200 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 1353 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 714 of file wallet.h.

Member Data Documentation

◆ cs_wallet [1/2]

CCriticalSection CWallet::cs_wallet
mutable

Definition at line 841 of file wallet.h.

◆ cs_wallet [2/2]

void CWallet::cs_wallet

Definition at line 1316 of file wallet.h.

◆ database

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

Internal database handle.

Definition at line 821 of file wallet.h.

◆ fAbortRescan

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

Definition at line 709 of file wallet.h.

◆ fBroadcastTransactions

bool CWallet::fBroadcastTransactions = false
private

Definition at line 726 of file wallet.h.

◆ fDecryptionThoroughlyChecked

bool CWallet::fDecryptionThoroughlyChecked
private

keeps track of whether Unlock has run a thorough check before

Definition at line 690 of file wallet.h.

◆ fScanningWallet

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

Definition at line 710 of file wallet.h.

◆ fUseCrypto

std::atomic<bool> CWallet::fUseCrypto
private

if fUseCrypto is true, mapKeys must be empty if fUseCrypto is false, vMasterKey must be empty

Definition at line 687 of file wallet.h.

◆ hdChain

CHDChain CWallet::hdChain
private

Definition at line 768 of file wallet.h.

◆ m_allow_fallback_fee

bool CWallet::m_allow_fallback_fee {true}

will be defined via chainparams

Definition at line 1118 of file wallet.h.

◆ m_best_block_time

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

Definition at line 728 of file wallet.h.

◆ m_chain

interfaces::Chain* CWallet::m_chain
private

Interface for accessing chain state.

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

◆ m_confirm_target

unsigned int CWallet::m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}

Definition at line 1115 of file wallet.h.

◆ m_default_address_type

OutputType CWallet::m_default_address_type {DEFAULT_ADDRESS_TYPE}

Definition at line 1127 of file wallet.h.

◆ m_default_change_type

OutputType CWallet::m_default_change_type {DEFAULT_CHANGE_TYPE}

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

◆ m_discard_rate

CFeeRate CWallet::m_discard_rate {DEFAULT_DISCARD_FEE}

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

◆ m_location

WalletLocation CWallet::m_location
private

Wallet location which includes wallet name (see WalletLocation).

Definition at line 818 of file wallet.h.

◆ m_min_fee

CFeeRate CWallet::m_min_fee {DEFAULT_TRANSACTION_MINFEE}

Override with -mintxfee.

Definition at line 1119 of file wallet.h.

◆ m_pay_tx_fee

CFeeRate CWallet::m_pay_tx_fee {DEFAULT_PAY_TX_FEE}

Definition at line 1114 of file wallet.h.

◆ m_pool_key_to_index

std::map<CKeyID, int64_t> CWallet::m_pool_key_to_index
private

Definition at line 777 of file wallet.h.

◆ m_scanning_progress

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

Definition at line 712 of file wallet.h.

◆ m_scanning_start

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

Definition at line 711 of file wallet.h.

◆ m_signal_rbf

bool CWallet::m_signal_rbf {DEFAULT_WALLET_RBF}

Definition at line 1117 of file wallet.h.

◆ m_spend_zero_conf_change

bool CWallet::m_spend_zero_conf_change {DEFAULT_SPEND_ZEROCONF_CHANGE}

Definition at line 1116 of file wallet.h.

◆ m_wallet_flags

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

Definition at line 778 of file wallet.h.

◆ mapMasterKeys

MasterKeyMap CWallet::mapMasterKeys

Definition at line 875 of file wallet.h.

◆ mutexScanning

std::mutex CWallet::mutexScanning
private

Definition at line 713 of file wallet.h.

◆ nAccountingEntryNumber

uint64_t CWallet::nAccountingEntryNumber = 0

Definition at line 906 of file wallet.h.

◆ nLastResend

int64_t CWallet::nLastResend = 0
private

Definition at line 725 of file wallet.h.

◆ nMasterKeyMaxID

unsigned int CWallet::nMasterKeyMaxID = 0

Definition at line 876 of file wallet.h.

◆ nNextResend

int64_t CWallet::nNextResend = 0
private

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

◆ NotifyCanGetAddressesChanged

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

Keypool has new keys.

Definition at line 1249 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 1255 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 1240 of file wallet.h.

◆ NotifyUnload

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

Wallet is about to be unloaded.

Definition at line 1224 of file wallet.h.

◆ NotifyWatchonlyChanged

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

Watch-only address added.

Definition at line 1246 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 1027 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 1243 of file wallet.h.

◆ wtxOrdered

TxItems CWallet::wtxOrdered

Definition at line 903 of file wallet.h.


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