doc: readme parameter restriction #82
Merged
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
adhusson
reviewed
Oct 7, 2024
QGarchery
reviewed
Oct 7, 2024
MathisGD
approved these changes
Oct 7, 2024
QGarchery
approved these changes
Oct 7, 2024
| - preLCF1 <= preLCF2; | ||
| - preLFC1 <= 1; | ||
| - 1 <= preLIF1 <= preLIF2 <= 1 / LLTV. | ||
| Note: Using `preLCF2 > 1`, you can select at which LTV between preLltv and LLTV the entire position will be pre-liquidated. |
There was a problem hiding this comment.
Suggested change
| Note: Using `preLCF2 > 1`, you can select at which LTV between preLltv and LLTV the entire position will be pre-liquidated. | |
| Note: Using `preLCF2 > 1`, one can select a LTV smaller than LLTV after which the position can be fully pre-liquidated. |
| maxPreLltv: marketParams.lltv - 1, | ||
| minPreLCF: WAD + 1, | ||
| maxPreLCF: type(uint256).max, | ||
| minPreLIF: WAD + 1, |
There was a problem hiding this comment.
Suggested change
| minPreLIF: WAD + 1, | |
| minPreLIF: WAD, |
adhusson
approved these changes
Oct 7, 2024
colin-morpho
reviewed
Oct 7, 2024
README.md
Outdated
| - preLFC1 <= 1; | ||
| - 1 <= preLIF1 <= preLIF2 <= 1 / LLTV. | ||
| Note: it is not mandatory that `preLCF1 <= 1` and `preLCF1 <= 1` hold. | ||
| Indeed without this, the pre-liquidation close factor can reach 100% before the position is liquidatable allowing additionnal pre-liquidation close factor configurations. |
There was a problem hiding this comment.
Alternatively you can write.
Suggested change
| Indeed without this, the pre-liquidation close factor can reach 100% before the position is liquidatable allowing additionnal pre-liquidation close factor configurations. | |
| Indeed, in some cases the pre-liquidation close factor reaches 100% with LTV lower than LLTV. |
There was a problem hiding this comment.
Used @adhusson's suggestion for this
"Note: Using preLCF2 > 1, you can select at which LTV between preLltv and LLTV the entire position will be pre-liquidated."
wdyt ?
|
|
||
| ### Pre-liquidation parameters restrictions | ||
|
|
||
| The PreLiquidation smart-contract enforces the following properties: |
There was a problem hiding this comment.
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.
Suggested change
| The PreLiquidation smart-contract enforces the following properties: | |
| The PreLiquidation smart-contract enforces the properties: |
Closed
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.
Wrote a short paragraph on the bounds of pre-liquidation parameters
Still struggling to find a clean phrasing for "allowing additionnal pre-liquidation close factor configuration" (the idea is that with preLCF2 > 1 you can handle more pre-liquidation close factor curves)