fix(crypt): Avoid expensive note commitment tree root recalculations in eq() methods #7386
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Re-calculating note commitment tree roots can take a long time if the root isn't cached in the state, or already calculated by Zebra.
Instead, it is cheaper to compare the tree frontier, which is at most 32 roots. (Less than 1 kB of byte comparisons.)
Specifications
https://docs.rs/incrementalmerkletree/0.4.0/incrementalmerkletree/frontier/struct.NonEmptyFrontier.html#impl-PartialEq%3CNonEmptyFrontier%3CH%3E%3E-for-NonEmptyFrontier%3CH%3E
Complex Code or Requirements
This fix helps avoid weird performance bugs in the next few state upgrades. We've already seen some performance issues in this code.
Solution
If both roots are cached, compare them. Otherwise, compare the whole frontier.
Review
This might be needed to get some tests for PR #7379 to pass.
Reviewer Checklist