Skip to content

feat(tm2): improve error message on invalid coins #4942

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.

Sign up for GitHub

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

Open
MikaelVallenet wants to merge 8 commits into
base: master
Choose a base branch
from
Open

feat(tm2): improve error message on invalid coins #4942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b727dcd
feat(tm2): improve error message on invalid coins
MikaelVallenet Dec 5, 2025
937edef
Merge branch 'master' into mikael/fix/improve-std-coins-error
MikaelVallenet Dec 10, 2025
9edfac2
chore: trigger CI
MikaelVallenet Dec 11, 2025
b4e2c73
chore: trigger CI
MikaelVallenet Dec 11, 2025
f4811ee
test(tm2): add coverage on is valid fail case for add & sub & parse &…
MikaelVallenet Dec 11, 2025
6064d55
test(tm2): add coverage on is valid fail case for add & sub & parse &…
MikaelVallenet Dec 11, 2025
19d4994
Merge branch 'master' into mikael/fix/improve-std-coins-error
MikaelVallenet Dec 11, 2025
4bc057e
test(tm2): add coverage on is valid fail case for add & sub & parse &…
MikaelVallenet Dec 11, 2025
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
24 changes: 18 additions & 6 deletions tm2/pkg/std/coin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func (coin Coin) IsEqual(other Coin) bool {
func (coin Coin) Add(coinB Coin) Coin {
res := coin.AddUnsafe(coinB)
if !res.IsValid() {
panic(fmt.Sprintf("invalid result: %v + %v = %v", coin, coinB, res))
panic(fmt.Sprintf("invalid result: %v + %v = %v (lowercase-only denoms, and positive amounts)", coin, coinB, res))
}
return res
}
Expand All @@ -144,7 +144,7 @@ func (coin Coin) AddUnsafe(coinB Coin) Coin {
func (coin Coin) Sub(coinB Coin) Coin {
res := coin.SubUnsafe(coinB)
if !res.IsValid() {
panic(fmt.Sprintf("invalid result: %v - %v = %v", coin, coinB, res))
panic(fmt.Sprintf("invalid result: %v - %v = %v (lowercase-only denoms, and positive amounts)", coin, coinB, res))
}
return res
}
Expand Down Expand Up @@ -192,7 +192,10 @@ func NewCoins(coins ...Coin) Coins {
}

if !newCoins.IsValid() {
panic(fmt.Errorf("invalid coin set: %s", newCoins))
panic(fmt.Errorf(
"invalid coin set: %s (must be sorted, lowercase-only denoms, and positive amounts)",
newCoins,
))
}

return newCoins
Expand Down Expand Up @@ -271,7 +274,10 @@ func (coins Coins) IsValid() bool {
func (coins Coins) Add(coinsB Coins) Coins {
res := coins.AddUnsafe(coinsB)
if !res.IsValid() {
panic(fmt.Sprintf("invalid result: %v + %v = %v", coins, coinsB, res))
panic(fmt.Sprintf(
"invalid result: %v + %v = %v (coins must be sorted, lowercase-only denoms, and positive amounts)",
coins, coinsB, res,
))
}
return res
}
Expand Down Expand Up @@ -372,7 +378,10 @@ func (coins Coins) DenomsSubsetOf(coinsB Coins) bool {
func (coins Coins) Sub(coinsB Coins) Coins {
res := coins.SubUnsafe(coinsB)
if !res.IsValid() {
panic(fmt.Sprintf("invalid result: %v - %v = %v", coins, coinsB, res))
panic(fmt.Sprintf(
"invalid result: %v - %v = %v (must be sorted, lowercase-only denoms, and positive amounts)",
coins, coinsB, res,
))
}
return res
}
Expand Down Expand Up @@ -717,7 +726,10 @@ func ParseCoins(coinsStr string) (Coins, error) {

// validate coins before returning
if !coins.IsValid() {
return nil, fmt.Errorf("parseCoins invalid: %#v", coins)
return nil, fmt.Errorf(
"parseCoins: invalid coins %v (must be sorted, lowercase-only denoms, and positive amounts)",
coins,
)
}

return coins, nil
Expand Down
53 changes: 43 additions & 10 deletions tm2/pkg/std/coin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import (
)

var (
testDenom1 = "atom"
testDenom2 = "muon"
testDenom1 = "atom"
testDenom2 = "muon"
testDenomInvalid = "Atom"
)

// ----------------------------------------------------------------------------
Expand Down Expand Up @@ -83,6 +84,13 @@ func TestAddCoin(t *testing.T) {
{NewCoin(testDenom1, 1), NewCoin(testDenom1, 1), NewCoin(testDenom1, 2), false},
{NewCoin(testDenom1, 1), NewCoin(testDenom1, 0), NewCoin(testDenom1, 1), false},
{NewCoin(testDenom1, 1), NewCoin(testDenom2, 1), NewCoin(testDenom1, 1), true},
{Coin{
Denom: testDenomInvalid,
Amount: 1,
}, Coin{
Denom: testDenomInvalid,
Amount: 1,
}, NewCoin(testDenom1, 0), true},
}

for tcIndex, tc := range cases {
Expand All @@ -109,6 +117,10 @@ func TestSubCoin(t *testing.T) {
{NewCoin(testDenom1, 5), NewCoin(testDenom1, 3), NewCoin(testDenom1, 2), false},
{NewCoin(testDenom1, 5), NewCoin(testDenom1, 0), NewCoin(testDenom1, 5), false},
{NewCoin(testDenom1, 1), NewCoin(testDenom1, 5), Coin{}, true},
{NewCoin(testDenom1, 1), Coin{
Denom: testDenomInvalid,
Amount: 1,
}, Coin{}, true},
}

for tcIndex, tc := range cases {
Expand Down Expand Up @@ -254,18 +266,24 @@ func TestAddCoins(t *testing.T) {
inputOne Coins
inputTwo Coins
expected Coins
panics bool
}{
{Coins{{testDenom1, one}, {testDenom2, one}}, Coins{{testDenom1, one}, {testDenom2, one}}, Coins{{testDenom1, two}, {testDenom2, two}}},
{Coins{{testDenom1, zero}, {testDenom2, one}}, Coins{{testDenom1, zero}, {testDenom2, zero}}, Coins{{testDenom2, one}}},
{Coins{{testDenom1, two}}, Coins{{testDenom2, zero}}, Coins{{testDenom1, two}}},
{Coins{{testDenom1, one}}, Coins{{testDenom1, one}, {testDenom2, two}}, Coins{{testDenom1, two}, {testDenom2, two}}},
{Coins{{testDenom1, zero}, {testDenom2, zero}}, Coins{{testDenom1, zero}, {testDenom2, zero}}, Coins(nil)},
{Coins{{testDenom1, one}, {testDenom2, one}}, Coins{{testDenom1, one}, {testDenom2, one}}, Coins{{testDenom1, two}, {testDenom2, two}}, false},
{Coins{{testDenom1, zero}, {testDenom2, one}}, Coins{{testDenom1, zero}, {testDenom2, zero}}, Coins{{testDenom2, one}}, false},
{Coins{{testDenom1, two}}, Coins{{testDenom2, zero}}, Coins{{testDenom1, two}}, false},
{Coins{{testDenom1, one}}, Coins{{testDenom1, one}, {testDenom2, two}}, Coins{{testDenom1, two}, {testDenom2, two}}, false},
{Coins{{testDenom1, zero}, {testDenom2, zero}}, Coins{{testDenom1, zero}, {testDenom2, zero}}, Coins(nil), false},
{Coins{{testDenom1, zero}}, Coins{{testDenomInvalid, one}}, Coins{}, true},
}

for tcIndex, tc := range cases {
res := tc.inputOne.Add(tc.inputTwo)
assert.True(t, res.IsValid())
require.Equal(t, tc.expected, res, "sum of coins is incorrect, tc #%d", tcIndex)
if tc.panics {
require.Panics(t, func() { tc.inputOne.Add(tc.inputTwo) })
} else {
res := tc.inputOne.Add(tc.inputTwo)
assert.True(t, res.IsValid())
require.Equal(t, tc.expected, res, "sum of coins is incorrect, tc #%d", tcIndex)
}
}
}

Expand Down Expand Up @@ -434,6 +452,8 @@ func TestParse(t *testing.T) {
{"2 3foo, 97 bar", false, nil}, // 3foo is invalid coin name
{"11me coin, 12you coin", false, nil}, // no spaces in coin names
{"1.2btc", false, nil}, // amount must be integer
{"-5foo", false, nil}, // amount must be positive
{"5Foo", false, nil}, // denom must be lowercase
}

for tcIndex, tc := range cases {
Expand Down Expand Up @@ -615,6 +635,17 @@ func TestNewCoins(t *testing.T) {
tenatom := NewCoin("atom", 10)
tenbtc := NewCoin("btc", 10)
zeroeth := NewCoin("eth", 0)

// don't use NewCoin(...) to avoid early panic
uppercase := Coin{
Denom: "UPC",
Amount: 10,
}
negative := Coin{
Denom: "neg",
Amount: -5,
}

tests := []struct {
name string
coins Coins
Expand All @@ -625,6 +656,8 @@ func TestNewCoins(t *testing.T) {
{"one coin", []Coin{tenatom}, Coins{tenatom}, false},
{"sort after create", []Coin{tenbtc, tenatom}, Coins{tenatom, tenbtc}, false},
{"sort and remove zeroes", []Coin{zeroeth, tenbtc, tenatom}, Coins{tenatom, tenbtc}, false},
{"panic on uppercase denom", []Coin{uppercase}, Coins{}, true},
{"panic on negative amount", []Coin{negative}, Coins{}, true},
{"panic on dups", []Coin{tenatom, tenatom}, Coins{}, true},
}
for _, tt := range tests {
Expand Down
Loading