Struct NodeState 

pub struct NodeState {

    pub node_id: u64,
    pub chain_config: ChainConfig,
    pub l1_client: L1Client,
    pub state_catchup: Arc<dyn StateCatchup>,
    pub genesis_header: GenesisHeader,
    pub genesis_state: ValidatedState,
    pub genesis_chain_config: ChainConfig,
    pub l1_genesis: Option<L1BlockInfo>,
    pub coordinator: EpochMembershipCoordinator<SeqTypes>,
    pub epoch_height: Option<u64>,
    pub genesis_version: Version,
    pub epoch_start_block: u64,
    pub light_client_contract_address: Cache<(), Address>,
    pub token_contract_address: Cache<(), Address>,
    pub finalized_hotshot_height: Cache<(), u64>,
    pub upgrades: BTreeMap<Version, Upgrade>,
    pub current_version: Version,
    pub epoch_rewards_calculator: Arc<Mutex<EpochRewardsCalculator>>,
}

Represents the immutable state of a node.

For mutable state, use ValidatedState.

Fields

node_id: u64

chain_config: ChainConfig

l1_client: L1Client

state_catchup: Arc<dyn StateCatchup>

genesis_header: GenesisHeader

genesis_state: ValidatedState

genesis_chain_config: ChainConfig

l1_genesis: Option<L1BlockInfo>

coordinator: EpochMembershipCoordinator<SeqTypes>

epoch_height: Option<u64>

genesis_version: Version

epoch_start_block: u64

light_client_contract_address: Cache<(), Address>

token_contract_address: Cache<(), Address>

finalized_hotshot_height: Cache<(), u64>

upgrades: BTreeMap<Version, Upgrade>

Map containing all planned and executed upgrades.

Currently, only one upgrade can be executed at a time. For multiple upgrades, the node needs to be restarted after each upgrade.

This field serves as a record for planned and past upgrades, listed in the genesis TOML file. It will be very useful if multiple upgrades are supported in the future.

current_version: Version

Current version of the sequencer.

This version is checked to determine if an upgrade is planned, and which version variant for versioned types to use in functions such as genesis. (example: genesis returns V2 Header if version is 0.2)

epoch_rewards_calculator: Arc<Mutex<EpochRewardsCalculator>>

Implementations

impl NodeState

pub async fn block_reward(&self, epoch: EpochNumber) -> Result<RewardAmount>

pub async fn fixed_block_reward(&self) -> Result<RewardAmount>

pub async fn light_client_contract_address(&self) -> Result<Address>

pub async fn token_contract_address(&self) -> Result<Address>

pub async fn finalized_hotshot_height(&self) -> Result<u64>

pub async fn light_client_history_start(&self) -> Result<Option<u64>>

The oldest HotShot block height the light client contract still holds a commitment for, or None when L1 finality or the contract’s history is unreadable. Some(0) means it still vouches for genesis. Never decreases for a given contract.

The window is set by prover cadence, not stateHistoryRetentionPeriod: one entry is evicted per update, so it can reach far further back than that setting suggests.

impl NodeState

pub fn new( node_id: u64, chain_config: ChainConfig, l1_client: L1Client, catchup: impl StateCatchup + 'static, current_version: Version, coordinator: EpochMembershipCoordinator<SeqTypes>, genesis_version: Version, ) -> Self

pub fn with_l1(self, l1_client: L1Client) -> Self

pub fn with_genesis(self, state: ValidatedState) -> Self

pub fn with_chain_config(self, cfg: ChainConfig) -> Self

pub fn with_upgrades(self, upgrades: BTreeMap<Version, Upgrade>) -> Self

pub fn with_current_version(self, version: Version) -> Self

pub fn with_genesis_version(self, version: Version) -> Self

pub fn with_epoch_height(self, epoch_height: u64) -> Self

pub fn with_epoch_start_block(self, epoch_start_block: u64) -> Self

Trait Implementations

impl Clone for NodeState

fn clone(&self) -> NodeState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeState

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

Formats the value using the given formatter.

impl InstanceState for NodeState