Enum Transaction

pub enum Transaction {
    V1 {
        inputs: Vec<Input>,
        outputs: Vec<Output>,
        lock_time: LockTime,
    },
    V2 {
        inputs: Vec<Input>,
        outputs: Vec<Output>,
        lock_time: LockTime,
        joinsplit_data: Option<JoinSplitData<Bctv14Proof>>,
    },
    V3 {
        inputs: Vec<Input>,
        outputs: Vec<Output>,
        lock_time: LockTime,
        expiry_height: Height,
        joinsplit_data: Option<JoinSplitData<Bctv14Proof>>,
    },
    V4 {
        inputs: Vec<Input>,
        outputs: Vec<Output>,
        lock_time: LockTime,
        expiry_height: Height,
        joinsplit_data: Option<JoinSplitData<Groth16Proof>>,
        sapling_shielded_data: Option<ShieldedData<PerSpendAnchor>>,
    },
    V5 {
        network_upgrade: NetworkUpgrade,
        lock_time: LockTime,
        expiry_height: Height,
        inputs: Vec<Input>,
        outputs: Vec<Output>,
        sapling_shielded_data: Option<ShieldedData<SharedAnchor>>,
        orchard_shielded_data: Option<ShieldedData>,
    },
}

A Zcash transaction.

A transaction is an encoded data structure that facilitates the transfer of value between two public key addresses on the Zcash ecosystem. Everything is designed to ensure that transactions can be created, propagated on the network, validated, and finally added to the global ledger of transactions (the blockchain).

Zcash has a number of different transaction formats. They are represented internally by different enum variants. Because we checkpoint on Canopy activation, we do not validate any pre-Sapling transaction types.

Variants

V1

A fully transparent transaction (version = 1).

Fields

inputs: Vec<Input>

The transparent inputs to the transaction.

outputs: Vec<Output>

The transparent outputs from the transaction.

lock_time: LockTime

The earliest time or block height that this transaction can be added to the chain.

V2

A Sprout transaction (version = 2).

Fields

inputs: Vec<Input>

The transparent inputs to the transaction.

outputs: Vec<Output>

The transparent outputs from the transaction.

lock_time: LockTime

The earliest time or block height that this transaction can be added to the chain.

joinsplit_data: Option<JoinSplitData<Bctv14Proof>>

The JoinSplit data for this transaction, if any.

V3

An Overwinter transaction (version = 3).

Fields

inputs: Vec<Input>

The transparent inputs to the transaction.

outputs: Vec<Output>

The transparent outputs from the transaction.

lock_time: LockTime

The earliest time or block height that this transaction can be added to the chain.

expiry_height: Height

The latest block height that this transaction can be added to the chain.

joinsplit_data: Option<JoinSplitData<Bctv14Proof>>

The JoinSplit data for this transaction, if any.

V4

A Sapling transaction (version = 4).

Fields

inputs: Vec<Input>

The transparent inputs to the transaction.

outputs: Vec<Output>

The transparent outputs from the transaction.

lock_time: LockTime

The earliest time or block height that this transaction can be added to the chain.

expiry_height: Height

The latest block height that this transaction can be added to the chain.

joinsplit_data: Option<JoinSplitData<Groth16Proof>>

The JoinSplit data for this transaction, if any.

sapling_shielded_data: Option<ShieldedData<PerSpendAnchor>>

The sapling shielded data for this transaction, if any.

V5

A version = 5 transaction , which supports Orchard, Sapling, and transparent, but not Sprout.

Fields

network_upgrade: NetworkUpgrade

The Network Upgrade for this transaction.

Derived from the ConsensusBranchId field.

lock_time: LockTime

The earliest time or block height that this transaction can be added to the chain.

expiry_height: Height

The latest block height that this transaction can be added to the chain.

inputs: Vec<Input>

The transparent inputs to the transaction.

outputs: Vec<Output>

The transparent outputs from the transaction.

sapling_shielded_data: Option<ShieldedData<SharedAnchor>>

The sapling shielded data for this transaction, if any.

orchard_shielded_data: Option<ShieldedData>

The orchard data for this transaction, if any.

Implementations

impl Transaction

pub fn new_v5_coinbase( network: &Network, height: Height, outputs: impl IntoIterator<Item = (Amount<NonNegative>, Script)>, miner_data: Vec<u8>, ) -> Transaction

Returns a new version 5 coinbase transaction for network and height, which contains the specified outputs.

pub fn new_v4_coinbase( height: Height, outputs: impl IntoIterator<Item = (Amount<NonNegative>, Script)>, miner_data: Vec<u8>, ) -> Transaction

Returns a new version 4 coinbase transaction for network and height, which contains the specified outputs.

