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:

Collaboration diagram for CWallet:

Classes
struct	Balance

struct	ScanResult

Public Types
typedef std::map< unsigned int, CMasterKey >	MasterKeyMap

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

using	UpdateWalletTxFn = std::function< bool(CWalletTx &wtx, bool new_tx)>
	Callback for updating transaction metadata in mapWallet. More...

Public Member Functions
WalletDatabase &	GetDatabase () const 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) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Select a set of coins such that nValueRet >= nTargetValue and at least all coins from coin_control are selected; never select unconfirmed coins if they are not ours param@[out] setCoinsRet Populated with inputs including pre-selected inputs from coin_control and Coin Selection if successful. More...

const std::string &	GetName () const
	Get a name for this wallet for logging/debugging purposes. More...

	CWallet (interfaces::Chain *chain, const std::string &name, std::unique_ptr< WalletDatabase > database)
	Construct wallet with specified name and database implementation. More...

	~CWallet ()

bool	IsCrypted () const

bool	IsLocked () const override

bool	Lock ()

bool	HaveChain () const
	Interface to assert chain access. More...

std::map< uint256, CWalletTx > mapWallet	GUARDED_BY (cs_wallet)
	Map from txid to CWalletTx for all transactions this wallet is interested in, including received and sent transactions. More...

int64_t nOrderPosNext	GUARDED_BY (cs_wallet)=0

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

const CAddressBookData *	FindAddressBookEntry (const CTxDestination &, bool allow_change=false) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

std::set< COutPoint > setLockedCoins	GUARDED_BY (cs_wallet)
	Set of Coins owned by this wallet that we won't try to spend from. More...

interfaces::Chain &	chain () const
	Interface for accessing chain state. More...

