Struct Block

pub struct Block {
    pub header: Arc<Header>,
    pub transactions: Vec<Arc<Transaction>>,
}

A Zcash block, containing a header and a list of transactions.

Fields

header: Arc<Header>

The block header, containing block metadata.

transactions: Vec<Arc<Transaction>>

The block transactions.

Implementations

impl Block

pub fn partial_chain_strategy<F, E>( current: LedgerState, count: usize, check_transparent_coinbase_spend: F, generate_valid_commitments: bool, ) -> BoxedStrategy<SummaryDebug<Vec<Arc<Self>>>>

where F: Fn(OutPoint, CoinbaseSpendRestriction, &Utxo) -> Result<(), E> + Copy + 'static,

Returns a strategy for creating vectors of blocks with increasing height.

Each vector is count blocks long.

check_transparent_coinbase_spend is used to check if transparent coinbase UTXOs are valid, before using them in blocks. Use allow_all_transparent_coinbase_spends to disable this check.

generate_valid_commitments specifies if the generated blocks should have valid commitments. This makes it much slower so it’s better to enable only when needed.

impl Block

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

Return the block height reported in the coinbase transaction, if any.

Note

Verified blocks have a valid height.

pub fn hash(&self) -> Hash

Compute the hash of this block.

pub fn commitment( &self, network: &Network, ) -> Result<Commitment, CommitmentError>

Get the parsed block Commitment for this block.

The interpretation of the commitment depends on the configured network, and this block’s height.

Returns an error if this block does not have a block height, or if the commitment value is structurally invalid.

pub fn check_transaction_network_upgrade_consistency( &self, network: &Network, ) -> Result<(), BlockError>

Check if the network_upgrade fields from each transaction in the block matches the network upgrade calculated from the network and block height.

Consensus

[NU5 onward] The nConsensusBranchId field MUST match the consensus branch ID used for SIGHASH transaction hashes, as specified in ZIP-244.

https://zips.z.cash/protocol/protocol.pdf#txnconsensus

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

Access the sprout::Nullifiers from all transactions in this block.

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

Access the sapling::Nullifiers from all transactions in this block.

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

Access the orchard::Nullifiers from all transactions in this block.

pub fn sprout_note_commitments(&self) -> impl Iterator<Item = &NoteCommitment>

Access the sprout::NoteCommitments from all transactions in this block.

pub fn sapling_note_commitments(&self) -> impl Iterator<Item = &Fq>

Access the sapling note commitments from all transactions in this block.

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

Access the orchard note commitments from all transactions in this block.

pub fn sapling_transactions_count(&self) -> u64

Count how many Sapling transactions exist in a block, i.e. transactions “where either of vSpendsSapling or vOutputsSapling is non-empty” https://zips.z.cash/zip-0221#tree-node-specification.

pub fn orchard_transactions_count(&self) -> u64

Count how many Orchard transactions exist in a block, i.e. transactions “where vActionsOrchard is non-empty.” https://zips.z.cash/zip-0221#tree-node-specification.

pub fn chain_value_pool_change( &self, utxos: &HashMap<OutPoint, Utxo>, deferred_balance: Option<Amount<NonNegative>>, ) -> Result<ValueBalance<NegativeAllowed>, ValueBalanceError>

Returns the overall chain value pool change in this block—the negative sum of the transaction value balances in this block.

These are the changes in the transparent, Sprout, Sapling, Orchard, and Deferred chain value pools, as a result of this block.

Positive values are added to the corresponding chain value pool and negative values are removed from the corresponding pool.

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

The given utxos must contain the transparent::Utxos of every input in this block, including UTXOs created by earlier transactions in this block. It can also contain unrelated UTXOs, which are ignored.

Note that the chain value pool has the opposite sign to the transaction value pool.

pub fn auth_data_root(&self) -> AuthDataRoot

Compute the root of the authorizing data Merkle tree, as defined in ZIP-244.

Trait Implementations

impl Arbitrary for Block

type Parameters = LedgerState

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Block>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(ledger_state: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Block

fn clone(&self) -> Block

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Display for Block

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

Formats the value using the given formatter.

impl<'a> From<&'a Block> for Hash

fn from(block: &'a Block) -> Hash

Converts to this type from the input type.

impl PartialEq for Block

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ZcashDeserialize for Block

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

Try to read self from the given reader.

impl ZcashSerialize for Block

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 Block

impl StructuralPartialEq for Block