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

fix: replace IsEqual with Equal #14739

Merged
merged 6 commits into from
Jan 24, 2023
Merged

fix: replace IsEqual with Equal #14739

merged 6 commits into from
Jan 24, 2023

Conversation

EmilGeorgiev
Copy link
Contributor

@EmilGeorgiev EmilGeorgiev commented Jan 23, 2023 •
edited
Loading

Description

Closes: #3246

replace the method Coin.IsEqual with Coin.Equal. The main difference between the two methods is that the first one rise a panic when denoms are not equal. This panic may lead to unexpected behavior

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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • [x ] reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers 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...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@EmilGeorgiev EmilGeorgiev force-pushed the EmilGeorgiev/fix-replace-IsEqual-with-Equal branch from 5066965 to ba6478b Compare January 23, 2023 18:38
@EmilGeorgiev EmilGeorgiev changed the title Emil georgiev/fix replace is equal with equal fix: replace IsEqual with Equal Jan 23, 2023
@EmilGeorgiev EmilGeorgiev force-pushed the EmilGeorgiev/fix-replace-IsEqual-with-Equal branch from 07ad1cb to 0426409 Compare January 23, 2023 18:57
@EmilGeorgiev
fix: replace the Coin.IsEqual with Coin.Equal
97ae555 
The method IsEqual throw panic if the denoms of two coins are not equal. This lead to unexpected
behavior of the, becasue in most of the cases the users expected an error to be returned

Issue: cosmos#3246
@EmilGeorgiev
hygiene: rename method IsEqual to Equal
699b185 
Rename method IsEqual of the type Coins to Equal to follow standardize terminology for 'Equal; function on structs

Refs: cosmos#3246
@EmilGeorgiev
hygiene: rename method Dec.IsEqual to Dec.Equal
a685604 
Refs: cosmos#3246
@EmilGeorgiev
fix: Replace the method DecCoin.IsEqual with DecCoin.Equal
e693abb 
Refs: cosmos#3246
@EmilGeorgiev EmilGeorgiev force-pushed the EmilGeorgiev/fix-replace-IsEqual-with-Equal branch from dd54135 to e693abb Compare January 24, 2023 05:05
@EmilGeorgiev EmilGeorgiev marked this pull request as ready for review January 24, 2023 06:22
@EmilGeorgiev EmilGeorgiev requested a review from a team as a code owner January 24, 2023 06:22
likhita-809
likhita-809 approved these changes Jan 24, 2023
View reviewed changes
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

lgtm

julienrbrt
julienrbrt approved these changes Jan 24, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Thank you!

@EmilGeorgiev
Copy link
Contributor Author

I don't have write access to the repository, so I can't merge the PR.

tac0turtle
tac0turtle reviewed Jan 24, 2023
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
@tac0turtle
Copy link
Member

thanks for the contribution

@tac0turtle tac0turtle enabled auto-merge (squash) January 24, 2023 09:30
@tac0turtle tac0turtle merged commit e9fbb01 into cosmos:main Jan 24, 2023
@ulbqb ulbqb mentioned this pull request Mar 27, 2024
Merged
5 tasks
@mergify mergify bot mentioned this pull request Mar 27, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

@likhita-809 likhita-809 likhita-809 approved these changes

@aaronc aaronc Awaiting requested review from aaronc aaronc is a code owner

@testinginprod testinginprod Awaiting requested review from testinginprod testinginprod is a code owner

Assignees
No one assigned
Labels
C:x/auth C:x/bank C:x/distribution distribution module related C:x/gov C:x/group C:x/slashing C:x/staking
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Standardize on terminology for Equal function on structs
4 participants
@EmilGeorgiev @tac0turtle @julienrbrt @likhita-809