Skip to content

Save new block tip #4412

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

Merged
merged 3 commits into from
Mar 1, 2025
Merged

Save new block tip #4412

merged 3 commits into from
Mar 1, 2025

Conversation

jackzhhuang
Copy link
Collaborator

@jackzhhuang jackzhhuang commented Mar 1, 2025

1, Save the new tips with the new block header not the selected header. If they are the same as another, the main header tips will be affected, else, the sub branch of the main will be affected.

2, Create the tips using parent id if the new block header's parent's pruning point was not saved.

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Other information

Summary by CodeRabbit

  • New Features

    • Introduced a dedicated mechanism for updating the chain’s state that enhances overall system resilience.
  • Bug Fixes

    • Improved error handling to gracefully recover from missing data scenarios, reducing unexpected interruptions and enhancing stability.

@jackzhhuang jackzhhuang requested a review from sanlee42 March 1, 2025 05:28
@jackzhhuang jackzhhuang requested a review from nkysg as a code owner March 1, 2025 05:28
Copy link

coderabbitai bot commented Mar 1, 2025

Walkthrough

The pull request improves error handling in the blockchain code by modifying the connect_dag method in chain/src/chain.rs. It replaces direct error propagation from the current_tips_hash call with a match statement that distinguishes between a KeyNotFound error, which triggers saving a new DAG state using the parent's header, and other errors that are propagated. Additionally, the new renew_tips method is introduced to encapsulate the logic for renewing tips based on the pruning point comparison.

Changes

File(s) Change Summary
chain/src/chain.rs Revised error handling in connect_dag by matching on the result from current_tips_hash, specifically handling KeyNotFound errors by saving new DAG state; added renew_tips method to encapsulate tip renewal logic.

Sequence Diagram(s)

sequenceDiagram
    participant BC as BlockChain
    participant CT as current_tips_hash
    participant DS as DAG State Store
    participant RT as renew_tips

    BC->>CT: Call current_tips_hash(pruning_point)
    alt KeyNotFound Error
        CT-->>BC: Return KeyNotFound error
        BC->>DS: Save new DAG state with parent_header tip
    else Other Error
        CT-->>BC: Return error
        BC-->>BC: Propagate error upwards
    else Success
        CT-->>BC: Return current tips
    end
    Note over BC,RT: Invoke tip renewal logic
    BC->>RT: Call renew_tips(parent_header, tip_header, tips)
    RT-->>DS: Update state based on pruning point check
Loading

Suggested reviewers

  • welbon
  • nkysg
  • simonjiao
  • yourmoonlight
  • sanlee42

Poem

I'm a hopping rabbit, code in my sight,
Fixing logic where errors once took flight.
With each tip renewed and bugs at bay,
I frolic in the DAG state all day.
Carrots and clean code guide my way!
🥕🐇

✨ Finishing Touches
  • 📝 Generate Docstrings

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>, 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.
  • @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.

@jackzhhuang jackzhhuang removed the request for review from nkysg March 1, 2025 05:28
@jackzhhuang jackzhhuang enabled auto-merge (squash) March 1, 2025 05:30
Copy link

@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

🧹 Nitpick comments (1)
chain/src/chain.rs (1)

1629-1657: Optimize logging to handle large tip sets gracefully.

Logging the entire set of tips at the info level could generate excessive log output if the DAG grows large. Consider only logging the size of the tips or switching to a debug level if the number of tips can become large.

- info!("pruning point not changed, save dag state without prune. tips are {:?}, pruning point is {:?}", tips, tip_header.pruning_point());
+ info!(
+     "pruning point not changed, save dag state without prune. tips count: {}, pruning point is {:?}",
+     tips.len(),
+     tip_header.pruning_point()
+ );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9a9407d and 090afb9.

📒 Files selected for processing (1)
  • chain/src/chain.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build and test
🔇 Additional comments (2)
chain/src/chain.rs (2)

1555-1571: Ensure KeyNotFound scenario is appropriately handled.

When encountering a KeyNotFound error for the parent pruning point, this logic creates a new DAG state using the parent’s ID as the lone tip. While this is a valid recovery strategy, please confirm that this behavior aligns with the intended chain continuity and that no alternative configuration is inadvertently overwritten.

Would you like a script to trace potential orphan states and confirm that the parent block is part of the main lineage before creating a new DAG state?


1624-1627: Good invocation of renew_tips.

Calling self.renew_tips ensures tips remain consistent with updated pruning points prior to returning the executed block. The error propagation using ? properly prevents partial state updates.

@jackzhhuang jackzhhuang merged commit c01ef2b into dag-master Mar 1, 2025
3 of 5 checks passed
@jackzhhuang jackzhhuang deleted the save-new-block-tip branch March 1, 2025 06:36
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