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(x/auth): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23273

Merged
merged 6 commits into from
Jan 9, 2025

Conversation

hoank101
Copy link
Contributor

@hoank101 hoank101 commented Jan 9, 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 from github.com/cosmos/cosmos-sdk to cosmossdk.io/core
    • Modified transaction builder and wrapper to use new codec implementation
    • Updated method signatures to incorporate new codec parameter
  • Technical Improvements

    • Enhanced transaction data handling and serialization process
    • Improved codec-related functionality in transaction processing

@hoank101 hoank101 requested a review from a team as a code owner January 9, 2025 14:08
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

📝 Walkthrough

Walkthrough

The pull request introduces changes to the codec implementation in the Cosmos SDK's authentication and transaction handling modules. The primary modification involves replacing the codec import from github.com/cosmos/cosmos-sdk with cosmossdk.io/core. This change impacts the x/auth/tx/builder.go and x/auth/tx/gogotx.go files, updating method signatures and struct definitions to incorporate the new codec type codec.BinaryCodec. The changes maintain the existing logic while updating the underlying codec implementation.

Changes

File Change Summary
x/auth/tx/builder.go - Added codec.BinaryCodec import from cosmossdk.io/core
- Updated newBuilder and newBuilderFromDecodedTx method signatures
- Added codec field to builder struct
- Modified getFee method to use new codec
x/auth/tx/gogotx.go - Replaced codec import with cosmossdk.io/core
- Added codec.BinaryCodec to gogoTxWrapper struct
- Updated GetSigningTxData, GetExtensionOptions, and GetNonCriticalExtensionOptions methods

Possibly related PRs

Suggested labels

C:x/tx, C:log

Suggested reviewers

  • tac0turtle
  • julienrbrt
  • kocubinski
  • testinginprod
  • aaronc

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9637391 and 7f3da54.

📒 Files selected for processing (2)
  • x/auth/tx/builder.go (1 hunks)
  • x/auth/tx/gogotx.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
x/auth/tx/gogotx.go (1)

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

x/auth/tx/builder.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 (2)
  • GitHub Check: Analyze
  • GitHub Check: Summary
🔇 Additional comments (7)
x/auth/tx/gogotx.go (3)

15-15: LGTM: Import change aligns with PR objective

The migration from github.com/cosmos/cosmos-sdk/codec to cosmossdk.io/core/codec is correctly implemented.


Line range hint 82-89: LGTM: Struct field addition is correct

The cdc codec.BinaryCodec field is properly integrated into the gogoTxWrapper struct and implements all necessary interfaces.


Line range hint 267-284: LGTM: Codec usage in conversion functions is correct

The intoAnyV1 and decodeFromAny functions properly utilize the new codec type for protobuf conversions.

x/auth/tx/builder.go (4)

17-17: LGTM: Import change is consistent

The codec import change maintains consistency with the changes in gogotx.go.


Line range hint 89-94: LGTM: Builder struct changes are correct

The codec field is properly integrated into the builder struct and is used consistently throughout its methods.


Line range hint 34-37: LGTM: Function signature updates are correct

The newBuilder and newBuilderFromDecodedTx functions properly handle the new codec parameter and maintain backward compatibility.

Also applies to: 39-43


Line range hint 34-43: Verify all callers are updated

Since this changes the signature of newBuilder and newBuilderFromDecodedTx, we should verify all callers are updated.

✅ Verification successful

All callers are properly updated

The only callers of these functions are in x/auth/tx/config.go and they already use the correct argument patterns matching the new signatures.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any direct calls to these functions
rg -l "newBuilder\(" --type go
rg -l "newBuilderFromDecodedTx\(" --type go

Length of output: 160


Script:

#!/bin/bash
# Check the actual usage context in config.go
rg "newBuilder(FromDecodedTx)?\(" x/auth/tx/config.go -A 3 -B 3

Length of output: 502

Finishing Touches

  • 📝 Generate Docstrings

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.

@hoank101
Copy link
Contributor Author

hoank101 commented Jan 9, 2025

cc @tac0turtle

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Thank you!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 9, 2025
@aljo242 aljo242 added this pull request to the merge queue Jan 9, 2025
Merged via the queue into cosmos:main with commit 80b1422 Jan 9, 2025
72 of 76 checks passed
mergify bot pushed a commit that referenced this pull request Jan 9, 2025
julienrbrt pushed a commit that referenced this pull request Jan 9, 2025
…os/cosmos-sdk/codec (backport #23273) (#23280)

Co-authored-by: DevOrbitlabs <hoa@notional.ventures>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/auth
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants