Enum DescriptorScript 

pub enum DescriptorScript {
    Key(DescriptorKey),
    Pkh(DescriptorKey),
    Wpkh(DescriptorKey),
    Sh(Box<DescriptorScript>),
    Wsh(Box<DescriptorScript>),
    Combo(DescriptorKey),
    Multi {
        threshold: usize,
        keys: Vec<DescriptorKey>,
    },
    SortedMulti {
        threshold: usize,
        keys: Vec<DescriptorKey>,
    },
    Addr(String),
    Raw(String),
    Tr {
        internal_key: DescriptorKey,
        tree: Option<Box<DescriptorTree>>,
    },
}

The parsed inner expression of an output descriptor.

This enum models all descriptor types defined in BIPs 380-386.

Variants

Key(DescriptorKey)

pk(KEY) — bare pubkey output (BIP 380).

Pkh(DescriptorKey)

pkh(KEY) — P2PKH (BIP 382).

Wpkh(DescriptorKey)

wpkh(KEY) — P2WPKH (BIP 381/382).

Sh(Box<DescriptorScript>)

sh(SCRIPT) — P2SH wrapper (BIP 383).

Wsh(Box<DescriptorScript>)

wsh(SCRIPT) — P2WSH wrapper (BIP 381).

Combo(DescriptorKey)

combo(KEY) — pk + pkh + if-segwit wpkh + p2sh-wpkh (BIP 384).

Multi

multi(K, KEY…) — bare multisig (BIP 383).

Fields

threshold: usize

The required-signature threshold K.

keys: Vec<DescriptorKey>

The N keys.

SortedMulti

sortedmulti(K, KEY…) — multisig with sorted keys (BIP 383).

Fields

threshold: usize

The required-signature threshold K.

keys: Vec<DescriptorKey>

The N keys (sorted at script generation time).

Addr(String)

addr(ADDRESS) — raw address descriptor (BIP 385).

Raw(String)

raw(HEX) — raw script hex (BIP 385).

Tr

tr(KEY) or tr(KEY, TREE) — Taproot (BIP 386).

Fields

internal_key: DescriptorKey

Taproot internal key.

tree: Option<Box<DescriptorTree>>

Optional script-path tree.

Implementations

impl DescriptorScript

pub fn type_name(&self) -> &str

Return a short string naming the top-level function.

pub fn keys(&self) -> Vec<&DescriptorKey>

Collect all DescriptorKey references in this script recursively.

pub fn is_ranged(&self) -> bool

Returns true when at least one key path in this script contains a derivation wildcard (*).

Trait Implementations

impl Clone for DescriptorScript

fn clone(&self) -> DescriptorScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorScript

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

Formats the value using the given formatter.