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

#include <wallet.h>

Inheritance diagram for wallet::CWallet:

Collaboration diagram for wallet::CWallet:

Classes
struct	AddrBookFilter

Public Types
enum class	SpendType { UNSPENT , CONFIRMED , MEMPOOL , NONMEMPOOL }

enum class	HDKeyFilter { Active , All , UnusedKey }
	Which descriptors GetHDPubKeys() should consider. More...

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.

using	ListAddrBookFunc = std::function< void(const CTxDestination &dest, const std::string &label, bool is_change, const std::optional< AddressPurpose > purpose)>
	Walk-through the address book entries.

using	HDPubKeyMap = std::map< CExtPubKey, std::set< DescriptorScriptPubKeyMan * > >

Public Member Functions
WalletDatabase &	GetDatabase () const override

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

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

	~CWallet ()

bool	IsLocked () const override

bool	Lock ()

bool	HaveChain () const
	Interface to assert chain access.

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

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::map< COutPoint, bool > m_locked_coins	GUARDED_BY (cs_wallet)
	Set of Coins owned by this wallet that we won't try to spend from.

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

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

std::set< Txid >	GetTxConflicts (const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

const std::unordered_map< COutPoint, WalletTXO, SaltedOutpointHasher > &	GetTXOs () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

std::optional< WalletTXO >	GetTXO (const COutPoint &outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	RefreshTXOsFromTx (const CWalletTx &wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Cache outputs that belong to the wallet from a single transaction.

void	RefreshAllTXOs () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Cache outputs that belong to the wallet for all transactions in the wallet.

int	GetTxDepthInMainChain (const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Return depth of transaction in blockchain: <0 : conflicts with a transaction this deep in the blockchain 0 : in memory pool, waiting to be included in a block >=1 : this many blocks deep in the main chain.

int	GetTxBlocksToMaturity (const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	IsTxImmatureCoinBase (const CWalletTx &wtx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

SpendType	HowSpent (const COutPoint &outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	IsSpent (const COutPoint &outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Outpoint is spent if any non-conflicted transaction spends it:

bool	IsSpentKey (const CScript &scriptPubKey) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	SetSpentKeyState (WalletBatch &batch, const Txid &hash, unsigned int n, bool used, std::set< CTxDestination > &tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

util::Result< void >	DisplayAddress (const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Display address on an external signer.

bool	IsLockedCoin (const COutPoint &output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	LoadLockedCoin (const COutPoint &coin, bool persistent) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	LockCoin (const COutPoint &output, bool persist) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	UnlockCoin (const COutPoint &output) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	UnlockAllCoins () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	ListLockedCoins (std::vector< COutPoint > &vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

ChainScanner &	Scanner ()

const ChainScanner &	Scanner () const

void	UpgradeDescriptorCache () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Upgrade DescriptorCaches.

void	LoadAddressPreviouslySpent (const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Marks destination as previously spent.

void	LoadAddressReceiveRequest (const CTxDestination &dest, const std::string &id, const std::string &request) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Appends payment request to destination.

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

util::Expected< void, WalletError >	Unlock (const SecureString &strWalletPassphrase)

util::Expected< void, WalletError >	ChangeWalletPassphrase (const SecureString &strOldWalletPassphrase, const SecureString &strNewWalletPassphrase)

bool	EncryptWallet (const SecureString &strWalletPassphrase)

unsigned int	ComputeTimeSmart (const CWalletTx &wtx, bool rescanning_old_block) const
	Compute smart timestamp for a transaction being added to the wallet.

int64_t	IncOrderPosNext (WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Increment the next transaction order id.

DBErrors	ReorderTransactions ()

void	MarkDirty ()

CWalletTx *	AddToWallet (CTransactionRef tx, const TxState &state, const UpdateWalletTxFn &update_wtx=nullptr, bool rescanning_old_block=false)
	Add the transaction to the wallet, wrapping it up inside a CWalletTx.

bool	AddToWalletIfInvolvingMe (const CTransactionRef &tx, const SyncTxState &state, bool rescanning_old_block) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Add a transaction to the wallet, or update it.

bool	LoadToWallet (CWalletTx &&wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	transactionAddedToMempool (const CTransactionRef &tx) override

void	blockConnected (const kernel::ChainstateRole &role, const interfaces::BlockInfo &block) override

void	blockDisconnected (const interfaces::BlockInfo &block) override

void	updatedBlockTip () override

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

void	SetNextResend ()
	Set the next time this wallet should resend transactions to 12-36 hours from now, ~1 day on average.

bool	ShouldResend () const
	Return true if all conditions for periodically resending transactions are met.

void	ResubmitWalletTransactions (node::TxBroadcast broadcast_method, bool force)

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

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

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

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

std::optional< common::PSBTError >	FillPSBT (PartiallySignedTransaction &psbtx, const common::PSBTFillOptions &options, bool &complete, size_t *n_signed=nullptr) const
	Fills out a PSBT with information from the wallet.

void	CommitTransaction (CTransactionRef tx, std::optional< Txid > replaces_txid=std::nullopt, std::optional< std::string > comment=std::nullopt, std::optional< std::string > comment_to=std::nullopt, const std::vector< std::string > &messages={}, const std::vector< std::string > &payment_requests={})
	Submit the transaction to the node's mempool and then relay to peers.

bool	SubmitTxMemoryPoolAndRelay (CWalletTx &wtx, std::string &err_string, node::TxBroadcast broadcast_method) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Pass this transaction to node for optional mempool insertion and relay to peers.

void	MaybeUpdateBirthTime (int64_t time)
	Updates wallet birth time if 'time' is below it.

size_t	KeypoolCountExternalKeys () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	TopUpKeyPool (unsigned int kpSize=0)

std::vector< CTxDestination >	ListAddrBookAddresses (const std::optional< AddrBookFilter > &filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Filter and retrieve destinations stored in the addressbook.

std::set< std::string >	ListAddrBookLabels (std::optional< AddressPurpose > purpose) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Retrieve all the known labels in the address book.

void	ForEachAddrBookEntry (const ListAddrBookFunc &func) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	MarkDestinationsDirty (const std::set< CTxDestination > &destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Marks all outputs in each one of the destinations dirty, so their cache is reset and does not return outdated information.

util::Result< CTxDestination >	GetNewDestination (OutputType type, const std::string &label)

util::Result< CTxDestination >	GetNewChangeDestination (OutputType type)

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

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

CAmount	GetDebit (const CTxIn &txin) const
	Returns amount of debit, i.e.

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

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

bool	IsMine (const COutPoint &outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

CAmount	GetDebit (const CTransaction &tx) const

DBErrors	PopulateWalletFromDB (bilingual_str &error, std::vector< bilingual_str > &warnings)

util::Result< void >	RemoveTxs (std::vector< Txid > &txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Erases the provided transactions from the wallet.

util::Result< void >	RemoveTxs (WalletBatch &batch, std::vector< Txid > &txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	SetAddressBook (const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &purpose)

bool	DelAddressBook (const CTxDestination &address)

bool	DelAddressBookWithDB (WalletBatch &batch, const CTxDestination &address)

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

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

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

unsigned int	GetKeyPoolSize () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

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

void	Close ()
	Close wallet database.

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

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

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

bool	AbandonTransaction (const Txid &hashTx)

bool	AbandonTransaction (CWalletTx &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	MarkReplaced (const Txid &originalHash, const Txid &newHash)
	Mark a transaction as replaced by another transaction.

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

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

bool	IsHDEnabled () const

bool	CanGetAddresses (bool internal=false) const

int64_t	GetBirthTime () const

void BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(void	SetWalletFlag (uint64_t flags)
	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.

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

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

void	InitWalletFlags (uint64_t flags)
	overwrite all flags by the given uint64_t flags must be uninitialised (or 0) only known flags may be present

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

uint64_t	GetWalletFlags () const
	Retrieve all of the wallet's flags.

std::string	LogName () const override
	Return wallet name for use in logs, will return "default wallet" if the wallet has no name.

std::string	DisplayName () const
	Return wallet name for display, like LogName() but translates "default wallet" string.

template<typename... Params>
void	WalletLogPrintf (util::log::FormatString< sizeof...(Params)> wallet_fmt, const Params &... params) const
	Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.

void	LogStats () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

bool	IsActiveScriptPubKeyMan (const ScriptPubKeyMan &spkm) const

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

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

std::set< ScriptPubKeyMan * >	GetScriptPubKeyMans (const CScript &script) const
	Get all the ScriptPubKeyMans for a script.

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

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

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

std::vector< WalletDescriptor >	GetWalletDescriptors (const CScript &script) const
	Get the wallet descriptors for a script.

LegacyDataSPKM *	GetLegacyDataSPKM () const
	Get the LegacyDataSPKM used for all legacy output types and both internal and external chains.

LegacyDataSPKM *	GetOrCreateLegacyDataSPKM ()

void	SetupLegacyDataSPKM ()
	Create a LegacyDataSPKM and set it for all legacy output types and both internal and external chains.

bool	WithEncryptionKey (std::function< bool(const CKeyingMaterial &)> cb) const override
	Pass the encryption key to cb().

bool	HasEncryptionKeys () const override

bool	HaveCryptedKeys () const

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

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, and write to database.

void	WriteBestBlock () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Write the current best block to database.

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

void	LoadDescriptorScriptPubKeyMan (uint256 id, WalletDescriptor &desc, const KeyMap &keys, const CryptedKeyMap &ckeys)
	Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it.

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

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

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

DescriptorScriptPubKeyMan &	SetupDescriptorScriptPubKeyMan (WalletBatch &batch, const CExtKey &master_key, const OutputType &output_type, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Create new DescriptorScriptPubKeyMan and add it to the wallet.

void	SetupDescriptorScriptPubKeyMans (WalletBatch &batch, const CExtKey &master_key) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Create new DescriptorScriptPubKeyMans and add them to the wallet.

void	SetupDescriptorScriptPubKeyMans () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	SetupOwnDescriptorScriptPubKeyMans (WalletBatch &batch) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Create new seed and default DescriptorScriptPubKeyMans for this wallet.

void	SetupWalletGeneration () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Setup new descriptors or seed for new address generation.

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

std::optional< bool >	IsInternalScriptPubKeyMan (ScriptPubKeyMan *spk_man) const
	Returns whether the provided ScriptPubKeyMan is internal.

util::Result< std::reference_wrapper< DescriptorScriptPubKeyMan > >	AddWalletDescriptor (WalletDescriptor &desc, const FlatSigningProvider &signing_provider, const std::string &label, bool internal) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Add a descriptor to the wallet, return a ScriptPubKeyMan & associated output type.

util::Expected< CExtPubKey, WalletError >	AddHDKey (const std::optional< CExtKey > &key)
	Add an HD key to the wallet and return its master xpub.

bool	MigrateToSQLite (bilingual_str &error) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Move all records from the BDB database to a new SQLite database for storage.

std::optional< MigrationData >	GetDescriptorsForLegacy (bilingual_str &error) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Get all of the descriptors from a legacy wallet.

util::Result< void >	ApplyMigrationData (WalletBatch &local_wallet_batch, MigrationData &data) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Adds the ScriptPubKeyMans from MigrationData to this wallet, removes the LegacyDataSPKM, and moves transaction and address book entries to watchonly_wallet or solvable_wallet as needed.

bool	CanGrindR () const
	Whether the (external) signer performs R-value signature grinding.

void	CacheNewScriptPubKeys (const std::set< CScript > &spks, ScriptPubKeyMan *spkm)
	Add scriptPubKeys for this ScriptPubKeyMan into the scriptPubKey cache.

void	TopUpCallback (const std::set< CScript > &spks, ScriptPubKeyMan *spkm) override
	Callback function for after TopUp completes containing any scripts that were added by a SPKMan.

HDPubKeyMap	GetHDPubKeys (HDKeyFilter filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Retrieve descriptor xpubs matching the requested filter.

std::optional< CKey >	GetKey (const CKeyID &keyid) const
	Find the private key for the given key id from the wallet's descriptors, if available Returns nullopt when no descriptor has the key or if the wallet is locked.

std::optional< CExtKey >	GetExtKey (const CExtPubKey &xpub) const
	Reconstruct the extended private key for an HD xpub.

void	DisconnectChainNotifications ()
	Disconnect chain notifications and wait for all notifications to be processed.

void	SetLastDecryptedFeatures (uint64_t features) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Set the features of the last client to decrypt this wallet.

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

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

virtual void	chainStateFlushed (const kernel::ChainstateRole &role, const CBlockLocator &locator)

Static Public Member Functions
static bool	LoadWalletArgs (std::shared_ptr< CWallet > wallet, const WalletContext &context, bilingual_str &error, std::vector< bilingual_str > &warnings)

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

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

Public Attributes
RecursiveMutex	cs_wallet
	Main wallet lock.

MasterKeyMap	mapMasterKeys

unsigned int	nMasterKeyMaxID = 0

TxItems	wtxOrdered

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

Mutex	m_unlock_mutex

RecursiveMutex	m_relock_mutex

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.

bool	m_signal_rbf {DEFAULT_WALLET_RBF}

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

CFeeRate	m_min_fee {DEFAULT_TRANSACTION_MINFEE}

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

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.

CFeeRate	m_consolidate_feerate {DEFAULT_CONSOLIDATE_FEERATE}
	When the actual feerate is less than the consolidate feerate, we will tend to make transactions which consolidate inputs.

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

OutputType	m_default_address_type {DEFAULT_ADDRESS_TYPE}

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

CAmount	m_max_tx_fee {DEFAULT_TRANSACTION_MAXFEE}
	Absolute maximum transaction fee (in satoshis) used by the wallet.

CFeeRate	m_max_tx_fee_rate {DEFAULT_MAX_TRANSACTION_FEERATE}
	Maximum transaction fee rate used for the wallet.

int64_t	m_keypool_size {DEFAULT_KEYPOOL_SIZE}
	Number of pre-generated keys/scripts by each spkm (part of the look-ahead process, used to detect payments)

std::string	m_notify_tx_changed_script
	Notify external script when a wallet transaction comes in or is updated (handled by -walletnotify)

btcsignals::signal< void()>	NotifyUnload
	Wallet is about to be unloaded.

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

btcsignals::signal< void(const Txid &hashTx, ChangeType status)>	NotifyTransactionChanged
	Wallet transaction added, removed or updated.

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

btcsignals::signal< void()>	NotifyCanGetAddressesChanged
	Keypool has new keys.

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

Private Types
enum class	TxUpdate { UNCHANGED , CHANGED , NOTIFY_CHANGED }

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

using	TryUpdatingStateFn = std::function< TxUpdate(CWalletTx &wtx)>

Private Member Functions
CKeyingMaterial vMasterKey	GUARDED_BY (cs_wallet)

bool	Unlock (const CKeyingMaterial &vMasterKeyIn)

TxSpends mapTxSpends	GUARDED_BY (cs_wallet)

void	AddToSpends (const COutPoint &outpoint, const Txid &txid) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	AddToSpends (const CWalletTx &wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	MarkConflicted (const uint256 &hashBlock, int conflicting_height, const Txid &hashTx)
	Mark a transaction (and its in-wallet descendants) as conflicting with a particular block.

void	RecursiveUpdateTxState (const Txid &tx_hash, const TryUpdatingStateFn &try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Mark a transaction (and its in-wallet descendants) as a particular tx state.

void	RecursiveUpdateTxState (WalletBatch *batch, const Txid &tx_hash, const TryUpdatingStateFn &try_updating_state) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

std::set< CWalletTx *, WalletTxOrderComparator >	GetMalleatedVariants (const CWalletTx &wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Collects all wallet txs that differ from wtx only in their scriptSigs (i.e.

void	SyncMalleatedTxMetadata (WalletBatch &batch, const CWalletTx &wtx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	SyncTransaction (const CTransactionRef &tx, const SyncTxState &state, bool rescanning_old_block=false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	SetAddressBookWithDB (WalletBatch &batch, const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &strPurpose)

void	UnsetWalletFlagWithDB (WalletBatch &batch, uint64_t flag)
	Unsets a wallet flag and saves it to disk.

void	UnsetBlankWalletFlag (WalletBatch &batch) override
	Unset the blank wallet flag and saves it to disk.

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.

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.

void	AddScriptPubKeyMan (const uint256 &id, std::unique_ptr< ScriptPubKeyMan > spkm_man)

void	AddActiveScriptPubKeyManWithDb (WalletBatch &batch, uint256 id, OutputType type, bool internal)

void	SetWalletFlagWithDB (WalletBatch &batch, uint64_t flags)
	Store wallet flags.

std::unordered_map< COutPoint, WalletTXO, SaltedOutpointHasher > m_txos	GUARDED_BY (cs_wallet)
	Set of both spent and unspent transaction outputs owned by this wallet.

std::optional< uint64_t > m_last_decrypted_features	GUARDED_BY (cs_wallet)
	Features of the last client to decrypt this wallet.

void	SetLastBlockProcessedInMem (int block_height, uint256 block_hash) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	UpdateTrucSiblingConflicts (const CWalletTx &parent_wtx, const Txid &child_txid, bool add_conflict) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Update mempool conflicts for TRUC sibling transactions.

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

static NodeClock::time_point	GetDefaultNextResend ()

Private Attributes
NodeClock::time_point	m_next_resend {GetDefaultNextResend()}
	The next scheduled rebroadcast of wallet transactions.

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

std::atomic< int64_t >	m_best_block_time {0}

std::atomic< int64_t >	m_birth_time {std::numeric_limits<int64_t>::max()}

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

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

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

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

std::unique_ptr< ChainScanner >	m_scanner

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

std::unordered_map< CScript, std::vector< ScriptPubKeyMan * >, SaltedSipHasher >	m_cached_spks
	Cache of descriptor ScriptPubKeys used for IsMine. Maps ScriptPubKey to set of spkms.

Friends
class	ChainScanner

Detailed Description

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

Definition at line 317 of file wallet.h.

Member Typedef Documentation

◆ HDPubKeyMap

using wallet::CWallet::HDPubKeyMap = std::map<CExtPubKey, std::set<DescriptorScriptPubKeyMan*> >

Definition at line 1075 of file wallet.h.

◆ ListAddrBookFunc

using wallet::CWallet::ListAddrBookFunc = std::function<void(const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose> purpose)>

Walk-through the address book entries.

Stops when the provided 'ListAddrBookFunc' returns false.

Definition at line 762 of file wallet.h.

◆ MasterKeyMap

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

Definition at line 466 of file wallet.h.

◆ TryUpdatingStateFn

using wallet::CWallet::TryUpdatingStateFn = std::function<TxUpdate(CWalletTx& wtx)>

private

Definition at line 353 of file wallet.h.

◆ TxItems

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

Definition at line 484 of file wallet.h.

◆ TxSpends

typedef std::unordered_multimap<COutPoint, Txid, SaltedOutpointHasher> wallet::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 343 of file wallet.h.

◆ UpdateWalletTxFn

using wallet::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 604 of file wallet.h.

Member Enumeration Documentation

◆ HDKeyFilter

enum class wallet::CWallet::HDKeyFilter

strong

Which descriptors GetHDPubKeys() should consider.

Enumerator
Active	Only active descriptors.
All	All descriptors.
UnusedKey	Only unused(KEY) descriptors.

Definition at line 1070 of file wallet.h.

◆ SpendType

enum class wallet::CWallet::SpendType

strong

Enumerator
UNSPENT
CONFIRMED
MEMPOOL
NONMEMPOOL

Definition at line 541 of file wallet.h.

◆ TxUpdate

enum class wallet::CWallet::TxUpdate

strongprivate

Enumerator
UNCHANGED
CHANGED
NOTIFY_CHANGED

Definition at line 351 of file wallet.h.

Constructor & Destructor Documentation

◆ CWallet()

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

Construct wallet with specified name and database implementation.

Definition at line 485 of file wallet.cpp.

◆ ~CWallet()

wallet::CWallet::~CWallet ( )

Definition at line 493 of file wallet.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ AddActiveScriptPubKeyMan()

void wallet::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 3548 of file wallet.cpp.

Here is the call graph for this function:

◆ AddActiveScriptPubKeyManWithDb()

void wallet::CWallet::AddActiveScriptPubKeyManWithDb	(	WalletBatch &	batch,
		uint256	id,
		OutputType	type,
		bool	internal
	)

private

Definition at line 3554 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddHDKey()

util::Expected< CExtPubKey, WalletError > wallet::CWallet::AddHDKey ( const std::optional< CExtKey > & key )

Add an HD key to the wallet and return its master xpub.

Requires the wallet to be unlocked. Returns a WalletError with code WalletErrorCode::UnlockNeeded if the wallet is locked.

Parameters

[in] key Optional extended private key to add. If not provided, a new random HD key will be generated.

Returns: The master xpub for the added HD key, or a WalletError on failure.

Definition at line 3686 of file wallet.cpp.

Here is the call graph for this function:

◆ AddScriptPubKeyMan()

void wallet::CWallet::AddScriptPubKeyMan	(	const uint256 &	id,
		std::unique_ptr< ScriptPubKeyMan >	spkm_man
	)

private

Definition at line 3371 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddWalletDescriptor()

util::Result< std::reference_wrapper< DescriptorScriptPubKeyMan > > wallet::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 3632 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApplyMigrationData()

util::Result< void > wallet::CWallet::ApplyMigrationData	(	WalletBatch &	local_wallet_batch,
		MigrationData &	data
	)

Adds the ScriptPubKeyMans from MigrationData to this wallet, removes the LegacyDataSPKM, and moves transaction and address book entries to watchonly_wallet or solvable_wallet as needed.

Definition at line 3850 of file wallet.cpp.

Here is the call graph for this function:

◆ AttachChain()

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

staticprivate

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

Definition at line 3042 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BackupWallet()

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

Definition at line 3182 of file wallet.cpp.

Here is the call graph for this function:

◆ CacheNewScriptPubKeys()

void wallet::CWallet::CacheNewScriptPubKeys	(	const std::set< CScript > &	spks,
		ScriptPubKeyMan *	spkm
	)

Add scriptPubKeys for this ScriptPubKeyMan into the scriptPubKey cache.

Definition at line 4446 of file wallet.cpp.

Here is the call graph for this function:

◆ CanGrindR()

bool wallet::CWallet::CanGrindR ( ) const

Whether the (external) signer performs R-value signature grinding.

Definition at line 4072 of file wallet.cpp.

Here is the call graph for this function:

◆ chain()

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

inline

Interface for accessing chain state.

Definition at line 504 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CommitTransaction()

void wallet::CWallet::CommitTransaction	(	CTransactionRef	tx,
		std::optional< Txid >	replaces_txid = `std::nullopt`,
		std::optional< std::string >	comment = `std::nullopt`,
		std::optional< std::string >	comment_to = `std::nullopt`,
		const std::vector< std::string > &	messages = `{}`,
		const std::vector< std::string > &	payment_requests = `{}`
	)

Submit the transaction to the node's mempool and then relay to peers.

Should be called after CreateTransaction unless you want to abort broadcasting the transaction.

Parameters

[in]	tx	The transaction to be broadcast.
[in]	replaces_txid	The txid of the transaction that this transaction replaces
[in]	comment	The user's comment for this transaction
[in]	comment_to	The comment for this transaction indicating where coins are sent to
[in]	messages	The BIP 21 URI messages to attach to this transaction

Definition at line 2138 of file wallet.cpp.

Here is the call graph for this function:

◆ ComputeTimeSmart()

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

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

Logic:

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

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

Definition at line 2632 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConnectScriptPubKeyManNotifiers()

void wallet::CWallet::ConnectScriptPubKeyManNotifiers ( )

Connect the signals from ScriptPubKeyMans to the signals in CWallet.

Definition at line 3423 of file wallet.cpp.

Here is the call graph for this function:

◆ CreateNew()

std::shared_ptr< CWallet > wallet::CWallet::CreateNew	(	WalletContext &	context,
		const std::string &	name,
		std::unique_ptr< WalletDatabase >	database,
		uint64_t	wallet_creation_flags,
		bool	born_encrypted,
		bilingual_str &	error,
		std::vector< bilingual_str > &	warnings
	)

static

Definition at line 2936 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DeactivateScriptPubKeyMan()

void wallet::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 3582 of file wallet.cpp.

Here is the call graph for this function:

◆ DelAddressBook()

bool wallet::CWallet::DelAddressBook ( const CTxDestination & address )

Definition at line 2342 of file wallet.cpp.

Here is the call graph for this function:

◆ DelAddressBookWithDB()

bool wallet::CWallet::DelAddressBookWithDB	(	WalletBatch &	batch,
		const CTxDestination &	address
	)

Definition at line 2349 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DisconnectChainNotifications()

void wallet::CWallet::DisconnectChainNotifications ( )

Disconnect chain notifications and wait for all notifications to be processed.

Definition at line 4552 of file wallet.cpp.

◆ DisplayAddress()

util::Result< void > wallet::CWallet::DisplayAddress ( const CTxDestination & dest )

Display address on an external signer.

Definition at line 2536 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DisplayName()

std::string wallet::CWallet::DisplayName ( ) const

inline

Return wallet name for display, like LogName() but translates "default wallet" string.

Definition at line 918 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EraseAddressReceiveRequest()

bool wallet::CWallet::EraseAddressReceiveRequest	(	WalletBatch &	batch,
		const CTxDestination &	dest,
		const std::string &	id
	)

Definition at line 2731 of file wallet.cpp.

Here is the call graph for this function:

◆ FillPSBT()

std::optional< PSBTError > wallet::CWallet::FillPSBT	(	PartiallySignedTransaction &	psbtx,
		const common::PSBTFillOptions &	options,
		bool &	complete,
		size_t *	n_signed = `nullptr`
	)		const

Fills out a PSBT with information from the wallet.

Fills in UTXOs if we have them. Tries to sign if options.sign=true. Sets complete if the PSBT is now complete (i.e. has all required signatures or signature-parts, and is ready to finalize.)

Parameters

[in]	psbtx	PartiallySignedTransaction to fill in
[in]	options	options for filling or signing
[out]	complete	indicates whether the PSBT is now complete
[out]	n_signed	the number of inputs signed by this wallet

Returns: an error if something goes wrong

Definition at line 2009 of file wallet.cpp.

Here is the call graph for this function:

◆ FindAddressBookEntry()

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

Definition at line 3162 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ForEachAddrBookEntry()

void wallet::CWallet::ForEachAddrBookEntry ( const ListAddrBookFunc & func ) const

Definition at line 2462 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetActiveScriptPubKeyMans()

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

Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers.

Definition at line 3263 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddressReceiveRequests()

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

Definition at line 2713 of file wallet.cpp.

Here is the call graph for this function:

◆ GetAllScriptPubKeyMans()

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

Returns all unique ScriptPubKeyMans.

Definition at line 3288 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBirthTime()

int64_t wallet::CWallet::GetBirthTime ( ) const

inline

Definition at line 882 of file wallet.h.

◆ GetBroadcastTransactions()

bool wallet::CWallet::GetBroadcastTransactions ( ) const

inline

Inquire whether this wallet broadcasts transactions.

Definition at line 845 of file wallet.h.

Here is the caller graph for this function:

◆ GetDatabase()

WalletDatabase & wallet::CWallet::GetDatabase ( ) const

inlineoverridevirtual

Implements wallet::WalletStorage.

Definition at line 456 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescriptorScriptPubKeyMan()

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

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

Definition at line 3599 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescriptorsForLegacy()

std::optional< MigrationData > wallet::CWallet::GetDescriptorsForLegacy ( bilingual_str & error ) const

Get all of the descriptors from a legacy wallet.

Definition at line 3831 of file wallet.cpp.

Here is the call graph for this function:

◆ GetExtKey()

std::optional< CExtKey > wallet::CWallet::GetExtKey ( const CExtPubKey & xpub ) const

Reconstruct the extended private key for an HD xpub.

Returns nullopt when no descriptor has the private key, or the wallet is locked.

Definition at line 4497 of file wallet.cpp.

Here is the call graph for this function:

◆ GetHDPubKeys()

CWallet::HDPubKeyMap wallet::CWallet::GetHDPubKeys ( HDKeyFilter filter ) const

Retrieve descriptor xpubs matching the requested filter.

Definition at line 4459 of file wallet.cpp.

Here is the call graph for this function:

◆ GetKey()

std::optional< CKey > wallet::CWallet::GetKey ( const CKeyID & keyid ) const

Find the private key for the given key id from the wallet's descriptors, if available Returns nullopt when no descriptor has the key or if the wallet is locked.

Definition at line 4482 of file wallet.cpp.

Here is the call graph for this function:

◆ GetKeyPoolSize()

unsigned int wallet::CWallet::GetKeyPoolSize ( ) const

Definition at line 2400 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastBlockHash()

uint256 wallet::CWallet::GetLastBlockHash ( ) const

inline

Definition at line 980 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastBlockHeight()

int wallet::CWallet::GetLastBlockHeight ( ) const

inline

Get last block processed height.

Definition at line 974 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLegacyDataSPKM()

LegacyDataSPKM * wallet::CWallet::GetLegacyDataSPKM ( ) const

Get the LegacyDataSPKM used for all legacy output types and both internal and external chains.

Definition at line 3361 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetName()

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

inline

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

Definition at line 464 of file wallet.h.

Here is the caller graph for this function:

◆ GetNewChangeDestination()

util::Result< CTxDestination > wallet::CWallet::GetNewChangeDestination ( OutputType type )

Definition at line 2437 of file wallet.cpp.

Here is the call graph for this function:

◆ GetNewDestination()

util::Result< CTxDestination > wallet::CWallet::GetNewDestination	(	OutputType	type,
		const std::string &	label
	)

Definition at line 2421 of file wallet.cpp.

Here is the call graph for this function:

◆ GetOrCreateLegacyDataSPKM()

LegacyDataSPKM * wallet::CWallet::GetOrCreateLegacyDataSPKM ( )

Definition at line 3381 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [1/2]

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

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

Definition at line 3297 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScriptPubKeyMan() [2/2]

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

Get the ScriptPubKeyMan by id.

Definition at line 3322 of file wallet.cpp.

◆ GetScriptPubKeyMans()

std::set< ScriptPubKeyMan * > wallet::CWallet::GetScriptPubKeyMans ( const CScript & script ) const

Get all the ScriptPubKeyMans for a script.

Definition at line 3307 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSolvingProvider() [1/2]

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

Get the SigningProvider for a script.

Definition at line 3330 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSolvingProvider() [2/2]

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

Definition at line 3336 of file wallet.cpp.

◆ GetTxBlocksToMaturity()

int wallet::CWallet::GetTxBlocksToMaturity ( const CWalletTx & wtx ) const

Returns: number of blocks to maturity for this transaction: 0 : is not a coinbase transaction, or is a mature coinbase transaction >0 : is a coinbase transaction which matures in this many blocks

Definition at line 3202 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxDepthInMainChain()

int wallet::CWallet::GetTxDepthInMainChain ( const CWalletTx & wtx ) const

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

Preconditions: it is only valid to call this function when the wallet is online and the block index is loaded. So this cannot be called by bitcoin-wallet tool code or by wallet migration code. If this is called without the wallet being online, it won't be able able to determine the the height of the last block processed, or the heights of blocks referenced in transaction, and might cause assert failures.

Definition at line 3188 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTXO()

std::optional< WalletTXO > wallet::CWallet::GetTXO ( const COutPoint & outpoint ) const

Definition at line 4542 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTXOs()

const std::unordered_map< COutPoint, WalletTXO, SaltedOutpointHasher > & wallet::CWallet::GetTXOs ( ) const

inline

Definition at line 510 of file wallet.h.

Here is the call graph for this function:

◆ GetWalletDescriptors()

std::vector< WalletDescriptor > wallet::CWallet::GetWalletDescriptors ( const CScript & script ) const

Get the wallet descriptors for a script.

Definition at line 3349 of file wallet.cpp.

Here is the call graph for this function:

◆ GUARDED_BY() [1/11]

CKeyingMaterial vMasterKey wallet::CWallet::GUARDED_BY ( cs_wallet )

private

◆ GUARDED_BY() [2/11]

TxSpends mapTxSpends wallet::CWallet::GUARDED_BY ( cs_wallet )

private

◆ GUARDED_BY() [3/11]

uint256 m_last_block_processed wallet::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() [4/11]

int m_last_block_processed_height wallet::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() [5/11]

std::unordered_map< COutPoint, WalletTXO, SaltedOutpointHasher > m_txos wallet::CWallet::GUARDED_BY ( cs_wallet )

private

Set of both spent and unspent transaction outputs owned by this wallet.

◆ GUARDED_BY() [6/11]

std::optional< uint64_t > m_last_decrypted_features wallet::CWallet::GUARDED_BY ( cs_wallet )

private

Features of the last client to decrypt this wallet.

◆ GUARDED_BY() [7/11]

std::unordered_map< Txid, CWalletTx, SaltedTxidHasher > mapWallet wallet::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() [8/11]

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

◆ GUARDED_BY() [9/11]

std::map< COutPoint, bool > m_locked_coins wallet::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. bool to track whether this locked coin is persisted to disk.

◆ GUARDED_BY() [10/11]

int64_t nRelockTime wallet::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 576 of file wallet.h.

◆ GUARDED_BY() [11/11]

int64_t nOrderPosNext wallet::CWallet::GUARDED_BY ( cs_wallet )

pure virtual

◆ HasEncryptionKeys()

bool wallet::CWallet::HasEncryptionKeys ( ) const

overridevirtual

Implements wallet::WalletStorage.

Definition at line 3410 of file wallet.cpp.

Here is the caller graph for this function:

◆ HaveChain()

bool wallet::CWallet::HaveChain ( ) const

inline

Interface to assert chain access.

Definition at line 478 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HaveCryptedKeys()

bool wallet::CWallet::HaveCryptedKeys ( ) const

Definition at line 3415 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsActiveScriptPubKeyMan()

bool wallet::CWallet::IsActiveScriptPubKeyMan ( const ScriptPubKeyMan & spkm ) const

Definition at line 3277 of file wallet.cpp.

Here is the call graph for this function:

◆ IsAddressPreviouslySpent()

bool wallet::CWallet::IsAddressPreviouslySpent ( const CTxDestination & dest ) const

Definition at line 2707 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsInternalScriptPubKeyMan()

std::optional< bool > wallet::CWallet::IsInternalScriptPubKeyMan ( ScriptPubKeyMan * spk_man ) const

Returns whether the provided ScriptPubKeyMan is internal.

Parameters

[in] spk_man The ScriptPubKeyMan to test

Returns: contains value only for active DescriptorScriptPubKeyMan, otherwise undefined

Definition at line 3613 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLocked()

bool wallet::CWallet::IsLocked ( ) const

overridevirtual

Implements wallet::WalletStorage.

Definition at line 3222 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLockedCoin()

bool wallet::CWallet::IsLockedCoin ( const COutPoint & output ) const

Definition at line 2595 of file wallet.cpp.

Here is the call graph for this function:

◆ IsTxImmatureCoinBase()

bool wallet::CWallet::IsTxImmatureCoinBase ( const CWalletTx & wtx ) const

Definition at line 3214 of file wallet.cpp.

Here is the call graph for this function:

◆ KeypoolCountExternalKeys()

size_t wallet::CWallet::KeypoolCountExternalKeys ( ) const

Definition at line 2388 of file wallet.cpp.

Here is the call graph for this function:

◆ ListAddrBookAddresses()

std::vector< CTxDestination > wallet::CWallet::ListAddrBookAddresses ( const std::optional< AddrBookFilter > & filter ) const

Filter and retrieve destinations stored in the addressbook.

Definition at line 2471 of file wallet.cpp.

Here is the call graph for this function:

◆ ListAddrBookLabels()

std::set< std::string > wallet::CWallet::ListAddrBookLabels ( std::optional< AddressPurpose > purpose ) const

Retrieve all the known labels in the address book.

Definition at line 2487 of file wallet.cpp.

Here is the call graph for this function:

◆ ListLockedCoins()

void wallet::CWallet::ListLockedCoins ( std::vector< COutPoint > & vOutpts ) const

Definition at line 2601 of file wallet.cpp.

Here is the call graph for this function:

◆ LoadActiveScriptPubKeyMan()

void wallet::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 3562 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadAddressPreviouslySpent()

void wallet::CWallet::LoadAddressPreviouslySpent ( const CTxDestination & dest )

Marks destination as previously spent.

Definition at line 2697 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadAddressReceiveRequest()

void wallet::CWallet::LoadAddressReceiveRequest	(	const CTxDestination &	dest,
		const std::string &	id,
		const std::string &	request
	)

Appends payment request to destination.

Definition at line 2702 of file wallet.cpp.

Here is the call graph for this function:

◆ LoadDescriptorScriptPubKeyMan()

void wallet::CWallet::LoadDescriptorScriptPubKeyMan	(	uint256	id,
		WalletDescriptor &	desc,
		const KeyMap &	keys,
		const CryptedKeyMap &	ckeys
	)

Instantiate a descriptor ScriptPubKeyMan from the WalletDescriptor and load it.

Definition at line 3435 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadExisting()

std::shared_ptr< CWallet > wallet::CWallet::LoadExisting	(	WalletContext &	context,
		const std::string &	name,
		std::unique_ptr< WalletDatabase >	database,
		bilingual_str &	error,
		std::vector< bilingual_str > &	warnings
	)

static

Definition at line 2998 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadLockedCoin()

void wallet::CWallet::LoadLockedCoin	(	const COutPoint &	coin,
		bool	persistent
	)

Definition at line 2551 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadWalletArgs()

bool wallet::CWallet::LoadWalletArgs	(	std::shared_ptr< CWallet >	wallet,
		const WalletContext &	context,
		bilingual_str &	error,
		std::vector< bilingual_str > &	warnings
	)

static

Definition at line 2788 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Lock()

bool wallet::CWallet::Lock ( )

Definition at line 3231 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LockCoin()

bool wallet::CWallet::LockCoin	(	const COutPoint &	output,
		bool	persist
	)

Definition at line 2557 of file wallet.cpp.

Here is the call graph for this function:

◆ LogName()

std::string wallet::CWallet::LogName ( ) const

inlineoverridevirtual

Return wallet name for use in logs, will return "default wallet" if the wallet has no name.

Implements wallet::WalletStorage.

Definition at line 911 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogStats()

void wallet::CWallet::LogStats ( ) const

inline

Definition at line 931 of file wallet.h.

Here is the call graph for this function:

◆ MarkDestinationsDirty()

void wallet::CWallet::MarkDestinationsDirty ( const std::set< CTxDestination > & destinations )

Marks all outputs in each one of the destinations dirty, so their cache is reset and does not return outdated information.

Definition at line 2448 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MigrateToSQLite()

bool wallet::CWallet::MigrateToSQLite ( bilingual_str & error )

Move all records from the BDB database to a new SQLite database for storage.

The original BDB file will be deleted and replaced with a new SQLite file. A backup is not created. May crash if something unexpected happens in the filesystem.

Definition at line 3757 of file wallet.cpp.

Here is the call graph for this function:

◆ PopulateWalletFromDB()

DBErrors wallet::CWallet::PopulateWalletFromDB	(	bilingual_str &	error,
		std::vector< bilingual_str > &	warnings
	)

Definition at line 2185 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postInitProcess()

void wallet::CWallet::postInitProcess ( )

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

Definition at line 3172 of file wallet.cpp.

Here is the call graph for this function:

◆ RefreshAllTXOs()

void wallet::CWallet::RefreshAllTXOs ( )

Cache outputs that belong to the wallet for all transactions in the wallet.

Definition at line 4534 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RefreshTXOsFromTx()

void wallet::CWallet::RefreshTXOsFromTx ( const CWalletTx & wtx )

Cache outputs that belong to the wallet from a single transaction.

Definition at line 4520 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveTxs() [1/2]

util::Result< void > wallet::CWallet::RemoveTxs ( std::vector< Txid > & txs_to_remove )

Erases the provided transactions from the wallet.

Definition at line 2239 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveTxs() [2/2]

util::Result< void > wallet::CWallet::RemoveTxs	(	WalletBatch &	batch,
		std::vector< Txid > &	txs_to_remove
	)

Definition at line 2253 of file wallet.cpp.

Here is the call graph for this function:

◆ Scanner() [1/2]

ChainScanner & wallet::CWallet::Scanner ( )

Definition at line 499 of file wallet.cpp.

Here is the caller graph for this function:

◆ Scanner() [2/2]

const ChainScanner & wallet::CWallet::Scanner ( ) const

Definition at line 500 of file wallet.cpp.

◆ SetAddressBook()

bool wallet::CWallet::SetAddressBook	(	const CTxDestination &	address,
		const std::string &	strName,
		const std::optional< AddressPurpose > &	purpose
	)

Definition at line 2336 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddressBookWithDB()

bool wallet::CWallet::SetAddressBookWithDB	(	WalletBatch &	batch,
		const CTxDestination &	address,
		const std::string &	strName,
		const std::optional< AddressPurpose > &	strPurpose
	)

private

Definition at line 2300 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddressPreviouslySpent()

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

Definition at line 2683 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddressReceiveRequest()

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

Definition at line 2724 of file wallet.cpp.

Here is the call graph for this function:

◆ SetBroadcastTransactions()

void wallet::CWallet::SetBroadcastTransactions ( bool broadcast )

inline

Set whether this wallet broadcasts transactions.

Definition at line 847 of file wallet.h.

Here is the call graph for this function:

◆ SetLastDecryptedFeatures()

void wallet::CWallet::SetLastDecryptedFeatures ( uint64_t features )

Set the features of the last client to decrypt this wallet.

Definition at line 4561 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetNextResend()

void wallet::CWallet::SetNextResend ( )

inline

Set the next time this wallet should resend transactions to 12-36 hours from now, ~1 day on average.

Definition at line 635 of file wallet.h.

Here is the call graph for this function:

◆ SetupDescriptorScriptPubKeyMan()

DescriptorScriptPubKeyMan & wallet::CWallet::SetupDescriptorScriptPubKeyMan	(	WalletBatch &	batch,
		const CExtKey &	master_key,
		const OutputType &	output_type,
		bool	internal
	)

Create new DescriptorScriptPubKeyMan and add it to the wallet.

Definition at line 3446 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupDescriptorScriptPubKeyMans() [1/2]

void wallet::CWallet::SetupDescriptorScriptPubKeyMans ( )

Definition at line 3486 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupDescriptorScriptPubKeyMans() [2/2]

void wallet::CWallet::SetupDescriptorScriptPubKeyMans	(	WalletBatch &	batch,
		const CExtKey &	master_key
	)

Create new DescriptorScriptPubKeyMans and add them to the wallet.

Definition at line 3460 of file wallet.cpp.

Here is the call graph for this function:

◆ SetupLegacyDataSPKM()

void wallet::CWallet::SetupLegacyDataSPKM ( )

Create a LegacyDataSPKM and set it for all legacy output types and both internal and external chains.

Definition at line 3387 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupOwnDescriptorScriptPubKeyMans()

void wallet::CWallet::SetupOwnDescriptorScriptPubKeyMans ( WalletBatch & batch )

Create new seed and default DescriptorScriptPubKeyMans for this wallet.

Definition at line 3470 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupWalletGeneration()

void wallet::CWallet::SetupWalletGeneration ( )

Setup new descriptors or seed for new address generation.

Definition at line 3536 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SignMessage()

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

Definition at line 2064 of file wallet.cpp.

Here is the call graph for this function:

◆ SignTransaction() [1/2]

bool wallet::CWallet::SignTransaction ( CMutableTransaction & tx ) const

Fetch the inputs and sign with SIGHASH_ALL.

Definition at line 1975 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SignTransaction() [2/2]

bool wallet::CWallet::SignTransaction	(	CMutableTransaction &	tx,
		const std::map< COutPoint, Coin > &	coins,
		int	sighash,
		std::map< int, bilingual_str > &	input_errors
	)		const

Sign the tx given the input coins and sighash.

Definition at line 1994 of file wallet.cpp.

Here is the call graph for this function:

◆ TopUpCallback()

void wallet::CWallet::TopUpCallback	(	const std::set< CScript > &	,
		ScriptPubKeyMan *
	)

overridevirtual

Callback function for after TopUp completes containing any scripts that were added by a SPKMan.

Implements wallet::WalletStorage.

Definition at line 4453 of file wallet.cpp.

Here is the call graph for this function:

◆ TopUpKeyPool()

bool wallet::CWallet::TopUpKeyPool ( unsigned int kpSize = 0 )

Definition at line 2411 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransactionChangeType()

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

Definition at line 2077 of file wallet.cpp.

Here is the call graph for this function:

◆ Unlock()

bool wallet::CWallet::Unlock ( const CKeyingMaterial & vMasterKeyIn )

private

Definition at line 3248 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnlockAllCoins()

bool wallet::CWallet::UnlockAllCoins ( )

Definition at line 2583 of file wallet.cpp.

Here is the call graph for this function:

◆ UnlockCoin()

bool wallet::CWallet::UnlockCoin ( const COutPoint & output )

Definition at line 2568 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 wallet::CWallet::WalletLogPrintf	(	util::log::FormatString< sizeof...(Params)>	wallet_fmt,
		const Params &...	params
	)		const

inline

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

Definition at line 926 of file wallet.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WithEncryptionKey()

bool wallet::CWallet::WithEncryptionKey ( std::function< bool(const CKeyingMaterial &)> cb ) const

overridevirtual

Pass the encryption key to cb().

Implements wallet::WalletStorage.

Definition at line 3404 of file wallet.cpp.

Here is the call graph for this function:

◆ WriteBestBlock()

void wallet::CWallet::WriteBestBlock ( ) const

Write the current best block to database.

Definition at line 4505 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ ChainScanner

friend class ChainScanner

friend

Definition at line 324 of file wallet.h.

Member Data Documentation

◆ cs_wallet

RecursiveMutex wallet::CWallet::cs_wallet

mutable

Main wallet lock.

This lock protects all the fields added by CWallet.

Definition at line 454 of file wallet.h.

◆ fBroadcastTransactions

bool wallet::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 330 of file wallet.h.

◆ m_allow_fallback_fee

bool wallet::CWallet::m_allow_fallback_fee {true}

will be false if -fallbackfee=0

Definition at line 697 of file wallet.h.

◆ m_best_block_time

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

private

Definition at line 332 of file wallet.h.

◆ m_birth_time

std::atomic<int64_t> wallet::CWallet::m_birth_time {std::numeric_limits<int64_t>::max()}

private

Definition at line 336 of file wallet.h.

◆ m_cached_spks

std::unordered_map<CScript, std::vector<ScriptPubKeyMan*>, SaltedSipHasher> wallet::CWallet::m_cached_spks

private

Cache of descriptor ScriptPubKeys used for IsMine. Maps ScriptPubKey to set of spkms.

Definition at line 426 of file wallet.h.

◆ m_chain

interfaces::Chain* wallet::CWallet::m_chain

private

Interface for accessing chain state.

Definition at line 382 of file wallet.h.

◆ m_chain_notifications_handler

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

Registered interfaces::Chain::Notifications handler.

Definition at line 501 of file wallet.h.

◆ m_confirm_target

unsigned int wallet::CWallet::m_confirm_target {DEFAULT_TX_CONFIRM_TARGET}

Definition at line 692 of file wallet.h.

◆ m_consolidate_feerate

CFeeRate wallet::CWallet::m_consolidate_feerate {DEFAULT_CONSOLIDATE_FEERATE}

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

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

Definition at line 714 of file wallet.h.

◆ m_database

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

private

Internal database handle.

Definition at line 388 of file wallet.h.

◆ m_default_address_type

OutputType wallet::CWallet::m_default_address_type {DEFAULT_ADDRESS_TYPE}

Definition at line 718 of file wallet.h.

◆ m_default_change_type

std::optional<OutputType> wallet::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 725 of file wallet.h.

◆ m_discard_rate

CFeeRate wallet::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 708 of file wallet.h.

◆ m_external_spk_managers

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

private

Definition at line 408 of file wallet.h.

◆ m_fallback_fee

CFeeRate wallet::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 704 of file wallet.h.

◆ m_internal_spk_managers

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

private

Definition at line 409 of file wallet.h.

◆ m_keypool_size

int64_t wallet::CWallet::m_keypool_size {DEFAULT_KEYPOOL_SIZE}

Number of pre-generated keys/scripts by each spkm (part of the look-ahead process, used to detect payments)

Definition at line 732 of file wallet.h.

◆ m_max_aps_fee

CAmount wallet::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 717 of file wallet.h.

◆ m_max_tx_fee

CAmount wallet::CWallet::m_max_tx_fee {DEFAULT_TRANSACTION_MAXFEE}

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

Definition at line 727 of file wallet.h.

◆ m_max_tx_fee_rate

CFeeRate wallet::CWallet::m_max_tx_fee_rate {DEFAULT_MAX_TRANSACTION_FEERATE}

Maximum transaction fee rate used for the wallet.

Definition at line 730 of file wallet.h.

◆ m_min_fee

CFeeRate wallet::CWallet::m_min_fee {DEFAULT_TRANSACTION_MINFEE}

Definition at line 698 of file wallet.h.

◆ m_name

std::string wallet::CWallet::m_name

private

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

Definition at line 385 of file wallet.h.

◆ m_next_resend

NodeClock::time_point wallet::CWallet::m_next_resend {GetDefaultNextResend()}

private

The next scheduled rebroadcast of wallet transactions.

Definition at line 327 of file wallet.h.

◆ m_notify_tx_changed_script

std::string wallet::CWallet::m_notify_tx_changed_script

Notify external script when a wallet transaction comes in or is updated (handled by -walletnotify)

Definition at line 735 of file wallet.h.

◆ m_relock_mutex

RecursiveMutex wallet::CWallet::m_relock_mutex

Definition at line 581 of file wallet.h.

◆ m_scanner

std::unique_ptr<ChainScanner> wallet::CWallet::m_scanner

private

Definition at line 390 of file wallet.h.

◆ m_signal_rbf

bool wallet::CWallet::m_signal_rbf {DEFAULT_WALLET_RBF}

Definition at line 696 of file wallet.h.

◆ m_spend_zero_conf_change

bool wallet::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 695 of file wallet.h.

◆ m_spk_managers

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

private

Definition at line 413 of file wallet.h.

◆ m_unlock_mutex

Mutex wallet::CWallet::m_unlock_mutex

Definition at line 579 of file wallet.h.

◆ m_wallet_flags

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

private

WalletFlags set on this wallet.

Definition at line 371 of file wallet.h.

◆ mapMasterKeys

MasterKeyMap wallet::CWallet::mapMasterKeys

Definition at line 467 of file wallet.h.

◆ nMasterKeyMaxID

unsigned int wallet::CWallet::nMasterKeyMaxID = 0

Definition at line 468 of file wallet.h.

◆ NotifyAddressBookChanged

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

Address book entry changed.

Note: called without lock cs_wallet held.

Definition at line 824 of file wallet.h.

◆ NotifyCanGetAddressesChanged

btcsignals::signal<void ()> wallet::CWallet::NotifyCanGetAddressesChanged

Keypool has new keys.

Definition at line 836 of file wallet.h.

◆ NotifyStatusChanged

btcsignals::signal<void (CWallet* wallet)> wallet::CWallet::NotifyStatusChanged

Wallet status (encrypted, locked) changed.

Note: Called without locks held.

Definition at line 842 of file wallet.h.

◆ NotifyTransactionChanged

btcsignals::signal<void(const Txid& hashTx, ChangeType status)> wallet::CWallet::NotifyTransactionChanged

Wallet transaction added, removed or updated.

Note: called with lock cs_wallet held.

Definition at line 830 of file wallet.h.

◆ NotifyUnload

btcsignals::signal<void ()> wallet::CWallet::NotifyUnload

Wallet is about to be unloaded.

Definition at line 815 of file wallet.h.

◆ ShowProgress

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

Show progress e.g.

for rescan

Definition at line 833 of file wallet.h.

◆ wtxOrdered

TxItems wallet::CWallet::wtxOrdered

Definition at line 485 of file wallet.h.

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

src/wallet/wallet.h
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

◆ HDPubKeyMap

◆ ListAddrBookFunc

◆ MasterKeyMap

◆ TryUpdatingStateFn

◆ TxItems

◆ TxSpends

◆ UpdateWalletTxFn

Member Enumeration Documentation

◆ HDKeyFilter

◆ SpendType

◆ TxUpdate

Constructor & Destructor Documentation

◆ CWallet()

◆ ~CWallet()

Member Function Documentation

◆ AddActiveScriptPubKeyMan()

◆ AddActiveScriptPubKeyManWithDb()

◆ AddHDKey()

◆ AddScriptPubKeyMan()

◆ AddWalletDescriptor()

◆ ApplyMigrationData()

◆ AttachChain()

◆ BackupWallet()

◆ CacheNewScriptPubKeys()

◆ CanGrindR()

◆ chain()

◆ CommitTransaction()

◆ ComputeTimeSmart()

◆ ConnectScriptPubKeyManNotifiers()

◆ CreateNew()

◆ DeactivateScriptPubKeyMan()

◆ DelAddressBook()

◆ DelAddressBookWithDB()

◆ DisconnectChainNotifications()

◆ DisplayAddress()

◆ DisplayName()

◆ EraseAddressReceiveRequest()

◆ FillPSBT()

◆ FindAddressBookEntry()

◆ ForEachAddrBookEntry()

◆ GetActiveScriptPubKeyMans()

◆ GetAddressReceiveRequests()

◆ GetAllScriptPubKeyMans()

◆ GetBirthTime()

◆ GetBroadcastTransactions()

◆ GetDatabase()

◆ GetDescriptorScriptPubKeyMan()

◆ GetDescriptorsForLegacy()

◆ GetExtKey()

◆ GetHDPubKeys()

◆ GetKey()

◆ GetKeyPoolSize()

◆ GetLastBlockHash()

◆ GetLastBlockHeight()

◆ GetLegacyDataSPKM()

◆ GetName()

◆ GetNewChangeDestination()

◆ GetNewDestination()

◆ GetOrCreateLegacyDataSPKM()

◆ GetScriptPubKeyMan() [1/2]

◆ GetScriptPubKeyMan() [2/2]

◆ GetScriptPubKeyMans()

◆ GetSolvingProvider() [1/2]

◆ GetSolvingProvider() [2/2]

◆ GetTxBlocksToMaturity()

◆ GetTxDepthInMainChain()

◆ GetTXO()

◆ GetTXOs()