search

lavanet / lava

Apache License 2.0
407 stars 206 forks source link

feat: PRT: Generic Parsers - Block Latest #1609

Closed shleikes closed 2 months ago

shleikes commented 2 months ago

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

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

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent enhancements to the blockchain codebase significantly improve parsing capabilities and the message crafting process. Key updates include the introduction of new data structures for managing block requests, refined error handling, and the addition of dependencies for improved functionality. These changes streamline operations and enhance clarity, directly impacting how the system processes block data and constructs messages.

Changes

File(s) Change Summary
cookbook/specs/near.json Added a new "parsers" field to enhance block finality parsing capabilities; minor formatting adjustment.
go.mod Introduced new indirect dependencies (gojq, timefmt-go); updated versions of existing dependencies (uniseg, sys).
protocol/chainlib/common.go, .../grpc.go, .../jsonRPC.go, .../rest.go, .../tendermintRPC.go Enhanced message crafting and parsing methods; new parameters for block requests; improved error handling and logging across chain parser implementations.
protocol/parser/parser.go Introduced ParsedInput type to enhance parsing logic; added functions for generic parsing; improved error handling and logging.
protocol/parser/parser_test.go Updated tests for ParseBlockFromParams to include new parameters; added comprehensive test cases to ensure robustness.
scripts/protocgen.sh Changed the shebang line from #!/usr/bin/env /bin/sh to #!/bin/bash to leverage Bash-specific features.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GrpcChainParser
    participant JsonRPCChainParser
    participant ParsedInput

    User->>GrpcChainParser: Request block
    GrpcChainParser->>ParsedInput: Process input
    ParsedInput->>GrpcChainParser: Return parsed data
    GrpcChainParser->>User: Return crafted message

    User->>JsonRPCChainParser: Request block
    JsonRPCChainParser->>ParsedInput: Process input
    ParsedInput->>JsonRPCChainParser: Return parsed data
    JsonRPCChainParser->>User: Return crafted message

🐰 In fields of code, I hop and play,
With parsing joys that brighten the day.
New structures abound, oh what a delight!
Error logs gleam, all shiny and bright.
Crafting messages with hashes anew,
In the world of blocks, I'm sprightly and true! 🌟

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 Configuration 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.
github-actions[bot] commented 2 months ago

Test Results

2 159 tests  +27   2 159 :white_check_mark: +27   25m 42s :stopwatch: -4s   143 suites ± 0       0 :zzz: ± 0      7 files   ± 0       0 :x: ± 0 

Results for commit 9424d328. ± Comparison against base commit 6ba87237.

:recycle: This comment has been updated with latest results.