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

Make Coins.AllGT() more robust and consistent #3820

Merged
merged 9 commits into from
Mar 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions PENDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@

### SDK

* [\#3820] Make Coins.IsAllGT() more robust and consistent.
* #3801 `baseapp` saftey improvements

### Tendermint
Expand Down
41 changes: 36 additions & 5 deletions types/coin.go
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,23 @@ func (coins Coins) safeAdd(coinsB Coins) Coins {
}
}

// DenomsSubsetOf returns true if receiver's denom set
// is subset of coinsB's denoms.
func (coins Coins) DenomsSubsetOf(coinsB Coins) bool {
// more denoms in B than in receiver
if len(coins) > len(coinsB) {
cwgoes marked this conversation as resolved.
Show resolved Hide resolved
return false
}

for _, coin := range coins {
cwgoes marked this conversation as resolved.
Show resolved Hide resolved
if coinsB.AmountOf(coin.Denom).IsZero() {
return false
}
}

return true
}

// Sub subtracts a set of coins from another.
//
// e.g.
Expand All @@ -294,15 +311,29 @@ func (coins Coins) SafeSub(coinsB Coins) (Coins, bool) {
return diff, diff.IsAnyNegative()
}

// IsAllGT returns true if for every denom in coins, the denom is present at a
// greater amount in coinsB.
// IsAllGT returns true if for every denom in coinsB,
// the denom is present at a greater amount in coins.
func (coins Coins) IsAllGT(coinsB Coins) bool {
diff, _ := coins.SafeSub(coinsB)
if len(diff) == 0 {
if len(coins) == 0 {
return false
}

return diff.IsAllPositive()
if len(coinsB) == 0 {
return true
}

if !coinsB.DenomsSubsetOf(coins) {
cwgoes marked this conversation as resolved.
Show resolved Hide resolved
return false
}

for _, coinB := range coinsB {
amountA, amountB := coins.AmountOf(coinB.Denom), coinB.Amount
if !amountA.GT(amountB) {
return false
}
}

return true
}

// IsAllGTE returns true iff for every denom in coins, the denom is present at
Expand Down
51 changes: 44 additions & 7 deletions types/coin_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,7 @@ func TestCoins(t *testing.T) {
mixedCase3 := Coins{
{"gAs", NewInt(1)},
}
empty := Coins{
{"gold", NewInt(0)},
}
null := Coins{}
empty := NewCoins()
badSort1 := Coins{
{"tree", NewInt(1)},
{"gas", NewInt(1)},
Expand Down Expand Up @@ -312,7 +309,7 @@ func TestCoins(t *testing.T) {
assert.False(t, mixedCase2.IsValid(), "First Coins denoms contain upper case characters")
assert.False(t, mixedCase3.IsValid(), "Single denom in Coins contains upper case characters")
assert.True(t, good.IsAllPositive(), "Expected coins to be positive: %v", good)
assert.False(t, null.IsAllPositive(), "Expected coins to not be positive: %v", null)
assert.False(t, empty.IsAllPositive(), "Expected coins to not be positive: %v", empty)
assert.True(t, good.IsAllGTE(empty), "Expected %v to be >= %v", good, empty)
assert.False(t, good.IsAllLT(empty), "Expected %v to be < %v", good, empty)
assert.True(t, empty.IsAllLT(good), "Expected %v to be < %v", empty, good)
Expand All @@ -331,7 +328,7 @@ func TestCoinsGT(t *testing.T) {