Parameters for one iteration of Coin Selection. More...

#include <coinselection.h>

Collaboration diagram for wallet::CoinSelectionParams:

Public Member Functions
	CoinSelectionParams (FastRandomContext &rng_fast, int change_output_size, int change_spend_size, CAmount min_change_target, CFeeRate effective_feerate, CFeeRate long_term_feerate, CFeeRate discard_feerate, int tx_noinputs_size, bool avoid_partial, std::optional< int > max_tx_weight=std::nullopt)

	CoinSelectionParams (FastRandomContext &rng_fast)

Public Attributes
FastRandomContext &	rng_fast
	Randomness to use in the context of coin selection. More...

int	change_output_size = 0
	Size of a change output in bytes, determined by the output type. More...

int	change_spend_size = 0
	Size of the input to spend a change output in virtual bytes. More...

CAmount	m_min_change_target {0}
	Mininmum change to target in Knapsack solver and CoinGrinder: select coins to cover the payment and at least this value of change. More...

CAmount	min_viable_change {0}
	Minimum amount for creating a change output. More...

CAmount	m_change_fee {0}
	Cost of creating the change output. More...

CAmount	m_cost_of_change {0}
	Cost of creating the change output + cost of spending the change output in the future. More...

CFeeRate	m_effective_feerate
	The targeted feerate of the transaction being built. More...

CFeeRate	m_long_term_feerate
	The feerate estimate used to estimate an upper bound on what should be sufficient to spend the change output sometime in the future. More...

CFeeRate	m_discard_feerate
	If the cost to spend a change output at the discard feerate exceeds its value, drop it to fees. More...

int	tx_noinputs_size = 0
	Size of the transaction before coin selection, consisting of the header and recipient output(s), excluding the inputs and change output(s). More...

bool	m_subtract_fee_outputs = false
	Indicate that we are subtracting the fee from outputs. More...

bool	m_avoid_partial_spends = false
	When true, always spend all (up to OUTPUT_GROUP_MAX_ENTRIES) or none of the outputs associated with the same address. More...

bool	m_include_unsafe_inputs = false
	When true, allow unsafe coins to be selected during Coin Selection. More...

uint32_t	m_version {CTransaction::CURRENT_VERSION}
	The version of the transaction we are trying to create. More...

std::optional< int >	m_max_tx_weight {std::nullopt}
	The maximum weight for this transaction. More...

Detailed Description

Parameters for one iteration of Coin Selection.

Definition at line 134 of file coinselection.h.

Constructor & Destructor Documentation

◆ CoinSelectionParams() [1/2]

wallet::CoinSelectionParams::CoinSelectionParams	(	FastRandomContext &	rng_fast,
		int	change_output_size,
		int	change_spend_size,
		CAmount	min_change_target,
		CFeeRate	effective_feerate,
		CFeeRate	long_term_feerate,
		CFeeRate	discard_feerate,
		int	tx_noinputs_size,
		bool	avoid_partial,
		std::optional< int >	max_tx_weight = `std::nullopt`
	)

inline

Definition at line 178 of file coinselection.h.

◆ CoinSelectionParams() [2/2]

wallet::CoinSelectionParams::CoinSelectionParams ( FastRandomContext & rng_fast )

inline

Definition at line 194 of file coinselection.h.

Member Data Documentation

◆ change_output_size

int wallet::CoinSelectionParams::change_output_size = 0

Size of a change output in bytes, determined by the output type.

Definition at line 138 of file coinselection.h.

◆ change_spend_size

int wallet::CoinSelectionParams::change_spend_size = 0

Size of the input to spend a change output in virtual bytes.

Definition at line 140 of file coinselection.h.

◆ m_avoid_partial_spends

bool wallet::CoinSelectionParams::m_avoid_partial_spends = false

When true, always spend all (up to OUTPUT_GROUP_MAX_ENTRIES) or none of the outputs associated with the same address.

This helps reduce privacy leaks resulting from address reuse. Dust outputs are not eligible to be added to output groups and thus not considered.

Definition at line 167 of file coinselection.h.

◆ m_change_fee

CAmount wallet::CoinSelectionParams::m_change_fee {0}

Cost of creating the change output.

Definition at line 149 of file coinselection.h.

◆ m_cost_of_change

CAmount wallet::CoinSelectionParams::m_cost_of_change {0}

Cost of creating the change output + cost of spending the change output in the future.

Definition at line 151 of file coinselection.h.

◆ m_discard_feerate

CFeeRate wallet::CoinSelectionParams::m_discard_feerate

If the cost to spend a change output at the discard feerate exceeds its value, drop it to fees.

Definition at line 158 of file coinselection.h.

◆ m_effective_feerate

CFeeRate wallet::CoinSelectionParams::m_effective_feerate

The targeted feerate of the transaction being built.

Definition at line 153 of file coinselection.h.

◆ m_include_unsafe_inputs

bool wallet::CoinSelectionParams::m_include_unsafe_inputs = false

When true, allow unsafe coins to be selected during Coin Selection.

This may spend unconfirmed outputs: 1) Received from other wallets, 2) replacing other txs, 3) that have been replaced.

Definition at line 172 of file coinselection.h.

◆ m_long_term_feerate

CFeeRate wallet::CoinSelectionParams::m_long_term_feerate

The feerate estimate used to estimate an upper bound on what should be sufficient to spend the change output sometime in the future.

Definition at line 156 of file coinselection.h.

◆ m_max_tx_weight

std::optional<int> wallet::CoinSelectionParams::m_max_tx_weight {std::nullopt}

The maximum weight for this transaction.

Definition at line 176 of file coinselection.h.

◆ m_min_change_target

CAmount wallet::CoinSelectionParams::m_min_change_target {0}

Mininmum change to target in Knapsack solver and CoinGrinder: select coins to cover the payment and at least this value of change.

Definition at line 143 of file coinselection.h.

◆ m_subtract_fee_outputs

bool wallet::CoinSelectionParams::m_subtract_fee_outputs = false

Indicate that we are subtracting the fee from outputs.

Definition at line 163 of file coinselection.h.

◆ m_version

uint32_t wallet::CoinSelectionParams::m_version {CTransaction::CURRENT_VERSION}

The version of the transaction we are trying to create.

Definition at line 174 of file coinselection.h.

◆ min_viable_change

CAmount wallet::CoinSelectionParams::min_viable_change {0}

Minimum amount for creating a change output.

If change budget is smaller than min_change then we forgo creation of change output.

Definition at line 147 of file coinselection.h.

◆ rng_fast

FastRandomContext& wallet::CoinSelectionParams::rng_fast

Randomness to use in the context of coin selection.

Definition at line 136 of file coinselection.h.

◆ tx_noinputs_size

int wallet::CoinSelectionParams::tx_noinputs_size = 0

Size of the transaction before coin selection, consisting of the header and recipient output(s), excluding the inputs and change output(s).

Definition at line 161 of file coinselection.h.

The documentation for this struct was generated from the following file:

src/wallet/coinselection.h

Public Member Functions

Public Attributes