Skip to content
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

x/leverage: Update ADRs to reflect implementations #897

Open
toteki opened this issue May 12, 2022 · 2 comments
Open

x/leverage: Update ADRs to reflect implementations #897

toteki opened this issue May 12, 2022 · 2 comments

Comments

@toteki
Copy link
Member

toteki commented May 12, 2022

ADRs haven't been touched since proposed phase, with new changes appearing instead in the code and the spec.

However, the availability of outdated information has caused confusion so we should update/clean/simplify them.

@robert-zaremba
Copy link
Member

robert-zaremba commented May 12, 2022

Notably ADR-07 (bad debt) must be updated.

  1. simplify the language
  2. clarify that the bad debt is when the collateral was liquidated but the borrow position is still open (liquidation didn't succeed to repay the borrow)
  3. focus only on the "insurance" mechanisms.

mergify bot pushed a commit that referenced this issue May 18, 2022
## Description

+ updated ADR 05 (liquidation) document
+ renamed `CalculateLiquidationLimit` -> `CalculateLiquidationThreshold`. The function return the maximum amount in USD we can borrow. Not a limit of a liquidation.
+ Updated error messages and style.

related to: #897

----

### 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...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added appropriate labels to the PR
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/umee-network/umee/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### 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...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
@robert-zaremba robert-zaremba self-assigned this Jun 23, 2022
@robert-zaremba
Copy link
Member

During the workshop we were talking about documentation issues, could you plan for this task in the next sprint (add check list of what to do and add them to the Linear)?

@robert-zaremba robert-zaremba added this to the v3.4 milestone Dec 21, 2022
@robert-zaremba robert-zaremba mentioned this issue Dec 21, 2022
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants