Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation and properties of reduceChangeOutputs. #32

Merged
merged 6 commits into from
Apr 7, 2020

Conversation

jonathanknowles
Copy link
Contributor

Related Issues

#18
#21
#22

Summary

This PR:

  • Clarifies the documentation of reduceChangeOutputs, adding examples.
  • Tests that reduceChangeOutputs only produces valid coins.

Copy link
Contributor

@paweljakubas paweljakubas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Justification: this name is consistent with the description and
behaviour of the function, which is to reduce each of the change
outputs, rather than to perform any rebalancing per se.
Relocate examples so that they are next to relevant explanations.

Add a section on handling insufficient change.
@jonathanknowles jonathanknowles force-pushed the jonathanknowles/reduce-change-outputs branch from 5b610f9 to 32ea203 Compare April 7, 2020 05:00
Test that:
- Generation produces valid coins.
- Shrinking produces valid coins.
@jonathanknowles jonathanknowles merged commit 95fabde into master Apr 7, 2020
@jonathanknowles jonathanknowles deleted the jonathanknowles/reduce-change-outputs branch April 7, 2020 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants