Fix: Propagate math errors instead of swallowing them in read-only views (#409) - #492
Open
OluwapelumiElisha wants to merge 1 commit into
Conversation
…able and streamed_total
|
@OluwapelumiElisha 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
1 participant
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.
Closes #409
What does this PR do?
Fixes an issue where the DripStream read-only views (withdrawable() and streamed_total()) swallow Err (such as ArithmeticOverflow) and silently map it to 0. By changing the return type of these views from i128 to Result<i128, Error>, we ensure that off-chain consumers and indexers can accurately distinguish between a brand-new unaccrued stream and a permanently locked/broken stream.
Why is this change needed?
Previously, if a stream's internal math overflowed or failed (e.g., end_time < start_time on direct init), mutative paths like withdraw or cancel would properly surface an ArithmeticOverflow and revert. However, the read-only views would silently swallow this error and report 0. A UI polling these views would have no indication that the stream's math was broken, making the locked state indistinguishable from a fresh stream.
Changes proposed:
contracts/stream/src/lib.rs: Modified withdrawable(env: Env) and streamed_total(env: Env) to return Result<i128, Error>.
Replaced .unwrap_or(0) with the ? operator to properly bubble up math::withdrawable and math::streamed_amount errors to the caller.
(Note: Rust tests using the generated Soroban client seamlessly unwrap successful results and automatically panic on errors, so no structural changes to tests were necessary.)
Related Issues
Merge #409