refactor(server/v2/cometbft): update function comments

[tianyeyouyou]

update comments & remove TODO

Summary by CodeRabbit

• New Features

  • Added functionality to retrieve a block by its hash.

• Refactor

  • Renamed internal functions for clarity and consistency.

[coderabbitai]

Walkthrough

Walkthrough

The changes primarily involve renaming functions and adding a new function in the server/v2/cometbft/client/rpc package. Specifically, GetBlockByHeight was renamed to itself, and a new function GetBlockByHash was introduced. Additionally, the calcTotalPages function in utils.go had its comment adjusted for clarity.

Changes

Files	Change Summary
server/v2/cometbft/client/rpc/block.go	Renamed GetBlockByHeight to GetBlockByHeight and added a new function GetBlockByHash.
server/v2/cometbft/client/rpc/utils.go	Updated the comment for calcTotalPages to clarify its purpose and functionality.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant CometRPC
    participant BlockService

    Client->>CometRPC: GetBlockByHash(hashHexString)
    CometRPC->>BlockService: Fetch block by hash
    BlockService-->>CometRPC: Return block data
    CometRPC-->>Client: Return block data

Loading

---

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6967fbd and d769719.

Files selected for processing (2)

• server/v2/cometbft/client/rpc/block.go (3 hunks)
• server/v2/cometbft/client/rpc/utils.go (1 hunks)

Files skipped from review due to trivial changes (1)

• server/v2/cometbft/client/rpc/utils.go

Additional context used

Path-based instructions (1)

server/v2/cometbft/client/rpc/block.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)

server/v2/cometbft/client/rpc/block.go (1)

58-58: Updated comment improves clarity and conciseness.

[coderabbitai]

Consider enhancing the error messages to include more details from the underlying errors.

- return nil, fmt.Errorf("unable to create response block from comet result block: %v", resBlock)
+ return nil, fmt.Errorf("unable to create response block from comet result block: %v, error: %w", resBlock, err)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	// GetBlockByHash gets block by hash
	// GetBlockByHash gets block by hash
	// ...
	return nil, fmt.Errorf("unable to create response block from comet result block: %v, error: %w", resBlock, err)