docs: document the cancellation settlement rules - #233
Merged
Conversation
|
@praizeD10 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cancellation is the part of the stream lifecycle most likely to catch
integrators off guard — specifically what each party receives, that the
split happens atomically, and that vesting stops permanently from that
point. The code comments in contract.rs describe this well, but there
was no prose a user reading the README would find.
Added a "Worked example: cancel" section alongside the existing
withdraw_amount worked example. It uses the same 1000-unit reference
stream the rest of the docs are built around, walks through both the
clean cancel and the cancel-after-partial-withdrawal case with exact
numbers, and calls out the two rejection conditions
(StreamAlreadyCompleted, AlreadyCancelled) so callers know the
boundaries.
No source code was changed. CI is unaffected.
Closes #148