Bitcoin Core  24.99.0
P2P Digital Currency
Public Member Functions | Public Attributes | Private Attributes | List of all members
wallet::CCoinControl Class Reference

Coin Control Features. More...

#include <coincontrol.h>

Collaboration diagram for wallet::CCoinControl:
[legend]

Public Member Functions

 CCoinControl ()
 
bool HasSelected () const
 
bool IsSelected (const COutPoint &output) const
 
bool IsExternalSelected (const COutPoint &output) const
 
bool GetExternalOutput (const COutPoint &outpoint, CTxOut &txout) const
 
void Select (const COutPoint &output)
 
void SelectExternal (const COutPoint &outpoint, const CTxOut &txout)
 
void UnSelect (const COutPoint &output)
 
void UnSelectAll ()
 
void ListSelected (std::vector< COutPoint > &vOutpoints) const
 
void SetInputWeight (const COutPoint &outpoint, int64_t weight)
 
bool HasInputWeight (const COutPoint &outpoint) const
 
int64_t GetInputWeight (const COutPoint &outpoint) const
 

Public Attributes

CTxDestination destChange = CNoDestination()
 Custom change destination, if not set an address is generated. More...
 
std::optional< OutputType > m_change_type
 Override the default change type if set, ignored if destChange is set. More...
 
bool m_include_unsafe_inputs = false
 If false, only safe inputs will be used. More...
 
bool m_allow_other_inputs = true
 If true, the selection process can add extra unselected inputs from the wallet while requires all selected inputs be used. More...
 
bool fAllowWatchOnly = false
 Includes watch only addresses which are solvable. More...
 
bool fOverrideFeeRate = false
 Override automatic min/max checks on fee, m_feerate must be set if true. More...
 
std::optional< CFeeRate > m_feerate
 Override the wallet's m_pay_tx_fee if set. More...
 
std::optional< unsigned int > m_confirm_target
 Override the default confirmation target if set. More...
 
std::optional< bool > m_signal_bip125_rbf
 Override the wallet's m_signal_rbf if set. More...
 
bool m_avoid_partial_spends = DEFAULT_AVOIDPARTIALSPENDS
 Avoid partial use of funds sent to a given address. More...
 
bool m_avoid_address_reuse = false
 Forbids inclusion of dirty (previously used) addresses. More...
 
FeeEstimateMode m_fee_mode = FeeEstimateMode::UNSET
 Fee estimation mode to control arguments to estimateSmartFee. More...
 
int m_min_depth = DEFAULT_MIN_DEPTH
 Minimum chain depth value for coin availability. More...
 
int m_max_depth = DEFAULT_MAX_DEPTH
 Maximum chain depth value for coin availability. More...
 
FlatSigningProvider m_external_provider
 SigningProvider that has pubkeys and scripts to do spend size estimation for external inputs. More...
 

Private Attributes

std::set< COutPoint > setSelected
 
std::map< COutPoint, CTxOut > m_external_txouts
 
std::map< COutPoint, int64_t > m_input_weights
 Map of COutPoints to the maximum weight for that input. More...
 

Detailed Description

Coin Control Features.

Definition at line 29 of file coincontrol.h.

Constructor & Destructor Documentation

◆ CCoinControl()

wallet::CCoinControl::CCoinControl ( )

Definition at line 10 of file coincontrol.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ GetExternalOutput()

bool wallet::CCoinControl::GetExternalOutput ( const COutPoint &  outpoint,
CTxOut &  txout 
) const
inline

Definition at line 81 of file coincontrol.h.

Here is the caller graph for this function:

◆ GetInputWeight()

int64_t wallet::CCoinControl::GetInputWeight ( const COutPoint &  outpoint) const
inline

Definition at line 127 of file coincontrol.h.

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

◆ HasInputWeight()

bool wallet::CCoinControl::HasInputWeight ( const COutPoint &  outpoint) const
inline

Definition at line 122 of file coincontrol.h.

Here is the caller graph for this function:

◆ HasSelected()

bool wallet::CCoinControl::HasSelected ( ) const
inline

Definition at line 66 of file coincontrol.h.

Here is the caller graph for this function:

◆ IsExternalSelected()

bool wallet::CCoinControl::IsExternalSelected ( const COutPoint &  output) const
inline

Definition at line 76 of file coincontrol.h.

Here is the caller graph for this function:

◆ IsSelected()

bool wallet::CCoinControl::IsSelected ( const COutPoint &  output) const
inline

Definition at line 71 of file coincontrol.h.

Here is the caller graph for this function:

◆ ListSelected()

void wallet::CCoinControl::ListSelected ( std::vector< COutPoint > &  vOutpoints) const
inline

Definition at line 112 of file coincontrol.h.

Here is the caller graph for this function:

◆ Select()

