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

RegisterLegacyAminoCodec should error if Msg name is >39 chars #10870

Closed
4 tasks
amaury1093 opened this issue Jan 4, 2022 · 1 comment · Fixed by #11349
Closed
4 tasks

RegisterLegacyAminoCodec should error if Msg name is >39 chars #10870

amaury1093 opened this issue Jan 4, 2022 · 1 comment · Fixed by #11349
Assignees
@blushi
Labels
C:Encoding

Comments

@amaury1093
Copy link
Contributor

amaury1093 commented Jan 4, 2022 •
edited by blushi
Loading

Summary

Make sure the Msg names (e.g. cosmos-sdk/MsgSend) are all < 40chars.

Problem Definition

At regen, we found an occasion where we couldn't sign on Ledger because a custom Msg name was >=40 chars: regen-network/regen-ledger#468. (Maybe it's this const)

We should catch that early.

Proposal

Create a new function RegisterAminoMsg(aminoCdc, msg, msgName) that would 1/ check that the Msg name is <40 chars and 2/ register that Msg within amino. RegisterAminoMsg panics (on startup) if the msgName is too long.

Then, everywhere where we register amino, e.g.

cosmos-sdk/x/bank/types/codec.go

Line 15 in bdee333

cdc.RegisterConcrete(&MsgSend{}, "cosmos-sdk/MsgSend", nil)

we would do:

- cdc.RegisterConcrete(&MsgSend{}, "cosmos-sdk/MsgSend", nil) 
+ RegisterAminoMsg(cdc, &MsgSend{}, "cosmos-sdk/MsgSend")

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@ValarDragon
Copy link
Contributor

Thank you for making this issue! If you hadn't, we'd have been stuck with no ledger support / being forced to use Authz for ledger support for some osmosis txs in the upcoming upgrade.

@ValarDragon ValarDragon mentioned this issue Feb 25, 2022
Merged
4 tasks
@blushi blushi self-assigned this Mar 7, 2022
@blushi blushi changed the title RegisterLegacyAminoCodec should error if Msg name is >40 chars RegisterLegacyAminoCodec should error if Msg name is >39 chars Mar 10, 2022
@blushi blushi mentioned this issue Mar 10, 2022
Merged
19 tasks
@amaury1093 amaury1093 moved this from Ready to In Progress in Cosmos SDK Maintenance Mar 10, 2022
@amaury1093 amaury1093 moved this from In Progress to In Review in Cosmos SDK Maintenance Mar 14, 2022
@mergify mergify bot closed this as completed in #11349 Mar 16, 2022
Repository owner moved this from In Review to Done in Cosmos SDK Maintenance Mar 16, 2022
mergify bot pushed a commit that referenced this issue Mar 16, 2022
@blushi
fix: RegisterLegacyAminoCodec should error if Msg name is >39 chars (#…
e0f812d 
…11349)

## Description

Closes: #10870



---

### 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)
- [x] 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)
@ValarDragon ValarDragon mentioned this issue Mar 16, 2022
Closed
@kevinstubbs kevinstubbs mentioned this issue Sep 19, 2022
Open
@xlab xlab mentioned this issue Mar 13, 2023
Closed
@DracoLi DracoLi mentioned this issue Mar 15, 2023
Merged
@mattverse mattverse mentioned this issue May 15, 2023
Merged
@dadamu dadamu mentioned this issue Jun 30, 2023
Merged
19 tasks
RiccardoM pushed a commit to desmos-labs/desmos that referenced this issue Jun 30, 2023
@dadamu
refactor: use RegisterAminoMsg to register Amino encodings (#1187)
6a228c0 
## Description

This PR replaces legacy amino registration of msgs into
`RegisterAminoMsg` in order to avoid the bug that a registered Msg name
that is too long when signing on ledger Nano device. See:
cosmos/cosmos-sdk#10870

<!-- Add a description of the changes that this PR introduces and the
files that
are the most critical to review. -->

---

### 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/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building
modules](https://docs.cosmos.network/v0.44/building-modules/intro.html)
- [ ] included the necessary unit and integration
[tests](https://github.com/desmos-labs/desmos/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)
@xlab xlab mentioned this issue Jul 16, 2023
Merged
19 tasks
@Ehsan-saradar Ehsan-saradar mentioned this issue Oct 2, 2023
Closed
@dudong2 dudong2 mentioned this issue Jul 26, 2024
Closed
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blushi blushi

Labels
C:Encoding
Projects
No open projects
Cosmos SDK Maintenance
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: RegisterLegacyAminoCodec should error if Msg name is >39 chars cosmos/cosmos-sdk
3 participants
@amaury1093 @blushi @ValarDragon