If like_zcashd is true, try to match the coinbase transactions generated by zcashd in the getblocktemplate RPC.

impl Transaction

pub fn hash(&self) -> Hash

Compute the hash (mined transaction ID) of this transaction.

The hash uniquely identifies mined v5 transactions, and all v1-v4 transactions, whether mined or unmined.

pub fn unmined_id(&self) -> UnminedTxId

Compute the unmined transaction ID of this transaction.

This ID uniquely identifies unmined transactions, regardless of version.

pub fn sighash( &self, nu: NetworkUpgrade, hash_type: HashType, all_previous_outputs: Arc<Vec<Output>>, input_index_script_code: Option<(usize, Vec<u8>)>, ) -> Result<SigHash, Error>

Calculate the sighash for the current transaction.

If you need to compute multiple sighashes for the same transactions, it’s more efficient to use Transaction::sighasher().

Details

all_previous_outputs represents the UTXOs being spent by each input in the transaction.

The input_index_script_code tuple indicates the index of the transparent Input for which we are producing a sighash and the respective script code being validated, or None if it’s a shielded input.

Panics

• if passed in any NetworkUpgrade from before NetworkUpgrade::Overwinter
• if called on a v1 or v2 transaction
• if the input index points to a transparent::Input::CoinBase
• if the input index is out of bounds for self.inputs()
• if the tx contains nConsensusBranchId field and nu doesn’t match it
• if the tx is not convertible to its librustzcash equivalent
• if nu doesn’t contain a consensus branch id convertible to its librustzcash equivalent

pub fn sighasher( &self, nu: NetworkUpgrade, all_previous_outputs: Arc<Vec<Output>>, ) -> Result<SigHasher, Error>

Return a SigHasher for this transaction.

pub fn auth_digest(&self) -> Option<AuthDigest>

Compute the authorizing data commitment of this transaction as specified in ZIP-244.

Returns None for pre-v5 transactions.

pub fn has_transparent_inputs(&self) -> bool

Does this transaction have transparent inputs?

pub fn has_transparent_outputs(&self) -> bool

Does this transaction have transparent outputs?

pub fn has_transparent_inputs_or_outputs(&self) -> bool

Does this transaction have transparent inputs or outputs?

pub fn has_transparent_or_shielded_inputs(&self) -> bool

Does this transaction have transparent or shielded inputs?

pub fn has_shielded_inputs(&self) -> bool

Does this transaction have shielded inputs?

See Self::has_transparent_or_shielded_inputs for details.

pub fn has_shielded_outputs(&self) -> bool

Does this transaction have shielded outputs?

See Self::has_transparent_or_shielded_outputs for details.

pub fn has_transparent_or_shielded_outputs(&self) -> bool

Does this transaction have transparent or shielded outputs?

pub fn has_enough_orchard_flags(&self) -> bool

Does this transaction has at least one flag when we have at least one orchard action?

pub fn coinbase_spend_restriction( &self, network: &Network, spend_height: Height, ) -> CoinbaseSpendRestriction

Returns the CoinbaseSpendRestriction for this transaction, assuming it is mined at spend_height.

pub fn is_overwintered(&self) -> bool

Return if the fOverwintered flag of this transaction is set.

pub fn version(&self) -> u32

Returns the version of this transaction.

Note that the returned version is equal to effectiveVersion, described in § 7.1 Transaction Encoding and Consensus:

effectiveVersion […] is equal to min(2, version) when fOverwintered = 0 and to version otherwise.

Zebra handles the fOverwintered flag via the Self::is_overwintered method.

pub fn lock_time(&self) -> Option<LockTime>

Get this transaction’s lock time.

pub fn raw_lock_time(&self) -> u32

Get the raw lock time value.

pub fn lock_time_is_time(&self) -> bool

Returns true if this transaction’s lock_time is a LockTime::Time. Returns false if it is a LockTime::Height (locked or unlocked), is unlocked, or if the transparent input sequence numbers have disabled lock times.

pub fn expiry_height(&self) -> Option<Height>

Get this transaction’s expiry height, if any.

pub fn network_upgrade(&self) -> Option<NetworkUpgrade>

Get this transaction’s network upgrade field, if any. This field is serialized as nConsensusBranchId (7.1).

pub fn inputs(&self) -> &[Input]

Access the transparent inputs of this transaction, regardless of version.

pub fn spent_outpoints(&self) -> impl Iterator<Item = OutPoint> + '_

Access the transparent::OutPoints spent by this transaction’s transparent::Inputs.

pub fn outputs(&self) -> &[Output]

Access the transparent outputs of this transaction, regardless of version.

pub fn is_coinbase(&self) -> bool

