Struct WScriptHash 

pub struct WScriptHash(/* private fields */);

SegWit (256-bit) version of a Bitcoin Script bytecode hash.

Note: there is another “script hash” object in bitcoin ecosystem (Electrum protocol) that looks similar to this one also being SHA256, however, they hash semantically different scripts and have reversed representations, so this type cannot be used for both.

Implementations

impl WScriptHash

pub fn from_script( witness_script: &WitnessScript, ) -> Result<Self, WitnessScriptSizeError>

Constructs a new WScriptHash after first checking the script size.

10,000-byte limit on the witness script

The witnessScript (≤ 10,000 bytes) is popped off the initial witness stack. SHA256 of the witnessScript must match the 32-byte witness program.

ref: BIP-0141

Errors

Returns an error if the script exceeds 10,000 bytes.

pub fn from_script_unchecked(script: &WitnessScript) -> Self

Constructs a new WScriptHash from any script irrespective of script size.

If you hash a script that exceeds 10,000 bytes in size and use it to create a Segwit output then the output will be unspendable (see [BIP-0141]).

ref: BIP-0141

impl WScriptHash

pub const fn from_byte_array(bytes: [u8; 32]) -> Self

Constructs a new type from the underlying byte array.

pub const fn to_byte_array(self) -> [u8; 32]

Returns the underlying byte array.

pub const fn as_byte_array(&self) -> &[u8; 32]

Returns a reference to the underlying byte array.

Trait Implementations

impl<'a> Arbitrary<'a> for WScriptHash

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<[u8]> for WScriptHash

fn as_ref(&self) -> &[u8]

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

impl AsRef<[u8; 32]> for WScriptHash

fn as_ref(&self) -> &[u8; 32]

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

impl Borrow<[u8]> for WScriptHash

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Borrow<[u8; 32]> for WScriptHash

fn borrow(&self) -> &[u8; 32]

Immutably borrows from an owned value.

impl Clone for WScriptHash

fn clone(&self) -> WScriptHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WScriptHash

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WScriptHash

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<WScriptHash, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for WScriptHash

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl FromStr for WScriptHash

Available on crate feature hex only.

type Err = DecodeFixedLengthBytesError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for WScriptHash

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 WScriptHash

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Ord for WScriptHash

fn cmp(&self, other: &WScriptHash) -> 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 WScriptHash

fn eq(&self, other: &WScriptHash) -> 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 WScriptHash

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

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&Script<WitnessScriptTag>> for WScriptHash

type Error = WitnessScriptSizeError

The type returned in the event of a conversion error.

fn try_from(witness_script: &WitnessScript) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScriptBuf<WitnessScriptTag>> for WScriptHash

type Error = WitnessScriptSizeError

The type returned in the event of a conversion error.

fn try_from(witness_script: &WitnessScriptBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScriptBuf<WitnessScriptTag>> for WScriptHash

type Error = WitnessScriptSizeError

The type returned in the event of a conversion error.

fn try_from(witness_script: WitnessScriptBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for WScriptHash

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Copy for WScriptHash

impl Eq for WScriptHash

impl StructuralPartialEq for WScriptHash