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 broken links #21751

Merged
merged 1 commit into from
Sep 16, 2024
Merged

docs: fix broken links #21751

merged 1 commit into from
Sep 16, 2024

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Sep 16, 2024

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

  • Documentation
    • Updated version link in UPGRADING.md to reflect the transition from alpha to beta release.
    • Modified CHANGELOG link for easier access to detailed updates.
    • Corrected URL for Fluent technology in the RFC document for accuracy.

@tac0turtle tac0turtle requested a review from a team as a code owner September 16, 2024 13:27
Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Walkthrough

Walkthrough

The pull request updates the UPGRADING.md file for the Cosmos SDK, changing the version from v0.52.0-alpha.0 to v0.52.0-beta.1. It modifies links for versioning and the CHANGELOG for better accessibility. Additionally, it clarifies the removal of the gRPC-web embedded client and provides a default URL for client applications. A minor correction in the URL for Fluent technology is also included in the docs/rfc/rfc-006-handlers.md file.

Changes

File Change Summary
UPGRADING.md Updated version link from v0.52.0-alpha.0 to v0.52.0-beta.1 and CHANGELOG link for accessibility. Clarified gRPC-web client removal.
docs/rfc/rfc-006-handlers.md Corrected URL for Fluent technology from "https://fluentlabs.xyz/" to "https://fluent.xyz/".

Possibly related PRs

  • chore: sync changelog with latest releases #21658: This PR updates the CHANGELOG.md file to synchronize it with the latest releases, which is directly related to the changes made in the main PR regarding the update of version links and documentation clarity for the Cosmos SDK.

Suggested labels

backport/v0.52.x


Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e49ecfe and a325f19.

Files selected for processing (2)
  • UPGRADING.md (3 hunks)
  • docs/rfc/rfc-006-handlers.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/rfc/rfc-006-handlers.md
Additional context used
Path-based instructions (1)
UPGRADING.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (5)
UPGRADING.md (5)

Line range hint 47-198: BaseApp changes: nested message simulation, vote extensions, and SetPreBlocker.

This section highlights important changes in BaseApp:

  1. Nested message simulation is now supported, allowing testing of complex transactions. However, be aware that the simulation does not guarantee future correct execution due to potential state changes.

  2. Vote extensions can be enabled by setting the Abci.VoteExtensionsEnableHeight consensus parameter. For new chains, this can be done in the genesis.json, while existing chains require an upgrade handler or governance proposal.

  3. The new SetPreBlocker method is crucial for running PreBlock and modifying consensus parameters before other modules. Update your application accordingly, especially if using depinject or app di.

Ensure you understand and apply these changes based on your application's requirements.

Tools
LanguageTool

[typographical] ~54-~54: It appears that a comma is missing.
Context: ...es described here. ### SimApp In this section we describe the changes made in Cosmos ...

(DURING_THAT_TIME_COMMA)


Line range hint 200-233: Config file changes: Confix, command updates, gRPC-Web, and database support.

This section introduces several changes related to configuration files:

  1. Confix is the new SDK tool for modifying and migrating configuration, replacing config.Cmd. Update your application to use Confix for configuration management.

  2. The <appd> config [key] and <appd> config [key] [value] commands have been replaced with <appd> config get client [key] and <appd> config set client [key] [value]. Adjust your application's commands accordingly.

  3. gRPC-Web now listens to the same address and port as the gRPC Gateway API server. If needed, set up a reverse-proxy to maintain the previous behavior.

  4. ClevelDB, BoltDB, and BadgerDB are no longer supported. Migrate to a supported database using a database migration tool.

Ensure you update your application's configuration management, commands, and database based on these changes.


Line range hint 235-269: Protobuf changes: CometBFT protos, Any type relocation, and interface updates.

This section highlights several changes related to protobuf:

  1. The cosmossdk.io/api/tendermint package has been removed as CometBFT now publishes its protos. Update your dependencies to use the CometBFT published protos instead.

  2. The codectypes.Any has moved to github.com/cosmos/gogoproto/types/any. Update your imports and buf.gen.gogo.yaml configuration files accordingly.

  3. The interfaces AnyUnpacker and UnpackInterfacesMessage must be replaced with the interfaces from the github.com/cosmos/gogoproto/types/any package.

Ensure you update your protobuf dependencies, imports, configuration files, and interfaces based on these changes.


Line range hint 271-462: Module changes: x/auth, x/accounts, x/crisis, x/distribution, x/gov, x/protocolpool, and general updates.

This section covers significant changes across various modules:

  1. x/auth: Vesting accounts and their related messages and CLIs have been removed. Existing vesting accounts will continue to work, but new ones cannot be created. Consider using x/accounts lockup or vesting accounts instead.

  2. x/accounts: Account numbers are now global and replace the legacy x/auth account numbers. During the upgrade, the account numbers must be migrated using the authkeeper.MigrateAccountNumber function.

  3. x/crisis: This module has been removed due to lack of support and functionality.

  4. x/distribution: Chains using this module must add the new x/protocolpool module during the upgrade.

  5. x/gov: The v1beta1 proposal handler now takes a context.Context instead of sdk.Context. Expedited proposals and proposal cancellation have been introduced, requiring configuration changes and migration of existing proposals.

  6. x/protocolpool: This new module handles community pool funds and its store must be added during the upgrade to v0.52.x.

  7. General changes:

    • Boilerplate code for emitting EventTypeMessage events has been removed.
    • The x/params module has been deprecated; migrate module parameters to their respective modules before v0.50.
    • Module Keeper methods now take a context.Context instead of sdk.Context, requiring interface updates and mock regeneration.

Carefully review and apply these changes based on your chain's specific requirements, ensuring a smooth upgrade process.


Line range hint 464-472: Tooling changes: Rosetta as a standalone tool.

This section highlights the changes related to Rosetta:

  1. Rosetta has moved to its own repository and is no longer imported by the Cosmos SDK SimApp by default.

  2. Users interested in using Rosetta can connect it standalone to any node without adding it to the node binary.

  3. The Rosetta tool now allows multi-chain connections, providing flexibility for users.

If you require Rosetta functionality, set it up as a standalone tool connected to your node, taking advantage of its multi-chain capabilities.


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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants