feat: add enabled/blacklist fields to tokens by toteki · Pull Request #913 · umee-network/umee

toteki · 2022-05-15T23:29:22Z

Description

Adds various options for disabling borrow, lend, and oracle price calculations of asset types.

Prevents token registry update from EVER removing base denoms from token registry. Therefore:

Gov updates only need to include the tokens they're actually adding/changing.
Removing tokens intentionally can be done by disabling borrowing/lending, or setting the Blacklist field depending on the situation. Their metadata and params remain in the token registry.

Also adds validation to SetRegisteredToken

closes: #869
closes: #724

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

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 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)

codecov-commenter · 2022-05-16T02:09:54Z

Codecov Report

Merging #913 (bf88e68) into main (fba208c) will increase coverage by 0.02%.
The diff coverage is 58.90%.

@@            Coverage Diff             @@
##             main     #913      +/-   ##
==========================================
+ Coverage   50.87%   50.90%   +0.02%     
==========================================
  Files          64       64              
  Lines        9451     9479      +28     
==========================================
+ Hits         4808     4825      +17     
- Misses       4397     4401       +4     
- Partials      246      253       +7

Impacted Files	Coverage Δ
x/leverage/keeper/genesis.go	`2.15% <0.00%> (ø)`
x/leverage/keeper/interest.go	`78.16% <0.00%> (-4.32%)`	⬇️
x/leverage/keeper/reserves.go	`78.94% <ø> (+2.99%)`	⬆️
x/leverage/keeper/token.go	`61.73% <55.55%> (+1.34%)`	⬆️
x/leverage/keeper/keeper.go	`45.88% <57.14%> (-0.75%)`	⬇️
x/leverage/keeper/oracle.go	`67.07% <66.66%> (-2.16%)`	⬇️
x/leverage/client/tests/suite.go	`100.00% <100.00%> (ø)`
x/leverage/gov_handler.go	`100.00% <100.00%> (+20.00%)`	⬆️
x/leverage/types/token.go	`42.85% <100.00%> (+9.52%)`	⬆️
... and 4 more

x/leverage/gov_handler.go

x/leverage/keeper/oracle.go

x/oracle/keeper/hooks_test.go

RafilxTenfen

LGTM

x/leverage/keeper/token.go

proto/umee/leverage/v1/leverage.proto

Co-authored-by: Rafael Tenfen <rafaeltenfen.rt@gmail.com>

CHANGELOG.md

proto/umee/leverage/v1/leverage.proto

robert-zaremba · 2022-05-16T21:55:00Z

proto/umee/leverage/v1/leverage.proto

+  // or withdrawn, but not liquidated. A blacklisted token must have enable_lend
+  // and enable_borrow set to false. Such tokens can be safely removed from the
+  // by the oracle and price feeder as well.
+  bool blacklist = 14;


how about renaming to disabled?

Runs the risk of being interpreted as just a combination of the other two being disabled.

This is more serious in that it also forces the value of the coin to zero in all calculations, which would have all kinds of consequences - we might look for a name that communicates that, but blacklist at least shows the severity.

In #913 (comment) I was thinking to remove this field.

What it would take to unblackist an asset?

Technically, only a governance proposal with the blacklisted field set back to false.

In reality, it seems unlikely that an accepted asset could become so nasty we have to blacklist it, but then recover to a point where we need to reverse the decision.

x/leverage/gov_handler_test.go

x/leverage/keeper/keeper_test.go

adamewozniak

left a few suggestions 🥳

x/leverage/gov_handler_test.go

x/leverage/keeper/keeper.go

x/oracle/keeper/hooks_test.go

Co-authored-by: Adam Wozniak <29418299+adamewozniak@users.noreply.github.com>

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

…e into adam/unsupported-assets

robert-zaremba

LGTM. Pending proto comments update

proto/umee/leverage/v1/leverage.proto

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

proto/umee/leverage/v1/leverage.proto

…rrow

add enabled/blacklist fields

25362ab

toteki added C:x/leverage C:Audit labels May 15, 2022

toteki added this to the Calypso milestone May 15, 2022

toteki added 4 commits May 15, 2022 16:32

update k.IsAcceptedToken

3fab3f8

update gov handler test

813b01c

simplify prefix functions

c21ef3e

fix tests

2a79b2d

add borrow/lend/blacklist restrictions

09c1839

