Struct Nudge

pub struct Nudge {
    pub chain_id: ChainID,
    pub view: ViewNumber,
    pub justify: PhaseCertificate,
}

Message broadcasted by a leader in view to “nudge” other validators to participate in the voting phase after justify.phase in order to make progress in committing a validator-set-updating block in the block tree identified by chain_id.

Permissible variants of justify.phase

nudge.justify.phase must be Prepare, Precommit, or Commit. This invariant is enforced in two places:

1. When a validator creates a Nudge using new.
2. When a replica receives a Nudge and checks the safe_nudge predicate.

Fields

chain_id: ChainID

ChainID of the block tree that justify.block is part of.

view: ViewNumber

Current ViewNumber of the proposer that created this Nudge.

justify: PhaseCertificate

PhaseVotes for this Nudge should be for the Phase immediately after justify.phase. E.g., if justify.phase == Precommit, then phase_vote.phase should be Commit.

Implementations

impl Nudge

pub fn new( chain_id: ChainID, view: ViewNumber, justify: PhaseCertificate, ) -> Self

Create a new Nudge message containing the given chain_id, view, and justify-ing PC.

Panics

justify.phase must be Prepare or Precommit. This function panics otherwise.

Trait Implementations

impl BorshDeserialize for Nudge

where ChainID: BorshDeserialize, ViewNumber: BorshDeserialize, PhaseCertificate: BorshDeserialize,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Nudge

where ChainID: BorshSerialize, ViewNumber: BorshSerialize, PhaseCertificate: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for Nudge

fn clone(&self) -> Nudge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Nudge> for HotStuffMessage

fn from(nudge: Nudge) -> Self

Converts to this type from the input type.