Struct breez_sdk_core::bitcoin::blockdata::script::Script

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

Bitcoin script.

A list of instructions in a simple, Forth-like, stack-based programming language that Bitcoin uses.

See Bitcoin Wiki: Script for more information.

Bitcoin Core References

• CScript definition

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>( secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, merkle_root: Option<TapBranchHash>, ) -> Script

where C: Verification,

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]

Returns the script data as a byte slice.

pub fn to_bytes(&self) -> Vec<u8>

Returns a copy of the script data.

pub fn into_bytes(self) -> Vec<u8>

Converts the script into a byte vector.

pub fn to_p2sh(&self) -> Script

Computes the P2SH output corresponding to this redeem script.

pub fn p2wpkh_script_code(&self) -> Option<Script>

Returns the script code used for spending a P2WPKH output if this script is a script pubkey for a P2WPKH output. The scriptCode is described in BIP143.

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>( &self, secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, ) -> Script

where C: Verification,

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<'_>

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<'_>

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>

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

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

where F: Into<u32>,

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<(), Error>

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

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

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]

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.

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

Performs copy-assignment from source.

impl Debug for Script

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

Formats the value using the given formatter.

impl Decodable for Script

fn consensus_decode_from_finite_reader<R>(r: &mut R) -> Result<Script, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

fn consensus_decode<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

impl Default for Script

fn default() -> Script

Returns the “default value” for a type.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for Script

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

Deserialize a value from raw data.

impl Display for Script

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

Formats the value using the given formatter.

impl Encodable for Script

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>

where W: Write + ?Sized,

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

impl From<ScriptDef> for Script

fn from(s: ScriptDef) -> Script

Converts to this type from the input type.

impl From<Vec<u8>> 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<Script, Error>

where I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produces an object from a byte iterator.

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

Produces 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<Script, Error>

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

impl Hash for Script

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

where __H: Hasher,

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<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) -> &<Script as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl Into<Script> for ShutdownScript

fn into(self) -> Script

Converts this type into the (usually inferred) input type.

impl LowerHex for Script

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

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.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Script

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

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

fn read<R>(r: &mut R) -> Result<Script, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Serialize for Script

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

where S: Serializer,

User-facing serialization for Script.

impl Serialize for Script

fn serialize(&self) -> Vec<u8>

Serialize a value as raw data.

impl TryFrom<Script> for ShutdownScript

type Error = InvalidShutdownScript

The type returned in the event of a conversion error.

fn try_from( script: Script, ) -> Result<ShutdownScript, <ShutdownScript as TryFrom<Script>>::Error>

Performs the conversion.

impl UpperHex for Script

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

Formats the value using the given formatter.

impl Writeable for Script

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for Script

impl StructuralPartialEq for Script