milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

rename try_into_taptree into try_into_tap_tree 

- docs(taproot): hide deprecated try_into_taptree
This commit is contained in:
aagbotemi 2025-04-19 10:45:55 +01:00
parent c85648cfd4
commit 73317c1c31
No known key found for this signature in database
GPG Key ID: 37C137D831F0A852
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
bitcoin/src/taproot/mod.rs
View File

@ -543,7 +543,22 @@ impl TaprootBuilder {
/// Converts the builder into a [`TapTree`] if the builder is a full tree and /// Converts the builder into a [`TapTree`] if the builder is a full tree and
/// does not contain any hidden nodes /// does not contain any hidden nodes
#[deprecated(since = "TBD", note = "use `try_into_tap_tree()` instead")]
#[doc(hidden)]
pub fn try_into_taptree(self) -> Result<TapTree, IncompleteBuilderError> { pub fn try_into_taptree(self) -> Result<TapTree, IncompleteBuilderError> {
self.try_into_tap_tree()
}
/// Converts the builder into a [`TapTree`] if the builder is a full tree and
/// does not contain any hidden nodes.
///
/// This function finalizes the taproot construction process by validating that the builder
/// is complete, and there are no hidden nodes, which would make the tree incomplete or ambiguous.
///
/// # Errors
///
/// Returns [`IncompleteBuilderError::HiddenParts`] if the builder contains any hidden nodes.
pub fn try_into_tap_tree(self) -> Result<TapTree, IncompleteBuilderError> {
let node = self.try_into_node_info()?; let node = self.try_into_node_info()?;
if node.has_hidden_nodes { if node.has_hidden_nodes {
// Reconstruct the builder as it was if it has hidden nodes // Reconstruct the builder as it was if it has hidden nodes
@ -770,7 +785,7 @@ impl TryFrom<TaprootBuilder> for TapTree {
/// ///
/// A [`TapTree`] iff the `builder` is complete, otherwise return [`IncompleteBuilderError`] /// A [`TapTree`] iff the `builder` is complete, otherwise return [`IncompleteBuilderError`]
/// error with the content of incomplete `builder` instance. /// error with the content of incomplete `builder` instance.
fn try_from(builder: TaprootBuilder) -> Result<Self, Self::Error> { builder.try_into_taptree() } fn try_from(builder: TaprootBuilder) -> Result<Self, Self::Error> { builder.try_into_tap_tree() }
} }
impl TryFrom<NodeInfo> for TapTree { impl TryFrom<NodeInfo> for TapTree {