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

docs: fix typos in UPGRADING.md #18613

Merged
merged 1 commit into from
Dec 2, 2023
Merged

docs: fix typos in UPGRADING.md #18613

merged 1 commit into from
Dec 2, 2023

Conversation

buldazer23
Copy link
Contributor

@buldazer23 buldazer23 commented Dec 2, 2023

Description

Closes: #XXXX


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

  • Documentation

    • Updated UPGRADING.md with instructions for adapting to new Cosmos SDK changes.
  • Refactor

    • Abstracted from CometBFT Go types to Cosmos SDK types.
    • Streamlined event emission in message execution.
  • Deprecations

    • Announced deprecation of the x/params module.
  • New Requirements

    • Clients must now set a codec when using grpc.Dial to interact with nodes.

@buldazer23 buldazer23 requested a review from a team as a code owner December 2, 2023 12:00
Copy link
Contributor

coderabbitai bot commented Dec 2, 2023

Walkthrough

Walkthrough

The Cosmos SDK has undergone significant updates to enhance modularity and usability. Key changes include the abstraction from CometBFT types, streamlining event emission, simplifying parameter store settings, and deprecating the x/params module. Clients must now explicitly set a codec when using gRPC to communicate with nodes. These changes aim to improve developer experience by reducing boilerplate, aligning with Go idioms, and enforcing better type safety and modularity.

Changes

File(s) Change Summary
Various Abstraction from CometBFT Go types to Cosmos SDK types, including logger and byte replacements.
Various Direct emission of events at message execution, removing the need for EventTypeMessage boilerplate.
Various Automatic parameter store setting in App Wiring, simplifying the setup process.
Various Deprecation of the x/params module, with guidance for migration to the new approach.
Various Clients are now required to set a codec in grpc.Dial when interacting with a node.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@buldazer23 buldazer23 changed the title fix typo in UPGRADING.md Documentation only changes in UPGRADING.md Dec 2, 2023
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9d086f8 and 9c1a845.
Files selected for processing (1)
  • UPGRADING.md (5 hunks)
Additional comments: 6
UPGRADING.md (6)
  • 150-156: The summary provided does not match the PR objective, which is to fix a typographical error in the UPGRADING.md file. The summary instead details extensive changes to the Cosmos SDK, which is not aligned with the PR objective of correcting a typo.

  • 150-156: The changes in this hunk correctly reflect the abstraction from CometBFT Go types, including the replacement of the CometBFT logger with the Cosmos SDK logger interface and the github.com/cometbft/cometbft/libs/bytes.HexByte with []byte.

  • 780-786: The removal of boilerplate code for emitting EventTypeMessage events with sdk.AttributeKeyModule and sdk.AttributeKeySender is correctly implemented in this hunk.

  • 909-912: The addition of the x/protocolpool store during an upgrade to v0.51.x is correctly implemented in this hunk.

  • 1000-1005: The deprecation of the x/params module and the recommendation for migrating modules away from using it are correctly documented in this hunk.

  • 1037-1040: The requirement for clients to set a codec when interacting with a node via grpc.Dial is correctly documented in this hunk.

@julienrbrt julienrbrt changed the title Documentation only changes in UPGRADING.md docs: fix typos in UPGRADING.md Dec 2, 2023
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!

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.50.x PR scheduled for inclusion in the v0.50's next stable release label Dec 2, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Dec 2, 2023
Merged via the queue into cosmos:main with commit 96df84f Dec 2, 2023
mergify bot pushed a commit that referenced this pull request Dec 2, 2023
(cherry picked from commit 96df84f)

# Conflicts:
#	UPGRADING.md
julienrbrt added a commit that referenced this pull request Dec 3, 2023
Co-authored-by: buldazer <93915704+buldazer23@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Copy link

@CASABECI CASABECI left a comment

Choose a reason for hiding this comment

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

Wkn

@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants