Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(relay): off-by-one slot when fetching from constraints cache #145

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

thedevbirb
Copy link
Contributor

@thedevbirb thedevbirb commented Jul 18, 2024

which results in the relay not verifying constraints proofs after builder submission

Summary by CodeRabbit

  • Bug Fixes

    • Updated error messages and log outputs to include the correct slot number, improving clarity and debugging.
  • Improvements

    • Enhanced log messages to clearly indicate successful verification of constraints and proofs with a new [BOLT] prefix.

…ch results in the relay not verifying constraints proofs after builder submission
Copy link
Contributor

coderabbitai bot commented Jul 18, 2024

Walkthrough

This update enhances the updateRedisBidWithProofs function in the RelayAPI struct by recalculating the slot value as the previous slot plus one, using this new slot value to fetch slot constraints and update log messages. Additionally, a [BOLT] prefix was added to log messages for clarity during constraint and proof verification. These changes improve error reporting and logging accuracy.

Changes

File Change Summary
mev-boost-relay/services/... Updated updateRedisBidWithProofs to use a new slot value, adjusted log messages, added [BOLT] prefix

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between d81c826 and fd4de3e.

Files selected for processing (1)
  • mev-boost-relay/services/api/service.go (3 hunks)
Additional comments not posted (5)
mev-boost-relay/services/api/service.go (5)

2151-2152: Introduce a new local variable newSlot.

The new local variable newSlot is introduced to store the value of api.headSlot.Load() + 1. This change is necessary to address the off-by-one error when fetching from the constraints cache.


2153-2153: Retrieve slot constraints using newSlot.

The retrieval of slotConstraints is now based on the newSlot value. This ensures that the correct slot constraints are fetched.


2157-2157: Update error log to reference newSlot.

The error log message now references newSlot instead of the previous slot value. This improves the accuracy of the log message.


2177-2177: Update warning log to reference newSlot.

The warning log message now references newSlot instead of the previous slot value. This improves the accuracy of the log message.


2188-2188: Add [BOLT] prefix to log message.

The log message now includes a [BOLT] prefix for clarity when reporting successful verification of constraints and proofs.

@thedevbirb thedevbirb merged commit ffad353 into unstable Jul 18, 2024
2 checks passed
@thedevbirb thedevbirb deleted the fix/relay/constraints-slot branch July 18, 2024 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant