Struct consensus_types::timeout_2chain::TwoChainTimeoutCertificate

pub struct TwoChainTimeoutCertificate { /* private fields */ }

TimeoutCertificate is a proof that 2f+1 participants in epoch i have voted in round r and we can now move to round r+1. DiemBFT v4 requires signature to sign on the TimeoutSigningRepr and carry the TimeoutWithHighestQC with highest quorum cert among 2f+1.

Implementations

impl TwoChainTimeoutCertificate

pub fn new(timeout: TwoChainTimeout) -> Self

Creates new TimeoutCertificate

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

Verifies the signatures for each validator, the signature is on the TimeoutSigningRepr where the hqc_round is in the signature map. We verify the following:

1. the highest quorum cert is valid
2. all signatures are properly formed (timeout.epoch, timeout.round, round)
3. timeout.hqc_round == max(signed round)

pub fn epoch(&self) -> u64

The epoch of the timeout.

pub fn round(&self) -> Round

The round of the timeout.

pub fn highest_hqc_round(&self) -> Round

The highest hqc round of the 2f+1 participants

pub fn signers(&self) -> impl Iterator<Item = &Author>

Returns the signatures certifying the round

pub fn add( &mut self, author: Author, timeout: TwoChainTimeout, signature: Ed25519Signature )

Add a new timeout message from author, the timeout should already be verified in upper layer.

Trait Implementations

impl Clone for TwoChainTimeoutCertificate

fn clone(&self) -> TwoChainTimeoutCertificate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TwoChainTimeoutCertificate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TwoChainTimeoutCertificate

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

Deserialize this value from the given Serde deserializer.

impl Display for TwoChainTimeoutCertificate

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

Formats the value using the given formatter.

impl PartialEq<TwoChainTimeoutCertificate> for TwoChainTimeoutCertificate

fn eq(&self, other: &TwoChainTimeoutCertificate) -> 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 TwoChainTimeoutCertificate

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 TwoChainTimeoutCertificate

impl StructuralEq for TwoChainTimeoutCertificate

impl StructuralPartialEq for TwoChainTimeoutCertificate