Struct consensus_types::vote::Vote

pub struct Vote { /* private fields */ }

Vote is the struct that is ultimately sent by the voter in response for receiving a proposal. Vote carries the LedgerInfo of a block that is going to be committed in case this vote is gathers QuorumCertificate (see the detailed explanation in the comments of LedgerInfo).

Implementations

impl Vote

pub fn new( vote_data: VoteData, author: Author, ledger_info_placeholder: LedgerInfo, validator_signer: &ValidatorSigner ) -> Self

Generates a new Vote corresponding to the “fast-vote” path without the round signatures that can be aggregated into a timeout certificate

pub fn new_with_signature( vote_data: VoteData, author: Author, ledger_info: LedgerInfo, signature: Ed25519Signature ) -> Self

Generates a new Vote using a signature over the specified ledger_info

pub fn add_timeout_signature(&mut self, signature: Ed25519Signature)

Generates a round signature, which can then be used for aggregating a timeout certificate. Typically called for generating vote messages that are sent upon timeouts.

pub fn add_2chain_timeout( &mut self, timeout: TwoChainTimeout, signature: Ed25519Signature )

Add the 2-chain timeout and signature in the vote.

pub fn vote_data(&self) -> &VoteData

pub fn author(&self) -> Author

Return the author of the vote

pub fn ledger_info(&self) -> &LedgerInfo

Return the LedgerInfo associated with this vote

pub fn signature(&self) -> &Ed25519Signature

Return the signature of the vote

pub fn generate_timeout(&self) -> Timeout

Returns the hash of the data represent by a timeout proposal

pub fn generate_2chain_timeout(&self, qc: QuorumCert) -> TwoChainTimeout

Returns the 2-chain timeout.

pub fn epoch(&self) -> u64

Return the epoch of the vote

pub fn timeout_signature(&self) -> Option<&Ed25519Signature>

Returns the signature for the vote_data().proposed().round() that can be aggregated for TimeoutCertificate.

pub fn two_chain_timeout(&self) -> Option<&(TwoChainTimeout, Ed25519Signature)>

Return the two chain timeout vote and signature.

pub fn is_timeout(&self) -> bool

The vote message is considered a timeout vote message if it carries a signature on the round, which can then be used for aggregating it to the TimeoutCertificate.

pub fn verify(&self, validator: &ValidatorVerifier) -> Result<()>

Verifies that the consensus data hash of LedgerInfo corresponds to the vote info, and then verifies the signature.

Trait Implementations

impl Clone for Vote

fn clone(&self) -> Vote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vote

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Vote

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Vote

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

Formats the value using the given formatter.

impl PartialEq<Vote> for Vote

fn eq(&self, other: &Vote) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Vote

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

Serialize this value into the given Serde serializer.

impl Eq for Vote

impl StructuralEq for Vote

impl StructuralPartialEq for Vote