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.

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

Jump to bottom

docs(baseapp): fixed typo in baseapp/baseapp.go #19322

Closed
wants to merge 15 commits into from
Closed

docs(baseapp): fixed typo in baseapp/baseapp.go #19322

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a313e20
fix(internal): fixed it with the appropriate link
meetrick Jan 30, 2024
2ed6b77
Merge branch 'main' into main
meetrick Jan 30, 2024
b46904c
refactor!(core): add in environment bundler of service (#19041)
tac0turtle Jan 30, 2024
b0c1c9f
chore: fix spelling errors (#19289)
github-prbot Jan 30, 2024
5cc9c3c
docs: Update ADR-070 (#19296)
alexanderbez Jan 30, 2024
dcbb589
feat(types): Implement .IsGT for types.Coin (#19281)
spoo-bar Jan 30, 2024
c0e486a
fix(simapp): home flag is not respected (#18994)
PoisonPhang Jan 30, 2024
ba85b84
feat(types): Add a ValueCodec for Uint complex type (#19164)
relyt29 Jan 30, 2024
3521f61
feat(x/gov): add `yes_quorum` parameter (#19167)
julienrbrt Jan 30, 2024
21e5d5a
chore(ci): add coderabbit settings (#19307)
tac0turtle Jan 31, 2024
bde8101
chore: fix spelling errors (#19308)
github-prbot Jan 31, 2024
8941920
chore: remove deprecated functions SortJSON and MustSortJSON (#19306)
DimitrisJim Jan 31, 2024
717e570
docs: updates to abci documentation (#19309)
samricotta Jan 31, 2024
31e76f7
feat(store/v2): Commit SS and SC Async (#19313)
alexanderbez Jan 31, 2024
ff81885
docs(baseapp): fixed typo in `baseapp/baseapp.go`
meetrick Feb 1, 2024
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
Prev Previous commit
Next Next commit
feat(types): Implement .IsGT for types.Coin (#19281)
  • Loading branch information
@spoo-bar @meetrick
spoo-bar authored and meetrick committed Feb 1, 2024
commit dcbb5897f960bf4baaf700b55888aefd1bdf2ac5
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i

### Features

* (types) [#19281](https://github.com/cosmos/cosmos-sdk/pull/19281) Added a new method, `IsGT`, for `types.Coin`. This method is used to check if a `types.Coin` is greater than another `types.Coin`.
* (client) [#18557](https://github.com/cosmos/cosmos-sdk/pull/18557) Add `--qrcode` flag to `keys show` command to support displaying keys address QR code.
* (client) [#18101](https://github.com/cosmos/cosmos-sdk/pull/18101) Add a `keyring-default-keyname` in `client.toml` for specifying a default key name, and skip the need to use the `--from` flag when signing transactions.
* (tests) [#17868](https://github.com/cosmos/cosmos-sdk/pull/17868) Added helper method `SubmitTestTx` in testutil to broadcast test txns to test e2e tests.
Expand Down
10 changes: 10 additions & 0 deletions types/coin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ func (coin Coin) IsZero() bool {
return coin.Amount.IsZero()
}

// IsGT returns true if they are the same type and the receiver is
// a greater value
func (coin Coin) IsGT(other Coin) bool {
if coin.Denom != other.Denom {
panic(fmt.Sprintf("invalid coin denominations; %s, %s", coin.Denom, other.Denom))
}

return coin.Amount.GT(other.Amount)
}
Comment on lines +71 to +79
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation of IsGT method correctly checks if the receiver Coin is of greater value than the other Coin instance by comparing their denominations and amounts. However, using panic for handling different denominations is not ideal for production code as it can cause the application to crash. Consider returning an error instead, which allows the caller to handle this case more gracefully.

- panic(fmt.Sprintf("invalid coin denominations; %s, %s", coin.Denom, other.Denom))
+ return false, fmt.Errorf("invalid coin denominations; %s, %s", coin.Denom, other.Denom)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
// IsGT returns true if they are the same type and the receiver is
// a greater value
func (coin Coin) IsGT(other Coin) bool {
if coin.Denom != other.Denom {
panic(fmt.Sprintf("invalid coin denominations; %s, %s", coin.Denom, other.Denom))
}
return coin.Amount.GT(other.Amount)
}
// IsGT returns true if they are the same type and the receiver is
// a greater value
func (coin Coin) IsGT(other Coin) (bool, error) {
if coin.Denom != other.Denom {
return false, fmt.Errorf("invalid coin denominations; %s, %s", coin.Denom, other.Denom)
}
return coin.Amount.GT(other.Amount), nil
}


// IsGTE returns true if they are the same type and the receiver is
// an equal or greater value
func (coin Coin) IsGTE(other Coin) bool {
Expand Down
24 changes: 24 additions & 0 deletions types/coin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,30 @@ func (s *coinTestSuite) TestQuoIntCoins() {
}
}

func (s *coinTestSuite) TestIsGTCoin() {
cases := []struct {
inputOne sdk.Coin
inputTwo sdk.Coin
expected bool
panics bool
}{
{sdk.NewInt64Coin(testDenom1, 2), sdk.NewInt64Coin(testDenom1, 1), true, false},
{sdk.NewInt64Coin(testDenom1, 1), sdk.NewInt64Coin(testDenom1, 1), false, false},
{sdk.NewInt64Coin(testDenom1, 1), sdk.NewInt64Coin(testDenom1, 2), false, false},
{sdk.NewInt64Coin(testDenom1, 1), sdk.NewInt64Coin(testDenom2, 1), false, true},
}

for tcIndex, tc := range cases {
tc := tc
if tc.panics {
s.Require().Panics(func() { tc.inputOne.IsGT(tc.inputTwo) })
} else {
res := tc.inputOne.IsGT(tc.inputTwo)
s.Require().Equal(tc.expected, res, "coin GT relation is incorrect, tc #%d", tcIndex)
}
}
}

func (s *coinTestSuite) TestIsGTECoin() {
cases := []struct {
inputOne sdk.Coin
Expand Down