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

refactor(x/bank/v2): migrate to handlers #21659

Merged
merged 6 commits into from
Sep 12, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 11, 2024

Description

Closes: #21577


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

  • New Features

    • Introduced mechanisms for parameter updates and retrieval within the bank module.
    • Enhanced message and query handling capabilities.
  • Bug Fixes

    • Temporarily disabled AutoCLI functionality due to unresolved issues.
  • Removals

    • Removed gRPC gateway plugin from build configuration.
    • Eliminated Query and Msg service definitions, impacting parameter access and updates.
    • Deleted message and query server implementations, altering how updates and queries are processed.
  • Refactor

    • Shifted to a more modular approach for registering message and query handlers.

Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

The pull request introduces significant changes to the bank module in the Cosmos SDK, including the removal of the grpc-gateway plugin configuration, deletion of service definitions for querying and updating parameters, and the introduction of a new handlers structure for managing messages and queries. The AutoCLI functionality is disabled temporarily, and various files related to message and query servers have been removed, indicating a shift towards a more modular design with dedicated handlers.

Changes

Files Change Summary
x/bank/proto/buf.gen.gogo.yaml Commented out grpc-gateway plugin configuration, indicating a temporary exclusion from the build.
x/bank/proto/cosmos/bank/v2/query.proto Removed Query service and its Params method, affecting access to module parameters.
x/bank/proto/cosmos/bank/v2/tx.proto Removed Msg service and its UpdateParams method, altering parameter update handling.
x/bank/v2/autocli.go Modified AutoCLIOptions method to return nil, disabling AutoCLI functionality.
x/bank/v2/keeper/handlers.go Added new handlers struct for managing messages and querying parameters.
x/bank/v2/keeper/msg_server.go Deleted file containing message server implementation, removing related functionality.
x/bank/v2/keeper/query_server.go Deleted file containing query server implementation, removing related functionality.
x/bank/v2/module.go Introduced new message and query handler registration methods, enhancing modularity.
x/bank/v2/types/codec.go Removed message service registration, simplifying message handling.

Assessment against linked issues

Objective Addressed Explanation
Migrate bank/v2 msg/query servers to handlers (#[21577])

Possibly related PRs

Suggested labels

C:x/accounts


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.
    • @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 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.

@julienrbrt julienrbrt changed the title updates refactor(x/bank/v2): migrate to handlers Sep 11, 2024
@julienrbrt julienrbrt marked this pull request as ready for review September 12, 2024 10:36
- name: grpc-gateway
out: ..
opt: logtostderr=true,allow_colon_final_segments=true
# - name: grpc-gateway ## TODO find a way to exclude v2
Copy link
Member Author

Choose a reason for hiding this comment

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

Tracked by #21683

},
},
}
return nil // Disable AutoCLI until https://github.com/cosmos/cosmos-sdk/issues/21682 is resolved.
Copy link
Member Author

Choose a reason for hiding this comment

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

Tracked by #21682

Copy link
Contributor

@hieuvubk hieuvubk left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@akhilkumarpilli akhilkumarpilli left a comment

Choose a reason for hiding this comment

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

lgtm

@julienrbrt julienrbrt added this pull request to the merge queue Sep 12, 2024
Merged via the queue into main with commit bf817f8 Sep 12, 2024
72 of 73 checks passed
@julienrbrt julienrbrt deleted the julien/bank-handlers branch September 12, 2024 12:28
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.

Migrate bank/v2 msg/query servers to handlers
4 participants