Struct bdk_chain::bitcoin::WitnessProgram

pub struct WitnessProgram { /* private fields */ }
Expand description

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. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for WitnessProgram

§

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

Formats the value using the given formatter. Read more
§

impl Hash for WitnessProgram

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl Ord for WitnessProgram

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for WitnessProgram

§

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

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

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

This method 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. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Copy for WitnessProgram

§

impl Eq for WitnessProgram

§

impl StructuralPartialEq for WitnessProgram

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V