Struct Script

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

A Bitcoin-style script for spending or encumbering coins in transparent transactions.

Script represents a serialized Bitcoin script, which is a sequence of operations used to specify conditions for spending Zcash coins in transparent transactions. In ZeWIF, scripts appear in two contexts:

• script_pubkey in outputs: Defines spending conditions (e.g., P2PKH, P2SH)
• script_sig in inputs: Contains signatures and data to satisfy spending conditions

Internally, Script is a wrapper around Data, providing a type-safe representation for script handling.

Zcash Concept Relation

Zcash inherits the Bitcoin script system for its transparent UTXO model. Unlike shielded transactions, which use zero-knowledge proofs, transparent transactions use explicit scripts to validate spending conditions.

Common script patterns in Zcash transparent addresses include:

• Pay to Public Key Hash (P2PKH): Sends to a standard transparent address
• Pay to Script Hash (P2SH): Sends to a script hash, enabling more complex conditions

Data Preservation

The Script type preserves the exact binary representation of transaction scripts from wallet data, ensuring cryptographic integrity during wallet migrations.

Examples

// Create a script from binary data (this would typically be from a transaction)
let script_bytes = vec![0x76, 0xa9, 0x14, /* more script bytes */];
let script = Script::from(Data::from_vec(script_bytes.clone()));

// Check script properties
assert_eq!(script.len(), script_bytes.len());
assert!(!script.is_empty());

Implementations

impl Script

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl AsRef<[u8]> for Script

Allows treating a Script as a byte slice

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

Debug formatting that includes script length and hex representation

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

Formats the value using the given formatter.

impl From<&Script> for CBOR

fn from(value: &Script) -> Self

Converts to this type from the input type.

impl From<Data> for Script

Creates a Script from Data, allowing conversion from variable-length bytes

fn from(data: Data) -> Self

Converts to this type from the input type.

impl From<Script> for CBOR

fn from(value: Script) -> Self

Converts to this type from the input type.

impl From<Script> for Data

Converts a Script to a Data value, allowing manipulation as variable-length bytes

fn from(script: Script) -> Self

Converts to this type from the input type.

impl From<Script> for Envelope

fn from(value: Script) -> Self

Converts to this type from the input type.

impl Hash for Script

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 Index<Range<usize>> for Script

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Script

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Script

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for Script

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Script

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for Script

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Script

Allows accessing individual bytes in the script by index

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<Range<usize>> for Script

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFrom<usize>> for Script

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFull> for Script

fn index_mut(&mut self, index: RangeFull) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeInclusive<usize>> for Script

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeTo<usize>> for Script

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeToInclusive<usize>> for Script

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Script

Allows modifying individual bytes in the script by index

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

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 TryFrom<CBOR> for Script

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl TryFrom<Envelope> for Script

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Script

impl StructuralPartialEq for Script