Struct bitcoin_scripts::WitnessScript

pub struct WitnessScript(_);

A content of the script from witness structure; en equivalent of redeemScript for witness-based transaction inputs. However, unlike RedeemScript, WitnessScript produce SHA256-based hashes of WScriptHash type.

Witness script can be nested within the redeem script in legacy P2WSH-in-P2SH schemes; for this purpose use RedeemScript::from method.

Implementations

impl WitnessScript

pub fn script_hash(&self) -> WScriptHash

Computes script commitment which participates in Witness or RedeemScript.

pub fn to_p2wsh(&self) -> PubkeyScript

Generates PubkeyScript matching given witnessScript for native SegWit outputs.

pub fn to_p2sh_wsh(&self) -> PubkeyScript

Generates PubkeyScript matching given witnessScript for legacy P2WSH-in-P2SH outputs.

Trait Implementations

impl AsMut<<WitnessScript as Wrapper>::Inner> for WitnessScript

fn as_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<<WitnessScript as Wrapper>::Inner> for WitnessScript

fn as_ref(&self) -> &<Self as Wrapper>::Inner

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<<WitnessScript as Wrapper>::Inner> for WitnessScript

fn borrow(&self) -> &<Self as Wrapper>::Inner

Immutably borrows from an owned value.

impl BorrowMut<<WitnessScript as Wrapper>::Inner> for WitnessScript

fn borrow_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Mutably borrows from an owned value.

impl Clone for WitnessScript

fn clone(&self) -> WitnessScript

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WitnessScript

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

Formats the value using the given formatter.

impl Default for WitnessScript

fn default() -> WitnessScript

Returns the “default value” for a type.

impl Deref for WitnessScript

type Target = <WitnessScript as Wrapper>::Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for WitnessScript

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for WitnessScript

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

Formats the value using the given formatter.

impl From<LockScript> for WitnessScript

fn from(lock_script: LockScript) -> Self

Converts to this type from the input type.

impl From<Script> for WitnessScript

fn from(v: Script) -> Self

Converts to this type from the input type.

impl From<WitnessScript> for LockScript

fn from(witness_script: WitnessScript) -> Self

Converts to this type from the input type.

impl From<WitnessScript> for RedeemScript

fn from(witness_script: WitnessScript) -> Self

Converts to this type from the input type.

impl From<WitnessScript> for Script

fn from(wrapped: WitnessScript) -> Self

Converts to this type from the input type.

impl Hash for WitnessScript

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for WitnessScript

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

Formats the value using the given formatter.

impl Ord for WitnessScript

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<WitnessScript> for WitnessScript

fn eq(&self, other: &WitnessScript) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<WitnessScript> for WitnessScript

fn partial_cmp(&self, other: &WitnessScript) -> 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 Strategy for WitnessScript

type Strategy = Wrapped

Specific strategy. List of supported strategies:

impl ToPubkeyScript for WitnessScript

fn to_pubkey_script(&self, strategy: ConvertInfo) -> Option<PubkeyScript>

Generates scriptPubkey for segwit non-taproot contexts. Fails by returning None for the following contexts:

• ConvertInfo::Bare since no witness structure will be present in the output transaction;
• ConvertInfo::Hashed since no witness structure will be present in the output transaction
• ConvertInfo::Taproot since taproot does not have an associated WitnessScript.

impl UpperHex for WitnessScript

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

Formats the value using the given formatter.

impl Wrapper for WitnessScript

type Inner = Script

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

Clones inner data of the wrapped type and return them

impl Eq for WitnessScript

impl StructuralEq for WitnessScript

impl StructuralPartialEq for WitnessScript