fix: add extra check in vesting #15373

julienrbrt · 2023-03-13T16:47:36Z

Description

Closes: #XXXX

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

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)

julienrbrt · 2023-03-13T17:08:34Z

x/auth/posthandler/tips.go

@@ -47,5 +49,10 @@ func (d tipDecorator) transferTip(ctx sdk.Context, sdkTx sdk.Tx) error {
 return err
 }

- return d.bankKeeper.SendCoins(ctx, tipper, tipTx.FeePayer(), tipTx.GetTip().Amount)
+ coins := tipTx.GetTip().Amount


This will not be backported to v0.46.

facundomedica

utACK

alexanderbez · 2023-03-13T21:56:10Z

x/auth/posthandler/tips.go

+ if err := d.bankKeeper.IsSendEnabledCoins(ctx, coins...); err != nil {
+ return fmt.Errorf("cannot tip these coins: %w", err)
+ }


Q: Why not move the IsSendEnabledCoins check directly into SendCoins and avoid having to have this check elsewhere potentially missing it.

This made sense to me, however we don't know how people are using our API and expect them to work.
Do you think that behavior change on such a core feature is acceptable?

I would imagine if a coin cannot be sent, as dictated by SendEnabled, then I'd expect SendCoins to fail/error.

Yes, I agree. However, we don't know if module devs made another (even though wrong) assumption.
Say you have a module that allows an authority only to moves send disabled denom, then this change in the SDK would break it.
It is safer keeping the status quo, imho.

I would say that breaks the safety model then and introduces a misuse of the APIs. If such a case exists, then I would introduce a new SendCoinsUnsafe API or something similar that bypasses such checks.

Just my 2 cents. Not a hill I'll die on, so I'm happy to approve this PR if you really thing this is the ideal approach.

I am more afraid to break, people's code by a change of code behavior.
I've looked deeper when is used IsSendEnabledCoins, and it is usually used way before calling SendCoins and before creating accounts in vesting, or in bank send in the SDK.
SendCoins on the other hand, is very, very much used and very commonly without that check: https://cs.github.com/?scopeName=All+repos&scope=&q=.SendCoins%28+language%3AGo.

I am going to merge it now, but this is maybe something we need to talk about. Personally, I agree with you, SendCoinsFromModuleToAccount checks if it is a blocked account, for instance, so we do have safety checks in another bank send method.

atheeshp · 2023-03-14T06:13:44Z

x/auth/vesting/msg_server.go

+ if err := bk.IsSendEnabledCoins(ctx, totalCoins...); err != nil {
+ return nil, err
+ }
+


should we update changelog?

Yes, but I'll do that in the backport PR, just to have on conflict less to fix in v0.47 :)

samricotta · 2023-03-14T07:28:17Z

x/auth/vesting/msg_server.go

@@ -188,8 +189,7 @@ func (s msgServer) CreatePeriodicVestingAccount(goCtx context.Context, msg *type
 }
 }()

