lavanet / lava

Apache License 2.0
404 stars 207 forks source link

feat: CNS-891: Same provider conflict #1614

Closed shleikes closed 1 month ago

shleikes commented 1 month 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 1 month ago

Walkthrough

The recent changes significantly enhance the functionality and robustness of the consensus and conflict handling systems within the protocol. Key modifications include refined logging practices, improved error handling, and streamlined conflict detection processes. New structures for managing finalization data have been introduced, along with adjustments to the testing framework for better validation. Overall, these updates aim to improve code clarity, maintainability, and the system's ability to handle complex scenarios effectively.

Changes

Files Change Summary
ecosystem/lava-sdk/src/lavaprotocol/finalization_consensus.ts Commented out relay reply settings, indicating a temporary suspension with future conflict logic planned.
proto/.../conflict_data.proto, proto/.../tx.proto Updated message structures to introduce RelayFinalization, simplifying conflict handling with a oneof construct.
proto/.../relay.proto Minor formatting changes; removed comments from RelayReply message.
protocol/chainlib/common.go Enhanced error handling and added a method for retrieving the listening address.
protocol/rpcconsumer/..., protocol/rpcprovider/... Major enhancements in finalization logic, new methods, and improved error handling for finalization data.
protocol/integration/protocol_test.go Updated tests with new mock implementations and error handling improvements to validate conflict scenarios.
protocol/rpcconsumer/consumer_state_tracker_mock.go Simplified transaction conflict detection by removing unnecessary parameters, enhancing method clarity.
protocol/lavasession/consumer_types.go Improved logging consistency by replacing utils.Attribute with utils.LogAttr.
protocol/monitoring/health.go Updated error handling to source from protocolerrors, enhancing error clarity and maintainability.

Sequence Diagram(s)

sequenceDiagram
    participant Consumer
    participant Provider
    participant Consensus
    participant Logger

    Consumer->>Provider: Request Block Finalization
    Provider->>Consensus: Submit Relay Reply
    Consensus-->>Logger: Log Finalization Status
    Provider->>Consumer: Send Finalized Blocks
    Consumer->>Consensus: Verify Finalization Data
    Consensus-->>Consumer: Return Verification Result

Poem

🐰 In the burrow where logic hops,
Changes bloom like springtime crops.
With clearer paths and logs that trace,
Conflicts dance, in a happy race.
New structures built, robust and bright,
A future hops in pure delight! 🌼✨


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 1 month ago

Test Results

2β€ˆ131 tests  +69   2β€ˆ131 :white_check_mark: +69   25m 20s :stopwatch: +8s β€‡β€ˆ143 suites + 2β€‚β€ƒβ€ƒβ€‡β€ˆβ€‡β€‡0 :zzz: ± 0  β€‡β€ˆβ€‡β€‡7 files   ± 0β€‚β€ƒβ€ƒβ€‡β€ˆβ€‡β€‡0 :x: ± 0 

Results for commit 2d42e7a2. ± Comparison against base commit fc8b70c6.

This pull request removes 11 and adds 80 tests. Note that renamed tests count towards both. ``` github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/empty github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/even_length github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/even_length_identical github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/min_<_zero github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/min_is_first github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/min_is_last github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/min_is_middle github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/min_is_zero github.com/lavanet/lava/v2/utils/lavaslices ‑ TestMedian/min_twice … ``` ``` github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictBasicResponseCheck github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictBasicResponseCheck/multiple_providers_-_everyone_is_returning_fake_block_hashes_-_return_conflict_error github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictBasicResponseCheck/multiple_providers_-_only_one_with_fake_block_hashes_-_return_ok github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictBasicResponseCheck/one_provider_-_fake_block_hashes_-_return_conflict_error github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictReport github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictReport/same_provider_conflict_report github.com/lavanet/lava/v2/protocol/integration ‑ TestSameProviderConflictReport/two_providers_conflict_report github.com/lavanet/lava/v2/protocol/lavaprotocol/finalizationconsensus ‑ TestQoS/APT1#01 github.com/lavanet/lava/v2/protocol/lavaprotocol/finalizationconsensus ‑ TestQoS/APT1#02 github.com/lavanet/lava/v2/protocol/lavaprotocol/finalizationconsensus ‑ TestQoS/APT1#03 … ```

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