Struct bitcoin::blockdata::script::Script

source · [−]

pub struct Script(_);

Expand description

A Bitcoin script.

Implementations

impl Script

pub fn new() -> Script

Creates a new empty script.

pub fn new_p2pk(pubkey: &PublicKey) -> Script

Generates P2PK-type of scriptPubkey.

pub fn new_p2pkh(pubkey_hash: &PubkeyHash) -> Script

Generates P2PKH-type of scriptPubkey.

pub fn new_p2sh(script_hash: &ScriptHash) -> Script

Generates P2SH-type of scriptPubkey with a given hash of the redeem script.

pub fn new_v0_wpkh(pubkey_hash: &WPubkeyHash) -> Script

👎 Deprecated since 0.28.0:

use Script::new_v0_p2wpkh method instead

Generates P2WPKH-type of scriptPubkey.

pub fn new_v0_p2wpkh(pubkey_hash: &WPubkeyHash) -> Script

Generates P2WPKH-type of scriptPubkey.

pub fn new_v0_wsh(script_hash: &WScriptHash) -> Script

👎 Deprecated since 0.28.0:

use Script::new_v0_p2wsh method instead

Generates P2WSH-type of scriptPubkey with a given hash of the redeem script.

pub fn new_v0_p2wsh(script_hash: &WScriptHash) -> Script

Generates P2WSH-type of scriptPubkey with a given hash of the redeem script.

pub fn new_v1_p2tr<C: Verification>(
    secp: &Secp256k1<C>,
    internal_key: UntweakedPublicKey,
    merkle_root: Option<TapBranchHash>
) -> Script

Generates P2TR for script spending path using an internal public key and some optional script tree merkle root.

pub fn new_v1_p2tr_tweaked(output_key: TweakedPublicKey) -> Script

Generates P2TR for key spending path for a known TweakedPublicKey.

pub fn new_witness_program(version: WitnessVersion, program: &[u8 ]) -> Script

Generates P2WSH-type of scriptPubkey with a given hash of the redeem script.

pub fn new_op_return(data: &[u8 ]) -> Script

Generates OP_RETURN-type of scriptPubkey for the given data.

pub fn script_hash(&self) -> ScriptHash

Returns 160-bit hash of the script.

pub fn wscript_hash(&self) -> WScriptHash

Returns 256-bit hash of the script for P2WSH outputs.

pub fn len(&self) -> usize

Returns the length in bytes of the script.

pub fn is_empty(&self) -> bool

Returns whether the script is the empty script.

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Returns the script data as a byte slice.

