Struct ScriptHash 

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

A 160-bit hash of Bitcoin Script bytecode.

Note: there is another “script hash” object in bitcoin ecosystem (Electrum protocol) that uses 256-bit hash and hashes a semantically different script. Thus, this type cannot represent it.

Implementations

impl ScriptHash

pub fn from_script<T>( redeem_script: &Script<T>, ) -> Result<Self, RedeemScriptSizeError>

where T: ScriptHashableTag,

Constructs a new ScriptHash after first checking the script size.

520-byte limitation on serialized script size

As a consequence of the requirement for backwards compatibility the serialized script is itself subject to the same rules as any other PUSHDATA operation, including the rule that no data greater than 520 bytes may be pushed to the stack. Thus it is not possible to spend a P2SH output if the redemption script it refers to is >520 bytes in length.

ref: BIP-0016

Errors

Returns an error if the script exceeds 520 bytes.

pub fn from_script_unchecked<T>(script: &Script<T>) -> Self

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

If you hash a script that exceeds 520 bytes in size and use it to create a P2SH output then the output will be unspendable (see BIP-0016).

impl ScriptHash

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

Constructs a new type from the underlying byte array.

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

Returns the underlying byte array.

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

Returns a reference to the underlying byte array.

Trait Implementations

impl<'a> Arbitrary<'a> for ScriptHash

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 ScriptHash

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

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

impl AsRef<[u8; 20]> for ScriptHash

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

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

impl Borrow<[u8]> for ScriptHash

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

Immutably borrows from an owned value.

impl Borrow<[u8; 20]> for ScriptHash

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

Immutably borrows from an owned value.

impl Clone for ScriptHash

fn clone(&self) -> ScriptHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptHash

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptHash

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

Deserialize this value from the given Serde deserializer.

impl Display for ScriptHash

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl FromStr for ScriptHash

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 ScriptHash

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 ScriptHash

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Ord for ScriptHash

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

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

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

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

Serialize this value into the given Serde serializer.

impl<T: ScriptHashableTag> TryFrom<&Script<T>> for ScriptHash

type Error = RedeemScriptSizeError

The type returned in the event of a conversion error.

fn try_from(redeem_script: &Script<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: ScriptHashableTag> TryFrom<&ScriptBuf<T>> for ScriptHash

type Error = RedeemScriptSizeError

The type returned in the event of a conversion error.

fn try_from(redeem_script: &ScriptBuf<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: ScriptHashableTag> TryFrom<ScriptBuf<T>> for ScriptHash

type Error = RedeemScriptSizeError

The type returned in the event of a conversion error.

fn try_from(redeem_script: ScriptBuf<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for ScriptHash

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Copy for ScriptHash

impl Eq for ScriptHash

impl StructuralPartialEq for ScriptHash