toteki commented May 16, 2022

View reviewed changes

x/leverage/gov_handler.go Show resolved Hide resolved

toteki commented May 16, 2022

View reviewed changes

x/leverage/keeper/oracle.go Outdated Show resolved Hide resolved

Update x/leverage/keeper/oracle.go

26faddc

toteki commented May 16, 2022

View reviewed changes

x/oracle/keeper/hooks_test.go Outdated Show resolved Hide resolved

toteki mentioned this pull request May 16, 2022

chore!: update ADR-05 and leverage keeper cosmetic updates #903

Merged

18 tasks

cl++

ff14d3a

toteki marked this pull request as ready for review May 16, 2022 03:21

toteki requested review from a team as code owners May 16, 2022 03:21

RafilxTenfen approved these changes May 16, 2022

View reviewed changes

x/leverage/keeper/token.go Outdated Show resolved Hide resolved

proto/umee/leverage/v1/leverage.proto Outdated Show resolved Hide resolved

toteki and others added 3 commits May 16, 2022 07:33

simplify

2f92cc0

Co-authored-by: Rafael Tenfen <rafaeltenfen.rt@gmail.com>

typo

5a58251

spec++

e2aa0cc

robert-zaremba reviewed May 16, 2022

View reviewed changes

adamewozniak reviewed May 16, 2022

View reviewed changes

toteki commented May 16, 2022

View reviewed changes

x/oracle/keeper/hooks_test.go Outdated Show resolved Hide resolved

toteki and others added 4 commits May 16, 2022 15:22

remove oracle TODO

2750479

++

cec6472

Co-authored-by: Adam Wozniak <29418299+adamewozniak@users.noreply.github.com>

++

e93e3e9

Co-authored-by: Adam Wozniak <29418299+adamewozniak@users.noreply.github.com>

++

9e1b043

toteki and others added 12 commits May 16, 2022 17:00

add gov handler test for invalid token

f5c2cd2

reduce token copypaste in gov_handler_test.go

a15c96e

++

b29e7f5

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

reduce token copypaste in borrows_test an keeper_test

f30b2dc

Merge branch 'adam/unsupported-assets' of github.com:umee-network/ume…

2109606

…e into adam/unsupported-assets

make proto-gen after proto comment change

1ead91a

cl: state breaking -> features for new stuff

2369490

Merge branch 'main' into adam/unsupported-assets

7217fa2

Merge branch 'main' into adam/unsupported-assets

6609ece

Merge branch 'main' into adam/unsupported-assets

9c841dd

fix stray slash

52c2e61

Require -> Assert

2baefad

robert-zaremba approved these changes May 19, 2022

View reviewed changes

proto/umee/leverage/v1/leverage.proto Outdated Show resolved Hide resolved

proto/umee/leverage/v1/leverage.proto Outdated Show resolved Hide resolved

proto/umee/leverage/v1/leverage.proto Outdated Show resolved Hide resolved

toteki and others added 2 commits May 19, 2022 12:33

Suggestion 1

d9abe77

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

suggestion 2

14795c1

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

toteki commented May 19, 2022

View reviewed changes

proto/umee/leverage/v1/leverage.proto Outdated Show resolved Hide resolved

toteki added 4 commits May 19, 2022 12:34

suggestion 3

b527d8f

make proto-gen and global rename enable->enable_msg for _lend and _bo…

5db2d39

…rrow

++

cb8f626

fix yaml

bf88e68

toteki merged commit 3150329 into main May 19, 2022

toteki deleted the adam/unsupported-assets branch May 19, 2022 22:30

This was referenced Apr 19, 2024

feat(auction): oracle fees #2500

Merged

chore: bump wasmd #2504

Merged

feat(ics20): support leverage/MsgRepay in Memo #2506

Merged

Conversation

toteki commented May 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Reviewers Checklist

Uh oh!

codecov-commenter commented May 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RafilxTenfen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

robert-zaremba May 16, 2022

Choose a reason for hiding this comment

Uh oh!

toteki May 18, 2022

Choose a reason for hiding this comment

Uh oh!

robert-zaremba May 18, 2022

Choose a reason for hiding this comment

Uh oh!

toteki May 18, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adamewozniak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

robert-zaremba left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

toteki commented May 15, 2022 •

edited

Loading

codecov-commenter commented May 16, 2022 •

edited

Loading