Struct HotShotConfig

pub struct HotShotConfig<TYPES: NodeType> {

    pub start_threshold: (u64, u64),
    pub num_nodes_with_stake: NonZeroUsize,
    pub known_nodes_with_stake: Vec<PeerConfig<TYPES>>,
    pub known_da_nodes: Vec<PeerConfig<TYPES>>,
    pub da_staked_committee_size: usize,
    pub fixed_leader_for_gpuvid: usize,
    pub next_view_timeout: u64,
    pub view_sync_timeout: Duration,
    pub num_bootstrap: usize,
    pub builder_timeout: Duration,
    pub data_request_delay: Duration,
    pub builder_urls: Vec1<Url>,
    pub start_proposing_view: u64,
    pub stop_proposing_view: u64,
    pub start_voting_view: u64,
    pub stop_voting_view: u64,
    pub start_proposing_time: u64,
    pub stop_proposing_time: u64,
    pub start_voting_time: u64,
    pub stop_voting_time: u64,
    pub epoch_height: u64,
    pub epoch_start_block: u64,
}

Holds configuration for a HotShot

Fields

start_threshold: (u64, u64)

The proportion of nodes required before the orchestrator issues the ready signal, expressed as (numerator, denominator)

num_nodes_with_stake: NonZeroUsize

Total number of nodes in the network

known_nodes_with_stake: Vec<PeerConfig<TYPES>>

List of known node’s public keys and stake value for certificate aggregation, serving as public parameter

known_da_nodes: Vec<PeerConfig<TYPES>>

All public keys known to be DA nodes

da_staked_committee_size: usize

List of DA committee (staking)nodes for static DA committee

fixed_leader_for_gpuvid: usize

Number of fixed leaders for GPU VID, normally it will be 0, it’s only used when running GPU VID

next_view_timeout: u64

Base duration for next-view timeout, in milliseconds

view_sync_timeout: Duration

Duration of view sync round timeouts

num_bootstrap: usize

Number of network bootstrap nodes

builder_timeout: Duration

The maximum amount of time a leader can wait to get a block from a builder

data_request_delay: Duration

time to wait until we request data associated with a proposal

builder_urls: Vec1<Url>

Builder API base URL

start_proposing_view: u64

View to start proposing an upgrade

stop_proposing_view: u64

View to stop proposing an upgrade. To prevent proposing an upgrade, set stop_proposing_view <= start_proposing_view.

start_voting_view: u64

View to start voting on an upgrade

stop_voting_view: u64

View to stop voting on an upgrade. To prevent voting on an upgrade, set stop_voting_view <= start_voting_view.

start_proposing_time: u64

Unix time in seconds at which we start proposing an upgrade

stop_proposing_time: u64

Unix time in seconds at which we stop proposing an upgrade. To prevent proposing an upgrade, set stop_proposing_time <= start_proposing_time.

start_voting_time: u64

Unix time in seconds at which we start voting on an upgrade

stop_voting_time: u64

Unix time in seconds at which we stop voting on an upgrade. To prevent voting on an upgrade, set stop_voting_time <= start_voting_time.

epoch_height: u64

Number of blocks in an epoch, zero means there are no epochs

epoch_start_block: u64

Epoch start block

Implementations

impl<TYPES: NodeType> HotShotConfig<TYPES>

pub fn set_view_upgrade(&mut self, view: u64)

Update a hotshot config to have a view-based upgrade.

pub fn hotshot_stake_table(&self) -> HSStakeTable<TYPES>

Return the known_nodes_with_stake as a HSStakeTable

Trait Implementations

impl<TYPES: Clone + NodeType> Clone for HotShotConfig<TYPES>

fn clone(&self) -> HotShotConfig<TYPES>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TYPES: NodeType> Debug for HotShotConfig<TYPES>

where Vec<PeerConfig<TYPES>>: Debug,

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

Formats the value using the given formatter.

impl<'de, TYPES: NodeType> Deserialize<'de> for HotShotConfig<TYPES>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TYPES: NodeType> From<HotShotConfigFile<TYPES>> for HotShotConfig<TYPES>

fn from(val: HotShotConfigFile<TYPES>) -> Self

Converts to this type from the input type.

impl<TYPES> Serialize for HotShotConfig<TYPES>

where TYPES: Serialize + NodeType,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.