-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: readme parameter restriction #82
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -36,6 +36,18 @@ The two main use-cases are: | |||||
1. Using normal fixed parameters when `preLIF1 = preLIF2` and `preLCF1 = preLCF2`. | ||||||
2. Using health dependent liquidation when either `preLIF1 < preLIF2` or `preLCF1 < preLCF2`, similar to a Quasi Dutch Auction (as in [Euler liquidations](https://docs-v1.euler.finance/getting-started/white-paper#liquidations)). | ||||||
|
||||||
|
||||||
### Pre-liquidation parameters restrictions | ||||||
|
||||||
The PreLiquidation smart-contract enforces the following properties: | ||||||
- preLltv < LLTV; | ||||||
- preLCF1 <= preLCF2; | ||||||
- preLFC1 <= 1; | ||||||
- 1 <= preLIF1 <= preLIF2 <= 1 / LLTV. | ||||||
Note: it is not mandatory that `preLCF1 <= 1` and `preLCF1 <= 1` hold. | ||||||
MathisGD marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
Indeed without this, the pre-liquidation close factor can reach 100% before the position is liquidatable allowing additionnal pre-liquidation close factor configurations. | ||||||
MathisGD marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Alternatively you can write.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Used @adhusson's suggestion for this |
||||||
A pre-liquidation close factor higher than 100% means that the whole position is pre-liquidatable. | ||||||
MathisGD marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
### `onPreLiquidate` callback | ||||||
|
||||||
By calling `preLiquidate` with a smart contract that implements the `IPreLiquidationCallback` interface, the liquidator can be called back. | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -40,7 +40,7 @@ contract PreLiquidationErrorTest is BaseTest { | |||||
factory.createPreLiquidation(id, preLiquidationParams); | ||||||
} | ||||||
|
||||||
function testCloseFactorDecreasing(PreLiquidationParams memory preLiquidationParams) public virtual { | ||||||
function testLCFDecreasing(PreLiquidationParams memory preLiquidationParams) public virtual { | ||||||
preLiquidationParams = boundPreLiquidationParameters({ | ||||||
preLiquidationParams: preLiquidationParams, | ||||||
minPreLltv: WAD / 100, | ||||||
|
@@ -57,6 +57,22 @@ contract PreLiquidationErrorTest is BaseTest { | |||||
factory.createPreLiquidation(id, preLiquidationParams); | ||||||
} | ||||||
|
||||||
function testLCFHigh(PreLiquidationParams memory preLiquidationParams) public virtual { | ||||||
preLiquidationParams = boundPreLiquidationParameters({ | ||||||
preLiquidationParams: preLiquidationParams, | ||||||
minPreLltv: WAD / 100, | ||||||
maxPreLltv: marketParams.lltv - 1, | ||||||
minPreLCF: WAD + 1, | ||||||
maxPreLCF: type(uint256).max, | ||||||
minPreLIF: WAD + 1, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
maxPreLIF: WAD.wDivDown(lltv), | ||||||
preLiqOracle: marketParams.oracle | ||||||
}); | ||||||
|
||||||
vm.expectRevert(ErrorsLib.PreLCFTooHigh.selector); | ||||||
factory.createPreLiquidation(id, preLiquidationParams); | ||||||
} | ||||||
|
||||||
function testLowPreLIF(PreLiquidationParams memory preLiquidationParams) public virtual { | ||||||
preLiquidationParams = boundPreLiquidationParameters({ | ||||||
preLiquidationParams: preLiquidationParams, | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove "following" as the properties are listed in the same sentence. Should you list them separately (e.g. by labeling with them names or ids out of a sentence) then using following would apply as the sentence is not self contained.