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(sync): check height bound to avoid overflow #1537

Merged
merged 2 commits into from
Mar 6, 2024
Merged

Conversation

tuxcanfly
Copy link
Contributor

@tuxcanfly tuxcanfly commented Feb 9, 2024

Overview

This PR adds an additional check to block height during sync. This avoids potential integer overflow. Fixes #1455

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Bug Fixes
    • Added a validation check to prevent negative initial height values in block and header synchronization processes.

Copy link
Contributor

coderabbitai bot commented Feb 9, 2024

Walkthrough

This update introduces a safeguard against negative initial heights in both the BlockSyncService and HeaderSyncService. By checking the initial height before proceeding with operations, the changes aim to prevent potential issues related to integer conversion, specifically addressing concerns of int64 overflows which were highlighted in a recent audit.

Changes

Files Change Summary
block/block_sync.go
block/header_sync.go
Added check for negative initial height before operations.

Assessment against linked issues

Objective Addressed Explanation
Check when converting from uint64 to int64 header height (#1455)

Poem

In the land of code, where logic reigns,
A rabbit hopped, fixing the chains.
🐇 With a flick and a hop, no height too steep,
Ensuring no negative dive, no erroneous leap.

"Let's guard the gates," it said with a smile,
"Ensure every number, walks the right mile."
🌟 In a world of bytes, where integers clash,
Our rabbit ensures, no overflow, no crash.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@tuxcanfly tuxcanfly marked this pull request as ready for review March 1, 2024 15:57
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between bec9ad0 and 32b37d9.
Files selected for processing (2)
  • block/block_sync.go (1 hunks)
  • block/header_sync.go (1 hunks)
Additional comments: 2
block/block_sync.go (1)
  • 102-104: The check for negative initial height in the WriteToBlockStoreAndBroadcast method is a good preventive measure against integer overflow issues. However, it's important to ensure that this check is also performed or accounted for in any other places where the initial height might be used or modified, to maintain consistency and robustness throughout the application.
block/header_sync.go (1)
  • 101-103: The addition of a check for negative initial height in the WriteToHeaderStoreAndBroadcast method is a prudent step to prevent integer overflow issues. Similar to the BlockSyncService, it's crucial to ensure that this validation is consistently applied across all relevant parts of the application where the initial height might be used or modified.

block/block_sync.go Show resolved Hide resolved
block/header_sync.go Show resolved Hide resolved
@gupadhyaya gupadhyaya added this pull request to the merge queue Mar 6, 2024
Merged via the queue into main with commit f61fa09 Mar 6, 2024
26 of 27 checks passed
@gupadhyaya gupadhyaya deleted the tux/fix-height-cast branch March 6, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Check when converting from uint64 to int64 header height
3 participants