Functions
CAmount	CWallet::GetBalance (const isminefilter &filter=ISMINE_SPENDABLE, const int min_depth=0) const

CAmount	CWallet::GetUnconfirmedBalance () const

CAmount	CWallet::GetImmatureBalance () const

CAmount	CWallet::GetUnconfirmedWatchOnlyBalance () const

CAmount	CWallet::GetImmatureWatchOnlyBalance () const

CAmount	CWallet::GetLegacyBalance (const isminefilter &filter, int minDepth) const

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

void	CWallet::AvailableCoins (std::vector< COutput > &vCoins, bool fOnlySafe=true, const CCoinControl *coinControl=nullptr, const CAmount &nMinimumAmount=1, const CAmount &nMaximumAmount=MAX_MONEY, const CAmount &nMinimumSumAmount=MAX_MONEY, const uint64_t nMaximumCount=0, const int nMinDepth=0, const int nMaxDepth=9999999) const EXCLUSIVE_LOCKS_REQUIRED(cs_main
	populate vCoins with vector of available COutputs. More...

std::map< CTxDestination, std::vector< COutput > >	CWallet::ListCoins () const EXCLUSIVE_LOCKS_REQUIRED(cs_main
	Return list of available coins and locked coins grouped by non-change output address. More...

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

bool	CWallet::SelectCoinsMinConf (const CAmount &nTargetValue, const CoinEligibilityFilter &eligibility_filter, std::vector< OutputGroup > groups, std::set< CInputCoin > &setCoinsRet, CAmount &nValueRet, const CoinSelectionParams &coin_selection_params, bool &bnb_used) const
	Shuffle and select coins until nTargetValue is reached while avoiding small change; This method is stochastic for some inputs and upon completion the coin set and corresponding actual target value is assembled. More...

bool	CWallet::SelectCoins (const std::vector< COutput > &vAvailableCoins, const CAmount &nTargetValue, std::set< CInputCoin > &setCoinsRet, CAmount &nValueRet, const CCoinControl &coin_control, CoinSelectionParams &coin_selection_params, bool &bnb_used) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Select a set of coins such that nValueRet >= nTargetValue and at least all coins from coinControl are selected; Never select unconfirmed coins if they are not ours. More...

bool	CWallet::SignTransaction (CMutableTransaction &tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

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

bool	CWallet::CreateTransaction (const std::vector< CRecipient > &vecSend, CTransactionRef &tx, CReserveKey &reservekey, CAmount &nFeeRet, int &nChangePosInOut, std::string &strFailReason, const CCoinControl &coin_control, bool sign=true)
	Create a new transaction paying the recipients with a set of coins selected by SelectCoins(); Also create the change output, when needed. More...

bool	CWallet::CommitTransaction (CTransactionRef tx, mapValue_t mapValue, std::vector< std::pair< std::string, std::string >> orderForm, CReserveKey &reservekey, CConnman *connman, CValidationState &state)
	Call after CreateTransaction unless you want to abort. More...

DBErrors	CWallet::LoadWallet (bool &fFirstRunRet)

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

DBErrors	CWallet::ZapWalletTx (std::vector< CWalletTx > &vWtx)

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

bool	CWallet::DelAddressBook (const CTxDestination &address)

const std::string &	CWallet::GetLabelName (const CScript &scriptPubKey) const

bool	CWallet::NewKeyPool ()
	Mark old keypool keys as used, and generate all new keys. More...

size_t	CWallet::KeypoolCountExternalKeys () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	CWallet::LoadKeyPool (int64_t nIndex, const CKeyPool &keypool) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

bool	CWallet::ReserveKeyFromKeyPool (int64_t &nIndex, CKeyPool &keypool, bool fRequestedInternal)
	Reserves a key from the keypool and sets nIndex to its index. More...

void	CWallet::KeepKey (int64_t nIndex)

void	CWallet::ReturnKey (int64_t nIndex, bool fInternal, const CPubKey &pubkey)

bool	CWallet::GetKeyFromPool (CPubKey &key, bool internal=false)

int64_t	CWallet::GetOldestKeyPoolTime ()

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

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

std::set< CTxDestination >	CWallet::GetLabelAddresses (const std::string &label) const

bool	CReserveKey::GetReservedKey (CPubKey &pubkey, bool internal=false)

void	CReserveKey::KeepKey ()

void	CReserveKey::ReturnKey ()

void	CWallet::MarkReserveKeysAsUsed (int64_t keypool_id) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Marks all keys in the keypool up to and including reserve_key as used. More...

void	CWallet::GetScriptForMining (std::shared_ptr< CReserveScript > &script)

void	CWallet::LockCoin (const COutPoint &output) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	CWallet::UnlockCoin (const COutPoint &output) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	CWallet::UnlockAllCoins () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

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

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

Detailed Description

Function Documentation

◆ AvailableCoins()

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

populate vCoins with vector of available COutputs.

Definition at line 2151 of file wallet.cpp.

Here is the caller graph for this function:

◆ CommitTransaction()

bool CWallet::CommitTransaction	(	CTransactionRef	tx,
		mapValue_t	mapValue,
		std::vector< std::pair< std::string, std::string >>	orderForm,
		CReserveKey &	reservekey,
		CConnman *	connman,
		CValidationState &	state
	)

Call after CreateTransaction unless you want to abort.

Definition at line 2958 of file wallet.cpp.

Here is the call graph for this function:

◆ CreateTransaction()

bool CWallet::CreateTransaction	(	const std::vector< CRecipient > &	vecSend,
		CTransactionRef &	tx,
		CReserveKey &	reservekey,
		CAmount &	nFeeRet,
		int &	nChangePosInOut,
		std::string &	strFailReason,
		const CCoinControl &	coin_control,
		bool	sign = `true`
	)

Create a new transaction paying the recipients with a set of coins selected by SelectCoins(); Also create the change output, when needed.

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

Definition at line 2561 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DelAddressBook()

bool CWallet::DelAddressBook ( const CTxDestination & address )

Definition at line 3110 of file wallet.cpp.

Here is the call graph for this function:

◆ FindNonChangeParentOutput()

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

Find non-change parent output.

Definition at line 2298 of file wallet.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,
		std::string &	strFailReason,
		bool	lockUnspents,
		const std::set< int > &	setSubtractFeeFromOutputs,
		CCoinControl	coinControl
	)

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

Definition at line 2479 of file wallet.cpp.

Here is the call graph for this function:

◆ GetAddressBalances()

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

Definition at line 3391 of file wallet.cpp.

Here is the call graph for this function:

◆ GetAddressGroupings()

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

Definition at line 3431 of file wallet.cpp.

Here is the call graph for this function:

◆ GetAvailableBalance()

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

Definition at line 2136 of file wallet.cpp.

◆ GetBalance()

CAmount CWallet::GetBalance	(	const isminefilter &	filter = `ISMINE_SPENDABLE`,
		const int	min_depth = `0`
	)		const

Definition at line 2022 of file wallet.cpp.

Here is the call graph for this function:

◆ GetImmatureBalance()

CAmount CWallet::GetImmatureBalance ( ) const

Definition at line 2054 of file wallet.cpp.

Here is the call graph for this function:

◆ GetImmatureWatchOnlyBalance()

CAmount CWallet::GetImmatureWatchOnlyBalance ( ) const

Definition at line 2083 of file wallet.cpp.

Here is the call graph for this function:

◆ GetKeyFromPool()

bool CWallet::GetKeyFromPool	(	CPubKey &	key,
		bool	internal = `false`
	)

Definition at line 3337 of file wallet.cpp.

Here is the call graph for this function:

◆ GetLabelAddresses()

std::set< CTxDestination > CWallet::GetLabelAddresses ( const std::string & label ) const

Definition at line 3524 of file wallet.cpp.

◆ GetLabelName()

const std::string & CWallet::GetLabelName ( const CScript & scriptPubKey ) const

Definition at line 3130 of file wallet.cpp.

Here is the call graph for this function:

◆ GetLegacyBalance()

CAmount CWallet::GetLegacyBalance	(	const isminefilter &	filter,
		int	minDepth
	)		const

Definition at line 2103 of file wallet.cpp.

◆ GetOldestKeyPoolTime()

int64_t CWallet::GetOldestKeyPoolTime ( )

Definition at line 3373 of file wallet.cpp.

◆ GetReservedKey()

bool CReserveKey::GetReservedKey	(	CPubKey &	pubkey,
		bool	internal = `false`
	)

Definition at line 3538 of file wallet.cpp.

Here is the call graph for this function:

◆ GetScriptForMining()

void CWallet::GetScriptForMining ( std::shared_ptr< CReserveScript > & script )

Definition at line 3595 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUnconfirmedBalance()

CAmount CWallet::GetUnconfirmedBalance ( ) const

Definition at line 2039 of file wallet.cpp.

Here is the call graph for this function:

◆ GetUnconfirmedWatchOnlyBalance()

CAmount CWallet::GetUnconfirmedWatchOnlyBalance ( ) const

Definition at line 2068 of file wallet.cpp.

Here is the call graph for this function:

◆ IsLockedCoin()

bool CWallet::IsLockedCoin	(	uint256	hash,
		unsigned int	n
	)		const

Definition at line 3624 of file wallet.cpp.

◆ KeepKey() [1/2]

void CWallet::KeepKey ( int64_t nIndex )

Definition at line 3312 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ KeepKey() [2/2]

void CReserveKey::KeepKey ( )

Definition at line 3554 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ KeypoolCountExternalKeys()

size_t CWallet::KeypoolCountExternalKeys ( )

Definition at line 3183 of file wallet.cpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ListLockedCoins()

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

Definition at line 3632 of file wallet.cpp.

Here is the caller graph for this function:

◆ LoadKeyPool()

void CWallet::LoadKeyPool	(	int64_t	nIndex,
		const CKeyPool &	keypool
	)

Definition at line 3189 of file wallet.cpp.

Here is the call graph for this function:

◆ LoadWallet()

DBErrors CWallet::LoadWallet ( bool & fFirstRunRet )

Definition at line 3005 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LockCoin()

void CWallet::LockCoin ( const COutPoint & output )

Definition at line 3606 of file wallet.cpp.

Here is the caller graph for this function:

◆ MarkReserveKeysAsUsed()

void CWallet::MarkReserveKeysAsUsed ( int64_t keypool_id )

Marks all keys in the keypool up to and including reserve_key as used.

Definition at line 3571 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NewKeyPool()

bool CWallet::NewKeyPool ( )

Mark old keypool keys as used, and generate all new keys.

Definition at line 3149 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReserveKeyFromKeyPool()

bool CWallet::ReserveKeyFromKeyPool	(	int64_t &	nIndex,
		CKeyPool &	keypool,
		bool	fRequestedInternal
	)

Reserves a key from the keypool and sets nIndex to its index.

Parameters

[out]	nIndex	the index of the key in keypool
[out]	keypool	the keypool the key was drawn from, which could be the the pre-split pool if present, or the internal or external pool
	fRequestedInternal	true if the caller would like the key drawn from the internal keypool, false if external is preferred

Returns: true if succeeded, false if failed due to empty keypool

Exceptions

std::runtime_error if keypool read failed, key was invalid, was not found in the wallet, or was misclassified in the internal or external keypool

Definition at line 3268 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReturnKey() [1/2]

void CWallet::ReturnKey	(	int64_t	nIndex,
		bool	fInternal,
		const CPubKey &	pubkey
	)

Definition at line 3320 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReturnKey() [2/2]

void CReserveKey::ReturnKey ( )

Definition at line 3562 of file wallet.cpp.

Here is the call graph for this function:

◆ 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,
		bool &	bnb_used
	)		const

Select a set of coins such that nValueRet >= nTargetValue and at least all coins from coinControl are selected; Never select unconfirmed coins if they are not ours.

Definition at line 2369 of file wallet.cpp.

◆ SelectCoinsMinConf()

bool CWallet::SelectCoinsMinConf	(	const CAmount &	nTargetValue,
		const CoinEligibilityFilter &	eligibility_filter,
		std::vector< OutputGroup >	groups,
		std::set< CInputCoin > &	setCoinsRet,
		CAmount &	nValueRet,
		const CoinSelectionParams &	coin_selection_params,
		bool &	bnb_used
	)		const

Shuffle and select coins until nTargetValue is reached while avoiding small change; This method is stochastic for some inputs and upon completion the coin set and corresponding actual target value is assembled.

Definition at line 2315 of file wallet.cpp.

Here is the call graph for this function:

◆ SetAddressBook()

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

Definition at line 3092 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SignTransaction()

bool CWallet::SignTransaction ( CMutableTransaction & tx )

Definition at line 2456 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TopUpKeyPool()

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

Definition at line 3210 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransactionChangeType()

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

Definition at line 2533 of file wallet.cpp.

◆ UnlockAllCoins()

void CWallet::UnlockAllCoins ( )

Definition at line 3618 of file wallet.cpp.

◆ UnlockCoin()

void CWallet::UnlockCoin ( const COutPoint & output )

Definition at line 3612 of file wallet.cpp.

◆ ZapSelectTx()

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

Definition at line 3036 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZapWalletTx()

DBErrors CWallet::ZapWalletTx ( std::vector< CWalletTx > & vWtx )

Definition at line 3068 of file wallet.cpp.

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ AvailableCoins()

◆ CommitTransaction()

◆ CreateTransaction()

◆ DelAddressBook()

◆ FindNonChangeParentOutput()

◆ FundTransaction()

◆ GetAddressBalances()

◆ GetAddressGroupings()

◆ GetAvailableBalance()

◆ GetBalance()

◆ GetImmatureBalance()

◆ GetImmatureWatchOnlyBalance()

◆ GetKeyFromPool()

◆ GetLabelAddresses()

◆ GetLabelName()

◆ GetLegacyBalance()

◆ GetOldestKeyPoolTime()

◆ GetReservedKey()

◆ GetScriptForMining()

◆ GetUnconfirmedBalance()

◆ GetUnconfirmedWatchOnlyBalance()

◆ IsLockedCoin()

◆ KeepKey() [1/2]

◆ KeepKey() [2/2]

◆ KeypoolCountExternalKeys()

◆ ListCoins()

◆ ListLockedCoins()

◆ LoadKeyPool()

◆ LoadWallet()

◆ LockCoin()

◆ MarkReserveKeysAsUsed()

◆ NewKeyPool()

◆ ReserveKeyFromKeyPool()

◆ ReturnKey() [1/2]

◆ ReturnKey() [2/2]

◆ SelectCoins()

◆ SelectCoinsMinConf()

◆ SetAddressBook()

◆ SignTransaction()

◆ TopUpKeyPool()

◆ TransactionChangeType()

◆ UnlockAllCoins()

◆ UnlockCoin()

◆ ZapSelectTx()

◆ ZapWalletTx()