fix: commitment deadline in case of missed block

namn-grg commented 1 month ago

Fixes #180

Summary by CodeRabbit

New Features
- Enhanced consensus management with the addition of a consensus_clock for improved time representation related to consensus slots.
- New method to retrieve the cached beacon genesis timestamp from the HeadTracker.
Bug Fixes
- Improved resilience in fetching the beacon genesis timestamp with a retry mechanism.
Refactor
- Simplified ConsensusState by removing the header field and renaming update_head to update_slot for clearer slot management.
- Standardized retry logic for subscribing to new head events in the HeadTracker.
Tests
- Added test cases to verify the correct behavior of the updated slot management functionality.

namn-grg commented 1 month ago

@coderabbitai review

coderabbitai[bot] commented 1 month ago

Walkthrough

Ahoy there! This grand update brings a treasure trove of changes to the SidecarDriver, ConsensusState, and HeadTracker. With enhancements to consensus management and more robust state handling, ye now have a mechanism that keeps better time with the blockchain—ensuring that missed blocks don’t leave ye stranded in the storm! The crew has made it easier to track events and state updates, setting a course for smoother sailing ahead.

Changes

Files	Change Summary
`.../driver.rs`, `.../consensus.rs`	Introduced `consensus_clock` in `SidecarDriver` for handling time and slot updates; removed `header` from `ConsensusState` for simplified management. Renamed `update_head` to `update_slot`.
`.../head_tracker.rs`	Added `beacon_genesis_timestamp` to cache the beacon genesis time; improved retry logic for fetching genesis details; introduced a public method for accessing the cached timestamp.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SidecarDriver
    participant ConsensusClock
    participant HeadTracker

    User->>SidecarDriver: Start driver
    SidecarDriver->>ConsensusClock: Initialize clock
    ConsensusClock-->>SidecarDriver: Clock ready
    SidecarDriver->>HeadTracker: Subscribe to new heads
    HeadTracker-->>SidecarDriver: New head event
    SidecarDriver->>ConsensusClock: Check for slot updates
    ConsensusClock-->>SidecarDriver: Slot updated
    SidecarDriver->>User: Respond with latest state

Assessment against linked issues

Objective	Addressed	Explanation
Fault tolerance for missed block initiation (180)	✅
Improved timing logic with consensus slot updates (180)	✅
Maintain separation of execution and consensus state (180)	❌	The new logic does not fully decouple timing from execution state updates.

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.

namn-grg commented 1 month ago

Thanks for the speedy review! Addressed it

chainbound / bolt