Struct WitnessProgram

pub struct WitnessProgram { /* private fields */ }

The segregated witness program.

The segregated witness program is technically only the program bytes excluding the witness version, however we maintain length invariants on the program that are governed by the version number, therefore we carry the version number around along with the program bytes.

Implementations

impl WitnessProgram

pub fn new( version: WitnessVersion, bytes: &[u8], ) -> Result<WitnessProgram, Error>

Creates a new witness program, copying the content from the given byte slice.

pub fn p2wpkh(pk: &CompressedPublicKey) -> WitnessProgram

Creates a WitnessProgram from pk for a P2WPKH output.

pub fn p2wsh(script: &Script) -> WitnessProgram

Creates a WitnessProgram from script for a P2WSH output.

pub fn p2tr<C>( secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, merkle_root: Option<TapNodeHash>, ) -> WitnessProgram

where C: Verification,

Creates a pay to taproot address from an untweaked key.

pub fn p2tr_tweaked(output_key: TweakedPublicKey) -> WitnessProgram

Creates a pay to taproot address from a pre-tweaked output key.

pub fn version(&self) -> WitnessVersion

Returns the witness program version.

pub fn program(&self) -> &PushBytes

Returns the witness program.

pub fn is_p2wpkh(&self) -> bool

Returns true if this witness program is for a P2WPKH output.

pub fn is_p2wsh(&self) -> bool

Returns true if this witness program is for a P2WPSH output.

pub fn is_p2tr(&self) -> bool

Returns true if this witness program is for a P2TR output.

Trait Implementations

impl Clone for WitnessProgram

fn clone(&self) -> WitnessProgram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WitnessProgram

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

Formats the value using the given formatter.

impl Hash for WitnessProgram

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WitnessProgram

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WitnessProgram

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WitnessProgram

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for WitnessProgram

impl Eq for WitnessProgram

impl StructuralPartialEq for WitnessProgram