chore: consensus spinout #20010

tac0turtle · 2024-04-11T09:28:44Z

Description

this pr spins the consensus module into its own go.mod

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

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 testing workflows for consensus changes.
- Improved Docker setup for consensus module development.
- Updated internal package paths to reflect new module organization standards.
- Added new telemetry functionality for better state management and conditional data collection.
Documentation
- Updated guidelines for maintaining a changelog in the consensus module.
Refactor
- Reorganized import statements across various tests and modules to align with new package paths.
- Improved struct declarations and test helper functions for enhanced readability and organization.
Bug Fixes
- Corrected minor typos and removed unused imports in several modules.

coderabbitai · 2024-04-11T09:28:50Z

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (2)

x/consensus/go.mod is excluded by !**/*.mod
x/consensus/go.sum is excluded by !**/*.sum

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The update involves migrating the x/consensus module from github.com/cosmos/cosmos-sdk to cosmossdk.io, adjusting import paths, Dockerfile configurations, testing workflows, and restructuring imports to accommodate the new module location.

Changes

Files	Changes
`.github/workflows/test.yml`, `Dockerfile`, Various `*.go` files	Updated import paths to `cosmossdk.io/x/consensus`. Added Dockerfile changes for `go.mod` and `go.sum` files. Included new job in test workflow for `x/consensus`.
`proto/cosmos/consensus/v1/*.proto`, `x/consensus/proto/cosmos/consensus/module/v1/module.proto`, `x/consensus/proto/cosmos/consensus/v1/query.proto`, `x/consensus/proto/cosmos/consensus/v1/tx.proto`	Updated `go_package` options to `cosmossdk.io/x/consensus/types`.
`x/consensus/sonar-project.properties`	Configured SonarQube analysis for the `x/consensus` module.
`CHANGELOG.md`, `x/consensus/CHANGELOG.md`	Updated to reflect changes and guidelines for maintaining a human-readable changelog.

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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

coderabbitai

Actionable comments posted: 2

CHANGELOG.md

x/accounts/defaults/lockup/lockup_test.go

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-04-30T10:40:09Z

tests/integration/distribution/keeper/msg_server_test.go

@@ -22,6 +22,7 @@ import (
 	"cosmossdk.io/x/bank"
 	bankkeeper "cosmossdk.io/x/bank/keeper"
 	banktypes "cosmossdk.io/x/bank/types"
+	consensustypes "cosmossdk.io/x/consensus/types"


Consider adding tests that specifically cover interactions between the consensus and distribution modules if the consensus logic impacts distribution operations.

Would you like me to help draft some test cases that cover the interactions between the consensus and distribution modules?

likhita-809

we should be adding vanity url to consensus module

tac0turtle · 2024-04-30T10:57:04Z

we should be adding vanity url to consensus module

merged here
cosmos/vanity#67

kocubinski · 2024-04-30T16:11:53Z

x/consensus/go.mod

+	cosmossdk.io/x/auth v0.0.0-00010101000000-000000000000
+	github.com/cometbft/cometbft v0.38.7-0.20240412124004-1f67e396cf45
+	github.com/cosmos/cosmos-proto v1.0.0-beta.5
+	github.com/cosmos/cosmos-sdk v0.51.0


is this permissible? for x/consensus to depend the sdk.. what in the sdk module does it need?

It's used in tests and a few other places. We need to spend some time undoing the sdk import before final release.

consensus spinout

9a33ed3

github-actions bot added C:x/gov C:x/auth C:x/group C:x/consensus labels Apr 11, 2024

tac0turtle added 3 commits April 11, 2024 11:41

test

433ea7e

build

b05f896

move some tests

56ebdad

github-actions bot added C:x/staking C:CLI C:x/slashing C:x/distribution distribution module related C:x/mint C:x/bank C:x/params C:x/evidence C:x/upgrade C:x/feegrant C:x/authz C:x/nft Type: CI C:x/circuit C:x/accounts C:x/protocolpool C:x/epochs labels Apr 11, 2024

linting

d0e49f5

github-actions bot added the C:Store label Apr 11, 2024

tac0turtle added 2 commits April 15, 2024 12:05

Merge branch 'main' into marko/consensus_spinout

16661fc

fix linting

d4c8afb

coderabbitai bot reviewed Apr 15, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Show resolved Hide resolved

tac0turtle assigned samricotta Apr 21, 2024

Merge branch 'main' into marko/consensus_spinout

052fd5d

github-actions bot removed the C:Store label Apr 25, 2024

tac0turtle added 2 commits April 25, 2024 11:55

fix more conflicts

392c9ed

linting fixes

6aa689c

tac0turtle force-pushed the marko/consensus_spinout branch from bc69c61 to 6aa689c Compare April 25, 2024 10:01

testinginprod approved these changes Apr 30, 2024

View reviewed changes

sontrinh16 reviewed Apr 30, 2024

View reviewed changes

x/accounts/defaults/lockup/lockup_test.go Outdated Show resolved Hide resolved

sontrinh16 approved these changes Apr 30, 2024

View reviewed changes

Merge branch 'main' into marko/consensus_spinout

76606f2

github-actions bot added the C:Store label Apr 30, 2024

coderabbitai bot reviewed Apr 30, 2024

View reviewed changes

likhita-809 approved these changes Apr 30, 2024

View reviewed changes

Merge branch 'main' into marko/consensus_spinout

56ea865

github-actions bot removed the C:Store label Apr 30, 2024

Merge branch 'main' into marko/consensus_spinout

04bf2c1

kocubinski reviewed Apr 30, 2024

View reviewed changes

tac0turtle and others added 6 commits May 2, 2024 12:12

fix helper

c7242c8

linting

690c8b9

go mod tidy

578e6e0

consensus in example

3473660

Merge branch 'main' into marko/consensus_spinout

e34838b

mod tidy

dcc13f6

tac0turtle enabled auto-merge May 3, 2024 13:58

tac0turtle added this pull request to the merge queue May 3, 2024

Merged via the queue into main with commit 43764cf May 3, 2024
82 of 84 checks passed

tac0turtle deleted the marko/consensus_spinout branch May 3, 2024 14:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: consensus spinout #20010

chore: consensus spinout #20010

tac0turtle commented Apr 11, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 11, 2024 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot Apr 30, 2024

likhita-809 left a comment

tac0turtle commented Apr 30, 2024

kocubinski Apr 30, 2024 •

edited

tac0turtle Apr 30, 2024

chore: consensus spinout #20010

chore: consensus spinout #20010

Conversation

tac0turtle commented Apr 11, 2024 • edited by coderabbitai bot

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 11, 2024 • edited

Auto Review Skipped

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 30, 2024

Choose a reason for hiding this comment

likhita-809 left a comment

Choose a reason for hiding this comment

tac0turtle commented Apr 30, 2024

kocubinski Apr 30, 2024 • edited

Choose a reason for hiding this comment

tac0turtle Apr 30, 2024

Choose a reason for hiding this comment

tac0turtle commented Apr 11, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 11, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

kocubinski Apr 30, 2024 •

edited