[R4R] Add Safety Measures to Coin/Coins #2797
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
alexanderbez
requested review from
cwgoes,
ebuchman and
rigelrozanski
as code owners
27 tasks
added 8 commits
November 13, 2018 16:06
Closed
alexanderbez
changed the title
ValarDragon
reviewed
Nov 15, 2018
cwgoes
reviewed
Nov 16, 2018
alexanderbez
changed the title
Codecov Report
@@ Coverage Diff @@
## develop #2797 +/- ##
==========================================
Coverage ? 56.94%
==========================================
Files ? 120
Lines ? 8281
Branches ? 0
==========================================
Hits ? 4716
Misses ? 3247
Partials ? 318 |
alexanderbez
changed the title
fedekunze
reviewed
Nov 17, 2018
| return nil, sdk.ErrInsufficientFee(fmt.Sprintf("invalid fee amount: %s", feeAmount)).Result() | ||
| } | ||
|
|
||
| newCoins, ok := coins.SafeMinus(feeAmount) |
There was a problem hiding this comment.
why are we not using plain Minus ?
There was a problem hiding this comment.
Because Minus will panic on any negative amount! So here want to gracefully return the error. As mentioned in a similar conversation above, I think we can do IsAllLTE here instead and then once sure, we can safely do subtraction.
| oldCoins := getCoins(ctx, am, addr) | ||
| newCoins := oldCoins.Minus(amt) | ||
| if !newCoins.IsNotNegative() { | ||
| newCoins, hasNeg := oldCoins.SafeMinus(amt) |
cwgoes
reviewed
Nov 19, 2018
jaekwon
reviewed
Nov 20, 2018
types/coin.go
Outdated
| diff := coins.Minus(coinsB) | ||
| if len(diff) == 0 { | ||
| diff, hasNeg := coins.SafeMinus(coinsB) | ||
| if len(diff) == 0 || hasNeg { |
There was a problem hiding this comment.
This is weird semantically. False isn't safe to return, esp when people might use !A.IsAllGT(B) as a synonym for A.IsAllLTE(B), etc.
jaekwon
reviewed
Nov 20, 2018
types/coin.go
Outdated
| func (coins Coins) IsAllGTE(coinsB Coins) bool { | ||
| diff := coins.Minus(coinsB) | ||
| diff, hasNeg := coins.SafeMinus(coinsB) | ||
| if hasNeg { |
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.
So initial attempts to move to unsigned integers caused headaches in implementation (e.g.
(A) - (B)should panic) under given time constraints 😞 . So I see this PR as a big step in improving safety, but an ultimate refactor should still take place (#1273) to utilize unsigned integers.That being said, this PR does the following:
inttype, but adds safety checks and measures (panics) whenever amounts are negative.Minuspanics on any negative coin,SafeMinusreturns a bool if a negative coin exists.IsValidto check if not positive.Equalto obey theassociativityaxiom.plusmethod to obey arithmetic laws.Uinttype.TL;DR Review
int.go,coin.go, andante.go🍍closes: #2776
Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
Wrote tests
Updated relevant documentation (
docs/)Added entries in
PENDING.mdwith issue #rereviewed
Files changedin the github PR explorerFor Admin Use: