Enum Network

pub enum Network {
    Mainnet,
    Testnet(Arc<Parameters>),
}

An enum describing the possible network choices.

Variants

Mainnet

The production mainnet.

Testnet(Arc<Parameters>)

A test network such as the default public testnet, a configured testnet, or Regtest.

Implementations

impl Network

pub fn magic(&self) -> Magic

Get the magic value associated to this Network.

impl Network

pub fn disable_pow(&self) -> bool

Returns true if proof-of-work validation should be disabled for this network

pub fn slow_start_interval(&self) -> Height

Returns slow start interval for this network

pub fn slow_start_shift(&self) -> Height

Returns slow start shift for this network

pub fn pre_nu6_funding_streams(&self) -> &FundingStreams

Returns pre-NU6 funding streams for this network

Commonly referred to as the “Dev Fund”.

Defined in Zcash Protocol Specification §7.10.1

pub fn post_nu6_funding_streams(&self) -> &FundingStreams

Returns post-NU6 funding streams for this network

Defined in Zcash Protocol Specification §7.10.1

pub fn funding_streams(&self, height: Height) -> &FundingStreams

Returns post-Canopy funding streams for this network at the provided height

pub fn should_allow_unshielded_coinbase_spends(&self) -> bool

Returns true if this network should allow transactions with transparent outputs that spend coinbase outputs.

impl Network

pub fn new_default_testnet() -> Self

Creates a new Network::Testnet with the default Testnet testnet::Parameters.

pub fn new_configured_testnet(params: Parameters) -> Self

Creates a new configured Network::Testnet with the provided Testnet testnet::Parameters.

pub fn new_regtest( nu5_activation_height: Option<u32>, nu6_activation_height: Option<u32>, ) -> Self

Creates a new Network::Testnet with Regtest parameters and the provided network upgrade activation heights.

pub fn is_default_testnet(&self) -> bool

Returns true if the network is the default Testnet, or false otherwise.

pub fn is_regtest(&self) -> bool

Returns true if the network is Regtest, or false otherwise.

pub fn kind(&self) -> NetworkKind

Returns the NetworkKind for this network.

pub fn iter() -> impl Iterator<Item = Self>

Returns an iterator over Network variants.

pub fn is_max_block_time_enforced(&self, 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 default_port(&self) -> u16

Get the default port associated to this network.

pub fn mandatory_checkpoint_height(&self) -> Height

Get the mandatory minimum checkpoint height for this network.

Mandatory checkpoints are a Zebra-specific feature. If a Zcash consensus rule only applies before the mandatory checkpoint, Zebra can skip validation of that rule. This is necessary because Zebra can’t fully validate the blocks prior to Canopy.

pub fn bip70_network_name(&self) -> String

Return the network name as defined in BIP70

pub fn lowercase_name(&self) -> String

Return the lowercase network name.

pub fn is_a_test_network(&self) -> bool

Returns true if this network is a testing network.

pub fn sapling_activation_height(&self) -> Height

Returns the Sapling activation height for this network.

impl Network

pub fn activation_list(&self) -> 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.

Note: This skips implicit network upgrade activations, use Network::full_activation_list to get an explicit list of all network upgrade activations.

pub fn full_activation_list(&self) -> Vec<(Height, NetworkUpgrade)>

Returns a vector of all implicit and explicit network upgrades for network, in ascending height order.

impl Network

pub fn sapling_efvk_hrp(&self) -> &'static str

Returns the human-readable prefix for an Zcash Sapling extended full viewing key for this network.

impl Network

Network methods for fetching blockchain vectors.

pub fn is_mainnet(&self) -> bool

Returns true if network is of type Mainnet.

pub fn block_iter(&self) -> Iter<'static, u32, &'static [u8]>

Returns iterator over blocks.

pub fn unmined_transactions_in_blocks( &self, block_height_range: impl RangeBounds<u32>, ) -> impl DoubleEndedIterator<Item = VerifiedUnminedTx>

Returns iterator over verified unmined transactions in the provided block height range.

pub fn block_map(&self) -> BTreeMap<u32, &'static [u8]>

Returns blocks indexed by height in a BTreeMap.

Returns Mainnet blocks if self is set to Mainnet, and Testnet blocks otherwise.

pub fn gen_block(&self) -> Option<&&[u8]>

Returns genesis block for chain.

pub fn test_block(&self, main_height: u32, test_height: u32) -> Option<Block>

Returns block bytes

pub fn blockchain_iter(&self) -> Iter<'_, u32, &[u8]>

Returns iterator over blockchain.

pub fn blockchain_map(&self) -> &BTreeMap<u32, &'static [u8]>

Returns BTreemap of blockchain.

pub fn block_sapling_roots_iter( &self, ) -> (Iter<'_, u32, &[u8]>, BTreeMap<u32, &[u8; 32]>)

Returns iterator over blocks and sapling roots.

pub fn block_sapling_roots_map( &self, ) -> (&BTreeMap<u32, &'static [u8]>, &BTreeMap<u32, &'static [u8; 32]>)

Returns BTreemap of blocks and sapling roots.

pub fn test_block_sapling_roots( &self, main_height: u32, test_height: u32, ) -> Option<(&[u8], [u8; 32])>

Returns block and sapling root bytes

pub fn block_sprout_roots_height( &self, ) -> (&BTreeMap<u32, &'static [u8]>, &BTreeMap<u32, &'static [u8; 32]>, u32)

Returns BTreemap of blocks and sprout roots, and last split height.

Trait Implementations

impl Arbitrary for Network

type Parameters = ()

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

type Strategy = BoxedStrategy<Network>

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

fn arbitrary_with(_args: ()) -> 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 Network

fn clone(&self) -> Network

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Network

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

Formats the value using the given formatter.

impl Default for Network

fn default() -> Network

Returns the “default value” for a type.

impl Display for Network

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

Formats the value using the given formatter.

impl<'a> From<&'a Network> for &'a str

fn from(network: &'a Network) -> &'a str

Converts to this type from the input type.

impl From<Network> for NetworkKind

fn from(network: Network) -> Self

Converts to this type from the input type.

impl FromStr for Network

type Err = InvalidNetworkError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl ParameterDifficulty for Network

fn target_difficulty_limit(&self) -> ExpandedDifficulty

Returns the easiest target difficulty allowed on network. See ParameterDifficulty::target_difficulty_limit

impl ParameterSubsidy for Network

Network methods related to Block Subsidy and Funding Streams

fn height_for_first_halving(&self) -> Height

Returns the minimum height after the first halving as described in protocol specification §7.10

fn post_blossom_halving_interval(&self) -> HeightDiff

Returns the halving interval after Blossom

fn pre_blossom_halving_interval(&self) -> HeightDiff

Returns the halving interval before Blossom

fn funding_stream_address_change_interval(&self) -> HeightDiff

Returns the address change interval for funding streams as described in protocol specification §7.10.

impl Parameters for Network

fn network_type(&self) -> Network

Returns the type of network configured by this set of consensus parameters.

fn activation_height(&self, nu: NetworkUpgrade) -> Option<BlockHeight>

Returns the activation height for a particular network upgrade, if an activation height has been set.

fn is_nu_active(&self, nu: NetworkUpgrade, height: BlockHeight) -> bool

Determines whether the specified network upgrade is active as of the provided block height on the network to which this Parameters value applies.

impl PartialEq for Network

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Network

impl StructuralPartialEq for Network