Enum BranchId

pub enum BranchId {
    Sprout,
    Overwinter,
    Sapling,
    Blossom,
    Heartwood,
    Canopy,
    Nu5,
    Nu6,
}

A globally-unique identifier for a set of consensus rules within the Zcash chain.

Each branch ID in this enum corresponds to one of the epochs between a pair of Zcash network upgrades. For example, BranchId::Overwinter corresponds to the blocks starting at Overwinter activation, and ending the block before Sapling activation.

The main use of the branch ID is in signature generation: transactions commit to a specific branch ID by including it as part of signature_hash. This ensures two-way replay protection for transactions across network upgrades.

See ZIP 200 for more details.

Variants

Sprout

The consensus rules at the launch of Zcash.

Overwinter

The consensus rules deployed by NetworkUpgrade::Overwinter.

Sapling

The consensus rules deployed by NetworkUpgrade::Sapling.

Blossom

The consensus rules deployed by NetworkUpgrade::Blossom.

Heartwood

The consensus rules deployed by NetworkUpgrade::Heartwood.

Canopy

The consensus rules deployed by NetworkUpgrade::Canopy.

Nu5

The consensus rules deployed by NetworkUpgrade::Nu5.

Nu6

The consensus rules deployed by NetworkUpgrade::Nu6.

Implementations

impl BranchId

pub fn for_height<P: Parameters>(parameters: &P, height: BlockHeight) -> Self

Returns the branch ID corresponding to the consensus rule set that is active at the given height.

This is the branch ID that should be used when creating transactions.

pub fn height_range<P: Parameters>( &self, params: &P, ) -> Option<impl RangeBounds<BlockHeight>>

Returns the range of heights for the consensus epoch associated with this branch id.

The resulting tuple implements the RangeBounds<BlockHeight> trait.

pub fn height_bounds<P: Parameters>( &self, params: &P, ) -> Option<(BlockHeight, Option<BlockHeight>)>

Returns the range of heights for the consensus epoch associated with this branch id.

The return type of this value is slightly more precise than Self::height_range:

• Some((x, Some(y))) means that the consensus rules corresponding to this branch id are in effect for the range x..y
• Some((x, None)) means that the consensus rules corresponding to this branch id are in effect for the range x..
• None means that the consensus rules corresponding to this branch id are never in effect.

pub fn sprout_uses_groth_proofs(&self) -> bool

Trait Implementations

impl Clone for BranchId

fn clone(&self) -> BranchId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BranchId

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

Formats the value using the given formatter.

impl DynamicUsage for BranchId

fn dynamic_usage(&self) -> usize

Returns a best estimate of the amount of heap-allocated memory used by this type.

fn dynamic_usage_bounds(&self) -> (usize, Option<usize>)

Returns the lower and upper bounds on the amount of heap-allocated memory used by this type.

impl From<BranchId> for u32

fn from(consensus_branch_id: BranchId) -> u32

Converts to this type from the input type.

impl PartialEq for BranchId

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

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BranchId

impl Eq for BranchId

impl StructuralPartialEq for BranchId