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

Select coins using the CoinGrinder deterministic search algorithm.

== Synopsis

Declared in `<wallet/coinselection.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:util/Result.adoc[util::Result<SelectionResult>]
CoinGrinder(
    std::vector<OutputGroup>& utxo_pool,
    xref:CAmount.adoc[CAmount] const& selection_target,
    xref:CAmount.adoc[CAmount] change_target,
    int max_selection_weight);
----

== Return Value

If successful, a valid SelectionResult, otherwise util::Error.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *utxo_pool*
| The output groups eligible for selection.
| *selection_target*
| The target value to select for.
| *change_target*
| The minimum change amount to target.
| *max_selection_weight*
| The maximum allowed weight for a valid selection.
|===


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