Struct hotshot_task_impls::quorum_vote::QuorumVoteTaskState

pub struct QuorumVoteTaskState<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {

    pub public_key: TYPES::SignatureKey,
    pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
    pub consensus: OuterConsensus<TYPES>,
    pub instance_state: Arc<TYPES::InstanceState>,
    pub latest_voted_view: TYPES::View,
    pub vote_dependencies: BTreeMap<TYPES::View, JoinHandle<()>>,
    pub network: Arc<I::Network>,
    pub membership: Arc<RwLock<TYPES::Membership>>,
    pub drb_computations: DrbComputations<TYPES>,
    pub output_event_stream: Sender<Event<TYPES>>,
    pub id: u64,
    pub consensus_metrics: Arc<ConsensusMetricsValue>,
    pub storage: Arc<RwLock<I::Storage>>,
    pub upgrade_lock: UpgradeLock<TYPES, V>,
    pub epoch_height: u64,
}

The state for the quorum vote task.

Contains all of the information for the quorum vote.

Fields

public_key: TYPES::SignatureKey

Public key.

private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey

Private Key.

consensus: OuterConsensus<TYPES>

Reference to consensus. The replica will require a write lock on this.

instance_state: Arc<TYPES::InstanceState>

Immutable instance state

latest_voted_view: TYPES::View

Latest view number that has been voted for.

vote_dependencies: BTreeMap<TYPES::View, JoinHandle<()>>

Table for the in-progress dependency tasks.

network: Arc<I::Network>

The underlying network

membership: Arc<RwLock<TYPES::Membership>>

Membership for Quorum certs/votes and DA committee certs/votes.

drb_computations: DrbComputations<TYPES>

Table for the in-progress DRB computation tasks.

output_event_stream: Sender<Event<TYPES>>

Output events to application

id: u64

The node’s id

consensus_metrics: Arc<ConsensusMetricsValue>

The consensus metrics

storage: Arc<RwLock<I::Storage>>

Reference to the storage.

upgrade_lock: UpgradeLock<TYPES, V>

Lock for a decided upgrade

epoch_height: u64

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

Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> QuorumVoteTaskState<TYPES, I, V>

fn create_event_dependency( &self, dependency_type: VoteDependency, view_number: TYPES::View, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, ) -> EventDependency<Arc<HotShotEvent<TYPES>>>

Create an event dependency.

fn create_dependency_task_if_new( &mut self, view_number: TYPES::View, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, event_sender: &Sender<Arc<HotShotEvent<TYPES>>>, event: Arc<HotShotEvent<TYPES>>, )

Create and store an AndDependency combining EventDependencys associated with the given view number if it doesn’t exist.

async fn update_latest_voted_view(&mut self, new_view: TYPES::View) -> bool

Update the latest voted view number.

pub async fn handle( &mut self, event: Arc<HotShotEvent<TYPES>>, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, event_sender: Sender<Arc<HotShotEvent<TYPES>>>, ) -> Result<()>

Handle a vote dependent event received on the event stream

async fn handle_eqc_voting( &self, proposal: &Proposal<TYPES, QuorumProposal2<TYPES>>, parent_leaf: &Leaf2<TYPES>, event_sender: Sender<Arc<HotShotEvent<TYPES>>>, event_receiver: Receiver<Arc<HotShotEvent<TYPES>>>, )

Handles voting for the last block in the epoch to form the Extended QC.

Trait Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> TaskState for QuorumVoteTaskState<TYPES, I, V>

type Event = HotShotEvent<TYPES>

Type of event sent and received by the task

fn handle_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, event: Arc<Self::Event>, sender: &'life1 Sender<Arc<Self::Event>>, receiver: &'life2 Receiver<Arc<Self::Event>>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Handles an event, providing direct access to the specific channel we received the event on.

fn cancel_subtasks(&mut self)

Joins all subtasks.