docs: clarify decommission and missed-deposit behavior in NatSpec#152
Open
Tranquil-Flow wants to merge 1 commit into
Open
docs: clarify decommission and missed-deposit behavior in NatSpec#152Tranquil-Flow wants to merge 1 commit into
Tranquil-Flow wants to merge 1 commit into
Conversation
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.
Summary
Closes #96
Adds comprehensive NatSpec documentation to clarify the existing decommission and missed-deposit behavior. As discussed in #96, the current behavior is correct for v1 — this PR documents it so the contract's rules are unambiguous to developers, auditors, and frontend integrators.
What's documented
ISavingCircles.sol:CircleStateenum: detailed description of each state (NotStarted, Active, DepositInProgress, DepositComplete, Expired, Decommissioned, MissedDeposit) and when transitions occurCircleDecommissionedevent: clarifies it fires after all recoverable funds have been returnedCircleTimedOuterror: explains the exact condition (round window elapsed + incomplete deposits)deposit(),depositFor(): documents partial deposit support, CircleTimedOut revert conditions, and that decommission must be called first to recover from missed-deposit statewithdraw(),withdrawFor(): documents the 5 conditions for withdrawal eligibility, payout amount formula, auto-deactivation on last claimdecommission(): full flow documentation including preconditions, refund mechanics, storage deletion, and post-decommission stateSavingCircles.sol:decommission(): inline documentation of the decommissionable conditions and refund flowisWithdrawable(): documents O(N) iteration and return semantics_isDecommissionable(): documents the time + state conditions and fund recovery purposeNo behavioral changes. Documentation only.
Test plan
forge testpasses (140 tests)