Struct Proposal 

pub struct Proposal<N: Network> { /* private fields */ }

A pending proposal by a validator.

When a validator creates and broadcasts a proposal, it collects endorsing signatures from other validators. When the validator has enough endorsements, it turns the proposal into a certificate. This struct holds the information about the pending proposal, in the proposing validator’s state, between the creation of the proposal and its turning into a certificate.

Invariant: batch_header.transmission_ids() contains the same elements as transmissions.keys(). Proposal::new and Proposal::read_le establish the invariant, by checking the condition; none of the other functions modifies the batch header or the transmissions.

Implementations

impl<N: Network> Proposal<N>

pub fn new( committee: Committee<N>, batch_header: BatchHeader<N>, transmissions: IndexMap<TransmissionID<N>, Transmission<N>>, ) -> Result<Self>

Initializes a new instance of the proposal.

The committee input is the active (i.e. lookback) committee for the batch round. A crucial protocol safety check made in this constructor is that the proposal author (the current validator), is a member of that committee, because only members of the committee can propose batches.

pub const fn batch_header(&self) -> &BatchHeader<N>

Returns the proposed batch header.

pub const fn batch_id(&self) -> Field<N>

Returns the proposed batch ID.

pub const fn round(&self) -> u64

Returns the round of the batch header.

pub const fn timestamp(&self) -> i64

Returns the timestamp of the batch header.

pub const fn transmissions( &self, ) -> &IndexMap<TransmissionID<N>, Transmission<N>>

Returns the transmissions.

pub fn into_transmissions(self) -> IndexMap<TransmissionID<N>, Transmission<N>>

Returns the transmissions.

pub fn signers(&self) -> HashSet<Address<N>>

Returns all the signers, including author and endorsers.

pub fn nonsigners(&self, committee: &Committee<N>) -> HashSet<Address<N>>

Returns the non-signers, i.e. the committee members that have not signed the proposal.

pub fn is_quorum_threshold_reached(&self, committee: &Committee<N>) -> bool

Returns true if the signers of the batch (author and endorsers) have reached the quorum threshold for the committee.

pub fn contains_transmission( &self, transmission_id: impl Into<TransmissionID<N>>, ) -> bool

Returns true if the proposal contains the given transmission ID.

pub fn get_transmission( &self, transmission_id: impl Into<TransmissionID<N>>, ) -> Option<&Transmission<N>>

Returns the transmission for the given transmission ID.

pub fn add_signature( &mut self, signer: Address<N>, signature: Signature<N>, committee: &Committee<N>, ) -> Result<()>

Adds an endorsing signature to the proposal, if the signature is valid and the signer is a committee member that has not already signed the proposal (this implicitly checks that the signature is not from the author).

pub fn to_certificate( &self, committee: &Committee<N>, ) -> Result<(BatchCertificate<N>, IndexMap<TransmissionID<N>, Transmission<N>>)>

Returns the batch certificate and transmissions.

Trait Implementations

impl<N: Debug + Network> Debug for Proposal<N>

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

Formats the value using the given formatter.

impl<N: Network> FromBytes for Proposal<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads Self from reader as little-endian bytes.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N: PartialEq + Network> PartialEq for Proposal<N>

fn eq(&self, other: &Proposal<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<N: Network> ToBytes for Proposal<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes self into writer as little-endian bytes.

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

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Eq + Network> Eq for Proposal<N>

impl<N: Network> StructuralPartialEq for Proposal<N>