Skip to content

docs: document the cancellation settlement rules - #233

Merged
Glittersup merged 1 commit into
TricklePay:mainfrom
praizeD10:docs/issue-148
Aug 31, 2026
Merged

docs: document the cancellation settlement rules#233
Glittersup merged 1 commit into
TricklePay:mainfrom
praizeD10:docs/issue-148

Conversation

@praizeD10

Copy link
Copy Markdown

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

@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

@Glittersup
Glittersup merged commit 26f3465 into TricklePay:main Aug 31, 2026
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.

Document the cancellation settlement rules

2 participants