Struct ProposalDependencyHandle

pub struct ProposalDependencyHandle<TYPES: NodeType, V: Versions> {

    pub latest_proposed_view: TYPES::View,
    pub view_number: TYPES::View,
    pub sender: Sender<Arc<HotShotEvent<TYPES>>>,
    pub receiver: Receiver<Arc<HotShotEvent<TYPES>>>,
    pub instance_state: Arc<TYPES::InstanceState>,
    pub membership: EpochMembership<TYPES>,
    pub public_key: TYPES::SignatureKey,
    pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
    pub consensus: OuterConsensus<TYPES>,
    pub timeout: u64,
    pub formed_upgrade_certificate: Option<UpgradeCertificate<TYPES>>,
    pub upgrade_lock: UpgradeLock<TYPES, V>,
    pub id: u64,
    pub view_start_time: Instant,
    pub epoch_height: u64,
}

Handler for the proposal dependency

Fields

latest_proposed_view: TYPES::View

Latest view number that has been proposed for (proxy for cur_view).

view_number: TYPES::View

The view number to propose for.

sender: Sender<Arc<HotShotEvent<TYPES>>>

The event sender.

receiver: Receiver<Arc<HotShotEvent<TYPES>>>

The event receiver.

instance_state: Arc<TYPES::InstanceState>

Immutable instance state

membership: EpochMembership<TYPES>

Membership for Quorum Certs/votes

public_key: TYPES::SignatureKey

Our public key

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

Our Private Key

consensus: OuterConsensus<TYPES>

Shared consensus task state

timeout: u64

View timeout from config.

formed_upgrade_certificate: Option<UpgradeCertificate<TYPES>>

The most recent upgrade certificate this node formed. Note: this is ONLY for certificates that have been formed internally, so that we can propose with them.

Certificates received from other nodes will get reattached regardless of this fields, since they will be present in the leaf we propose off of.

upgrade_lock: UpgradeLock<TYPES, V>

Lock for a decided upgrade

id: u64

The node’s id

view_start_time: Instant

The time this view started

epoch_height: u64

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

Implementations

impl<TYPES: NodeType, V: Versions> ProposalDependencyHandle<TYPES, V>

async fn wait_for_qc_event( &self, rx: Receiver<Arc<HotShotEvent<TYPES>>>, ) -> Option<(QuorumCertificate2<TYPES>, Option<NextEpochQuorumCertificate2<TYPES>>, Option<LightClientStateUpdateCertificate<TYPES>>)>

Return the next HighQc we get from the event stream

async fn wait_for_transition_qc( &self, ) -> Result<Option<(QuorumCertificate2<TYPES>, NextEpochQuorumCertificate2<TYPES>)>>

async fn wait_for_highest_qc( &self, ) -> Result<(QuorumCertificate2<TYPES>, Option<NextEpochQuorumCertificate2<TYPES>>, Option<LightClientStateUpdateCertificate<TYPES>>)>

Waits for the configured timeout for nodes to send HighQc messages to us. We’ll then propose with the highest QC from among these proposals. A light client state update certificate is also returned if the highest QC is an epoch root QC.

async fn publish_proposal( &self, commitment_and_metadata: CommitmentAndMetadata<TYPES>, _vid_share: Proposal<TYPES, VidDisperse<TYPES>>, view_change_evidence: Option<ViewChangeEvidence2<TYPES>>, formed_upgrade_certificate: Option<UpgradeCertificate<TYPES>>, parent_qc: QuorumCertificate2<TYPES>, maybe_next_epoch_qc: Option<NextEpochQuorumCertificate2<TYPES>>, maybe_state_cert: Option<LightClientStateUpdateCertificate<TYPES>>, ) -> Result<()>

Publishes a proposal given the CommitmentAndMetadata, VidDisperse and high qc hotshot_types::simple_certificate::QuorumCertificate, with optional [ViewChangeEvidence].

fn print_proposal_events(&self, res: &[Vec<Vec<Arc<HotShotEvent<TYPES>>>>])

async fn handle_proposal_deps( &self, res: &[Vec<Vec<Arc<HotShotEvent<TYPES>>>>], ) -> Result<()>

Trait Implementations

impl<TYPES: NodeType, V: Versions> HandleDepOutput for ProposalDependencyHandle<TYPES, V>

type Output = Vec<Vec<Vec<Arc<HotShotEvent<TYPES>>>>>

Type we expect from completed dependency

async fn handle_dep_result(self, res: Self::Output)

Called once when the Dependency completes handles the results