void wallet::CCoinControl::Select ( const COutPoint &  output)
inline

Definition at line 91 of file coincontrol.h.

Here is the caller graph for this function:

◆ SelectExternal()

void wallet::CCoinControl::SelectExternal ( const COutPoint &  outpoint,
const CTxOut &  txout 
)
inline

Definition at line 96 of file coincontrol.h.

Here is the caller graph for this function:

◆ SetInputWeight()

void wallet::CCoinControl::SetInputWeight ( const COutPoint &  outpoint,
int64_t  weight 
)
inline

Definition at line 117 of file coincontrol.h.

Here is the caller graph for this function:

◆ UnSelect()

void wallet::CCoinControl::UnSelect ( const COutPoint &  output)
inline

Definition at line 102 of file coincontrol.h.

Here is the caller graph for this function:

◆ UnSelectAll()

void wallet::CCoinControl::UnSelectAll ( )
inline

Definition at line 107 of file coincontrol.h.

Here is the caller graph for this function:

Member Data Documentation

◆ destChange

CTxDestination wallet::CCoinControl::destChange = CNoDestination()

Custom change destination, if not set an address is generated.

Definition at line 33 of file coincontrol.h.

◆ fAllowWatchOnly

bool wallet::CCoinControl::fAllowWatchOnly = false

Includes watch only addresses which are solvable.

Definition at line 42 of file coincontrol.h.

◆ fOverrideFeeRate

bool wallet::CCoinControl::fOverrideFeeRate = false

Override automatic min/max checks on fee, m_feerate must be set if true.

Definition at line 44 of file coincontrol.h.

◆ m_allow_other_inputs

bool wallet::CCoinControl::m_allow_other_inputs = true

If true, the selection process can add extra unselected inputs from the wallet while requires all selected inputs be used.

Definition at line 40 of file coincontrol.h.

◆ m_avoid_address_reuse

bool wallet::CCoinControl::m_avoid_address_reuse = false

Forbids inclusion of dirty (previously used) addresses.

Definition at line 54 of file coincontrol.h.

◆ m_avoid_partial_spends

bool wallet::CCoinControl::m_avoid_partial_spends = DEFAULT_AVOIDPARTIALSPENDS

Avoid partial use of funds sent to a given address.

Definition at line 52 of file coincontrol.h.

◆ m_change_type

std::optional<OutputType> wallet::CCoinControl::m_change_type

Override the default change type if set, ignored if destChange is set.

Definition at line 35 of file coincontrol.h.

◆ m_confirm_target

std::optional<unsigned int> wallet::CCoinControl::m_confirm_target

Override the default confirmation target if set.

Definition at line 48 of file coincontrol.h.

◆ m_external_provider

FlatSigningProvider wallet::CCoinControl::m_external_provider

SigningProvider that has pubkeys and scripts to do spend size estimation for external inputs.

Definition at line 62 of file coincontrol.h.

◆ m_external_txouts

std::map<COutPoint, CTxOut> wallet::CCoinControl::m_external_txouts
private

Definition at line 136 of file coincontrol.h.

◆ m_fee_mode

FeeEstimateMode wallet::CCoinControl::m_fee_mode = FeeEstimateMode::UNSET

Fee estimation mode to control arguments to estimateSmartFee.

Definition at line 56 of file coincontrol.h.

◆ m_feerate

std::optional<CFeeRate> wallet::CCoinControl::m_feerate

Override the wallet's m_pay_tx_fee if set.

Definition at line 46 of file coincontrol.h.

◆ m_include_unsafe_inputs

bool wallet::CCoinControl::m_include_unsafe_inputs = false

If false, only safe inputs will be used.

Definition at line 37 of file coincontrol.h.

◆ m_input_weights

std::map<COutPoint, int64_t> wallet::CCoinControl::m_input_weights
private

Map of COutPoints to the maximum weight for that input.

Definition at line 138 of file coincontrol.h.

◆ m_max_depth

int wallet::CCoinControl::m_max_depth = DEFAULT_MAX_DEPTH

Maximum chain depth value for coin availability.

Definition at line 60 of file coincontrol.h.

◆ m_min_depth

int wallet::CCoinControl::m_min_depth = DEFAULT_MIN_DEPTH

Minimum chain depth value for coin availability.

Definition at line 58 of file coincontrol.h.

◆ m_signal_bip125_rbf

std::optional<bool> wallet::CCoinControl::m_signal_bip125_rbf

Override the wallet's m_signal_rbf if set.

Definition at line 50 of file coincontrol.h.

◆ setSelected

std::set<COutPoint> wallet::CCoinControl::setSelected
private

Definition at line 135 of file coincontrol.h.

The documentation for this class was generated from the following files:
Generated on Sat Mar 25 2023 02:44:48 for Bitcoin Core by doxygen 1.9.1