Struct ParametersBuilder 

pub struct ParametersBuilder {

    network_name: String,
    network_magic: Magic,
    genesis_hash: Hash,
    activation_heights: BTreeMap<Height, NetworkUpgrade>,
    slow_start_interval: Height,
    funding_streams: Vec<FundingStreams>,
    should_lock_funding_stream_address_period: bool,
    target_difficulty_limit: ExpandedDifficulty,
    disable_pow: bool,
    should_allow_unshielded_coinbase_spends: bool,
    pre_blossom_halving_interval: HeightDiff,
    post_blossom_halving_interval: HeightDiff,
    lockbox_disbursements: Vec<(String, Amount<NonNegative>)>,
    checkpoints: Arc<CheckpointList>,
}

Builder for the Parameters struct.

Fields

network_name: String

The name of this network to be used by the Display trait impl.

network_magic: Magic

The network magic, acts as an identifier for the network.

genesis_hash: Hash

The genesis block hash

activation_heights: BTreeMap<Height, NetworkUpgrade>

The network upgrade activation heights for this network, see Parameters::activation_heights for more details.

slow_start_interval: Height

Slow start interval for this network

funding_streams: Vec<FundingStreams>

Funding streams for this network

should_lock_funding_stream_address_period: bool

A flag indicating whether to allow changes to fields that affect the funding stream address period.

target_difficulty_limit: ExpandedDifficulty

Target difficulty limit for this network

disable_pow: bool

A flag for disabling proof-of-work checks when Zebra is validating blocks

should_allow_unshielded_coinbase_spends: bool

Whether to allow transactions with transparent outputs to spend coinbase outputs, similar to fCoinbaseMustBeShielded in zcashd.

pre_blossom_halving_interval: HeightDiff

The pre-Blossom halving interval for this network

post_blossom_halving_interval: HeightDiff

The post-Blossom halving interval for this network

lockbox_disbursements: Vec<(String, Amount<NonNegative>)>

Expected one-time lockbox disbursement outputs in NU6.1 activation block coinbase for this network

checkpoints: Arc<CheckpointList>

Checkpointed block hashes and heights for this network.

Implementations

impl ParametersBuilder

pub fn with_network_name(self, network_name: impl Display) -> Self

Sets the network name to be used in the Parameters being built.

pub fn with_network_magic(self, network_magic: Magic) -> Self

Sets the network name to be used in the Parameters being built.

pub fn with_genesis_hash(self, genesis_hash: impl Display) -> Self

Parses the hex-encoded block hash and sets it as the genesis hash in the Parameters being built.

pub fn with_activation_heights(self, _: ConfiguredActivationHeights) -> Self

Checks that the provided network upgrade activation heights are in the correct order, then sets them as the new network upgrade activation heights.

pub fn with_slow_start_interval(self, slow_start_interval: Height) -> Self

Sets the slow start interval to be used in the Parameters being built.

pub fn with_funding_streams( self, funding_streams: Vec<ConfiguredFundingStreams>, ) -> Self

Sets funding streams to be used in the Parameters being built.

Panics

If funding_streams is longer than FUNDING_STREAMS_TESTNET, and one of the extra streams requires a default value.

pub fn clear_funding_streams(self) -> Self

Clears funding streams from the Parameters being built.

pub fn extend_funding_streams(self) -> Self

Extends the configured funding streams to have as many recipients as are required for their height ranges by repeating the recipients that have been configured.

This should be called after configuring the desired network upgrade activation heights.

pub fn with_target_difficulty_limit( self, target_difficulty_limit: impl Into<ExpandedDifficulty>, ) -> Self

Sets the target difficulty limit to be used in the Parameters being built.

pub fn with_disable_pow(self, disable_pow: bool) -> Self

Sets the disable_pow flag to be used in the Parameters being built.

pub fn with_unshielded_coinbase_spends( self, should_allow_unshielded_coinbase_spends: bool, ) -> Self

Sets the disable_pow flag to be used in the Parameters being built.

pub fn with_halving_interval( self, pre_blossom_halving_interval: HeightDiff, ) -> Self

Sets the pre and post Blosssom halving intervals to be used in the Parameters being built.

pub fn with_lockbox_disbursements( self, lockbox_disbursements: Vec<ConfiguredLockboxDisbursement>, ) -> Self

Sets the expected one-time lockbox disbursement outputs for this network

pub fn with_checkpoints( self, checkpoints: impl Into<ConfiguredCheckpoints>, ) -> Self

Sets the checkpoints for the network as the provided ConfiguredCheckpoints.

fn finish(self) -> Parameters

Converts the builder to a Parameters struct

fn to_network_unchecked(&self) -> Network

Converts the builder to a configured Network::Testnet

pub fn to_network(self) -> Network

Checks funding streams and converts the builder to a configured Network::Testnet

pub fn is_compatible_with_default_parameters(&self) -> bool

Returns true if these Parameters should be compatible with the default Testnet parameters.

Trait Implementations

impl Clone for ParametersBuilder

fn clone(&self) -> ParametersBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParametersBuilder

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

Formats the value using the given formatter.

impl Default for ParametersBuilder

fn default() -> Self

Creates a ParametersBuilder with all of the default Testnet parameters except network_name.

impl PartialEq for ParametersBuilder

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

impl StructuralPartialEq for ParametersBuilder