fix: RegisterLegacyAminoCodec should error if Msg name is >39 chars #414
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package legacy | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| ) | ||
|
|
||
| // RegisterAminoMsg first checks that the msgName is <40 chars | ||
| // (else this would break ledger nano signing: https://github.com/cosmos/cosmos-sdk/issues/10870), | ||
| // then registers the concrete msg type with amino. | ||
| func RegisterAminoMsg(cdc *codec.LegacyAmino, msg sdk.Msg, msgName string) { | ||
| if len(msgName) > 39 { | ||
| panic(fmt.Errorf("msg name %s is too long to be registered with amino", msgName)) | ||
| } | ||
| cdc.RegisterConcrete(msg, msgName, nil) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package legacy_test | ||
|
|
||
| import ( | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| "github.com/cosmos/cosmos-sdk/codec/legacy" | ||
| "github.com/cosmos/cosmos-sdk/testutil/testdata" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestRegisterAminoMsg(t *testing.T) { | ||
| cdc := codec.NewLegacyAmino() | ||
|
|
||
| testCases := map[string]struct { | ||
| msgName string | ||
| expPanic bool | ||
| }{ | ||
| "all good": { | ||
| msgName: "cosmos-sdk/Test", | ||
| }, | ||
| "msgName too long": { | ||
| msgName: strings.Repeat("a", 40), | ||
| expPanic: true, | ||
| }, | ||
| } | ||
| for name, tc := range testCases { | ||
| t.Run(name, func(t *testing.T) { | ||
| fn := func() { legacy.RegisterAminoMsg(cdc, &testdata.TestMsg{}, tc.msgName) } | ||
| if tc.expPanic { | ||
| require.Panics(t, fn) | ||
| } else { | ||
| require.NotPanics(t, fn) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| // Package legacy contains a global amino Cdc which is deprecated but | ||
| // still used in several places within the SDK. This package is intended | ||
| // to be removed at some point in the future when the global Cdc is removed. | ||
| // It also contains a util function RegisterAminoMsg that checks a msg name length | ||
| // before registering the concrete msg type with amino. | ||
| package legacy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to my other comment. Just noting that this registers a new message, which doesn't seem related to the size limit.