Enum zebra_chain::parameters::network_upgrade::NetworkUpgrade

pub enum NetworkUpgrade {
    Genesis,
    BeforeOverwinter,
    Overwinter,
    Sapling,
    Blossom,
    Heartwood,
    Canopy,
    Nu5,
}

A Zcash network upgrade.

Network upgrades can change the Zcash network protocol or consensus rules in incompatible ways.

Variants

Genesis

The Zcash protocol for a Genesis block.

Zcash genesis blocks use a different set of consensus rules from other BeforeOverwinter blocks, so we treat them like a separate network upgrade.

BeforeOverwinter

The Zcash protocol before the Overwinter upgrade.

We avoid using Sprout, because the specification says that Sprout is the name of the pre-Sapling protocol, before and after Overwinter.

Overwinter

The Zcash protocol after the Overwinter upgrade.

Sapling

The Zcash protocol after the Sapling upgrade.

Blossom

The Zcash protocol after the Blossom upgrade.

Heartwood

The Zcash protocol after the Heartwood upgrade.

Canopy

The Zcash protocol after the Canopy upgrade.

Nu5

The Zcash protocol after the Nu5 upgrade.

Note: Network Upgrade 5 includes the Orchard Shielded Protocol, non-malleable transaction IDs, and other changes. There is no special code name for Nu5.

Implementations

impl NetworkUpgrade

pub fn activation_list(network: Network) -> BTreeMap<Height, NetworkUpgrade>

Returns a map between activation heights and network upgrades for network, in ascending height order.

If the activation height of a future upgrade is not known, that network upgrade does not appear in the list.

This is actually a bijective map.

When the environment variable TEST_FAKE_ACTIVATION_HEIGHTS is set and it’s a test build, this returns a list of fake activation heights used by some tests.

pub fn current(network: Network, height: Height) -> NetworkUpgrade

Returns the current network upgrade for network and height.

pub fn next(network: Network, height: Height) -> Option<NetworkUpgrade>

Returns the next network upgrade for network and height.

Returns None if the next upgrade has not been implemented in Zebra yet.

pub fn activation_height(&self, network: Network) -> Option<Height>

Returns the activation height for this network upgrade on network.

Returns None if this network upgrade is a future upgrade, and its activation height has not been set yet.

pub fn is_activation_height(network: Network, height: Height) -> bool

Returns true if height is the activation height of any network upgrade on network.

Use NetworkUpgrade::activation_height to get the specific network upgrade.

pub(crate) fn branch_id_list() -> HashMap<NetworkUpgrade, ConsensusBranchId>

Returns an unordered mapping between NetworkUpgrades and their ConsensusBranchIds.

Branch ids are the same for mainnet and testnet.

If network upgrade does not have a branch id, that network upgrade does not appear in the list.

This is actually a bijective map.

pub fn branch_id(&self) -> Option<ConsensusBranchId>

Returns the consensus branch id for this network upgrade.

Returns None if this network upgrade has no consensus branch id.

pub fn target_spacing(&self) -> Duration

Returns the target block spacing for the network upgrade.

Based on PRE_BLOSSOM_POW_TARGET_SPACING and POST_BLOSSOM_POW_TARGET_SPACING from the Zcash specification.

pub fn target_spacing_for_height(network: Network, height: Height) -> Duration

Returns the target block spacing for network and height.

See NetworkUpgrade::target_spacing for details.

pub fn target_spacings( network: Network ) -> impl Iterator<Item = (Height, Duration)>

Returns all the target block spacings for network and the heights where they start.

pub fn minimum_difficulty_spacing_for_height( network: Network, height: Height ) -> Option<Duration>

Returns the minimum difficulty block spacing for network and height. Returns None if the testnet minimum difficulty consensus rule is not active.

Based on https://zips.z.cash/zip-0208#minimum-difficulty-blocks-on-the-test-network

pub fn is_testnet_min_difficulty_block( network: Network, block_height: Height, block_time: DateTime<Utc>, previous_block_time: DateTime<Utc> ) -> bool

Returns true if the gap between block_time and previous_block_time is greater than the Testnet minimum difficulty time gap. This time gap depends on the network and block_height.

Returns false on Mainnet, when block_height is less than the minimum difficulty start height, and when the time gap is too small.

block_time can be less than, equal to, or greater than previous_block_time, because block times are provided by miners.

Implements the Testnet minimum difficulty adjustment from ZIPs 205 and 208.

Spec Note: Some parts of ZIPs 205 and 208 previously specified an incorrect check for the time gap. This function implements the correct “greater than” check.

pub fn averaging_window_timespan(&self) -> Duration

Returns the averaging window timespan for the network upgrade.

AveragingWindowTimespan from the Zcash specification.

pub fn averaging_window_timespan_for_height( network: Network, height: Height ) -> Duration

Returns the averaging window timespan for network and height.

See NetworkUpgrade::averaging_window_timespan for details.

pub fn is_max_block_time_enforced(network: Network, height: Height) -> bool

Returns true if the maximum block time rule is active for network and height.

Always returns true if network is the Mainnet. If network is the Testnet, the height should be at least TESTNET_MAX_TIME_START_HEIGHT to return true. Returns false otherwise.

Part of the consensus rules at https://zips.z.cash/protocol/protocol.pdf#blockheader

pub fn from_branch_id(branch_id: u32) -> Option<NetworkUpgrade>

Returns the NetworkUpgrade given an u32 as ConsensusBranchId

impl NetworkUpgrade

pub fn branch_id_strategy() -> BoxedStrategy<NetworkUpgrade>

Generates network upgrades.

pub fn reduced_branch_id_strategy() -> BoxedStrategy<NetworkUpgrade>

Generates network upgrades from a reduced set

Trait Implementations

impl Arbitrary for NetworkUpgrade

type Parameters = ()

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

type Strategy = TupleUnion<((u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>), (u32, Arc<fn() -> NetworkUpgrade>))>

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

fn arbitrary_with(_top: 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 NetworkUpgrade

fn clone(&self) -> NetworkUpgrade

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkUpgrade

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NetworkUpgrade

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NetworkUpgrade

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

Formats the value using the given formatter.

impl Hash for NetworkUpgrade

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 PartialEq for NetworkUpgrade

fn eq(&self, other: &NetworkUpgrade) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NetworkUpgrade

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

Serialize this value into the given Serde serializer.

impl Copy for NetworkUpgrade

impl Eq for NetworkUpgrade

impl StructuralEq for NetworkUpgrade

impl StructuralPartialEq for NetworkUpgrade