Struct BlockProducerVrfEvaluatorState

pub struct BlockProducerVrfEvaluatorState {
    pub status: BlockProducerVrfEvaluatorStatus,
    pub won_slots: BTreeMap<u32, VrfWonSlotWithHash>,
    pub latest_evaluated_slot: u32,
    pub genesis_timestamp: Timestamp,
    last_evaluated_epoch: Option<u32>,
    pending_evaluation: Option<PendingEvaluation>,
    epoch_context: EpochContext,
}

Vrf evaluator sub-state

Fields

status: BlockProducerVrfEvaluatorStatus

won_slots: BTreeMap<u32, VrfWonSlotWithHash>

latest_evaluated_slot: u32

genesis_timestamp: Timestamp

last_evaluated_epoch: Option<u32>

pending_evaluation: Option<PendingEvaluation>

epoch_context: EpochContext

Implementations

impl BlockProducerVrfEvaluatorState

pub fn new(now: Timestamp) -> Self

pub fn evaluate_epoch_bounds(global_slot: &u32) -> SlotPositionInEpoch

Determines the position of a slot within an epoch (at the beginning, end, or within the epoch). This function calculates the position based on the global_slot and a predefined number of slots per epoch.

Arguments:

• global_slot: A reference to a 32-bit unsigned integer representing the global slot number.

Returns:

• SlotPositionInEpoch: An enum indicating the slot’s position (Beginning, End, or Within).

pub fn next_won_slot( &self, cur_global_slot: u32, best_tip: &ArcBlockWithHash, ) -> Option<BlockProducerWonSlot>

Fetches the next slot that has been won based on the current global slot and the best tip information. If there are no future won slots, returns None.

Arguments:

• cur_global_slot: The current global slot as a 32-bit unsigned integer.
• best_tip: A reference to the ArcBlockWithHash representing the current best tip.

Returns:

• Option<BlockProducerWonSlot>: The next won slot, if any, as a BlockProducerWonSlot or None if there are no more slots won in the future.

pub fn epoch_context(&self) -> &EpochContext

Retrieves the current epoch context.

Returns:

• &EpochContext: A reference to the EpochContext

pub fn set_epoch_context(&mut self)

Sets the epoch context based on the current evaluation status and the available data. This method updates the epoch_context field in the ReadinessCheck state

pub fn is_idle(&self) -> bool

pub fn is_initialized(&self) -> bool

pub fn is_epoch_evaluated(&self, epoch_number: u32) -> bool

Determines if a given epoch number has already been evaluated.

Arguments:

• epoch_number: The epoch number as a 32-bit unsigned integer to check.

Returns:

• bool: true if the epoch has already been evaluated, otherwise false.

pub fn last_evaluated_epoch(&self) -> Option<u32>

Retrieves the number of the last evaluated epoch, if any.

Returns:

• Option<u32>: The epoch number of the last evaluated epoch, or None if no epoch has been evaluated yet.

pub fn latest_evaluated_global_slot(&self) -> u32

TODO: remove, not needed anymore

pub fn is_readiness_check(&self) -> bool

Returns true if the evaluator is in the ReadinessCheck state, otherwise false.

pub fn is_epoch_bound_evaluated(&self) -> bool

Returns true if the evaluator is in the EpochBoundsCheck state, otherwise false.

pub fn can_check_next_evaluation(&self) -> bool

Returns true if the evaluator is in a state that can perform a ReadinessCheck``, otherwise false`.

pub fn can_construct_delegator_table(&self) -> bool

Returns true if the evaluator is in the ReadyToEvaluate state, otherwise false.

pub fn is_delegator_table_requested(&self) -> bool

Returns true if the evaluator is in the EpochDelegatorTablePending state, otherwise false.

pub fn is_delegator_table_constructed(&self) -> bool

Returns true if the evaluator is in the EpochDelegatorTableSuccess state, otherwise false.

pub fn can_start_epoch_evaluation(&self) -> bool

TODO: redundant fn, remove?

pub fn is_evaluating(&self) -> bool

Returns true if the evaluator is in any of the following states: SlotEvaluationPending, SlotEvaluationReceived, EpochEvaluationPending, EpochBoundsCheck, otherwise false .

pub fn is_evaluation_pending(&self) -> bool

pub fn is_slot_selection(&self) -> bool

Returns true if the evaluator is in the InitialSlotSelection state, otherwise false.

pub fn is_slot_requested(&self) -> bool

Returns true if the evaluator is in the SlotEvaluationPending state, otherwise false.

pub fn is_slot_evaluated(&self) -> bool

Returns true if the evaluator is in the SlotEvaluationReceived state, otherwise false.

pub fn set_latest_evaluated_global_slot(&mut self, global_slot: &u32)

pub fn initialize_evaluator(&mut self, _epoch: u32, _last_height: u32)

pub fn set_last_evaluated_epoch(&mut self, epoch_number: u32)

pub fn initial_slot(&self) -> Option<u32>

pub fn get_epoch_bound_from_check(&self) -> Option<SlotPositionInEpoch>

pub fn set_pending_evaluation(&mut self, pending_evaluation: PendingEvaluation)

pub fn unset_pending_evaluation(&mut self)

pub fn current_evaluation(&self) -> Option<PendingEvaluation>

pub fn currently_evaluated_epoch(&self) -> Option<u32>

pub fn construct_vrf_input(&self) -> Option<VrfEvaluatorInput>

pub fn retention_slot(&self, current_epoch_number: &u32) -> u32

pub fn cleanup_old_won_slots(&mut self, current_epoch_number: &u32)

pub fn vrf_delegator_table_inputs( &self, ) -> Option<(&LedgerHash, &AccountPublicKey)>

If we need to construct delegator table, get it’s inputs.

impl BlockProducerVrfEvaluatorState

pub fn reducer( state_context: Substate<'_, Self>, action: BlockProducerVrfEvaluatorActionWithMetaRef<'_>, )

Trait Implementations

impl Clone for BlockProducerVrfEvaluatorState

fn clone(&self) -> BlockProducerVrfEvaluatorState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockProducerVrfEvaluatorState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockProducerVrfEvaluatorState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BlockProducerVrfEvaluatorState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SubstateAccess<BlockProducerVrfEvaluatorState> for State

fn substate(&self) -> SubstateResult<&BlockProducerVrfEvaluatorState>

Attempts to obtain an immutable reference to the substate.

fn substate_mut( &mut self, ) -> SubstateResult<&mut BlockProducerVrfEvaluatorState>

Attempts to obtain a mutable reference to the substate.