fix(crypto): fix nested multisigs fail to marshal by catconcat · Pull Request #20404 · cosmos/cosmos-sdk

catconcat · 2024-05-15T17:37:10Z

Description

Closes: #20382

Issue appears after #19869, but I am unable to find the root of cause. ~~For now workaround Marshal -> MarshalJSON seems to fix the bug~~

Fixes the issue by overriding the MarshalAmino

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
confirmed ! in 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
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
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 all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Bug Fixes
- Improved JSON marshaling for multisig keys to ensure consistent data formatting.
Tests
- Added a new test to verify the output of nested multisig keys.
- Updated existing tests to focus on JSON marshaling for better coverage.

coderabbitai · 2024-05-15T17:37:18Z

Walkthrough

The changes primarily address a regression issue with nested multisigs in the Cosmos SDK. The Bytes() method in LegacyAminoPubKey now uses JSON marshaling instead of binary marshaling to resolve the issue. Corresponding test functions have been updated or added to ensure the correctness of JSON marshaling and nested multisig key outputs.

Changes

File Path	Change Summary
`crypto/keys/multisig/multisig.go`	Modified `Bytes()` method in `LegacyAminoPubKey` to use `AminoCdc.MustMarshalJSON(m)`.
`crypto/keys/multisig/multisig_test.go`	Replaced `TestAminoBinaryNested` with `TestAminoMarshalJSON` for testing JSON marshaling.
`crypto/keys/multisig/amino.go`	Added `MarshalAmino` and `UnmarshalAmino` functions to override amino binary marshaling. Adjusted `MarshalAminoJSON`.
`client/keys/output_test.go`	Added `TestBech32KeysOutputNestedMsig` to verify output of nested multisig key structures.

Assessment against linked issues

Objective	Addressed	Explanation
Resolve regression issue with nested multisigs failing marshal/unmarshal in main (#20382)	✅
Ensure JSON marshaling is used instead of binary marshaling for `LegacyAminoPubKey` (#20382)	✅
Add test functions to verify JSON marshaling and nested multisig key outputs (#20382)	✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1643711 and db715be.

Files selected for processing (3)

client/keys/output_test.go (1 hunks)
crypto/keys/multisig/multisig.go (1 hunks)
crypto/keys/multisig/multisig_test.go (1 hunks)

Files skipped from review due to trivial changes (1)

crypto/keys/multisig/multisig_test.go

Additional Context Used

Path-based Instructions (2)

client/keys/output_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

crypto/keys/multisig/multisig.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (2)

client/keys/output_test.go (1)

69-69: LGTM! The test function is well-implemented and covers the necessary cases.

crypto/keys/multisig/multisig.go (1)

44-44: LGTM! Ensure this change does not introduce any unintended side effects in other parts of the codebase.

client/keys/output_test.go

…bs/cosmos-sdk into tuan/fix-nested-marshal-msig

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between db715be and 81b7b3b.

Files selected for processing (1)

client/keys/output_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

client/keys/output_test.go

testinginprod · 2024-05-16T07:59:50Z

crypto/keys/multisig/multisig.go

 // Bytes returns the proto encoded version of the LegacyAminoPubKey
 func (m *LegacyAminoPubKey) Bytes() []byte {
-	return AminoCdc.MustMarshal(m)
+	return AminoCdc.MustMarshalJSON(m)


This does not seem the correct way of handling the problem, based off:

This is most likely related to the LegacyAminoPubKey not being registered in some codec somewhere.

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 81b7b3b and fc94fbf.

Files selected for processing (1)

crypto/keys/multisig/amino.go (1 hunks)

Files not reviewed due to errors (1)

crypto/keys/multisig/amino.go (no review received)

Additional Context Used

Path-based Instructions (1)

crypto/keys/multisig/amino.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fc94fbf and dbeb769.

Files selected for processing (1)

crypto/keys/multisig/multisig_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

crypto/keys/multisig/multisig_test.go

facundomedica · 2024-05-21T10:04:11Z

This looks like a fix to me, I've seen something similar with other types, secp256k1 keys iirc

adjust Bytes() methods and add test for nested msig

f36d909

github-actions bot added C:CLI C:Keys Keybase, KMS and HSMs labels May 15, 2024

Merge branch 'main' into tuan/fix-nested-marshal-msig

db715be

catconcat marked this pull request as ready for review May 15, 2024 17:39

catconcat requested a review from a team May 15, 2024 17:39

coderabbitai bot reviewed May 15, 2024

View reviewed changes

client/keys/output_test.go Outdated Show resolved Hide resolved

remove println

b5f8985

tac0turtle assigned julienrbrt May 15, 2024

catconcat added 2 commits May 16, 2024 08:08

update test

18a7b95

Merge branch 'tuan/fix-nested-marshal-msig' of github.com:notional-la…

81b7b3b

…bs/cosmos-sdk into tuan/fix-nested-marshal-msig

coderabbitai bot reviewed May 16, 2024

View reviewed changes

testinginprod reviewed May 16, 2024

View reviewed changes

use MustMarshal and override the MarshalAmino

fc94fbf

catconcat requested a review from testinginprod May 16, 2024 10:06

Merge branch 'main' into tuan/fix-nested-marshal-msig

d8d83b6

coderabbitai bot reviewed May 16, 2024

View reviewed changes

catconcat added 2 commits May 17, 2024 08:32

Merge branch 'main' into tuan/fix-nested-marshal-msig

955718c

add test for nested multisig marshal/unmarshal

dbeb769

coderabbitai bot reviewed May 17, 2024

View reviewed changes

catconcat added 2 commits May 17, 2024 16:38

Merge branch 'main' into tuan/fix-nested-marshal-msig

2102417

Merge branch 'main' into tuan/fix-nested-marshal-msig

152f29a

catconcat marked this pull request as draft May 19, 2024 01:25

facundomedica mentioned this pull request May 22, 2024

fix: nested multisig signatures using CLI #20438

Merged

12 tasks

catconcat closed this May 29, 2024

catconcat deleted the tuan/fix-nested-marshal-msig branch May 29, 2024 15:21

mergify bot mentioned this pull request Jun 17, 2024

fix: nested multisig signatures using CLI (backport #20438) #20692

Merged

12 tasks

TropicalDog17 mentioned this pull request Aug 17, 2024

OrbitLabs _Tendermint2 grant allinbits/grants#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(crypto): fix nested multisigs fail to marshal#20404

fix(crypto): fix nested multisigs fail to marshal#20404
catconcat wants to merge 11 commits intocosmos:mainfrom
notional-labs:tuan/fix-nested-marshal-msig

catconcat commented May 15, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 15, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

testinginprod May 16, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

facundomedica commented May 21, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

catconcat commented May 15, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

testinginprod May 16, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

facundomedica commented May 21, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

catconcat commented May 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 15, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)