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: header sync timestamp validation #6799

Merged
merged 2 commits into from
Feb 17, 2025

Conversation

SWvheerden
Copy link
Collaborator

@SWvheerden SWvheerden commented Feb 17, 2025

Description

Fixes validation by sorting the timestamps during syncing

Block timestamps are supposed to be after the median of the past 11 blocks. Median is supposed to be ordered, this was not ordered for syncing but was ordered for propagation. This PR makes sure the list is always sorted.

Summary by CodeRabbit

  • Bug Fixes
    • Improved accuracy of time-related computations by ensuring the median is calculated correctly through sorting.
    • Added enhanced logging to provide clearer diagnostics for timing discrepancies when block header timestamps are less than the median.

@SWvheerden SWvheerden requested a review from a team as a code owner February 17, 2025 15:39
Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

The changes update helper functions in the validation module to ensure that the median timestamp is computed correctly. A sorting mechanism is now applied to the timestamps vector in the calc_median_timestamp function, and an additional warning log in the check_header_timestamp_greater_than_median function logs the timestamps vector when the block header timestamp is below the computed median. The overall control flow remains unchanged, with improvements aimed at robustness and easier debugging.

Changes

File Change Summary
base_layer/core/src/validation/helpers.rs Added sorting of the timestamps vector in calc_median_timestamp for accurate median calculation; introduced warning logging in check_header_timestamp_greater_than_median when header timestamps are below the median.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant calc_median_timestamp
    Caller->>+calc_median_timestamp: Provide unsorted timestamps slice
    calc_median_timestamp->>calc_median_timestamp: Clone timestamps to mutable vector and sort
    calc_median_timestamp->>calc_median_timestamp: Compute median value
    calc_median_timestamp-->>Caller: Return median timestamp
Loading
sequenceDiagram
    participant Caller
    participant check_header_timestamp_greater_than_median
    participant Logger
    Caller->>+check_header_timestamp_greater_than_median: Call with header timestamp and median
    check_header_timestamp_greater_than_median->>check_header_timestamp_greater_than_median: Compare header timestamp to median
    alt Header Timestamp < Median
        check_header_timestamp_greater_than_median->>Logger: Log warning with timestamps vector
    end
    check_header_timestamp_greater_than_median-->>Caller: Return verification result
Loading

Poem

I'm a little rabbit, swift on my feet,
Hopping through code with a rhythmic beat.
Sorting timestamps so they neatly align,
And logging warnings when numbers decline.
In fields of logic, I bounce with delight,
Coding with charm from morning till night.
🐇✨ Happy hops in every byte!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3071352 and d8050ad.

📒 Files selected for processing (1)
  • base_layer/core/src/validation/helpers.rs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • base_layer/core/src/validation/helpers.rs
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: test (mainnet, stagenet)
  • GitHub Check: test (nextnet, nextnet)
  • GitHub Check: test (testnet, esmeralda)
  • GitHub Check: cargo check with stable
  • GitHub Check: clippy

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

Test Results (CI)

    2 files     72 suites   21m 30s ⏱️
1 360 tests 1 359 ✅ 0 💤 1 ❌
2 402 runs  2 401 ✅ 0 💤 1 ❌

For more details on these failures, see this check.

Results for commit 3071352.

@SWvheerden SWvheerden merged commit c705ffe into tari-project:development Feb 17, 2025
10 of 13 checks passed
@SWvheerden SWvheerden changed the title fix: validation fix: header sync timestamp validation Feb 18, 2025
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.

2 participants