chore: use separate type for QueryFinalizedBundle

[troykessler]

Summary by CodeRabbit

• Documentation

  • Updated OpenAPI description to reflect new response type for the Query/Staker RPC method.

• New Features

  • Added new fields to the QueryFinalizedBundleResponse message for enhanced data representation.

• Refactor

  • Renamed response type in the FinalizedBundleQuery RPC method to QueryFinalizedBundleResponse.
  • Updated related methods and functions to use the new response type.

• Chores

  • Added a new function to convert RawFinalizedBundle to QueryFinalizedBundleResponse.

[coderabbitai]

Walkthrough

The core change involves updating the response type for the FinalizedBundleQuery RPC method from FinalizedBundle to QueryFinalizedBundleResponse. This includes modifying the OpenAPI documentation, renaming the response type in the protocol buffers, updating the relevant function in the checks.go file, and adding a new function to convert raw bundles to the new response type. The goal is to enhance the response structure with additional fields and improve clarity.

Changes

File Path	Change Summary
docs/static/openapi.yml	Updated description to reflect new response type for Query/Staker RPC method.
proto/kyve/query/v1beta1/bundles.proto	Renamed response type and added new fields to QueryFinalizedBundleResponse message.
testutil/integration/checks.go	Updated checkFinalizedBundle function to use QueryFinalizedBundleResponse parameter type.
x/bundles/keeper/getters_bundles.go	Added RawBundleToQueryBundleResponse function for converting raw bundles to the new response.
x/query/keeper/grpc_query_finalized_bundles.go	Updated FinalizedBundleQuery method to return QueryFinalizedBundleResponse.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant Server
    participant Database

    Client->>Server: QueryFinalizedBundleRequest
    Server->>Database: Fetch RawFinalizedBundle
    Database-->>Server: RawFinalizedBundle
    Server->>Server: Convert RawFinalizedBundle to QueryFinalizedBundleResponse
    Server-->>Client: QueryFinalizedBundleResponse

Loading

Poem

In the land of code where bundles lie,
A change was made, oh my, oh my!
Responses now are clear and bright,
With fields that shine in data's light.
A rabbit hops with joy anew,
For code's improved, for me and you! 🐇✨

Warning

Review ran into problems

Problems (1)

• Git: Failed to clone repository. Please contact CodeRabbit support.

---

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
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 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: 1

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 68eeeed and f62e56c.

Files selected for processing (2)

• docs/static/openapi.yml (1 hunks)
• testutil/integration/checks.go (1 hunks)

Additional comments not posted (1)

testutil/integration/checks.go (1)

262-262: LGTM! The updated function signature and checks align with the new QueryFinalizedBundleResponse type.