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

Update TaprootBuilder::finalize 

This commit does two things:
1) BUG FIX: We should have checked that the length of the branch is 1
before computing the spend_info on it. This was introduced in #936, but
slipped past my review :(
2) Update the return type to return the consumed `self` value. This
function can only error when there the tree building is not complete.
Returning TaprootBuilderError causes issues in downstream projects that
need to deal with error cases which cannot happen in this function
This commit is contained in:
sanket1729 2022-07-28 17:20:16 -07:00
parent 5813ec7ac0
commit 0b88051318
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/util/taproot.rs
View File

@ -199,7 +199,8 @@ impl TaprootSpendInfo {
I: IntoIterator<Item=(u32, Script)>, I: IntoIterator<Item=(u32, Script)>,
C: secp256k1::Verification, C: secp256k1::Verification,
{ {
TaprootBuilder::with_huffman_tree(script_weights)?.finalize(secp, internal_key) let builder = TaprootBuilder::with_huffman_tree(script_weights)?;
Ok(builder.finalize(secp, internal_key).expect("Huffman Tree is always complete"))
} }
/// Creates a new key spend with `internal_key` and `merkle_root`. Provide [`None`] for /// Creates a new key spend with `internal_key` and `merkle_root`. Provide [`None`] for
@ -451,19 +452,23 @@ impl TaprootBuilder {
/// Creates a [`TaprootSpendInfo`] with the given internal key. /// Creates a [`TaprootSpendInfo`] with the given internal key.
/// ///
// TODO: in a future breaking API change, this no longer needs to return result /// Returns the unmodified builder as Err if the builder is not finalized.
/// See also [`TaprootBuilder::is_finalized`]
pub fn finalize<C: secp256k1::Verification>( pub fn finalize<C: secp256k1::Verification>(
mut self, mut self,
secp: &Secp256k1<C>, secp: &Secp256k1<C>,
internal_key: UntweakedPublicKey, internal_key: UntweakedPublicKey,
) -> Result<TaprootSpendInfo, TaprootBuilderError> { ) -> Result<TaprootSpendInfo, TaprootBuilder> {
match self.branch.pop() { match self.branch.len() {
None => Ok(TaprootSpendInfo::new_key_spend(secp, internal_key, None)), 0 => Ok(TaprootSpendInfo::new_key_spend(secp, internal_key, None)),
Some(Some(node)) => { 1 => {
if let Some(Some(node)) = self.branch.pop() {
Ok(TaprootSpendInfo::from_node_info(secp, internal_key, node)) Ok(TaprootSpendInfo::from_node_info(secp, internal_key, node))
} else {
unreachable!("Size checked above. Builder guarantees the last element is Some")
} }
_ => Err(TaprootBuilderError::IncompleteTree), }
_ => Err(self),
} }
} }
@ -1013,8 +1018,6 @@ pub enum TaprootBuilderError {
OverCompleteTree, OverCompleteTree,
/// Invalid taproot internal key. /// Invalid taproot internal key.
InvalidInternalKey(secp256k1::Error), InvalidInternalKey(secp256k1::Error),
/// Called finalize on an incomplete tree.
IncompleteTree,
/// Called finalize on a empty tree. /// Called finalize on a empty tree.
EmptyTree, EmptyTree,
} }
@ -1036,9 +1039,6 @@ impl fmt::Display for TaprootBuilderError {
TaprootBuilderError::InvalidInternalKey(ref e) => { TaprootBuilderError::InvalidInternalKey(ref e) => {
write_err!(f, "invalid internal x-only key"; e) write_err!(f, "invalid internal x-only key"; e)
} }
TaprootBuilderError::IncompleteTree => {
write!(f, "Called finalize on an incomplete tree")
}
TaprootBuilderError::EmptyTree => { TaprootBuilderError::EmptyTree => {
write!(f, "Called finalize on an empty tree") write!(f, "Called finalize on an empty tree")
} }
@ -1057,7 +1057,6 @@ impl std::error::Error for TaprootBuilderError {
InvalidMerkleTreeDepth(_) InvalidMerkleTreeDepth(_)
| NodeNotInDfsOrder | NodeNotInDfsOrder
| OverCompleteTree | OverCompleteTree
| IncompleteTree
| EmptyTree => None | EmptyTree => None
} }
} }