diff options
author | benthecarman <benthecarman@live.com> | 2021-09-05 12:55:54 -0500 |
---|---|---|
committer | benthecarman <benthecarman@live.com> | 2021-09-05 12:55:54 -0500 |
commit | d2eccacd188959c5aed661d0d5b39c119e7c7a32 (patch) | |
tree | 0a99deeddb10a613547776c52dc6adc3bba312be /src/wallet | |
parent | f4e12fd50c23875f4b5f272c94449eb81de43d5d (diff) |
doc: Clarify that change_cost cannot be negative in GetSelectionWaste
Diffstat (limited to 'src/wallet')
-rw-r--r-- | src/wallet/coinselection.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/wallet/coinselection.h b/src/wallet/coinselection.h index 35617d455b..5ebf7d02a6 100644 --- a/src/wallet/coinselection.h +++ b/src/wallet/coinselection.h @@ -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 |