const CWalletTx *	GetWalletTx (const uint256 &hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	IsTrusted (const CWalletTx &wtx, std::set< uint256 > &trusted_parents) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	CanSupportFeature (enum WalletFeature wf) const override EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	check whether we support the named feature More...

void	AvailableCoins (std::vector< COutput > &vCoins, 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 () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Return list of available coins and locked coins grouped by non-change output address. More...

const CTxOut &	FindNonChangeParentOutput (const CTransaction &tx, int output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Find non-change parent output. More...

bool	AttemptSelection (const CAmount &nTargetValue, const CoinEligibilityFilter &eligibility_filter, std::vector< COutput > coins, std::set< CInputCoin > &setCoinsRet, CAmount &nValueRet, const CoinSelectionParams &coin_selection_params) 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 param@[in] coins Set of UTXOs to consider. 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< OutputGroup >	GroupOutputs (const std::vector< COutput > &outputs, const CoinSelectionParams &coin_sel_params, const CoinEligibilityFilter &filter, bool positive_only) const

bool	DisplayAddress (const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Display address on an external signer. More...

bool	IsLockedCoin (uint256 hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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 () const

bool	IsScanning () const

int64_t	ScanningDuration () const

double	ScanningProgress () const

void	UpgradeKeyMetadata () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Upgrade stored CKeyMetadata objects to store key origin info as KeyOriginInfo. More...

void	UpgradeDescriptorCache () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Upgrade DescriptorCaches. More...

bool	LoadMinVersion (int nVersion) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	LoadDestData (const CTxDestination &dest, const std::string &key, const std::string &value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Adds a destination data tuple to the store, without saving it to disk. More...

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

bool	Unlock (const SecureString &strWalletPassphrase, bool accept_no_keys=false)

bool	ChangeWalletPassphrase (const SecureString &strOldWalletPassphrase, const SecureString &strNewWalletPassphrase)

bool	EncryptWallet (const SecureString &strWalletPassphrase)

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

unsigned int	ComputeTimeSmart (const CWalletTx &wtx) 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 ()

CWalletTx *	AddToWallet (CTransactionRef tx, const CWalletTx::Confirmation &confirm, const UpdateWalletTxFn &update_wtx=nullptr, bool fFlushOnClose=true)

bool	LoadToWallet (const uint256 &hash, const UpdateWalletTxFn &fill_wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	transactionAddedToMempool (const CTransactionRef &tx, uint64_t mempool_sequence) override

void	blockConnected (const CBlock &block, int height) override

void	blockDisconnected (const CBlock &block, int height) override

void	updatedBlockTip () override

int64_t	RescanFromTime (int64_t startTime, const WalletRescanReserver &reserver, bool update)
	Scan active chain for relevant transactions after importing keys. More...

ScanResult	ScanForWalletTransactions (const uint256 &start_block, int start_height, std::optional< int > max_height, const WalletRescanReserver &reserver, bool fUpdate)
	Scan the block chain (starting in start_block) for transactions from or to us. More...

void	transactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence) override

void	ReacceptWalletTransactions () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	ResendWalletTransactions ()

Balance	GetBalance (int min_depth=0, bool avoid_reuse=true) const

CAmount	GetAvailableBalance (const CCoinControl *coinControl=nullptr) const

OutputType	TransactionChangeType (const std::optional< OutputType > &change_type, const std::vector< CRecipient > &vecSend) const

bool	FundTransaction (CMutableTransaction &tx, CAmount &nFeeRet, int &nChangePosInOut, bilingual_str &error, bool lockUnspents, const std::set< int > &setSubtractFeeFromOutputs, CCoinControl)
	Insert additional inputs into the transaction by calling CreateTransaction();. More...

bool	SignTransaction (CMutableTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Fetch the inputs and sign with SIGHASH_ALL. More...

bool	SignTransaction (CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, std::string > &input_errors) const
	Sign the tx given the input coins and sighash. More...

SigningResult	SignMessage (const std::string &message, const PKHash &pkhash, std::string &str_sig) const

TransactionError	FillPSBT (PartiallySignedTransaction &psbtx, bool &complete, int sighash_type=1, bool sign=true, bool bip32derivs=true, size_t *n_signed=nullptr) const
	Fills out a PSBT with information from the wallet. More...

bool	CreateTransaction (const std::vector< CRecipient > &vecSend, CTransactionRef &tx, CAmount &nFeeRet, int &nChangePosInOut, bilingual_str &error, const CCoinControl &coin_control, FeeCalculation &fee_calc_out, 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 () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	TopUpKeyPool (unsigned int kpSize=0)

int64_t	GetOldestKeyPoolTime () const

std::set< std::set< CTxDestination > >	GetAddressGroupings () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

std::map< CTxDestination, CAmount >	GetAddressBalances () const

std::set< CTxDestination >	GetLabelAddresses (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 EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

isminetype	IsMine (const CScript &script) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

isminetype	IsMine (const CTxIn &txin) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

CAmount	GetDebit (const CTxIn &txin, const isminefilter &filter) const
	Returns amount of debit if the input matches the filter, otherwise returns 0. More...

isminetype	IsMine (const CTxOut &txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

CAmount	GetCredit (const CTxOut &txout, const isminefilter &filter) const

bool	IsChange (const CTxOut &txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	IsChange (const CScript &script) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

CAmount	GetChange (const CTxOut &txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	IsMine (const CTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	IsFromMe (const CTransaction &tx) const
	should probably be renamed to IsRelevantToMe More...

CAmount	GetDebit (const CTransaction &tx, const isminefilter &filter) const

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 ()

DBErrors	ZapSelectTx (std::vector< uint256 > &vHashIn, std::vector< uint256 > &vHashOut) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	SetAddressBook (const CTxDestination &address, const std::string &strName, const std::string &purpose)

bool	DelAddressBook (const CTxDestination &address)

bool	IsAddressUsed (const CTxDestination &dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	SetAddressUsed (WalletBatch &batch, const CTxDestination &dest, bool used) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

std::vector< std::string >	GetAddressReceiveRequests () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

unsigned int	GetKeyPoolSize () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	SetMinVersion (enum WalletFeature, WalletBatch *batch_in=nullptr) override
	signify that a particular wallet feature is now used. More...

int	GetVersion () const
	get the current wallet format (the oldest client version guaranteed to understand this wallet) More...

std::set< uint256 >	GetConflicts (const uint256 &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Get wallet transactions that conflict with given transaction (spend same outputs) More...

bool	HasWalletSpend (const uint256 &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Check if a given transaction has any of its outputs spent by another transaction in the wallet. More...

void	Flush ()
	Flush wallet (bitdb flush) More...

void	Close ()
	Close wallet database. More...

bool	GetBroadcastTransactions () const
	Inquire whether this wallet broadcasts transactions. More...

void	SetBroadcastTransactions (bool broadcast)
	Set whether this wallet broadcasts transactions. More...

bool	TransactionCanBeAbandoned (const uint256 &hashTx) const
	Return whether transaction can be abandoned. More...

bool	AbandonTransaction (const uint256 &hashTx)

bool	MarkReplaced (const uint256 &originalHash, const uint256 &newHash)
	Mark a transaction as replaced by another transaction (e.g., BIP 125). More...

void	postInitProcess ()
	Wallet post-init setup Gives the wallet a chance to register repetitive tasks and complete post-init tasks. More...

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

bool	IsHDEnabled () const

bool	CanGetAddresses (bool internal=false) const

void	UnsetWalletFlag (uint64_t flag)
	Unsets a single wallet flag. More...

bool	IsWalletFlagSet (uint64_t flag) const override
	check if a certain wallet flag is set More...

bool	AddWalletFlags (uint64_t flags)
	overwrite all flags by the given uint64_t returns false if unknown, non-tolerable flags are present More...

bool	LoadWalletFlags (uint64_t flags)
	Loads the flags into the wallet. More...

bool	IsLegacy () const
	Determine if we are a legacy wallet. More...

const std::string	GetDisplayName () const override
	Returns a bracketed wallet name for displaying in logs, will return [default wallet] if the wallet has no name. More...

template<typename... Params>
void	WalletLogPrintf (std::string fmt, Params... parameters) const
	Prepends the wallet name in logging output to ease debugging in multi-wallet use cases. More...

bool	UpgradeWallet (int version, bilingual_str &error)
	Upgrade the wallet. More...

std::set< ScriptPubKeyMan * >	GetActiveScriptPubKeyMans () const
	Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers. More...

std::set< ScriptPubKeyMan * >	GetAllScriptPubKeyMans () const
	Returns all unique ScriptPubKeyMans. More...

ScriptPubKeyMan *	GetScriptPubKeyMan (const OutputType &type, bool internal) const
	Get the ScriptPubKeyMan for the given OutputType and internal/external chain. More...

ScriptPubKeyMan *	GetScriptPubKeyMan (const CScript &script) const
	Get the ScriptPubKeyMan for a script. More...

ScriptPubKeyMan *	GetScriptPubKeyMan (const uint256 &id) const
	Get the ScriptPubKeyMan by id. More...

std::set< ScriptPubKeyMan * >	GetScriptPubKeyMans (const CScript &script, SignatureData &sigdata) const
	Get all of the ScriptPubKeyMans for a script given additional information in sigdata (populated by e.g. a psbt) More...

std::unique_ptr< SigningProvider >	GetSolvingProvider (const CScript &script) const
	Get the SigningProvider for a script. More...

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

LegacyScriptPubKeyMan *	GetLegacyScriptPubKeyMan () const
	Get the LegacyScriptPubKeyMan which is used for all types, internal, and external. More...

LegacyScriptPubKeyMan *	GetOrCreateLegacyScriptPubKeyMan ()

void	SetupLegacyScriptPubKeyMan ()
	Make a LegacyScriptPubKeyMan and set it for all types, internal, and external. More...

const CKeyingMaterial &	GetEncryptionKey () const override

bool	HasEncryptionKeys () const override

int	GetLastBlockHeight () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Get last block processed height. More...

uint256	GetLastBlockHash () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	SetLastBlockProcessed (int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Set last block processed height, currently only use in unit test. More...

void	ConnectScriptPubKeyManNotifiers ()
	Connect the signals from ScriptPubKeyMans to the signals in CWallet. More...

void	LoadDescriptorScriptPubKeyMan (uint256 id, WalletDescriptor &desc)
	Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it. More...

void	AddActiveScriptPubKeyMan (uint256 id, OutputType type, bool internal)
	Adds the active ScriptPubKeyMan for the specified type and internal. More...

void	LoadActiveScriptPubKeyMan (uint256 id, OutputType type, bool internal)
	Loads an active ScriptPubKeyMan for the specified type and internal. More...

void	DeactivateScriptPubKeyMan (uint256 id, OutputType type, bool internal)
	Remove specified ScriptPubKeyMan from set of active SPK managers. More...

void	SetupDescriptorScriptPubKeyMans () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Create new DescriptorScriptPubKeyMans and add them to the wallet. More...

DescriptorScriptPubKeyMan *	GetDescriptorScriptPubKeyMan (const WalletDescriptor &desc) const
	Return the DescriptorScriptPubKeyMan for a WalletDescriptor if it is already in the wallet. More...

ScriptPubKeyMan *	AddWalletDescriptor (WalletDescriptor &desc, const FlatSigningProvider &signing_provider, const std::string &label, bool internal)
	Add a descriptor to the wallet, return a ScriptPubKeyMan & associated output type. More...

Public Member Functions inherited from WalletStorage
virtual	~WalletStorage ()=default

Public Member Functions inherited from interfaces::Chain::Notifications
virtual	~Notifications ()

Static Public Member Functions
static std::shared_ptr< CWallet >	Create (interfaces::Chain *chain, const std::string &name, std::unique_ptr< WalletDatabase > database, uint64_t wallet_creation_flags, bilingual_str &error, std::vector< bilingual_str > &warnings)

Public Attributes
RecursiveMutex	cs_wallet
	Main wallet lock. More...

MasterKeyMap	mapMasterKeys

unsigned int	nMasterKeyMaxID = 0

TxItems	wtxOrdered

uint64_t	nAccountingEntryNumber = 0

std::unique_ptr< interfaces::Handler >	m_chain_notifications_handler
	Registered interfaces::Chain::Notifications handler. More...

Mutex	m_unlock_mutex

CFeeRate	m_pay_tx_fee {DEFAULT_PAY_TX_FEE}

unsigned int	m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}

bool	m_spend_zero_conf_change {DEFAULT_SPEND_ZEROCONF_CHANGE}
	Allow Coin Selection to pick unconfirmed UTXOs that were sent from our own wallet if it cannot fund the transaction otherwise. More...

bool	m_signal_rbf {DEFAULT_WALLET_RBF}

bool	m_allow_fallback_fee {true}
	will be false if -fallbackfee=0 More...

CFeeRate	m_min_fee {DEFAULT_TRANSACTION_MINFEE}
	Override with -mintxfee. More...

CFeeRate	m_fallback_fee {DEFAULT_FALLBACK_FEE}
	If fee estimation does not have enough data to provide estimates, use this fee instead. More...

CFeeRate	m_discard_rate {DEFAULT_DISCARD_FEE}
	If the cost to spend a change output at this feerate is greater than the value of the output itself, just drop it to fees. More...

CAmount	m_max_aps_fee {DEFAULT_MAX_AVOIDPARTIALSPEND_FEE}
	The maximum fee amount we're willing to pay to prioritize partial spend avoidance. More...

OutputType	m_default_address_type {DEFAULT_ADDRESS_TYPE}

std::optional< OutputType >	m_default_change_type {}
	Default output type for change outputs. More...

CAmount	m_default_max_tx_fee {DEFAULT_TRANSACTION_MAXFEE}
	Absolute maximum transaction fee (in satoshis) used by default for the wallet. More...

boost::signals2::signal< void()>	NotifyUnload
	Wallet is about to be unloaded. More...

boost::signals2::signal< void(const CTxDestination &address, const std::string &label, bool isMine, const std::string &purpose, ChangeType status)>	NotifyAddressBookChanged
	Address book entry changed. More...

boost::signals2::signal< void(const uint256 &hashTx, ChangeType status)>	NotifyTransactionChanged
	Wallet transaction added, removed or updated. More...

boost::signals2::signal< void(const std::string &title, int nProgress)>	ShowProgress
	Show progress e.g. More...

boost::signals2::signal< void(bool fHaveWatchOnly)>	NotifyWatchonlyChanged
	Watch-only address added. More...

boost::signals2::signal< void()>	NotifyCanGetAddressesChanged
	Keypool has new keys. More...

boost::signals2::signal< void(CWallet *wallet)>	NotifyStatusChanged
	Wallet status (encrypted, locked) changed. More...

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

Private Member Functions
CKeyingMaterial vMasterKey	GUARDED_BY (cs_wallet)

bool	Unlock (const CKeyingMaterial &vMasterKeyIn, bool accept_no_keys=false)

int nWalletVersion	GUARDED_BY (cs_wallet)
	the current wallet version: clients below this version are not able to load the wallet More...

TxSpends mapTxSpends	GUARDED_BY (cs_wallet)

void	AddToSpends (const COutPoint &outpoint, const uint256 &wtxid) 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)
	Mark a transaction (and its in-wallet descendants) as conflicting with a particular block. More...

void	MarkInputsDirty (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Mark a transaction's inputs dirty, thus forcing the outputs to be recomputed. More...

void	SyncMetaData (std::pair< TxSpends::iterator, TxSpends::iterator >) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	SyncTransaction (const CTransactionRef &tx, 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)
	Height of last block processed is used by wallet to know depth of transactions without relying on Chain interface beyond asynchronous updates. More...

bool	CreateTransactionInternal (const std::vector< CRecipient > &vecSend, CTransactionRef &tx, CAmount &nFeeRet, int &nChangePosInOut, bilingual_str &error, const CCoinControl &coin_control, FeeCalculation &fee_calc_out, bool sign) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

Private Attributes
std::atomic< bool >	fAbortRescan {false}

std::atomic< bool >	fScanningWallet {false}

std::atomic< int64_t >	m_scanning_start {0}

std::atomic< double >	m_scanning_progress {0}

int64_t	nNextResend = 0
	The next scheduled rebroadcast of wallet transactions. More...

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

std::atomic< int64_t >	m_best_block_time {0}

std::atomic< uint64_t >	m_wallet_flags {0}
	WalletFlags set on this wallet. More...

interfaces::Chain *	m_chain
	Interface for accessing chain state. More...

std::string	m_name
	Wallet name: relative directory name or "" for default wallet. More...

const std::unique_ptr< WalletDatabase >	m_database
	Internal database handle. More...

std::map< OutputType, ScriptPubKeyMan * >	m_external_spk_managers

std::map< OutputType, ScriptPubKeyMan * >	m_internal_spk_managers

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

Friends
class	WalletRescanReserver

Detailed Description

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

Definition at line 226 of file wallet.h.

Member Typedef Documentation

◆ MasterKeyMap

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

Definition at line 367 of file wallet.h.

◆ TxItems

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

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

◆ UpdateWalletTxFn

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

Callback for updating transaction metadata in mapWallet.

Parameters

wtx	- reference to mapWallet transaction to update
new_tx	- true if wtx is newly inserted, false if it previously existed

Returns: true if wtx is changed and needs to be saved to disk, otherwise false

Definition at line 516 of file wallet.h.

Constructor & Destructor Documentation

◆ CWallet()

CWallet::CWallet	(	interfaces::Chain *	chain,
		const std::string &	name,
		std::unique_ptr< WalletDatabase >	database
	)

inline

Construct wallet with specified name and database implementation.

Definition at line 372 of file wallet.h.

Here is the caller graph for this function:

◆ ~CWallet()

CWallet::~CWallet ( )

inline

Definition at line 379 of file wallet.h.

Here is the call graph for this function:

Member Function Documentation

◆ AbortRescan()

void CWallet::AbortRescan ( )

inline

Definition at line 472 of file wallet.h.

◆ AddActiveScriptPubKeyMan()

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

Adds the active ScriptPubKeyMan for the specified type and internal.

Writes it to the wallet file

Parameters

[in]	id	The unique id for the ScriptPubKeyMan
[in]	type	The OutputType this ScriptPubKeyMan provides addresses for
[in]	internal	Whether this ScriptPubKeyMan provides change addresses

Definition at line 3168 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddWalletDescriptor()

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

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

Definition at line 3235 of file wallet.cpp.

Here is the call graph for this function:

◆ AttachChain()

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

staticprivate

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

Definition at line 2733 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AttemptSelection()

bool CWallet::AttemptSelection	(	const CAmount &	nTargetValue,
		const CoinEligibilityFilter &	eligibility_filter,
		std::vector< COutput >	coins,
		std::set< CInputCoin > &	setCoinsRet,
		CAmount &	nValueRet,
		const CoinSelectionParams &	coin_selection_params
	)		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 param@[in] coins Set of UTXOs to consider.

These will be categorized into OutputGroups and filtered using eligibility_filter before selecting coins. param@[out] setCoinsRet Populated with the coins selected if successful. param@[out] nValueRet Used to return the total value of selected coins.

Definition at line 355 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AvailableCoins()

void CWallet::AvailableCoins	(	std::vector< COutput > &	vCoins,
		const CCoinControl *	coinControl = `nullptr`,
		const CAmount &	nMinimumAmount = `1`,
		const CAmount &	nMaximumAmount = `MAX_MONEY`,
		const CAmount &	nMinimumSumAmount = `MAX_MONEY`,
		const uint64_t	nMaximumCount = `0`
	)		const

populate vCoins with vector of available COutputs.

Definition at line 67 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BackupWallet()

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

Definition at line 2874 of file wallet.cpp.

Here is the call graph for this function:

◆ CanSupportFeature()

bool CWallet::CanSupportFeature ( enum WalletFeature wf ) const

inlineoverridevirtual

check whether we support the named feature

Implements WalletStorage.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeTimeSmart()

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConnectScriptPubKeyManNotifiers()

void CWallet::ConnectScriptPubKeyManNotifiers ( )

Connect the signals from ScriptPubKeyMans to the signals in CWallet.

Definition at line 3082 of file wallet.cpp.

Here is the call graph for this function:

◆ Create()

std::shared_ptr< CWallet > CWallet::Create	(	interfaces::Chain *	chain,
		const std::string &	name,
		std::unique_ptr< WalletDatabase >	database,
		uint64_t	wallet_creation_flags,
		bilingual_str &	error,
		std::vector< bilingual_str > &	warnings
	)

static

Definition at line 2505 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateTransaction()

bool CWallet::CreateTransaction	(	const std::vector< CRecipient > &	vecSend,
		CTransactionRef &	tx,
		CAmount &	nFeeRet,
		int &	nChangePosInOut,
		bilingual_str &	error,
		const CCoinControl &	coin_control,
		FeeCalculation &	fee_calc_out,
		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.

Note: passing nChangePosInOut as -1 will result in setting a random position

Definition at line 873 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateTransactionInternal()

bool CWallet::CreateTransactionInternal	(	const std::vector< CRecipient > &	vecSend,
		CTransactionRef &	tx,
		CAmount &	nFeeRet,
		int &	nChangePosInOut,
		bilingual_str &	error,
		const CCoinControl &	coin_control,
		FeeCalculation &	fee_calc_out,
		bool	sign
	)

private

Definition at line 571 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DeactivateScriptPubKeyMan()

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

Remove specified ScriptPubKeyMan from set of active SPK managers.

Writes the change to the wallet file.

Parameters

[in]	id	The unique id for the ScriptPubKeyMan
[in]	type	The OutputType this ScriptPubKeyMan provides addresses for
[in]	internal	Whether this ScriptPubKeyMan provides change addresses

Definition at line 3196 of file wallet.cpp.

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

◆ FindAddressBookEntry()

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

Definition at line 2819 of file wallet.cpp.

Here is the caller graph for this function:

◆ FindNonChangeParentOutput()

const CTxOut & CWallet::FindNonChangeParentOutput	(	const CTransaction &	tx,
		int	output
	)		const

Find non-change parent output.

Definition at line 210 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FundTransaction()

bool CWallet::FundTransaction	(	CMutableTransaction &	tx,
		CAmount &	nFeeRet,
		int &	nChangePosInOut,
		bilingual_str &	error,
		bool	lockUnspents,
		const std::set< int > &	setSubtractFeeFromOutputs,
		CCoinControl	coinControl
	)

Insert additional inputs into the transaction by calling CreateTransaction();.

Definition at line 920 of file spend.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 2961 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddressBalances()

std::map< CTxDestination, CAmount > CWallet::GetAddressBalances ( ) const

Definition at line 342 of file receive.cpp.

Here is the call graph for this function:

◆ GetAddressGroupings()

std::set< std::set< CTxDestination > > CWallet::GetAddressGroupings ( ) const

Definition at line 380 of file receive.cpp.

Here is the call graph for this function:

◆ GetAddressReceiveRequests()

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

Definition at line 2453 of file wallet.cpp.

◆ GetAllScriptPubKeyMans()

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

Returns all unique ScriptPubKeyMans.

Definition at line 2975 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetAvailableBalance()

CAmount CWallet::GetAvailableBalance ( const CCoinControl * coinControl = nullptr ) const

Definition at line 195 of file spend.cpp.

Here is the call graph for this function:

◆ GetBalance()

CWallet::Balance CWallet::GetBalance	(	int	min_depth = `0`,
		bool	avoid_reuse = `true`
	)		const

Definition at line 313 of file receive.cpp.

Here is the call graph for this function:

◆ GetBroadcastTransactions()

bool CWallet::GetBroadcastTransactions ( ) const

inline

Inquire whether this wallet broadcasts transactions.

Definition at line 761 of file wallet.h.

Here is the caller graph for this function:

◆ GetChange() [1/2]

CAmount CWallet::GetChange ( const CTransaction & tx ) const

Definition at line 99 of file receive.cpp.

Here is the call graph for this function:

◆ GetChange() [2/2]

CAmount CWallet::GetChange ( const CTxOut & txout ) const

Definition at line 91 of file receive.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCredit() [1/2]

CAmount CWallet::GetCredit	(	const CTransaction &	tx,
		const isminefilter &	filter
	)		const

Definition at line 52 of file receive.cpp.

Here is the call graph for this function:

◆ GetCredit() [2/2]

CAmount CWallet::GetCredit	(	const CTxOut &	txout,
		const isminefilter &	filter
	)		const

Definition at line 44 of file receive.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDatabase()

WalletDatabase& CWallet::GetDatabase ( ) const

inlineoverridevirtual

Implements WalletStorage.

Definition at line 346 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescriptorScriptPubKeyMan()

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

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

Definition at line 3222 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDisplayName()

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

inlineoverridevirtual

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

Implements WalletStorage.

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

◆ GetKeyBirthTimes()

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

Definition at line 2297 of file wallet.cpp.

Here is the call graph for this function:

◆ GetLastBlockHash()

uint256 CWallet::GetLastBlockHash ( ) const

inline

Definition at line 870 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastBlockHeight()

int CWallet::GetLastBlockHeight ( ) const

inline

Get last block processed height.

Definition at line 864 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan * CWallet::GetLegacyScriptPubKeyMan ( ) const

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

Definition at line 3040 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetName()

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

inline

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

Definition at line 365 of file wallet.h.

Here is the caller graph for this function:

◆ GetOrCreateLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan * CWallet::GetOrCreateLegacyScriptPubKeyMan ( )

Definition at line 3052 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [1/3]

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

Get the ScriptPubKeyMan for a script.

Definition at line 3005 of file wallet.cpp.

◆ GetScriptPubKeyMan() [2/3]

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

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

Definition at line 2984 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [3/3]

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

Get the ScriptPubKeyMan by id.

Definition at line 3016 of file wallet.cpp.

◆ GetScriptPubKeyMans()

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

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

Definition at line 2994 of file wallet.cpp.

◆ GetSolvingProvider() [1/2]

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

Get the SigningProvider for a script.

Definition at line 3024 of file wallet.cpp.

Here is the caller graph for this function:

◆ GetSolvingProvider() [2/2]

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

Definition at line 3030 of file wallet.cpp.

◆ GetVersion()

int CWallet::GetVersion ( ) const

inline

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

Definition at line 713 of file wallet.h.

Here is the caller graph for this function:

◆ GroupOutputs()

std::vector< OutputGroup > CWallet::GroupOutputs	(	const std::vector< COutput > &	outputs,
		const CoinSelectionParams &	coin_sel_params,
		const CoinEligibilityFilter &	filter,
		bool	positive_only
	)		const

Definition at line 269 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/10]

CKeyingMaterial vMasterKey CWallet::GUARDED_BY ( cs_wallet )

private

◆ GUARDED_BY() [2/10]

int nWalletVersion CWallet::GUARDED_BY ( cs_wallet )

inlineprivate

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

Definition at line 240 of file wallet.h.

◆ GUARDED_BY() [3/10]

TxSpends mapTxSpends CWallet::GUARDED_BY ( cs_wallet )

private

◆ GUARDED_BY() [4/10]

uint256 m_last_block_processed CWallet::GUARDED_BY ( cs_wallet )

private

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

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

◆ GUARDED_BY() [5/10]

int m_last_block_processed_height CWallet::GUARDED_BY ( cs_wallet )

private

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

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

◆ GUARDED_BY() [6/10]

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

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

◆ GUARDED_BY() [7/10]

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

◆ GUARDED_BY() [8/10]

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

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

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

◆ GUARDED_BY() [9/10]

int64_t nRelockTime CWallet::GUARDED_BY ( cs_wallet )

inline

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

Definition at line 490 of file wallet.h.

◆ GUARDED_BY() [10/10]

int64_t nOrderPosNext CWallet::GUARDED_BY ( cs_wallet )

pure virtual

◆ HasEncryptionKeys()

bool CWallet::HasEncryptionKeys ( ) const

overridevirtual

Implements WalletStorage.

Definition at line 3077 of file wallet.cpp.

Here is the caller graph for this function:

◆ HaveChain()

bool CWallet::HaveChain ( ) const

inline

Interface to assert chain access.

Definition at line 390 of file wallet.h.

Here is the caller graph for this function:

◆ IsAbortingRescan()

bool CWallet::IsAbortingRescan ( ) const

inline

Definition at line 473 of file wallet.h.

◆ IsAddressUsed()

bool CWallet::IsAddressUsed ( const CTxDestination & dest ) const

Definition at line 2438 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsAllFromMe()

bool CWallet::IsAllFromMe	(	const CTransaction &	tx,
		const isminefilter &	filter
	)		const

Returns whether all of the inputs match the filter.

Definition at line 23 of file receive.cpp.

Here is the call graph for this function:

◆ IsChange() [1/2]

bool CWallet::IsChange ( const CScript & script ) const

Definition at line 64 of file receive.cpp.

Here is the call graph for this function:

◆ IsChange() [2/2]

bool CWallet::IsChange ( const CTxOut & txout ) const

Definition at line 86 of file receive.cpp.

Here is the caller graph for this function:

◆ IsCrypted()

bool CWallet::IsCrypted ( ) const

Definition at line 2918 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLegacy()

bool CWallet::IsLegacy ( ) const

Determine if we are a legacy wallet.

Definition at line 3213 of file wallet.cpp.

Here is the caller graph for this function:

◆ IsLocked()

bool CWallet::IsLocked ( ) const

overridevirtual

Implements WalletStorage.

Definition at line 2923 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsMine()

isminetype CWallet::IsMine ( const CTxIn & txin ) const

Definition at line 10 of file receive.cpp.

Here is the call graph for this function:

◆ IsScanning()

bool CWallet::IsScanning ( ) const

inline

Definition at line 474 of file wallet.h.

◆ IsTrusted()

bool CWallet::IsTrusted	(	const CWalletTx &	wtx,
		std::set< uint256 > &	trusted_parents
	)		const

Definition at line 274 of file receive.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ListCoins()

std::map< CTxDestination, std::vector< COutput > > CWallet::ListCoins ( ) const

Return list of available coins and locked coins grouped by non-change output address.

Definition at line 228 of file spend.cpp.

Here is the call graph for this function:

◆ LoadActiveScriptPubKeyMan()

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

Loads an active ScriptPubKeyMan for the specified type and internal.

(used by LoadWallet)

Parameters

[in]	id	The unique id for the ScriptPubKeyMan
[in]	type	The OutputType this ScriptPubKeyMan provides addresses for
[in]	internal	Whether this ScriptPubKeyMan provides change addresses

Definition at line 3177 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadDescriptorScriptPubKeyMan()

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

Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it.

Definition at line 3090 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadDestData()

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

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

Definition at line 2433 of file wallet.cpp.

Here is the caller graph for this function:

◆ LoadMinVersion()

bool CWallet::LoadMinVersion ( int nVersion )

inline

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postInitProcess()

void CWallet::postInitProcess ( )

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

Definition at line 2862 of file wallet.cpp.

Here is the call graph for this function:

◆ ScanningDuration()

int64_t CWallet::ScanningDuration ( ) const

inline

Definition at line 475 of file wallet.h.

Here is the call graph for this function:

◆ ScanningProgress()

double CWallet::ScanningProgress ( ) const

inline

Definition at line 476 of file wallet.h.

◆ SelectCoins()

bool CWallet::SelectCoins	(	const std::vector< COutput > &	vAvailableCoins,
		const CAmount &	nTargetValue,
		std::set< CInputCoin > &	setCoinsRet,
		CAmount &	nValueRet,
		const CCoinControl &	coin_control,
		CoinSelectionParams &	coin_selection_params
	)		const

Select a set of coins such that nValueRet >= nTargetValue and at least all coins from coin_control are selected; never select unconfirmed coins if they are not ours param@[out] setCoinsRet Populated with inputs including pre-selected inputs from coin_control and Coin Selection if successful.

param@[out] nValueRet Total value of selected coins including pre-selected ones from coin_control and Coin Selection if successful.

Definition at line 373 of file spend.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddressReceiveRequest()

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

Definition at line 2467 of file wallet.cpp.

Here is the call graph for this function:

◆ SetAddressUsed()

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

Definition at line 2417 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBroadcastTransactions()

void CWallet::SetBroadcastTransactions ( bool broadcast )

inline

Set whether this wallet broadcasts transactions.

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

Here is the call graph for this function:

◆ SetupDescriptorScriptPubKeyMans()

void CWallet::SetupDescriptorScriptPubKeyMans ( )

Create new DescriptorScriptPubKeyMans and add them to the wallet.

Definition at line 3101 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupLegacyScriptPubKeyMan()

void CWallet::SetupLegacyScriptPubKeyMan ( )

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

Definition at line 3058 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Unlock()

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

private

Definition at line 2946 of file wallet.cpp.

Here is the caller graph for this function:

◆ UpgradeWallet()

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

Upgrade the wallet.

Definition at line 2829 of file wallet.cpp.

Here is the call graph for this function:

◆ WalletLogPrintf()

template<typename... Params>

void CWallet::WalletLogPrintf	(	std::string	fmt,
		Params...	parameters
	)		const

inline

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

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

Member Data Documentation

◆ cs_wallet

RecursiveMutex CWallet::cs_wallet

mutable

Main wallet lock.

This lock protects all the fields added by CWallet.

Definition at line 344 of file wallet.h.

◆ fAbortRescan

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

private

Definition at line 233 of file wallet.h.

◆ fBroadcastTransactions

bool CWallet::fBroadcastTransactions = false

private

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

Definition at line 246 of file wallet.h.

◆ fScanningWallet

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

private

Definition at line 234 of file wallet.h.

◆ m_allow_fallback_fee

bool CWallet::m_allow_fallback_fee {true}

will be false if -fallbackfee=0

Definition at line 626 of file wallet.h.

◆ m_best_block_time

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

private

Definition at line 248 of file wallet.h.

◆ m_chain

interfaces::Chain* CWallet::m_chain

private

Interface for accessing chain state.

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

◆ m_confirm_target

unsigned int CWallet::m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}

Definition at line 621 of file wallet.h.

◆ m_database

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

private

Internal database handle.

Definition at line 305 of file wallet.h.

◆ m_default_address_type

OutputType CWallet::m_default_address_type {DEFAULT_ADDRESS_TYPE}

Definition at line 641 of file wallet.h.

◆ m_default_change_type

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

Default output type for change outputs.

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

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

◆ m_discard_rate

CFeeRate CWallet::m_discard_rate {DEFAULT_DISCARD_FEE}

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

Definition at line 637 of file wallet.h.

◆ m_external_spk_managers

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

private

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

◆ m_internal_spk_managers

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

private

Definition at line 324 of file wallet.h.

◆ m_max_aps_fee

CAmount CWallet::m_max_aps_fee {DEFAULT_MAX_AVOIDPARTIALSPEND_FEE}

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

note: this is absolute fee, not fee rate

Definition at line 640 of file wallet.h.

◆ m_min_fee

CFeeRate CWallet::m_min_fee {DEFAULT_TRANSACTION_MINFEE}

Override with -mintxfee.

Definition at line 627 of file wallet.h.

◆ m_name

std::string CWallet::m_name

private

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

Definition at line 302 of file wallet.h.

◆ m_pay_tx_fee

CFeeRate CWallet::m_pay_tx_fee {DEFAULT_PAY_TX_FEE}

Definition at line 620 of file wallet.h.

◆ m_scanning_progress

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

private

Definition at line 236 of file wallet.h.

◆ m_scanning_start

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

private

Definition at line 235 of file wallet.h.

◆ m_signal_rbf

bool CWallet::m_signal_rbf {DEFAULT_WALLET_RBF}

Definition at line 625 of file wallet.h.

◆ m_spend_zero_conf_change

bool CWallet::m_spend_zero_conf_change {DEFAULT_SPEND_ZEROCONF_CHANGE}

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

Definition at line 624 of file wallet.h.

◆ m_spk_managers

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

private

Definition at line 328 of file wallet.h.

◆ m_unlock_mutex

Mutex CWallet::m_unlock_mutex

Definition at line 490 of file wallet.h.

◆ m_wallet_flags

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

private

WalletFlags set on this wallet.

Definition at line 288 of file wallet.h.

◆ mapMasterKeys

MasterKeyMap CWallet::mapMasterKeys

Definition at line 368 of file wallet.h.

◆ nAccountingEntryNumber

uint64_t CWallet::nAccountingEntryNumber = 0

Definition at line 400 of file wallet.h.

◆ nMasterKeyMaxID

unsigned int CWallet::nMasterKeyMaxID = 0

Definition at line 369 of file wallet.h.

◆ nNextResend

int64_t CWallet::nNextResend = 0

private

The next scheduled rebroadcast of wallet transactions.

Definition at line 243 of file wallet.h.

◆ NotifyAddressBookChanged

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

Address book entry changed.

Note: called without lock cs_wallet held.

Definition at line 737 of file wallet.h.

◆ NotifyCanGetAddressesChanged

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

Keypool has new keys.

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

◆ NotifyTransactionChanged

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

Wallet transaction added, removed or updated.

Note: called with lock cs_wallet held.

Definition at line 743 of file wallet.h.

◆ NotifyUnload

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

Wallet is about to be unloaded.

Definition at line 728 of file wallet.h.

◆ NotifyWatchonlyChanged

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

Watch-only address added.

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

◆ wtxOrdered

TxItems CWallet::wtxOrdered

Definition at line 397 of file wallet.h.

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

src/wallet/wallet.h
src/wallet/receive.cpp
src/wallet/spend.cpp
src/wallet/wallet.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ MasterKeyMap

◆ TxItems

◆ TxSpends

◆ UpdateWalletTxFn

Constructor & Destructor Documentation

◆ CWallet()

◆ ~CWallet()

Member Function Documentation

◆ AbortRescan()

◆ AddActiveScriptPubKeyMan()

◆ AddWalletDescriptor()

◆ AttachChain()

◆ AttemptSelection()

◆ AvailableCoins()

◆ BackupWallet()

◆ CanSupportFeature()

◆ chain()

◆ ComputeTimeSmart()

◆ ConnectScriptPubKeyManNotifiers()

◆ Create()

◆ CreateTransaction()

◆ CreateTransactionInternal()

◆ DeactivateScriptPubKeyMan()

◆ DummySignTx()

◆ FindAddressBookEntry()

◆ FindNonChangeParentOutput()

◆ FundTransaction()

◆ GetActiveScriptPubKeyMans()

◆ GetAddressBalances()

◆ GetAddressGroupings()

◆ GetAddressReceiveRequests()

◆ GetAllScriptPubKeyMans()

◆ GetAvailableBalance()

◆ GetBalance()

◆ GetBroadcastTransactions()

◆ GetChange() [1/2]

◆ GetChange() [2/2]

◆ GetCredit() [1/2]

◆ GetCredit() [2/2]

◆ GetDatabase()

◆ GetDescriptorScriptPubKeyMan()

◆ GetDisplayName()

◆ GetEncryptionKey()

◆ GetKeyBirthTimes()

◆ GetLastBlockHash()

◆ GetLastBlockHeight()

◆ GetLegacyScriptPubKeyMan()

◆ GetName()

◆ GetOrCreateLegacyScriptPubKeyMan()

◆ GetScriptPubKeyMan() [1/3]

◆ GetScriptPubKeyMan() [2/3]

◆ GetScriptPubKeyMan() [3/3]

◆ GetScriptPubKeyMans()

◆ GetSolvingProvider() [1/2]

◆ GetSolvingProvider() [2/2]

◆ GetVersion()

◆ GroupOutputs()

◆ GUARDED_BY() [1/10]

◆ GUARDED_BY() [2/10]

◆ GUARDED_BY() [3/10]

◆ GUARDED_BY() [4/10]

◆ GUARDED_BY() [5/10]

◆ GUARDED_BY() [6/10]

◆ GUARDED_BY() [7/10]

◆ GUARDED_BY() [8/10]

◆ GUARDED_BY() [9/10]

◆ GUARDED_BY() [10/10]

◆ HasEncryptionKeys()