Enum bitcoin_scripts::convert::ConvertInfo

#[repr(u8)]
pub enum ConvertInfo {
    Bare,
    Hashed,
    NestedV0,
    SegWitV0,
    Taproot,
}

Descriptor category specifies way how the scriptPubkey is structured

Variants

Bare

Bare descriptors: pk and bare scripts, including OP_RETURNs.

The script or public key gets right into scriptPubkey, i.e. as P2PK (for a public key) or as custom script (mostly used for OP_RETURN)

Hashed

Hash-based descriptors: pkh for public key hashes and BIP-16 sh for P2SH scripts.

We hash public key or script and use non-SegWit scriptPubkey encoding, i.e. P2PKH or P2SH with corresponding non-segwit transaction input scriptSig containing copy of crate::LockScript in redeemScript field

NestedV0

SegWit descriptors for legacy wallets defined in BIP 141 as P2SH nested types https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki#P2WPKH_nested_in_BIP16_P2SH: sh(wpkh) and sh(wsh)

Compatibility variant for SegWit outputs when the SegWit version and program are encoded as crate::RedeemScript in scriptSig transaction input field, while the original public key or crate::WitnessScript are stored in witness. scriptPubkey contains a normal P2SH composed agains the redeemScript from scriptSig (P2SH-P2WPKH and P2SH-P2WSH variants).

This type works with only with witness version v0, i.e. not applicable for Taproot.

SegWitV0

Native SegWit descriptors: wpkh for public keys and wsh for scripts

We produce either P2WPKH or P2WSH output and use witness field in transaction input to store the original crate::LockScript or the public key

Taproot

Native Taproot descriptors: taproot

Implementations

impl ConvertInfo

pub fn is_segwit(self) -> bool

Detects whether conversion is a non-nested segwit

pub fn is_taproot(self) -> bool

Detects whether conversion is a taproot conversion

Trait Implementations

impl Clone for ConvertInfo

fn clone(&self) -> ConvertInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConvertInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ConvertInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ConvertInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ConvertInfo

fn cmp(&self, other: &ConvertInfo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ConvertInfo> for ConvertInfo

fn eq(&self, other: &ConvertInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ConvertInfo> for ConvertInfo

fn partial_cmp(&self, other: &ConvertInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ConvertInfo

impl Eq for ConvertInfo

impl StructuralEq for ConvertInfo

impl StructuralPartialEq for ConvertInfo