feat: add preliquidatable class #251
Draft
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
Jean-Grimal
commented
Jan 24, 2025
Comment on lines
189
to
198
| /** | ||
| * This position's pre health factor (collateral power over debt, scaled by WAD). | ||
| * If the debt is 0, health factor is `MaxUint256`. | ||
| * `undefined` iff the market's oracle is undefined or reverts. | ||
| */ | ||
| get preHealthFactor() { | ||
| return MarketUtils.getHealthFactor(this, this.market, { | ||
| lltv: this.preLiquidationParams.preLltv, | ||
| }); | ||
| } |
There was a problem hiding this comment.
Maybe this function is useless and we should just override healthFactor
Comment on lines
210
to
237
| /** | ||
| * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position | ||
| * and the reason for the limit. | ||
| * Returns `undefined` iff the market's price is undefined. | ||
| * @deprecated Use `getBorrowCapacityLimit` instead. | ||
| */ | ||
| get borrowCapacityLimit() { | ||
| if (this.maxBorrowAssets == null) return; | ||
|
|
||
| // handle edge cases when the user is (pre)liquidatable (maxBorrow < borrow) | ||
| const maxBorrowableAssets = MathLib.zeroFloorSub( | ||
| this.maxBorrowAssets, | ||
| this.market.toBorrowAssets(this.borrowShares), | ||
| ); | ||
|
|
||
| const liquidity = this.market.liquidity; | ||
|
|
||
| if (maxBorrowableAssets > liquidity) | ||
| return { | ||
| value: liquidity, | ||
| limiter: CapacityLimitReason.liquidity, | ||
| }; | ||
|
|
||
| return { | ||
| value: maxBorrowableAssets, | ||
| limiter: CapacityLimitReason.collateral, | ||
| }; | ||
| } |
There was a problem hiding this comment.
Does it make sense to implement this function as it is deprecated ?
Comment on lines
239
to
259
| /** | ||
| * Returns the maximum amount of collateral assets that can be withdrawn given a certain borrow position | ||
| * and the reason for the limit. | ||
| * Returns `undefined` iff the market's price is undefined. | ||
| * @deprecated Use `getWithdrawCollateralCapacityLimit` instead. | ||
| */ | ||
| get withdrawCollateralCapacityLimit() { | ||
| const withdrawableCollateral = this.withdrawableCollateral; | ||
| if (withdrawableCollateral == null) return; | ||
|
|
||
| if (this.collateral > withdrawableCollateral) | ||
| return { | ||
| value: withdrawableCollateral, | ||
| limiter: CapacityLimitReason.collateral, | ||
| }; | ||
|
|
||
| return { | ||
| value: this.collateral, | ||
| limiter: CapacityLimitReason.position, | ||
| }; | ||
| } |
Signed-off-by: Jean-Grimal <83286814+Jean-Grimal@users.noreply.github.com>
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.
Given that for the
accrualPositionclass, a significant portion of the logic is actually in theMarketclass (or inMarketUtils), I had several options for the functions of the new class I need to create/override:Implement them (if they are new functions, otherwise override them) directly in the
preLiquidatablePositionclass without changing eitheraccrualPositionorMarket.Implement them (if they are new functions, otherwise override them) directly in the
preLiquidatablePositionclass and move the logic fromMarketUtilstoaccrualPosition(for better consistency).Implement the new logic in
MarketUtilsand/or in a new utility file.I chose 1 for these first version, but could change.