Returns true if this transaction has valid inputs for a coinbase transaction, that is, has a single input and it is a coinbase input (null prevout).

pub fn is_valid_non_coinbase(&self) -> bool

Returns true if this transaction has valid inputs for a non-coinbase transaction, that is, does not have any coinbase input (non-null prevouts).

Note that it’s possible for a transaction return false in both Transaction::is_coinbase and Transaction::is_valid_non_coinbase, though those transactions will be rejected.

pub fn sprout_groth16_joinsplits( &self, ) -> Box<dyn Iterator<Item = &JoinSplit<Groth16Proof>> + '_>

Returns the Sprout JoinSplit<Groth16Proof>s in this transaction, regardless of version.

pub fn joinsplit_count(&self) -> usize

Returns the number of JoinSplits in this transaction, regardless of version.

pub fn sprout_nullifiers(&self) -> Box<dyn Iterator<Item = &Nullifier> + '_>

Access the sprout::Nullifiers in this transaction, regardless of version.

pub fn sprout_joinsplit_pub_key(&self) -> Option<VerificationKeyBytes>

Access the JoinSplit public validating key in this transaction, regardless of version, if any.

pub fn has_sprout_joinsplit_data(&self) -> bool

Return if the transaction has any Sprout JoinSplit data.

pub fn sprout_note_commitments( &self, ) -> Box<dyn Iterator<Item = &NoteCommitment> + '_>

Returns the Sprout note commitments in this transaction.

pub fn sapling_anchors(&self) -> Box<dyn Iterator<Item = Root> + '_>

Access the deduplicated sapling::tree::Roots in this transaction, regardless of version.

pub fn sapling_spends_per_anchor( &self, ) -> Box<dyn Iterator<Item = Spend<PerSpendAnchor>> + '_>

Iterate over the sapling Spends for this transaction, returning Spend<PerSpendAnchor> regardless of the underlying transaction version.

Shared anchors in V5 transactions are copied into each sapling spend. This allows the same code to validate spends from V4 and V5 transactions.

Correctness

Do not use this function for serialization.

pub fn sapling_outputs(&self) -> Box<dyn Iterator<Item = &Output> + '_>

Iterate over the sapling Outputs for this transaction

pub fn sapling_nullifiers(&self) -> Box<dyn Iterator<Item = &Nullifier> + '_>

Access the sapling::Nullifiers in this transaction, regardless of version.

pub fn sapling_note_commitments(&self) -> Box<dyn Iterator<Item = &Fq> + '_>

Returns the Sapling note commitments in this transaction, regardless of version.

pub fn has_sapling_shielded_data(&self) -> bool

Return if the transaction has any Sapling shielded data.

pub fn orchard_shielded_data(&self) -> Option<&ShieldedData>

Access the orchard::ShieldedData in this transaction, regardless of version.

pub fn orchard_actions(&self) -> impl Iterator<Item = &Action>

Iterate over the orchard::Actions in this transaction, if there are any, regardless of version.

pub fn orchard_nullifiers(&self) -> impl Iterator<Item = &Nullifier>

Access the orchard::Nullifiers in this transaction, if there are any, regardless of version.

pub fn orchard_note_commitments(&self) -> impl Iterator<Item = &Base>

Access the note commitments in this transaction, if there are any, regardless of version.

pub fn orchard_flags(&self) -> Option<Flags>

Access the orchard::Flags in this transaction, if there is any, regardless of version.

pub fn has_orchard_shielded_data(&self) -> bool

Return if the transaction has any Orchard shielded data, regardless of version.

pub fn output_values_to_sprout( &self, ) -> Box<dyn Iterator<Item = &Amount<NonNegative>> + '_>

Returns the vpub_old fields from JoinSplits in this transaction, regardless of version, in the order they appear in the transaction.

These values are added to the sprout chain value pool, and removed from the value pool of this transaction.

pub fn input_values_from_sprout( &self, ) -> Box<dyn Iterator<Item = &Amount<NonNegative>> + '_>

Returns the vpub_new fields from JoinSplits in this transaction, regardless of version, in the order they appear in the transaction.

These values are removed from the value pool of this transaction. and added to the sprout chain value pool.

pub fn sapling_value_balance(&self) -> ValueBalance<NegativeAllowed>

Return the sapling value balance, the change in the transaction value pool due to sapling Spends and Outputs.

Returns the valueBalanceSapling field in this transaction.

Positive values are added to this transaction’s value pool, and removed from the sapling chain value pool. Negative values are removed from this transaction, and added to sapling pool.

https://zebra.zfnd.org/dev/rfcs/0012-value-pools.html#definitions

pub fn sapling_binding_sig(&self) -> Option<Signature<Binding>>

Returns the Sapling binding signature for this transaction.

