Refactor/cancel to pause #113
Merged
Conversation
This file contains 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
refactor: don't refund in pause function feat: keep track of debt after pausing
smol-ninja
force-pushed
the
refactor/cancel-to-pause
branch
from
93717e1 to
621ff8c
Compare
smol-ninja
requested changes
May 23, 2024
There was a problem hiding this comment.
Thank you very much for this PR @andreivladbrg. I have reviewed it and left my comments. I will re-review it later after those comments have been addressed.
Note: the coverage has gone down.
refactor: remove pauseMultiple function
This comment was marked as resolved.
This comment was marked as resolved.
andreivladbrg
force-pushed
the
refactor/cancel-to-pause
branch
from
670bdf4 to
aef3c12
Compare
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
smol-ninja
requested changes
May 23, 2024
…Of function test: be more precise for caller test branches test: remove unneeded test for pause function docs: correct invariants
|
@smol-ninja there is only one thing left: #113 (comment) since it is only about a in rest, i've addressed all the feedback in my commits, please lmk if it looks good |
smol-ninja
reviewed
May 23, 2024
smol-ninja
approved these changes
May 24, 2024
|
Thanks for the long discussion @andreivladbrg. Feel free to merge this PR now. |
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.
Related issues
canceloverpausefunction #85.remainingAmount#91Credits to @smol-ninja for coming with this idea of carrying the debt after pausing. (and thanks for explaining on slack)
Changes
This PR renames
canceltopauseand removes the refund from this function - similarly to create/deposit, now refund and pause are distinct operations.The remaining amount is now summed only by streamed amount, in
_pauseand_adjustRatePerSecondfunctions. And it is subtracted in_withdrawif there is debt, and if it is not it set to 0.The biggest change is in how the withdrawable amount is calculated. Since now the remaining amount can be greater than the balance, each case of the debt must be handled within it. We have to mentain the invariant (balance > withdrawable) - also see the diagrams below
Diagrams
State diagram
Calculation diagram