pub fn to_bytes(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns a copy of the script data.

pub fn into_bytes(self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Converts the script into a byte vector.

pub fn to_p2sh(&self) -> Script

Computes the P2SH output corresponding to this redeem script.

pub fn to_v0_p2wsh(&self) -> Script

Computes the P2WSH output corresponding to this witnessScript (aka the “witness redeem script”).

pub fn to_v1_p2tr<C: Verification>(
    &self,
    secp: &Secp256k1<C>,
    internal_key: UntweakedPublicKey
) -> Script

Computes P2TR output with a given internal key and a single script spending path equal to the current script, assuming that the script is a Tapscript.

pub fn witness_version(&self) -> Option<WitnessVersion>

Returns witness version of the script, if any, assuming the script is a scriptPubkey.

pub fn is_p2sh(&self) -> bool

Checks whether a script pubkey is a P2SH output.

pub fn is_p2pkh(&self) -> bool

Checks whether a script pubkey is a P2PKH output.

pub fn is_p2pk(&self) -> bool

Checks whether a script pubkey is a P2PK output.

pub fn is_witness_program(&self) -> bool

Checks whether a script pubkey is a Segregated Witness (segwit) program.

pub fn is_v0_p2wsh(&self) -> bool

Checks whether a script pubkey is a P2WSH output.

pub fn is_v0_p2wpkh(&self) -> bool

Checks whether a script pubkey is a P2WPKH output.

pub fn is_v1_p2tr(&self) -> bool

Checks whether a script pubkey is a P2TR output.

pub fn is_op_return(&self) -> bool

Check if this is an OP_RETURN output.

pub fn is_provably_unspendable(&self) -> bool

Checks whether a script can be proven to have no satisfying input.

pub fn dust_value(&self) -> Amount

Returns the minimum value an output with this script should have in order to be broadcastable on today’s Bitcoin network.

pub fn instructions(&self) -> Instructions<'_>ⓘNotable traits for Instructions<'a>`impl<'a> Iterator for Instructions<'a> type Item = Result<Instruction<'a>, Error>;`

Iterates over the script in the form of Instructions, which are an enum covering opcodes, datapushes and errors.

At most one error will be returned and then the iterator will end. To instead iterate over the script as sequence of bytes, treat it as a slice using script[..] or convert it to a vector using into_bytes().

To force minimal pushes, use Self::instructions_minimal.

pub fn instructions_minimal(&self) -> Instructions<'_>ⓘNotable traits for Instructions<'a>`impl<'a> Iterator for Instructions<'a> type Item = Result<Instruction<'a>, Error>;`

Iterates over the script in the form of Instructions while enforcing minimal pushes.

pub fn verify(
    &self,
    index: usize,
    amount: Amount,
    spending: &[u8 ]
) -> Result<(), Error>

Available on crate feature bitcoinconsensus only.

Shorthand for Self::verify_with_flags with flag bitcoinconsensus::VERIFY_ALL.

pub fn verify_with_flags<F: Into<u32>>(
    &self,
    index: usize,
    amount: Amount,
    spending: &[u8 ],
    flags: F
) -> Result<(), Error>

Available on crate feature bitcoinconsensus only.

Verifies spend of an input script.

Parameters

index - The input index in spending which is spending this transaction.
amount - The amount this script guards.
spending - The transaction that attempts to spend the output holding this script.
flags - Verification flags, see bitcoinconsensus::VERIFY_ALL and similar.

pub fn bytes_to_asm_fmt(script: &[u8 ], f: &mut dyn Write) -> Result

Writes the assembly decoding of the script bytes to the formatter.

pub fn fmt_asm(&self, f: &mut dyn Write) -> Result

Writes the assembly decoding of the script to the formatter.

pub fn bytes_to_asm(script: &[u8 ]) -> String

Creates an assembly decoding of the script in the given byte slice.

pub fn asm(&self) -> String

Returns the assembly decoding of the script.

Trait Implementations

impl AsRef<[u8 ]> for Script

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

impl Clone for Script

fn clone(&self) -> Script

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 Script

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

Formats the value using the given formatter. Read more

impl Decodable for Script

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

impl Default for Script

fn default() -> Script

Returns the “default value” for a type. Read more

impl Deserialize for Script

fn deserialize(bytes: &[u8 ]) -> Result<Self, Error>

Deserialize a value from raw data.

impl<'de> Deserialize<'de> for Script

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for Script

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

Formats the value using the given formatter. Read more

impl Encodable for Script

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success. Read more

impl From<Vec<u8, Global>> for Script

Creates a new script from an existing vector.

fn from(v: Vec<u8>) -> Script

Converts to this type from the input type.

impl FromHex for Script

fn from_byte_iter<I>(iter: I) -> Result<Self, Error> where
I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produce an object from a byte iterator

fn from_hex(s: &str) -> Result<Self, Error>

Produce an object from a hex string

impl FromStr for Script

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Script

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

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,

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

impl<I> Index<I> for Script where
[u8 ]: Index<I>,

type Output = <[u8 ] as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

impl LowerHex for Script

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

Formats the value using the given formatter.

impl Ord for Script

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl PartialEq<Script> for Script

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl PartialOrd<Script> for Script

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

Available on crate feature serde only.

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

User-facing serialization for Script.

impl Serialize for Script

fn serialize(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Serialize a value as raw data.

impl UpperHex for Script

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

Formats the value using the given formatter.

impl Eq for Script

impl StructuralEq for Script

impl StructuralPartialEq for Script

Auto Trait Implementations

impl RefUnwindSafe for Script

impl Send for Script

impl Sync for Script

impl Unpin for Script

impl UnwindSafe for Script

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Base32Len for T where
T: AsRef<[u8 ]>,

fn base32_len(&self) -> usize

Calculate the base32 serialized length

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<'f, T> CheckBase32<Vec<u5, Global>> for T where
T: AsRef<[u8 ]>,

type Err = Error

Error type if conversion fails

fn check_base32(
self
) -> Result<Vec<u5, Global>, <T as CheckBase32<Vec<u5, Global>>>::Err>

Check if all values are in range and return array-like struct of u5 values

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> ToBase32 for T where
T: AsRef<[u8 ]>,

fn write_base32<W>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> where
W: WriteBase32,

Encode as base32 and write it to the supplied writer Implementations shouldn’t allocate. Read more

fn to_base32(&self) -> Vec<u5, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Convert Self to base32 vector

impl<T> ToHex for T where
T: LowerHex,

fn to_hex(&self) -> String

Outputs the hash in hexadecimal form

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,