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.

Sign up for GitHub

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

Jump to bottom

Add invalidate block method and invalidated_blocks field to NonFinalizedState #9167

Merged
merged 5 commits into from
Feb 11, 2025
Merged

Add invalidate block method and invalidated_blocks field to NonFinalizedState #9167

merged 5 commits into from
Feb 11, 2025

Conversation

elijahhampton
Copy link
Contributor

@elijahhampton elijahhampton commented Jan 26, 2025 •
edited by arya2
Loading

Motivation

This PR implements a new method invalidate_block to invalidate a block based on the block::Hash along with the blocks descendants. This PR closes the following issue: #8840 , #8841

Specifications & References

Reference: #8634

Solution

  • Adds invalidate_block method to NonFinalizedState
  • Changes visibility to pub(crate) for UpdateWith / RevertPosition in chain.rs
  • Adds test for invalidate_block in vectors.rs
  • Adds new invalidated_blocks state to NonFinalizedState

Tests

Follow-up Work

PR Author's Checklist

  • The PR name will make sense to users.
  • The PR provides a CHANGELOG summary.
  • The solution is tested.
  • The documentation is up to date.
  • The PR has a priority label.

PR Reviewer's Checklist

  • The PR Author's checklist is complete.
  • The PR resolves the issue.

Elijah Hampton added 2 commits January 25, 2025 19:38
Adds new invalidate_block method to non finalized state. Adds test ca…
84b2cd1 
…se in vectors.rs. Updates non finalized state to track invalidated_blocks
Merge branch 'main' of github.com:elijahhampton/zebra into add-invali…
a4b0a5a 
…date-block-method-to-nonfinalizedstate
@elijahhampton elijahhampton requested a review from a team as a code owner January 26, 2025 00:47
@elijahhampton elijahhampton requested review from arya2 and removed request for a team January 26, 2025 00:47
@elijahhampton
Copy link
Contributor Author

Closes #8840 , #8841

This was linked to issues Jan 27, 2025
Add an invalidate_block() method to the NonFinalizedState for removing a block and its descendents #8841
Closed
Add a field to the NonFinalizedState for invalidated blocks #8840
Closed
arya2
arya2 previously approved these changes Jan 29, 2025
View reviewed changes
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

Thank you for getting this done.

This looks excellent. I left some optional suggestions, but none of them are blockers so feel free to resolve them without making changes if you'd like this to merge as-is.

@arya2 arya2 added I-usability Zebra is hard to understand or use C-testing Category: These are tests A-rpc Area: Remote Procedure Call interfaces A-state Area: State / database changes C-feature Category: New features P-Medium ⚡ labels Jan 29, 2025
@oxarbitrage oxarbitrage added do-not-merge Tells Mergify not to merge this PR and removed do-not-merge Tells Mergify not to merge this PR labels Feb 3, 2025
@elijahhampton
Removes InvalidatedBlockData struct. Wraps invalidated_blocks HashMap…
fa9f4c8 
… values with Arc. Optimizies invalidate_block fn to return early if root has hash of desired block.
@elijahhampton elijahhampton requested a review from arya2 February 5, 2025 22:56
arya2
arya2 reviewed Feb 6, 2025
View reviewed changes
Copy link
Contributor

@arya2 arya2 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you for the updates!

I left a suggestion for refactoring the methods, but if you'd prefer to keep it as-is, the only blocker is updating the invalidated_blocks field before returning early in NonFinalizedState.invalidate_block().

@elijahhampton
Adds child_blocks method and refactors invalidate_block in chain.rs. …
a4af5d1 
…Refactors invalidate_block in NonFinalizedState.
@elijahhampton
Copy link
Contributor Author

Thank you for the updates!

I left a suggestion for refactoring the methods, but if you'd prefer to keep it as-is, the only blocker is updating the invalidated_blocks field before returning early in NonFinalizedState.invalidate_block().

I refactored the functions with the suggested changes

@elijahhampton elijahhampton requested a review from arya2 February 7, 2025 21:03
arya2
arya2 approved these changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

Thanks again!

mergify bot added a commit that referenced this pull request Feb 10, 2025
@mergify
Merge of #9167
b44c5d7
@mergify mergify bot mentioned this pull request Feb 10, 2025
Closed
mergify bot added a commit that referenced this pull request Feb 10, 2025
@mergify
Merge of #9167
e67d347
@mergify mergify bot mentioned this pull request Feb 10, 2025
Closed
@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 10, 2025

This pull request has been removed from the queue for the following reason: checks failed.

The merge conditions cannot be satisfied due to failing checks:

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

@mpguerra
Copy link
Contributor

@mergify requeue

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 11, 2025

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify bot added a commit that referenced this pull request Feb 11, 2025
@mergify
Merge of #9167
736182d
@mergify mergify bot mentioned this pull request Feb 11, 2025
Closed
mergify bot added a commit that referenced this pull request Feb 11, 2025
@mergify
Merge of #9167
b6cb0d5
@mergify mergify bot mentioned this pull request Feb 11, 2025
Closed
mergify bot added a commit that referenced this pull request Feb 11, 2025
@mergify
Merge of #9167
8882eec
@mergify mergify bot mentioned this pull request Feb 11, 2025
Closed
mergify bot added a commit that referenced this pull request Feb 11, 2025
@mergify
Merge of #9167
4b5c195
@mergify mergify bot mentioned this pull request Feb 11, 2025
Closed
mergify bot added a commit that referenced this pull request Feb 11, 2025
@mergify
Merge of #9167
d0e1a4a
@mergify mergify bot mentioned this pull request Feb 11, 2025
Closed
mergify bot added a commit that referenced this pull request Feb 11, 2025
@mergify
Merge of #9167
7b218d1
@mergify mergify bot merged commit 9bda2c8 into ZcashFoundation:main Feb 11, 2025
86 checks passed
gustavovalverde pushed a commit that referenced this pull request Feb 13, 2025
@elijahhampton @gustavovalverde
Add invalidate block method and invalidated_blocks field to NonFinali…
6715833 
…zedState (#9167)

* Adds new invalidate_block method to non finalized state. Adds test case in vectors.rs. Updates non finalized state to track invalidated_blocks

* Removes InvalidatedBlockData struct. Wraps invalidated_blocks HashMap values with Arc. Optimizies invalidate_block fn to return early if root has hash of desired block.

* Update metrics whenever chain_set is modified

* Adds child_blocks method and refactors invalidate_block in chain.rs. Refactors invalidate_block in NonFinalizedState.

---------

Co-authored-by: Elijah Hampton <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arya2 arya2 arya2 approved these changes

Assignees

@elijahhampton elijahhampton

Labels
A-rpc Area: Remote Procedure Call interfaces A-state Area: State / database changes C-feature Category: New features C-testing Category: These are tests I-usability Zebra is hard to understand or use P-Medium ⚡
Projects
None yet
Milestone
No milestone
4 participants
@elijahhampton @mpguerra @arya2 @oxarbitrage