TaprootMerkleBranch improvements
#2263
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kixunil
added
enhancement
API break
Kixunil
force-pushed
the
taproot-merkle-branch-improvements
branch
7 times, most recently
from
d3665af
to
20a65c7
Compare
While `clippy` now allows `TBD` to be used in `since` parameter of `deprecated` attribute it is only available in the newest, nightly, version. Switch `clippy` version to nightly to enable the `TBD` value.
These names are more descriptive.
Kixunil
force-pushed
the
taproot-merkle-branch-improvements
branch
from
20a65c7
to
83f00d9
Compare
tcharding
reviewed
Dec 8, 2023
tcharding
reviewed
Dec 8, 2023
| self.0.iter() | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
If we have DerefMut is there a reason we don't have IntoIterator for &'a mut TaprootMerkleBranch?
I see we do get iter_mut (from having Deref to a slice I believe).
(I'm trying to deepen my understanding of all all these stdlib traits.)
There was a problem hiding this comment.
Oh, I forgot about that one!
The type is naturally a collection of hashes so make it behave that way by implementing `Deref`, `AsRef`, `Borrow` and their mutable versions as well as `IntoIterator` for its reference. `IntoIterator` for itself is not yet implemented because it's a bit more complicated.
Since the iterator created by `IntoIterator` should be called `IntoIter` we move the whole `TaprootMerkleBranch` to its own module which contains the type to avoid confusion. This has an additional benefit of reducing the scope where the invariant could be broken. This already uncovered that our internal code was abusing access to the private field (although the code was correct). To implement the iterator we simply delegate to `vec::IntoIter`, including overriding the default method which are likely to be implemented by `Vec` more optimally. We avoid exposing `vec::IntoIter` directly since we may want to change the representation (e.g. to `ArrayVec`).
These functions either delegate to functions with identical signature or contain condition that may be optimized-out after inlining.
Kixunil
force-pushed
the
taproot-merkle-branch-improvements
branch
from
83f00d9
to
e1cc989
Compare
|
Added the missing |
tcharding
approved these changes
Dec 9, 2023
tcharding
reviewed
Dec 9, 2023
| /// | ||
| /// # Errors | ||
| /// If inner proof length is more than [`TAPROOT_CONTROL_MAX_NODE_COUNT`] (128). | ||
| #[inline] |
There was a problem hiding this comment.
What is the benefit of inlining a private function?
There was a problem hiding this comment.
Not thinking when I add attributes. :D But it's harmless so I suggest let's keep it unless anyone objects or the PR has to change anyway.
|
LGTM! Note that we're almost guaranteed to get breakages from using a nightly clippy. |
apoelstra
approved these changes
Dec 11, 2023
|
If we want to use |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This contains several improvements to
TaprootMerkleBranchthat make the API more idiomatic.