doc: Clarify that change_cost cannot be negative in GetSelectionWaste

This commit is contained in:
benthecarman 2021-09-05 12:55:54 -05:00
parent f4e12fd50c
commit d2eccacd18
No known key found for this signature in database
GPG key ID: D7CC770B81FD22A8

View file

@ -174,7 +174,9 @@ struct OutputGroup
* change_cost = effective_feerate * change_output_size + long_term_feerate * change_spend_size
*
* @param[in] inputs The selected inputs
* @param[in] change_cost The cost of creating change and spending it in the future. Only used if there is change. Must be 0 if there is no change.
* @param[in] change_cost The cost of creating change and spending it in the future.
* Only used if there is change, in which case it must be positive.
* Must be 0 if there is no change.
* @param[in] target The amount targeted by the coin selection algorithm.
* @param[in] use_effective_value Whether to use the input's effective value (when true) or the real value (when false).
* @return The waste