Struct EpochChangeMessage 

pub struct EpochChangeMessage<T: NodeType, S> {
    pub cert1: Certificate1<T>,
    pub cert2: Certificate2<T>,
    pub proposal: Proposal<T>,
    _marker: PhantomData<fn() -> S>,
}

Message sent at the end of an epoch by the current committee to the next committee. Both certificates are on the last block of the epoch. The protocol spec only requires the second certificate, but for consistency in the code and with the existing Proposal and Leaf structures We include the Certificate1. This allows us to use the Certificate1 as the Justify QC on the first proposal. The Certificate2 also required on that proposal but as next_epoch_justify_qc on the Leaf.

We include the proposal because the new leader in the next epoch will need it to build a header for the first block of the next epoch.

Fields

cert1: Certificate1<T>

cert2: Certificate2<T>

proposal: Proposal<T>

_marker: PhantomData<fn() -> S>

Implementations

impl<T: NodeType> EpochChangeMessage<T, Validated>

pub fn validated( cert1: Certificate1<T>, cert2: Certificate2<T>, proposal: Proposal<T>, ) -> Self

Wrap certificates this node has verified (or formed itself).

impl<T: NodeType> EpochChangeMessage<T, Unchecked>

pub(crate) fn into_validated(self) -> EpochChangeMessage<T, Validated>

Mark this message’s certificates as verified.

impl<T: NodeType, S> EpochChangeMessage<T, S>

pub fn well_formed(&self, epoch_height: u64) -> Result<(), EpochChangeError>

Structural validity of the message, independent of signatures.

Every part must name the same block, and cert1 and the proposal the same view. cert2 may be at a later view: a re-vote commits the last block of an epoch again at a view of its own, and the first block of the next epoch still names the block’s own cert1. A certificate’s own view and block number are covered by the signatures over it, and the proposal’s are covered by the leaf commitment, so agreement between them otherwise rests on an honest signer being in the quorum. Comparing them makes the message self-checking. Proposal::epoch is not covered by the commitment at all and has no other check.

What the embedded proposal claims about itself and its parent is checked by the same functions the proposal path uses, except for the boundary Cert2 only the first proposal of an epoch carries.

Trait Implementations

impl<T: Clone + NodeType, S: Clone> Clone for EpochChangeMessage<T, S>

fn clone(&self) -> EpochChangeMessage<T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + NodeType, S: Debug> Debug for EpochChangeMessage<T, S>

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

Formats the value using the given formatter.

impl<'de, T: NodeType, S> Deserialize<'de> for EpochChangeMessage<T, S>

where S: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq + NodeType, S: Eq> Eq for EpochChangeMessage<T, S>

impl<T: NodeType, S> HasEpoch for EpochChangeMessage<T, S>

fn epoch(&self) -> Option<EpochNumber>

Returns Epoch

impl<T: NodeType, S> HasViewNumber for EpochChangeMessage<T, S>

fn view_number(&self) -> ViewNumber

The view of the commit: the next epoch starts after it.

impl<T: Hash + NodeType, S: Hash> Hash for EpochChangeMessage<T, S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq + NodeType, S: PartialEq> PartialEq for EpochChangeMessage<T, S>

fn eq(&self, other: &EpochChangeMessage<T, S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T, S> Serialize for EpochChangeMessage<T, S>

where T: Serialize + NodeType,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq + NodeType, S: PartialEq> StructuralPartialEq for EpochChangeMessage<T, S>

impl<T: NodeType> Verifiable<T> for EpochChangeMessage<T, Unchecked>

type Key = EpochNumber

Identifies the Verifiable, e.g. ViewNumber or EpochNumber.

type Output = EpochChangeMessage<T, Validated>

fn key(&self) -> Option<EpochNumber>

fn check( self, stake_table: &[<T::SignatureKey as SignatureKey>::StakeTableEntry], threshold: U256, epoch_height: u64, upgrade_lock: &UpgradeLock<T>, _: &EpochMembershipCoordinator<T>, ) -> Result<Self::Output>

fn epochs(&self) -> impl Iterator<Item = EpochNumber>

The epochs whose committees Self::check reads.