From ca02c79a48a79b1a065503e60f2022998137743b Mon Sep 17 00:00:00 2001 From: NagaTulasi Date: Wed, 13 Apr 2022 15:53:55 +0530 Subject: [PATCH 1/5] safesub added --- types/coin.go | 15 ++++++++++++--- types/coin_test.go | 24 ++++++++++++++++++++++++ x/staking/types/authz.go | 8 +++----- 3 files changed, 39 insertions(+), 8 deletions(-) diff --git a/types/coin.go b/types/coin.go index d523c806154a..c93dbd8d6050 100644 --- a/types/coin.go +++ b/types/coin.go @@ -118,16 +118,25 @@ func (coin Coin) AddAmount(amount Int) Coin { // Sub subtracts amounts of two coins with same denom. If the coins differ in denom // then it panics. func (coin Coin) Sub(coinB Coin) Coin { + res, err := coin.SafeSub(coinB) + if err != nil { + panic(err) + } + + return res +} + +func (coin Coin) SafeSub(coinB Coin) (Coin, error) { if coin.Denom != coinB.Denom { - panic(fmt.Sprintf("invalid coin denominations; %s, %s", coin.Denom, coinB.Denom)) + return Coin{}, fmt.Errorf("invalid coin denoms: %s, %s", coin.Denom, coinB.Denom) } res := Coin{coin.Denom, coin.Amount.Sub(coinB.Amount)} if res.IsNegative() { - panic("negative coin amount") + return Coin{}, fmt.Errorf("negative coin amount") } - return res + return res, nil } // SubAmount subtracts an amount from the Coin. diff --git a/types/coin_test.go b/types/coin_test.go index 8252b0f1b462..4ede386e3d49 100644 --- a/types/coin_test.go +++ b/types/coin_test.go @@ -505,6 +505,30 @@ func (s *coinTestSuite) TestSubCoins() { } } +func (s *coinTestSuite) TestSafeSubCoin() { + cases := []struct { + inputOne sdk.Coin + inputTwo sdk.Coin + expected sdk.Coin + expErrMsg string + }{ + {sdk.NewInt64Coin(testDenom1, 1), sdk.NewInt64Coin(testDenom2, 1), sdk.NewInt64Coin(testDenom1, 1), "invalid coin denoms"}, + {sdk.NewInt64Coin(testDenom1, 10), sdk.NewInt64Coin(testDenom1, 1), sdk.NewInt64Coin(testDenom1, 9), ""}, + {sdk.NewInt64Coin(testDenom1, 5), sdk.NewInt64Coin(testDenom1, 0), sdk.NewInt64Coin(testDenom1, 5), ""}, + {sdk.NewInt64Coin(testDenom1, 1), sdk.NewInt64Coin(testDenom1, 5), sdk.Coin{}, "negative coin amount"}, + } + + for _, tc := range cases { + tc := tc + res, err := tc.inputOne.SafeSub(tc.inputTwo) + if err != nil { + s.Require().Contains(err.Error(), tc.expErrMsg) + return + } + s.Require().Equal(tc.expected, res) + } +} + func (s *coinTestSuite) TestCoins_Validate() { testCases := []struct { name string diff --git a/x/staking/types/authz.go b/x/staking/types/authz.go index e26712ade2e4..b3d6e9e95c6d 100644 --- a/x/staking/types/authz.go +++ b/x/staking/types/authz.go @@ -103,12 +103,10 @@ func (a StakeAuthorization) Accept(ctx sdk.Context, msg sdk.Msg) (authz.AcceptRe Updated: &StakeAuthorization{Validators: a.GetValidators(), AuthorizationType: a.GetAuthorizationType()}}, nil } - // check sufficient balance exists. - if _, isNegative := sdk.NewCoins(*a.MaxTokens).SafeSub(sdk.NewCoins(amount)); isNegative { - return authz.AcceptResponse{}, sdkerrors.ErrInsufficientFunds.Wrapf("amount is more than max tokens") + limitLeft, err := a.MaxTokens.SafeSub(amount) + if err != nil { + return authz.AcceptResponse{}, sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, "negative coin amount") } - - limitLeft := a.MaxTokens.Sub(amount) if limitLeft.IsZero() { return authz.AcceptResponse{Accept: true, Delete: true}, nil } From aef468e6678897b047453e83ce8784c608286ba1 Mon Sep 17 00:00:00 2001 From: NagaTulasi Date: Wed, 13 Apr 2022 18:14:15 +0530 Subject: [PATCH 2/5] Added Changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 487c256e03bb..e22efbaa9f8d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -206,6 +206,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Bug Fixes +* [\#11630](https://github.com/cosmos/cosmos-sdk/pull/11630) Added SafeSub method to avoid panic in Sub method for sdk.Coin * [\#11558](https://github.com/cosmos/cosmos-sdk/pull/11558) Fix `--dry-run` not working when using tx command. * [\#11354](https://github.com/cosmos/cosmos-sdk/pull/11355) Added missing pagination flag for `bank q total` query. * [\#11197](https://github.com/cosmos/cosmos-sdk/pull/11197) Signing with multisig now works with multisig address which is not in the keyring. From ed84d38b599854feed2e6307d043ba5504b17437 Mon Sep 17 00:00:00 2001 From: NagaTulasi Date: Wed, 13 Apr 2022 18:37:21 +0530 Subject: [PATCH 3/5] Updated Changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e22efbaa9f8d..630e0fc29e58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -175,6 +175,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements +* [\#11630](https://github.com/cosmos/cosmos-sdk/pull/11630) Added SafeSub method to avoid panic in Sub method for sdk.Coin * [\#11511](https://github.com/cosmos/cosmos-sdk/pull/11511) Add api server flags to start command. * [\#11484](https://github.com/cosmos/cosmos-sdk/pull/11484) Implement getter for keyring backend option. * [\#11449](https://github.com/cosmos/cosmos-sdk/pull/11449) Improved error messages when node isn't synced. @@ -206,7 +207,6 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Bug Fixes -* [\#11630](https://github.com/cosmos/cosmos-sdk/pull/11630) Added SafeSub method to avoid panic in Sub method for sdk.Coin * [\#11558](https://github.com/cosmos/cosmos-sdk/pull/11558) Fix `--dry-run` not working when using tx command. * [\#11354](https://github.com/cosmos/cosmos-sdk/pull/11355) Added missing pagination flag for `bank q total` query. * [\#11197](https://github.com/cosmos/cosmos-sdk/pull/11197) Signing with multisig now works with multisig address which is not in the keyring. From 04163b072c12d2ff2e02651b96fc9d7d45d4e31b Mon Sep 17 00:00:00 2001 From: NagaTulasi Date: Wed, 13 Apr 2022 20:38:09 +0530 Subject: [PATCH 4/5] add godocs --- types/coin.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/types/coin.go b/types/coin.go index c93dbd8d6050..ffffa5a6685e 100644 --- a/types/coin.go +++ b/types/coin.go @@ -115,8 +115,7 @@ func (coin Coin) AddAmount(amount Int) Coin { return Coin{coin.Denom, coin.Amount.Add(amount)} } -// Sub subtracts amounts of two coins with same denom. If the coins differ in denom -// then it panics. +// Sub subtracts amounts of two coins with same denom and panics on error. func (coin Coin) Sub(coinB Coin) Coin { res, err := coin.SafeSub(coinB) if err != nil { @@ -126,6 +125,8 @@ func (coin Coin) Sub(coinB Coin) Coin { return res } +// SafeSub safely subtracts the amounts of two coins. It returns an error if the coins differ +// in denom or subtraction results in negative coin denom. func (coin Coin) SafeSub(coinB Coin) (Coin, error) { if coin.Denom != coinB.Denom { return Coin{}, fmt.Errorf("invalid coin denoms: %s, %s", coin.Denom, coinB.Denom) From 248e1a0c1e2a7d311ee165fbb5d8c761927fcf5e Mon Sep 17 00:00:00 2001 From: NagaTulasi Date: Thu, 14 Apr 2022 22:24:43 +0530 Subject: [PATCH 5/5] Review comments addressed --- CHANGELOG.md | 2 +- x/staking/types/authz.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 630e0fc29e58..606778bf535e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -175,7 +175,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements -* [\#11630](https://github.com/cosmos/cosmos-sdk/pull/11630) Added SafeSub method to avoid panic in Sub method for sdk.Coin +* [\#11630](https://github.com/cosmos/cosmos-sdk/pull/11630) Add SafeSub method to sdk.Coin. * [\#11511](https://github.com/cosmos/cosmos-sdk/pull/11511) Add api server flags to start command. * [\#11484](https://github.com/cosmos/cosmos-sdk/pull/11484) Implement getter for keyring backend option. * [\#11449](https://github.com/cosmos/cosmos-sdk/pull/11449) Improved error messages when node isn't synced. diff --git a/x/staking/types/authz.go b/x/staking/types/authz.go index b3d6e9e95c6d..6419ede7a702 100644 --- a/x/staking/types/authz.go +++ b/x/staking/types/authz.go @@ -105,7 +105,7 @@ func (a StakeAuthorization) Accept(ctx sdk.Context, msg sdk.Msg) (authz.AcceptRe limitLeft, err := a.MaxTokens.SafeSub(amount) if err != nil { - return authz.AcceptResponse{}, sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, "negative coin amount") + return authz.AcceptResponse{}, err } if limitLeft.IsZero() { return authz.AcceptResponse{Accept: true, Delete: true}, nil