docs: mark isWithdrawable() as deprecated - #151
Open
Tranquil-Flow wants to merge 1 commit into
Open
Conversation
Mark isWithdrawable() as @deprecated in both ISavingCircles interface and the SavingCircles implementation. The original function has O(N²) gas cost from iterating all members and checking deposits for each round. Recommend isMemberWithdrawable(id, member) for per-member checks or currentRoundWithdrawer(id) for the current round's designated withdrawer. - Closes: #126
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.
Summary
Closes #126
Marks
isWithdrawable()as@deprecatedin bothISavingCirclesinterface andSavingCirclesimplementation.The function has O(N²) gas cost — it iterates all members and for each calls
_activeClaimableCheck, which itself scans all members. The deprecation notice directs callers to:isMemberWithdrawable(id, member)for per-member O(N) checkscurrentRoundWithdrawer(id)for O(1) lookup of the current round's recipientFunction retained for backward compatibility; removal planned for the next breaking release.
Changes
ISavingCircles.sol: added@dev @deprecatedNatSpec with migration guidanceSavingCircles.sol: added matching@dev @deprecatedNatSpecTest plan
forge testpasses (140 tests)