-
Notifications
You must be signed in to change notification settings - Fork 170
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
docs: market params design_doc #1152
Conversation
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.
Is there anything new in this PR?
- I thought you were mentioning to reverse
collateral_utilization
. It stays the same in this PR. Also, as noted in docs: ADR-4: max collateral utilization #940, reversing doesn't help. I think you are noting this in this PR as well (in alternatives section). Commenting about it because I thought that this was the motivation to block Add MaxCollateralUtilization or MinCollateralLiquidity to Token Registry #1036. - If this is going to improve documentation, then let's put it as a documentation (in x/leverage/spec)
@@ -47,69 +47,6 @@ The calculated borrow limit, which weighs collateral uTokens against borrowed as | |||
|
|||
Note also that as a consequence of uToken interest, the asset value of uToken collateral increases over time, meaning a user who repays positions in full and redeems collateral uTokens will receive back more base assets than they deposited originally, reducing the effective interest. | |||
|
|||
### Collateral utilization |
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.
Why moving this definitions?
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.
It was not part of the original decision - since ADR-003 will be renamed to a design doc (and already functioned as one), this is an attempt to apply the rule "don't modify old design docs, but make a new one instead."
Since multiple parameters are being added in the same timeframe, it made sense to group the proposals.
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 know, but they are related to the borrowing as well.
Hence, if we are moving this then let's already organize it in a documentation, rather than scatter it around decision docs.
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.
What specifically should I do to this PR before merging? As it stands, it is a completed design doc
representing parameters which were added together on a single theme.
Moving the collateral utilization definition back to 003 violates "don't modify old design docs" rule. Removing this document altogether and putting it in the spec goes against our decision to use design doc PRs.
As I see it, this should either be merged unchanged, or moved to the design docs folder first then merged. Spec updates are a separate issue and do not happen during the initial design PR.
|
|
|
||
This quantity has the property of increasing rapidly (as 1/N -> 0) when available supply is under stress. | ||
|
||
Stable assets will have high max collateral utilization (can go even to 50). Volatile assets should have significantly smaller collateral utilization, and assets with high risk should have max collateral utilization close to 1. |
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.
Stable assets will have high max collateral utilization (can go even to 50). Volatile assets should have significantly smaller collateral utilization, and assets with high risk should have max collateral utilization close to 1. | |
Stable assets will have high max collateral utilization (up to to 50). Volatile assets should have significantly smaller collateral utilization, and assets with high risk should have max collateral utilization close to 1. |
I hoped we won't merge PRs without updated documentation ( |
Current practice is to update spec simultaneous with implementation, so it is always exactly up to date (as opposed to containing unimplemented features). As an example, the We will likely update the descriptions (specifically failure conditions) of Also since spec is scheduled for overhaul (to be fleshed out to be an adequate source of truth) we can wait until v3 release candidate is out to do the large spec updates. If the above turns out to be bad practice, we can revisit it - for now, I want to rush v3. |
I have never seen that. The whole motivation to redo the adr process and put more pressure to the documentation was that both were and still are very outdated.
We should really link it to the code / or proto file rather than copying it. This way we are sure the we will be up to date. |
True - we don't need to update the docs now, we don't have that task. But if in any current tasks we are updating something then we should already slowly construct the updated docs. |
New ADR (as folder is not yet moved/renamed) absorbs some previous changes and proposes three similarly themed parameters:
MaxSupplyUtilization
MaxCollateralShare
MinCollateralLiquidity
(alternative:MaxCollateralUtilization
)This has been split off from #1141 into a docs-only PR for process.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
to the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...