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.

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

Add SafeSub for sdk.Coin #11603

Closed
4 tasks
atheeshp opened this issue Apr 12, 2022 · 4 comments · Fixed by #11630
Closed
4 tasks

Add SafeSub for sdk.Coin #11603

atheeshp opened this issue Apr 12, 2022 · 4 comments · Fixed by #11630

Comments

@atheeshp
Copy link
Contributor

atheeshp commented Apr 12, 2022

Summary

Coin.Sub panics on errors, instead returning error (ie, adding SafeSub method to Coin) would be helpful for operations inside other modules like x/authz

Problem Definition

Currently in staking authz we are using sdk.Coin for authorization.MaxTokens. sdk.Coin has Sub (which panics when balance goes to negative) method, but not SafeSub (which returns error when balance goes to negative) method.

ref: #11478

Proposal

Either convert the panic in Sub method to error or add SafeSub method for sdk.Coin.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@atheeshp atheeshp mentioned this issue Apr 12, 2022
4 tasks
@amaury1093 amaury1093 changed the title eliminate panic for sdk.Coin Add SafeSub for sdk.Coin Apr 12, 2022
@amaury1093
Copy link
Contributor

Either convert the panic in Sub method to error

That would be a big API breaking change, so I prefer to add SafeSub. It also aligns with sdk.Coins API.

@anilcse
Copy link
Collaborator

anilcse commented Apr 12, 2022

That would be a big API breaking change, so I prefer to add SafeSub. It also aligns with sdk.Coins API.

Yes, Let's add SafeSub method to the Coin.

@alexanderbez
Copy link
Contributor

alexanderbez commented Apr 12, 2022

Agreed. SafeSub sounds reasonable 👍

@anilcse you wanna take this on or should I?

@NagaTulasi
Copy link
Contributor

I can take up this issue.

@mergify mergify bot closed this as completed in #11630 Apr 14, 2022
Repository owner moved this from Ready to Done in Cosmos SDK Maintenance Apr 14, 2022
mergify bot pushed a commit that referenced this issue Apr 14, 2022
## Description

Closes: #11603



---

### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants