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: remove consensus as a imported type in modules #21480

Merged
merged 27 commits into from
Sep 10, 2024

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Aug 30, 2024

Description

This pr proposes a cleanup to avoid importing the consensus module which allows us to avoid comet imports in other modules. Now a consensus keeper muust be passed to upgrade, staking, evidence and antehandlers, in order to avoid using the router to call the consensus module.


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

    • Enhanced integration of consensus parameters across various modules, improving functionality related to transaction processing and governance.
  • Bug Fixes

    • Streamlined error handling and control flow in several functions, improving reliability when interacting with consensus-related data.
  • Refactor

    • Removed unnecessary dependencies on the cosmossdk.io/x/consensus module across multiple components, simplifying the codebase.
  • Tests

    • Updated test setups to reflect changes in consensus handling, improving the robustness of integration tests.

Copy link
Contributor

coderabbitai bot commented Aug 30, 2024

Walkthrough

Walkthrough

The changes involve the removal of the cosmossdk.io/x/consensus dependency across multiple modules in the Cosmos SDK codebase. Several modules have been updated to integrate a new ConsensusParamsKeeper interface, enhancing their functionality related to consensus parameters. Additionally, modifications to test setups and mock implementations reflect these architectural changes, improving the management of consensus-related operations within the application.

Changes

File(s) Change Summary
client/v2/go.mod, go.mod Removed references to cosmossdk.io/x/consensus from require and replace sections, indicating a shift in dependency management.
simapp/app.go Updated NewSimApp function to include ConsensusParamsKeeper for improved governance and evidence management.
x/accounts/defaults/lockup/go.mod, x/accounts/defaults/multisig/go.mod, x/accounts/go.mod, x/bank/go.mod, x/circuit/go.mod, x/distribution/go.mod, x/epochs/go.mod, x/evidence/go.mod, x/feegrant/go.mod, x/gov/go.mod, x/mint/go.mod, x/nft/go.mod, x/params/go.mod, x/protocolpool/go.mod, x/slashing/go.mod, x/staking/go.mod, x/upgrade/go.mod Removed cosmossdk.io/x/consensus dependency from various go.mod files, indicating a significant refactoring of module dependencies.
x/staking/keeper/msg_server.go Streamlined CreateValidator and RotateConsPubKey methods by directly accessing ConsensusParamsKeeper for public key types, simplifying logic and reducing external dependencies.
x/upgrade/keeper/abci_test.go, x/upgrade/keeper/keeper_test.go Enhanced testing framework by integrating mock ConsensusKeeper into test setups, allowing for better simulation of consensus behavior.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant App
    participant ConsensusParamsKeeper
    participant StakingKeeper

    Client->>App: Send transaction
    App->>ConsensusParamsKeeper: Retrieve consensus parameters
    ConsensusParamsKeeper-->>App: Return parameters
    App->>StakingKeeper: Process staking logic
    StakingKeeper-->>App: Return staking result
    App-->>Client: Return transaction result
Loading

Possibly related issues


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.

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.

nice! lgtm

Copy link
Member

@julienrbrt julienrbrt Sep 10, 2024

Choose a reason for hiding this comment

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

could you revert this? this is why your test is failing.

Copy link
Member Author

Choose a reason for hiding this comment

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

it gets modified when i run make test

@tac0turtle tac0turtle added this pull request to the merge queue Sep 10, 2024
Merged via the queue into main with commit f220f8b Sep 10, 2024
89 of 90 checks passed
@tac0turtle tac0turtle deleted the marko/test_consensus branch September 10, 2024 15:41
mergify bot pushed a commit that referenced this pull request Sep 10, 2024
(cherry picked from commit f220f8b)

# Conflicts:
#	client/v2/go.mod
#	client/v2/go.sum
#	scripts/mockgen.sh
#	x/accounts/defaults/lockup/go.mod
#	x/accounts/defaults/multisig/go.mod
#	x/authz/go.mod
#	x/bank/go.mod
#	x/distribution/go.mod
#	x/epochs/go.mod
#	x/evidence/go.mod
#	x/gov/go.mod
#	x/mint/go.mod
#	x/slashing/go.mod
#	x/staking/go.mod
#	x/upgrade/go.mod
tac0turtle added a commit that referenced this pull request Sep 10, 2024
…1480) (#21638)

Co-authored-by: Marko <marko@baricevic.me>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
mark-rushakoff added a commit that referenced this pull request Sep 11, 2024
This was introduced in #21480.
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.

4 participants