feat(types): Implement .IsGT for types.Coin #19281
Conversation
…/cosmos-sdk into spoorthi/add-coins-IsGT
WalkthroughThe recent updates introduce a method Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| // 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) | ||
| } |
There was a problem hiding this comment.
The implementation of IsGT method correctly compares two Coin instances to determine if the receiver coin's amount is greater than the other's, ensuring they have the same denomination. However, using panic for handling different denominations is not ideal for comparison operations, as it forces the caller to handle potential panics, which could be avoided with error handling.
Consider returning an error alongside the boolean result to handle denomination mismatches more gracefully, allowing the caller to decide how to handle such cases without the risk of a panic.
- func (coin Coin) IsGT(other Coin) bool {
+ func (coin Coin) IsGT(other Coin) (bool, error) {
if coin.Denom != other.Denom {
- 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)
}
- return coin.Amount.GT(other.Amount)
+ return coin.Amount.GT(other.Amount), nil
}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.
| // 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 | |
| } |
julienrbrt
changed the title
Description
Closes: #XXXX
Implements
.IsGT()for types.Coin.SDK already implements
.IsLT,.IsLTEand.IsGTE, but it does not implement.IsGT.It would be useful to add a new method to compare coins and have more consistency, since all the rest already exist.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...