osmosis-labs / osmosis

The AMM Laboratory
https://app.osmosis.zone
Apache License 2.0
875 stars 562 forks source link

feat: module hash by height query #8427

Closed czarcas7ic closed 1 week ago

czarcas7ic commented 2 weeks ago

Query that exposes the per module hash at a given height, which is useful for debugging app hashes.

czarcas7ic commented 1 week ago

https://github.com/cosmos/cosmos-sdk/pull/20779

coderabbitai[bot] commented 1 week ago

Walkthrough

The recent update introduces a new command module-hash-by-height that allows users to retrieve and display module hashes at a specific blockchain height. This feature is part of the cmd package within the Osmosis application's command-line interface. The new functionality assists in debugging by enabling users to query module hashes at particular heights, facilitating better insights into the application's state at those points in time.

Changes

Files Change Summary
cmd/.../module_hash_by_height.go Introduces module-hash-by-height command, functions to query module hashes, and utility for database access.
cmd/.../root.go Adds moduleHashByHeightQuery function to the root command initialization, integrating the new query functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant CLI as CLI (osmosisd)
    participant Server as Server Context
    participant Database as Database

    User->>CLI: Run `module-hash-by-height` with specific height
    CLI->>Server: Initialize server context
    CLI->>Database: Open Database connection
    Database-->>CLI: Database Connection Established
    CLI->>Server: Query module hashes at given height
    Server-->>CLI: Return module hashes
    CLI-->>User: Display module hashes

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 4c70b0253af830a0275be0f0eb880fd0b26ae3d2 and 40c208993248462602fe49d3a65783790267531e.
Files selected for processing (2) * cmd/osmosisd/cmd/module_hash_by_height.go (1 hunks) * cmd/osmosisd/cmd/root.go (1 hunks)
Additional comments not posted (4)
cmd/osmosisd/cmd/module_hash_by_height.go (3)
`25-26`: **New function `moduleHashByHeightQuery` added.** This function is the entry point for the new CLI command to retrieve module hashes at a specific height. It is well-structured and follows the expected pattern for Cobra commands. --- `60-106`: **Function `getModuleHashesAtHeight` effectively retrieves and processes module hashes.** This function is responsible for the core functionality of fetching module hashes at a given height. It handles errors appropriately and transforms the hashes into a more readable format before sorting them. --- `108-111`: **Function `openDB` added for database access.** This utility function is a clean abstraction for opening a database connection. It uses parameters to specify the database type and location, which enhances modularity and reusability.
cmd/osmosisd/cmd/root.go (1)
`720-720`: **Integration of `moduleHashByHeightQuery` into the root command.** The new command is correctly integrated into the root command sequence. It is placed logically in the command initialization, ensuring it's available alongside other similar functionality.
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.