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: remove consensus authority #21734

Merged
merged 4 commits into from
Sep 16, 2024
Merged

chore: remove consensus authority #21734

merged 4 commits into from
Sep 16, 2024

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Sep 14, 2024

Description

Closes: #21731

remove the consensus authority as its no longer used


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 error handling for unsupported storage types in the root store creation process.
  • Bug Fixes

    • Removed outdated consensus authority mechanisms, simplifying the consensus management process.
  • Refactor

    • Streamlined the consensus management by eliminating unnecessary parameters and methods related to consensus authority.
  • Documentation

    • Updated comments and documentation to reflect the removal of the GetConsensusAuthority method and related changes.

Copy link
Contributor

coderabbitai bot commented Sep 14, 2024

Walkthrough

Walkthrough

The pull request involves significant changes to the consensus mechanism in the CometBFT server. It removes the consensusAuthority field from the Consensus struct and related functions, simplifying how authority is managed within the consensus engine. This includes alterations to the initialization processes and the AppI interface, reflecting a shift in design philosophy regarding consensus authority. Additionally, error handling improvements were made in the storage factory.

Changes

File Change Summary
server/v2/cometbft/abci.go Removed consensusAuthority from Consensus struct and related methods, simplifying initialization.
server/v2/cometbft/abci_test.go Modified setUpConsensus to remove consensusAuthority from NewConsensus function call.
server/v2/cometbft/server.go Removed appI.GetConsensusAuthority() from NewConsensus parameters in CometBFTServer.Init.
server/v2/types.go Removed GetConsensusAuthority method from AppI interface.
simapp/v2/app_di.go Removed GetConsensusAuthority method from SimApp struct.
store/v2/root/factory.go Added error handling for unknown storage types in CreateRootStore function.

Sequence Diagram(s)

sequenceDiagram
    participant A as App
    participant C as CometBFTServer
    participant D as Consensus

    A->>C: Init()
    C->>D: NewConsensus()
    D-->>C: Consensus instance
    C-->>A: Initialized
Loading

Assessment against linked issues

Objective Addressed Explanation
Remove need for ConsensusAuthority for comet server in app v2 (#21731)

Possibly related PRs

  • refactor(simapp): simplify simapp di #21718: The changes in this PR involve the removal of several keeper declarations in the simapp/app_di.go file, which aligns with the main PR's focus on simplifying the consensus authority management by removing related fields and methods.

Suggested labels

C:orm


Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0f7047e and cb5e38e.

Files selected for processing (2)
  • server/v2/cometbft/abci_test.go (1 hunks)
  • server/v2/cometbft/server.go (0 hunks)
Files not reviewed due to no reviewable changes (1)
  • server/v2/cometbft/server.go
Files skipped from review as they are similar to previous changes (1)
  • server/v2/cometbft/abci_test.go

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 generate interesting stats about this repository and render them as a table.
    -- @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.

ACK! Can you put the authority in app_config to "gov" instead of consensus?

store/v2/root/factory.go Show resolved Hide resolved
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 16, 2024
Copy link
Member

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

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

<3 this

@tac0turtle tac0turtle added this pull request to the merge queue Sep 16, 2024
Merged via the queue into main with commit a9f057b Sep 16, 2024
71 of 72 checks passed
@tac0turtle tac0turtle deleted the marko/21731 branch September 16, 2024 20:11
mergify bot pushed a commit that referenced this pull request Sep 16, 2024
Co-authored-by: Julien Robert <julien@rbrt.fr>
(cherry picked from commit a9f057b)

# Conflicts:
#	server/v2/types.go
#	store/v2/root/factory.go
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:server/v2 cometbft C:server/v2 Issues related to server/v2 C:Store
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove need for ConsensusAuthority for comet server in app v2
4 participants