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

feat: replace all ModuleCdc instances with legacy.Cdc #11240

Merged
merged 10 commits into from
Feb 23, 2022
Merged

feat: replace all ModuleCdc instances with legacy.Cdc #11240

merged 10 commits into from
Feb 23, 2022

Conversation

RiccardoM
Copy link
Contributor

@RiccardoM RiccardoM commented Feb 21, 2022 •
edited
Loading

Description

Replaces all the various ModuleCdc instances with the global legacy.Cdc to properly support Amino serialization for the x/authz module. This is needed in order to correctly support Ledger signing for MsgExec and messages.

Closes: #11232

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
  • 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)

tac0turtle
tac0turtle approved these changes Feb 21, 2022
View reviewed changes
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

lgtm, can you add a changelog entry for this as well.

@RiccardoM
Copy link
Contributor Author

lgtm, can you add a changelog entry for this as well.

Done

@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Feb 21, 2022
@amaury1093
Copy link
Contributor

i'm not sure which should go first between this and #11224, I guess any is fine?

I just put automerge on. If @RiccardoM you can merge master into your branch, this can get merged

@tac0turtle
Copy link
Member

seems like tests are not liking the current changes, once they are fixed and the pr updated to master the bot will merge it

@RiccardoM
Copy link
Contributor Author

@marbar3778 @AmauryM The only test failing is the proposals testcase for TestDecodeStore. It fails with the following:

error marshaling into JSON: json: error calling MarshalJSON for type *types.Any: JSON marshal marshaling error for &Any{TypeUrl:/cosmos.gov.v1beta1.TextProposal,Value:[10 4 116 101 115 116 18 4 116 101 115 116],XXX_unrecognized:[]}, this is likely because amino is being used directly (instead of codec.LegacyAmino which is preferred) or UnpackInterfacesMessage is not defined for some type which contains a protobuf Any either directly or via one of its members.

Any idea how to fix this?

@amaury1093
Copy link
Contributor

amaury1093 commented Feb 22, 2022 •
edited
Loading

@RiccardoM Not sure about the above error yet (didn't reproduce, which TestDecodeStore is it? in gov?) but I think we should also register sdk.Msg on legacy.Cdc.

Inside codec/legacy/codec.go's init, add:

sdk.RegisterLegacyAminoCodec(Cdc)

it would solve this test

@RiccardoM
Merge branch 'master' of github.com:cosmos/cosmos-sdk into riccardo/r…
4adac64 
…eplace-amino-codec-with-global

� Conflicts:
�	CHANGELOG.md
�	x/auth/types/codec.go
�	x/bank/types/codec.go
�	x/crisis/types/codec.go
�	x/distribution/types/codec.go
�	x/evidence/types/codec.go
�	x/gov/types/v1beta1/codec.go
�	x/gov/types/v1beta2/codec.go
�	x/group/codec.go
�	x/slashing/types/codec.go
�	x/staking/types/codec.go
@RiccardoM
fixed auth test
3f61c30
@RiccardoM
added SDK Amino registration to global Amino codec
ff257ba
@RiccardoM
added back the registration of missing interfaces and concrete types …
c616bdd 
…for bank and staking authorizations
@RiccardoM
Copy link
Contributor Author

Thanks @AmauryM, seems like your fix also solved the other failing tests. Looks like it's ready to be merged

@mergify mergify bot merged commit ff31490 into cosmos:master Feb 23, 2022
RiccardoM added a commit to desmos-labs/cosmos-sdk that referenced this pull request Feb 24, 2022
@RiccardoM
feat: replace all ModuleCdc instances with legacy.Cdc (cosmos#11240)
ff65314 
## Description
Replaces all the various `ModuleCdc` instances with the global `legacy.Cdc` to properly support Amino serialization for the `x/authz` module. This is needed in order to correctly support Ledger signing for `MsgExec` and messages.

Closes: cosmos#11232

---

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

- [x] 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
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] 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
- [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](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 ff31490)
@RiccardoM RiccardoM mentioned this pull request Feb 25, 2022
Closed
19 tasks
@amaury1093 amaury1093 mentioned this pull request Mar 1, 2022
Merged
22 tasks
leobragaz pushed a commit to desmos-labs/cosmos-sdk that referenced this pull request Apr 5, 2022
@RiccardoM @leobragaz
feat: replace all ModuleCdc instances with legacy.Cdc (cosmos#11240)
ec177f4 
## Description
Replaces all the various `ModuleCdc` instances with the global `legacy.Cdc` to properly support Amino serialization for the `x/authz` module. This is needed in order to correctly support Ledger signing for `MsgExec` and messages.

Closes: cosmos#11232

---

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

- [x] 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
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] 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
- [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](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 ff31490)
@alexanderbez
Copy link
Contributor

@RiccardoM can you please revert this PR in favor of requiring developers to explicitly register their authz codec with other modules?

@amaury1093 amaury1093 mentioned this pull request Apr 14, 2022
Closed
4 tasks
RiccardoM added a commit to desmos-labs/cosmos-sdk that referenced this pull request Oct 25, 2022
@RiccardoM
feat: replace all ModuleCdc instances with legacy.Cdc (cosmos#11240)
3bf2ea3 
## Description
Replaces all the various `ModuleCdc` instances with the global `legacy.Cdc` to properly support Amino serialization for the `x/authz` module. This is needed in order to correctly support Ledger signing for `MsgExec` and messages.

Closes: cosmos#11232

---

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

- [x] 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
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] 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
- [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](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 ff31490)
@0Tech 0Tech mentioned this pull request Oct 27, 2022
Merged
3 tasks
RiccardoM added a commit to desmos-labs/cosmos-sdk that referenced this pull request Nov 14, 2022
@RiccardoM
feat: replace all ModuleCdc instances with legacy.Cdc (cosmos#11240)
76e99a1 
## Description
Replaces all the various `ModuleCdc` instances with the global `legacy.Cdc` to properly support Amino serialization for the `x/authz` module. This is needed in order to correctly support Ledger signing for `MsgExec` and messages.

Closes: cosmos#11232

---

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

- [x] 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
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] 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
- [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](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 ff31490)
@rhuairahrighairidh rhuairahrighairidh mentioned this pull request May 27, 2023
Merged
1 task
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

@amaury1093 amaury1093 amaury1093 approved these changes

@aaronc aaronc Awaiting requested review from aaronc

@alexanderbez alexanderbez Awaiting requested review from alexanderbez

@atheeshp atheeshp Awaiting requested review from atheeshp

Assignees
No one assigned
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:CLI C:Simulations C:x/auth C:x/bank C:x/crisis C:x/distribution distribution module related C:x/evidence C:x/gov C:x/params C:x/slashing C:x/staking C:x/upgrade
Projects
No open projects
Cosmos SDK: Core Development
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove module-level ModuleCdc, use the global legacy.Cdc
4 participants
@RiccardoM @amaury1093 @tac0turtle @alexanderbez