Enum wallet::descriptor::Category

#[non_exhaustive]
#[repr(u8)]
pub enum Category {
    Bare,
    Hashed,
    Nested,
    SegWit,
    Taproot,
}

Descriptor category specifies way how the scriptPubkey is structured

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future 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 sigScript containing copy of [LockScript] in redeemScript field

Nested

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 RedeemScript in sigScript transaction input field, while the original public key or WitnessScript are stored in witness. scriptPubkey contains a normal P2SH composed agains the redeemScript from sigScript (P2SH-P2WPKH and P2SH-P2WSH variants).

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

SegWit

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 [LockScript] or the public key

Taproot

Native Taproot descriptors: taproot

Implementations

impl Category

pub fn is_witness(self) -> bool

pub fn into_outer_category(self) -> ContentType

Trait Implementations

impl Clone for Category

fn clone(&self) -> Category

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Category

impl Debug for Category

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

Formats the value using the given formatter.

impl Deduce for Category

fn deduce(
    pubkey_script: &PubkeyScript,
    has_witness: Option<bool>
) -> Result<Category, DeductionError>

Deduction of a descriptor from a scriptPubkey data and, optionally, information about the presence of the witness for P2SH scriptPubkey’s.

impl Display for Category

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

Formats the value using the given formatter.

impl Eq for Category

impl From<Category> for ContentType

fn from(category: Category) -> Self

Performs the conversion.

impl<Pk> From<Descriptor<Pk>> for Category where
    Pk: MiniscriptKey, 

fn from(descriptor: Descriptor<Pk>) -> Self

Performs the conversion.

impl From<FullType> for Category

fn from(full: FullType) -> Self

Performs the conversion.

impl Hash for Category

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

Feeds this value into the given Hasher.

pub 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 Category

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Category> for Category

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Category> for Category

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 StrictDecode for Category

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for Category

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl StructuralEq for Category

impl StructuralPartialEq for Category