doc: readme parameter restriction #82
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -36,6 +36,17 @@ 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; | ||||||
| - 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. Alternatively you can write.
Suggested change
There was a problem hiding this comment. 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. | ||||||
|
|
||||||
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.
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.