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.

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

chore: use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec in store.go and keeper.go #23294

Closed
wants to merge 1 commit into from

Conversation

tiendn
Copy link

@tiendn tiendn commented Jan 10, 2025

Description

Partially addresses: #23253


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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

  • Refactor
    • Updated codec import paths in multiple modules from Cosmos SDK to Cosmossdk.io namespace
    • Changes do not impact existing functionality of governance and NFT modules

The modifications represent a technical migration of codec package imports, maintaining the existing behavior of the system while updating to a newer dependency source.

…github.com/cosmos/cosmos-sdk/codec in store.go and keeper.go
@tiendn tiendn requested review from alpe, lucaslopezf, a team and julienrbrt as code owners January 10, 2025 03:41
Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

📝 Walkthrough

Walkthrough

This pull request involves updating the codec import path in two different files from the Cosmos SDK's traditional codec import to a new import path under the Cosmossdk.io namespace. The changes are specifically in the governance (x/gov/migrations/v5/store.go) and NFT (x/nft/keeper/keeper.go) modules, where the import statement for the codec package is modified from github.com/cosmos/cosmos-sdk/codec to cosmossdk.io/core/codec. The core functionality of the affected files remains unchanged.

Changes

File Change Summary
x/gov/migrations/v5/store.go Updated codec import path from Cosmos SDK to Cosmossdk.io namespace
x/nft/keeper/keeper.go Updated codec import path from Cosmos SDK to Cosmossdk.io namespace

Possibly related PRs

Suggested reviewers

  • tac0turtle
  • julienrbrt

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
x/gov/migrations/v5/store.go (1)

Line range hint 55-55: Fix typo in comment.

There's a typo in the comment: "consisitution" should be "constitution".

-	// Set the default consisitution if it is not set
+	// Set the default constitution if it is not set
🧰 Tools
🪛 golangci-lint (1.62.2)

9-9: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

📜 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 bf6d7e9.

📒 Files selected for processing (2)
  • x/gov/migrations/v5/store.go (1 hunks)
  • x/nft/keeper/keeper.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • x/nft/keeper/keeper.go
🧰 Additional context used
📓 Path-based instructions (1)
x/gov/migrations/v5/store.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Summary
🔇 Additional comments (2)
x/gov/migrations/v5/store.go (2)

Line range hint 24-24: LGTM! Codec interface usage is correct.

The function correctly uses the codec.BinaryCodec interface from the new import path without requiring any implementation changes.

🧰 Tools
🪛 golangci-lint (1.62.2)

9-9: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)


10-10: LGTM! Verify consistency across the codebase.

The import path change aligns with the PR objectives. Let's verify that this change is consistent across other files using the codec package.

✅ Verification successful

Import change is correct and follows the established pattern

The change to cosmossdk.io/core/codec aligns with:

  • The project's use of stable cosmossdk.io/core v1.0.0
  • The consistent pattern seen in other migrated files
  • The broader migration to the cosmossdk.io namespace
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining old codec imports that might need updating
# and verify the consistency of the new import path usage

echo "Checking for old codec imports..."
rg --type go "github.com/cosmos/cosmos-sdk/codec"

echo "Verifying new codec import usage..."
rg --type go "cosmossdk.io/core/codec"

Length of output: 61172


Script:

#!/bin/bash
# Check migration files and their codec imports
echo "Checking migration files codec imports..."
rg --type go --glob "*/migrations/**/store.go" "^import.*codec"

echo -e "\nChecking for documentation about codec import changes..."
rg --type go --type md "cosmossdk.io/core/codec" -B 2 -A 2

Length of output: 2167


Script:

#!/bin/bash
# Find migration files and check their imports
echo "Finding migration files..."
fd -t f store.go migrations/

echo -e "\nChecking migration files content..."
fd -t f store.go migrations/ -x cat {}

echo -e "\nChecking go.mod for codec dependencies..."
grep -A 5 "cosmossdk.io/core" go.mod

Length of output: 755

@tiendn tiendn closed this Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant