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

Improve docs in LeafVersion

This commit is contained in:
Dr Maxim Orlovsky 2022-01-07 16:03:04 +01:00
parent 839c022f29
commit b028385a72
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/util/taproot.rs
View File

@ -771,8 +771,12 @@ pub enum LeafVersion {
} }
impl LeafVersion { impl LeafVersion {
/// Obtain LeafVersion from u8, will error when last bit of ver is odd or /// Obtain LeafVersion from consensus byte representation.
/// when ver is 0x50 (ANNEX_TAG) ///
/// # Errors
/// - If the last bit of the `version` is odd.
/// - If the `version` is 0x50 ([`TAPROOT_ANNEX_PREFIX`]).
/// - If the `version` is not a valid [`LeafVersion`] byte.
// Text from BIP341: // Text from BIP341:
// In order to support some forms of static analysis that rely on // In order to support some forms of static analysis that rely on
// being able to identify script spends without access to the output being // being able to identify script spends without access to the output being
@ -791,7 +795,7 @@ impl LeafVersion {
} }
} }
/// Get the inner version from LeafVersion /// Get consensus representation of the [`LeafVersion`].
pub fn into_consensus(self) -> u8 { pub fn into_consensus(self) -> u8 {
match self { match self {
LeafVersion::TapScript => TAPROOT_LEAF_TAPSCRIPT, LeafVersion::TapScript => TAPROOT_LEAF_TAPSCRIPT,