Returns Some(binding_sig) for transactions that contain Sapling shielded data (V4+), or None for transactions without Sapling components.

pub fn joinsplit_pub_key(&self) -> Option<VerificationKeyBytes>

Returns the JoinSplit public key for this transaction.

Returns Some(pub_key) for transactions that contain JoinSplit data (V2-V4), or None for transactions without JoinSplit components or unsupported versions.

Note

JoinSplits are deprecated in favor of Sapling and Orchard

pub fn joinsplit_sig(&self) -> Option<Signature>

Returns the JoinSplit signature this for transaction.

Returns Some(signature) for transactions that contain JoinSplit data (V2-V4), or None for transactions without JoinSplit components or unsupported versions.

Note

JoinSplits are deprecated in favor of Sapling and Orchard

pub fn orchard_value_balance(&self) -> ValueBalance<NegativeAllowed>

Return the orchard value balance, the change in the transaction value pool due to orchard::Actions.

Returns the valueBalanceOrchard field in this transaction.

Positive values are added to this transaction’s value pool, and removed from the orchard chain value pool. Negative values are removed from this transaction, and added to orchard pool.

https://zebra.zfnd.org/dev/rfcs/0012-value-pools.html#definitions

pub fn value_balance( &self, utxos: &HashMap<OutPoint, Utxo>, ) -> Result<ValueBalance<NegativeAllowed>, ValueBalanceError>

Returns the value balances for this transaction.

These are the changes in the transaction value pool, split up into transparent, Sprout, Sapling, and Orchard values.

Calculated as the sum of the inputs and outputs from each pool, or the sum of the value balances from each pool.

Positive values are added to this transaction’s value pool, and removed from the corresponding chain value pool. Negative values are removed from this transaction, and added to the corresponding pool.

https://zebra.zfnd.org/dev/rfcs/0012-value-pools.html#definitions

utxos must contain the utxos of every input in the transaction, including UTXOs created by earlier transactions in this block.

Note

The chain value pool has the opposite sign to the transaction value pool.

pub fn has_shielded_data(&self) -> bool

Does this transaction have shielded inputs or outputs?

pub fn version_group_id(&self) -> Option<u32>

Get the version group ID for this transaction, if any.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl Display for Transaction

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

Formats the value using the given formatter.

impl From<&Transaction> for AuthDigest

fn from(transaction: &Transaction) -> Self

Computes the authorizing data commitment for a transaction.

Panics

If passed a pre-v5 transaction.

impl From<&Transaction> for Hash

fn from(transaction: &Transaction) -> Self

Converts to this type from the input type.

impl From<&Transaction> for UnminedTx

fn from(transaction: &Transaction) -> Self

Converts to this type from the input type.

impl From<&Transaction> for UnminedTxId

fn from(transaction: &Transaction) -> Self

Converts to this type from the input type.

impl From<&Transaction> for WtxId

fn from(transaction: &Transaction) -> Self

Computes the witnessed transaction ID for a transaction.

Panics

If passed a pre-v5 transaction.

impl From<Transaction> for AuthDigest

fn from(transaction: Transaction) -> Self

Computes the authorizing data commitment for a transaction.

Panics

If passed a pre-v5 transaction.

impl From<Transaction> for Hash

fn from(transaction: Transaction) -> Self

Converts to this type from the input type.

impl From<Transaction> for UnminedTx

fn from(transaction: Transaction) -> Self

Converts to this type from the input type.

impl From<Transaction> for UnminedTxId

fn from(transaction: Transaction) -> Self

Converts to this type from the input type.

impl From<Transaction> for WtxId

fn from(transaction: Transaction) -> Self

Computes the witnessed transaction ID for a transaction.

Panics

If passed a pre-v5 transaction.

impl PartialEq for Transaction

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

No valid Zcash message contains more transactions than can fit in a single block

tx messages contain a single transaction, and block messages are limited to the maximum block size.

fn max_allocation() -> u64

Provides a loose upper bound on the size of the Vec<T: TrustedPreallocate> which can possibly be received from an honest peer.

impl ZcashDeserialize for Transaction

fn zcash_deserialize<R: Read>(reader: R) -> Result<Self, SerializationError>

Try to read self from the given reader.

impl ZcashSerialize for Transaction

fn zcash_serialize<W: Write>(&self, writer: W) -> Result<(), Error>

Write self to the given writer using the canonical format.

fn zcash_serialize_to_vec(&self) -> Result<Vec<u8>, Error>

Helper function to construct a vec to serialize the current struct into

fn zcash_serialized_size(&self) -> usize

Get the size of self by using a fake writer.

impl Eq for Transaction

impl StructuralPartialEq for Transaction