Add documentation and todos #111
Open
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
This change introduces the _borrowOrCreateReserveVault helper function from the jord/liquidation branch, which simplifies reserve vault access patterns in the codebase. Changes: - Add _borrowOrCreateReserveVault helper to create reserves on-demand - Use helper in liquidateRepayForSeize for debt reserve deposits - Use helper in internalRepay for debt reserve deposits - Remove redundant reserve creation in liquidateViaDex (handled by internal functions) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit adds comprehensive documentation improvements and TODO comments throughout the codebase to better track technical debt and clarify functionality. Changes: - Enhanced InternalPosition field documentation (targetHealth, minHealth, maxHealth) - Added TODO comments to setDrawDownSink and setTopUpSource - Improved InterestCurve interface documentation with parameter descriptions - Enhanced TokenState totalCreditBalance and totalDebitBalance documentation - Added blank line after balance update helpers comment block - Added TODO comments to unused functions (updateCreditBalance, updateDebitBalance) - Updated updateInterestIndices comment - Added TODO for InterestCurve abstraction improvement - Enhanced PositionView struct documentation for balances and snapshots fields - Added TODO comments to healthFactor and maxWithdraw functions - Added documentation TODOs to helper functions (computeAdjustedBalancesAfterWithdrawal, computeRequiredDepositForHealth, computeAvailableWithdrawal) - Added permission system TODO to createPosition - Added refactoring TODOs to large functions (depositAndPush, withdrawAndPull) - Enhanced rebalancePosition documentation with detailed behavior description - Added TODO for MOET type enforcement in rebalance logic Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove modifications to liquidateRepayForSeize, liquidateViaDex, and internalRepay as these functions will be removed in the future. Changes reverted: - liquidateRepayForSeize: Restore inline reserve creation for both seizeType and debtType - liquidateViaDex: Restore reserve vault creation for both tokens - internalRepay: Restore inline reserve creation and reference pattern Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
jordanschalm
commented
Jan 16, 2026
jordanschalm
commented
Jan 16, 2026
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.
This PR improves documentation and adds TODOs.
(PS: Claude didn't write these comments, it only helped move them from another branch.)