- err = bk.SendCoins(ctx, from, to, totalCoins)
- if err != nil {
+ if err = bk.SendCoins(ctx, from, to, totalCoins); err != nil {


More a question, what is the point in changing these

Compacter code but that's it

## Description Closes: #XXXX --- ### 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/main/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/main/docs/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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) (cherry picked from commit 721c24a) # Conflicts: # x/auth/testutil/expected_keepers_mocks.go # x/auth/vesting/msg_server_test.go

## Description Closes: #XXXX --- ### 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/main/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/main/docs/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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) (cherry picked from commit 721c24a)

Co-authored-by: Julien Robert <julien@rbrt.fr>

…os#15383)" This reverts commit f382e43.

* fix: create snapshot dir for rocksdb backend (backport cosmos#15054) (cosmos#15065) Co-authored-by: yihuang <huang@crypto.com> * chore: Add check for uneven stores' height (backport cosmos#14410) (cosmos#15115) Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * refactor!: remove store v2alpha1 (cosmos#15152) * build: use cometbft in v0.46 (cosmos#15090) * chore: bump cometbft to v0.34.27 final (cosmos#15206) * fix: Change proposer address cast for `sdk_block` conversion (backport cosmos#15243) (cosmos#15245) Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * fix: revert double close fix (cosmos#15255) * chore: prepare v0.46.11 release (cosmos#15259) * feat: add extend cb to avoid unmarshal state twice for sim test (backport: cosmos#15305) (cosmos#15321) * feat: add extend cb with genesisState for sim test (backport: cosmos#15305) (cosmos#15349) * fix: add extra check in vesting (backport cosmos#15373) (cosmos#15383) Co-authored-by: Julien Robert <julien@rbrt.fr> * docs: update cosmwasm link (cosmos#15441) * fix: remove extra `;` in service.proto (cosmos#15443) * fix: flaky group genesis sim (backport cosmos#15447) (cosmos#15461) Co-authored-by: Robert Zaremba <robert@zaremba.ch> * feat: add delegator to withdraw address (backport cosmos#15462) (cosmos#15473) Co-authored-by: Marko <marbar3778@yahoo.com> * docs: improve proto vesting docs about time attributes (backport cosmos#15474) (cosmos#15481) Co-authored-by: Julien Robert <julien@rbrt.fr> * feat: add query `groups` in `x/group` (backport cosmos#14879) (cosmos#15476) Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * fix: Makefile rocksdb (backport cosmos#15422) (cosmos#15525) Co-authored-by: Robert Zaremba <robert@zaremba.ch> * fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667) Co-authored-by: Daniel Wedul <github@wedul.com> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * fix: remove unnecessary cms typecasting (backport cosmos#14054) (cosmos#15669) Co-authored-by: Javier Su <javier.su.weijie@gmail.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * chore: prepare v0.46.12 release notes (cosmos#15685) * fix: upstream error on empty version (backport cosmos#13355) (cosmos#15717) Co-authored-by: Marko <marbar3778@yahoo.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * feat: More flexibility for `CacheMultiStoreWithVersion` (backport cosmos#15683) (cosmos#15775) Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * feat: add moduleStateCb to allow access moduleState in sim test (backport cosmos#15903) (cosmos#15925) Co-authored-by: mmsqe <tqd0800210105@gmail.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * build(deps): bump cometbft to v0.34.28 (cosmos#15973) * chore(gov): improve proposal conversion error message (backport cosmos#15979) (cosmos#15981) Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * feat!: bootstrap comet cmd for local state sync (backport cosmos#16061) (cosmos#16080) Co-authored-by: Marko <marbar3778@yahoo.com> * chore(auth/vesting): fix typo in `create-period-vesting-account` cmd example (backport cosmos#16085) (cosmos#16087) Co-authored-by: Julien Robert <julien@rbrt.fr> * feat: add local snapshots management commands (backport cosmos#16067) (cosmos#16103) Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * fix: snapshot commands panic if snapshot don't exists (backport cosmos#16138) (cosmos#16140) Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * feat: add Close method for resource cleanup in graceful shutdown (backport cosmos#16193) (cosmos#16205) Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * feat: save restored snapshot locally (backport cosmos#16060) (cosmos#16262) Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * chore: update sidebar v0.46 (cosmos#16304) * chore: add baseapp circuit breaker setter (cosmos#16289) Co-authored-by: Julien Robert <julien@rbrt.fr> * fix: allow any address in `ValidatePromptAddress` (backport cosmos#16312) (cosmos#16314) Co-authored-by: Julien Robert <julien@rbrt.fr> * feat(group): add group event tally result (backport cosmos#16191) (cosmos#16306) Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * fix: Revert "fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)" (cosmos#16331) * chore: prepare v0.46.13 (cosmos#16249) * chore: small snapshot commands & docs improvement (backport cosmos#16404) (cosmos#16409) Co-authored-by: Julien Robert <julien@rbrt.fr> * Add the quarantine and sanction stores to the import-export sim test. * refactor: avoid breaking change due to cosmos#16415 included in v0.50 (backport cosmos#16430) (cosmos#16432) Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Facundo Medica <facundomedica@gmail.com> * chore: prepare v0.46.13 (2/2) (cosmos#16443) * fix: patch barberry (cosmos#16466) * Better gov prop error handling. * Fix the group sims random genesis so it can't pick the same account twice for the group policies since that address is the primary key for the table. Also, output the genesis state after it's randomized just like all the other modules do. * Add changelog entries. * Regen the swagger docs. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com> Co-authored-by: mmsqe <mavis@crypto.com> Co-authored-by: Robert Zaremba <robert@zaremba.ch> Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Javier Su <javier.su.weijie@gmail.com> Co-authored-by: mmsqe <tqd0800210105@gmail.com> Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com> Co-authored-by: Facundo Medica <facundomedica@gmail.com>

* fix: create snapshot dir for rocksdb backend (backport cosmos#15054) (cosmos#15065) * chore: Add check for uneven stores' height (backport cosmos#14410) (cosmos#15115) * refactor!: remove store v2alpha1 (cosmos#15152) * build: use cometbft in v0.46 (cosmos#15090) * chore: bump cometbft to v0.34.27 final (cosmos#15206) * fix: Change proposer address cast for `sdk_block` conversion (backport cosmos#15243) (cosmos#15245) * fix: revert double close fix (cosmos#15255) * chore: prepare v0.46.11 release (cosmos#15259) * feat: add extend cb to avoid unmarshal state twice for sim test (backport: cosmos#15305) (cosmos#15321) * feat: add extend cb with genesisState for sim test (backport: cosmos#15305) (cosmos#15349) * fix: add extra check in vesting (backport cosmos#15373) (cosmos#15383) * docs: update cosmwasm link (cosmos#15441) * fix: remove extra `;` in service.proto (cosmos#15443) * fix: flaky group genesis sim (backport cosmos#15447) (cosmos#15461) * feat: add delegator to withdraw address (backport cosmos#15462) (cosmos#15473) * docs: improve proto vesting docs about time attributes (backport cosmos#15474) (cosmos#15481) * feat: add query `groups` in `x/group` (backport cosmos#14879) (cosmos#15476) * fix: Makefile rocksdb (backport cosmos#15422) (cosmos#15525) * fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667) * fix: remove unnecessary cms typecasting (backport cosmos#14054) (cosmos#15669) * chore: prepare v0.46.12 release notes (cosmos#15685) * fix: upstream error on empty version (backport cosmos#13355) (cosmos#15717) * feat: More flexibility for `CacheMultiStoreWithVersion` (backport cosmos#15683) (cosmos#15775) * feat: add moduleStateCb to allow access moduleState in sim test (backport cosmos#15903) (cosmos#15925) * build(deps): bump cometbft to v0.34.28 (cosmos#15973) * chore(gov): improve proposal conversion error message (backport cosmos#15979) (cosmos#15981) * feat!: bootstrap comet cmd for local state sync (backport cosmos#16061) (cosmos#16080) * chore(auth/vesting): fix typo in `create-period-vesting-account` cmd example (backport cosmos#16085) (cosmos#16087) * feat: add local snapshots management commands (backport cosmos#16067) (cosmos#16103) * fix: snapshot commands panic if snapshot don't exists (backport cosmos#16138) (cosmos#16140) * feat: add Close method for resource cleanup in graceful shutdown (backport cosmos#16193) (cosmos#16205) * feat: save restored snapshot locally (backport cosmos#16060) (cosmos#16262) * chore: update sidebar v0.46 (cosmos#16304) * chore: add baseapp circuit breaker setter (cosmos#16289) * fix: allow any address in `ValidatePromptAddress` (backport cosmos#16312) (cosmos#16314) * feat(group): add group event tally result (backport cosmos#16191) (cosmos#16306) * fix: Revert "fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)" (cosmos#16331) * chore: prepare v0.46.13 (cosmos#16249) * chore: small snapshot commands & docs improvement (backport cosmos#16404) (cosmos#16409) * Add the quarantine and sanction stores to the import-export sim test. * refactor: avoid breaking change due to cosmos#16415 included in v0.50 (backport cosmos#16430) (cosmos#16432) * chore: prepare v0.46.13 (2/2) (cosmos#16443) * fix: patch barberry (cosmos#16466) * Better gov prop error handling. * Fix the group sims random genesis so it can't pick the same account twice for the group policies since that address is the primary key for the table. Also, output the genesis state after it's randomized just like all the other modules do. * Add changelog entries. * Regen the swagger docs. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com> Co-authored-by: mmsqe <mavis@crypto.com> Co-authored-by: Robert Zaremba <robert@zaremba.ch> Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Javier Su <javier.su.weijie@gmail.com> Co-authored-by: mmsqe <tqd0800210105@gmail.com> Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com> Co-authored-by: Facundo Medica <facundomedica@gmail.com>

julienrbrt added 2 commits March 9, 2023 10:53

fix: add extra check in vesting

2ae109e

updates

0dc4e29

julienrbrt requested a review from a team as a code owner March 13, 2023 16:47

github-actions bot added the C:x/auth label Mar 13, 2023

Merge branch 'main' into julien/vesting

16ff5b7

julienrbrt added backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release labels Mar 13, 2023

make mcoks

2349ebb

julienrbrt commented Mar 13, 2023

View reviewed changes

Merge branch 'main' into julien/vesting

c15ae34

facundomedica approved these changes Mar 13, 2023

View reviewed changes

Merge branch 'main' into julien/vesting

dda7318

alexanderbez reviewed Mar 13, 2023

View reviewed changes

Merge branch 'main' into julien/vesting

4ab1005

atheeshp approved these changes Mar 14, 2023

View reviewed changes

samricotta reviewed Mar 14, 2023

View reviewed changes

samricotta approved these changes Mar 14, 2023

View reviewed changes

julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 14, 2023

mergify bot merged commit 721c24a into main Mar 14, 2023

mergify bot deleted the julien/vesting branch March 14, 2023 09:18

This was referenced Mar 14, 2023

fix: add extra check in vesting (backport #15373) #15382

Merged

fix: add extra check in vesting (backport #15373) #15383

Merged

julienrbrt added a commit that referenced this pull request Mar 14, 2023

fix: add extra check in vesting (backport #15373) (#15383)

f382e43

Co-authored-by: Julien Robert <julien@rbrt.fr>

julienrbrt added a commit that referenced this pull request Mar 14, 2023

fix: add extra check in vesting (backport #15373) (#15382)

7106134

Co-authored-by: Julien Robert <julien@rbrt.fr>

GAtom22 added a commit to evmos/cosmos-sdk that referenced this pull request Mar 23, 2023

Revert "fix: add extra check in vesting (backport cosmos#15373) (cosm…

e949ffd

…os#15383)" This reverts commit f382e43.

faddat mentioned this pull request Mar 28, 2023

update linter to 1521 ChihuahuaChain/cosmos-sdk#6

Closed

19 tasks

faddat mentioned this pull request Jun 8, 2023

barberry realiotech/cosmos-sdk#30

Merged

0xstepit mentioned this pull request Jul 1, 2024

chore(cachemulti): add Copy method evmos/cosmos-sdk#52

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add extra check in vesting #15373

fix: add extra check in vesting #15373

julienrbrt commented Mar 13, 2023

julienrbrt Mar 13, 2023

facundomedica left a comment

alexanderbez Mar 13, 2023

julienrbrt Mar 13, 2023

alexanderbez Mar 13, 2023

julienrbrt Mar 13, 2023 •

edited

Loading

alexanderbez Mar 14, 2023 •

edited

Loading

julienrbrt Mar 14, 2023

alexanderbez Mar 14, 2023

atheeshp Mar 14, 2023

julienrbrt Mar 14, 2023

samricotta Mar 14, 2023

julienrbrt Mar 14, 2023

fix: add extra check in vesting #15373

fix: add extra check in vesting #15373

Conversation

julienrbrt commented Mar 13, 2023

Description

Author Checklist

Reviewers Checklist

Choose a reason for hiding this comment

facundomedica left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

julienrbrt Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

alexanderbez Mar 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

julienrbrt Mar 13, 2023 •

edited

Loading

alexanderbez Mar 14, 2023 •

edited

Loading