[#wallet-OutputGroup]
= xref:wallet.adoc[wallet]::OutputGroup
:relfileprefix: ../
:mrdocs:

A group of UTXOs paid to the same output script.

== Synopsis

Declared in `<wallet/coinselection.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct OutputGroup;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:wallet/OutputGroup/2constructor-01c.adoc[`OutputGroup`]         [.small]#[constructor]#
| Constructors
| xref:wallet/OutputGroup/EligibleForSpending.adoc[`EligibleForSpending`] 
| Report whether this group passes an eligibility filter.
| xref:wallet/OutputGroup/GetSelectionAmount.adoc[`GetSelectionAmount`] 
| Return the value used for this group during coin selection.
| xref:wallet/OutputGroup/Insert.adoc[`Insert`] 
| Add an output to the group, updating its aggregate values.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:wallet/OutputGroup/effective_value.adoc[`effective_value`] 
| The value of the UTXOs after deducting the cost of spending them at the effective feerate.
| xref:wallet/OutputGroup/fee.adoc[`fee`] 
| The fee to spend these UTXOs at the effective feerate.
| xref:wallet/OutputGroup/long_term_fee.adoc[`long_term_fee`] 
| The fee to spend these UTXOs at the long term feerate.
| xref:wallet/OutputGroup/m_ancestors.adoc[`m_ancestors`] 
| The aggregated count of unconfirmed ancestors of all UTXOs in this group. Not deduplicated and may overestimate when ancestors are shared.
| xref:wallet/OutputGroup/m_depth.adoc[`m_depth`] 
| The minimum number of confirmations the UTXOs in the group have. Unconfirmed is 0.
| xref:wallet/OutputGroup/m_from_me.adoc[`m_from_me`] 
| Whether the UTXOs were sent by the wallet to itself. This is relevant because we may want at least a certain number of confirmations on UTXOs received from outside wallets while trusting our own UTXOs more.
| xref:wallet/OutputGroup/m_long_term_feerate.adoc[`m_long_term_feerate`] 
| The feerate for spending a created change output eventually (i.e. not urgently, and thus at a lower feerate). Calculated using long term fee estimate. This is used to decide whether it could be economical to create a change output.
| xref:wallet/OutputGroup/m_max_cluster_count.adoc[`m_max_cluster_count`] 
| The maximum cluster count of a single UTXO in this output group.
| xref:wallet/OutputGroup/m_outputs.adoc[`m_outputs`] 
| The list of UTXOs contained in this output group.
| xref:wallet/OutputGroup/m_subtract_fee_outputs.adoc[`m_subtract_fee_outputs`] 
| Indicate that we are subtracting the fee from outputs. When true, the value that is used for coin selection is the UTXO's real value rather than effective value
| xref:wallet/OutputGroup/m_value.adoc[`m_value`] 
| The total value of the UTXOs in sum.
| xref:wallet/OutputGroup/m_weight.adoc[`m_weight`] 
| Total weight of the UTXOs in this group.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#