chore(x/group,x/nft,x/mint): use `cosmossdk.io/core/codec` instead of `github.com/cosmos/cosmos-sdk/codec` #23293

caseylove · 2025-01-10T03:18:18Z

Description

Partially addresses #23253

Summary by CodeRabbit

Dependency Updates
- Updated codec imports from Cosmos SDK to cosmossdk.io/core
Error Handling Improvements
- Enhanced error management in genesis state marshaling
- Replaced MustMarshalJSON with explicit error checking
- Improved unmarshalling error reporting in various modules
Code Maintenance
- Updated method signatures to accommodate new codec interface
- Refined error handling across multiple packages

…ithub.com/cosmos/cosmos-sdk/codec

coderabbitai · 2025-01-10T03:18:26Z

📝 Walkthrough

Walkthrough

This pull request introduces a systematic update to the codec dependency across multiple modules in the Cosmos SDK. The changes primarily involve replacing the codec import from github.com/cosmos/cosmos-sdk/codec with cosmossdk.io/core/codec. Additionally, the modifications enhance error handling in various methods like DefaultGenesis and unmarshalling processes by replacing MustMarshalJSON and MustUnmarshal with more explicit error-checking approaches that panic with specific error messages.

Changes

File	Change Summary
`x/group/internal/orm/types.go`	Updated codec import and `NewTypeSafeRowGetter` function signature to use new codec
`x/group/keeper/genesis.go`	Updated codec import and improved error handling in `InitGenesis`
`x/group/module/module.go`	Updated codec import and enhanced error handling in `DefaultGenesis`
`x/group/simulation/decoder.go`	Updated codec import and improved error handling for unmarshalling
`x/mint/module.go`	Updated codec import and enhanced error handling in `DefaultGenesis`
`x/nft/module/module.go`	Updated codec import and added error handling in `DefaultGenesis`
`x/nft/simulation/decoder.go`	Updated codec import and improved error handling for unmarshalling

Possibly related PRs

feat(core): add a new codec to core #22326: Updates codec dependency to cosmossdk.io/core
build(deps): use cosmossdk.io/core v1.0.0-alpha.5 #22369: Updates cosmossdk.io/core dependency version
chore(x/upgrade): Use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23261: Updates codec import in x/upgrade module
chore(x/auth): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23273: Updates codec import in x/auth module

Suggested reviewers

tac0turtle
alpe
kocubinski
julienrbrt
sontrinh16
testinginprod

Finishing Touches

📝 Generate Docstrings (Beta)

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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: 0

🧹 Nitpick comments (4)

x/nft/simulation/decoder.go (1)
22-27: Consider adding context to panic messages.

While the error handling is improved by using Unmarshal instead of MustUnmarshal, the panic messages could be more descriptive to aid in debugging simulation failures.
-			if err := cdc.Unmarshal(kvA.Value, &classA); err != nil {
-				panic(err)
+			if err := cdc.Unmarshal(kvA.Value, &classA); err != nil {
+				panic(fmt.Errorf("failed to unmarshal NFT class A: %w", err))
Also applies to: 31-36
x/group/simulation/decoder.go (1)
22-27: Consider adding context to panic messages.

While the error handling is consistent across all struct types, the panic messages could be more descriptive. Consider wrapping errors with context about which type failed to unmarshal.
-			if err := cdc.Unmarshal(kvA.Value, &groupA); err != nil {
-				panic(err)
+			if err := cdc.Unmarshal(kvA.Value, &groupA); err != nil {
+				panic(fmt.Errorf("failed to unmarshal GroupInfo A: %w", err))
Also applies to: 33-38, 44-49, 55-60, 66-71
x/group/keeper/genesis.go (1)
15-17: Consider using errors.Wrap for consistency.

The error handling in InitGenesis could be more consistent with the rest of the file by using errors.Wrap instead of panic.
-	if err := cdc.UnmarshalJSON(data, &genesisState); err != nil {
-		panic(err)
+	if err := cdc.UnmarshalJSON(data, &genesisState); err != nil {
+		return errors.Wrap(err, "failed to unmarshal genesis state")
+	}
x/nft/module/module.go (1)
88-92: Consider returning error instead of panic in DefaultGenesis.

While the error handling is improved by using MarshalJSON instead of MustMarshalJSON, consider returning an error instead of panicking to be consistent with other genesis-related methods in the module.
-func (am AppModule) DefaultGenesis() json.RawMessage {
+func (am AppModule) DefaultGenesis() (json.RawMessage, error) {
 	data, err := am.cdc.MarshalJSON(nft.DefaultGenesisState())
 	if err != nil {
-		panic(err)
+		return nil, errors.Wrap(err, "failed to marshal default genesis state")
 	}
-	return data
+	return data, nil
}

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 517839b and d6d2a29.

📒 Files selected for processing (7)

x/group/internal/orm/types.go (1 hunks)
x/group/keeper/genesis.go (1 hunks)
x/group/module/module.go (2 hunks)
x/group/simulation/decoder.go (2 hunks)
x/mint/module.go (2 hunks)
x/nft/module/module.go (2 hunks)
x/nft/simulation/decoder.go (2 hunks)

🧰 Additional context used

📓 Path-based instructions (7)

x/mint/module.go (1)