Struct CertificatePair

pub struct CertificatePair<TYPES: NodeType> {
    qc: QuorumCertificate2<TYPES>,
    next_epoch_qc: Option<NextEpochQuorumCertificate2<TYPES>>,
}

A pair of QCs (or a single QC) attesting to a leaf.

Generally we only need a single QC, but during an epoch transition, we require a pair: one signed by the current membership and one signed by the next epoch’s membership. This type encapsulates both.

Fields

qc: QuorumCertificate2<TYPES>

The basic QC.

next_epoch_qc: Option<NextEpochQuorumCertificate2<TYPES>>

A QC from the next epoch’s membership, if this QC is part of an epoch transition.

Implementations

impl<TYPES: NodeType> CertificatePair<TYPES>

pub fn new( qc: QuorumCertificate2<TYPES>, next_epoch_qc: Option<NextEpochQuorumCertificate2<TYPES>>, ) -> Self

Create a certificate pair.

pub fn non_epoch_change(qc: QuorumCertificate2<TYPES>) -> Self

Create a certificate for a non-epoch-transitioning block.

pub fn for_parent(leaf: &Leaf2<TYPES>) -> Self

Create a certificate for the parent of a leaf, using the justifying QCs in the leaf.

pub fn qc(&self) -> &QuorumCertificate2<TYPES>

The raw QC.

pub fn next_epoch_qc(&self) -> Option<&NextEpochQuorumCertificate2<TYPES>>

A raw QC from the subsequent epoch’s quorum, if this certificate is part of an epoch change.

pub fn leaf_commit(&self) -> Commitment<Leaf2<TYPES>>

The leaf commitment signed by this certificate.

pub fn epoch(&self) -> Option<TYPES::Epoch>

The epoch number this certificate belongs to.

None if this certificate originated before epochs were enabled.

pub fn block_number(&self) -> Option<u64>

The block number attached to this certificate.

None if this certificate originated before epochs were enabled.

pub fn verify_next_epoch_qc( &self, epoch_height: u64, ) -> Result<Option<&NextEpochQuorumCertificate2<TYPES>>>

Verify that the next epoch QC is present and consistent if required.

This checks that if required, the next epoch QC is present and is consistent with the primary QC. It does not check the signature on either QC, only that the data being signed over is consistent between the two.

Returns the next epoch QC if it is present and invariants are satisfied. Returns an error if a required next epoch QC is missing or if it is inconsistent with the primary QC. Returns None if a next epoch QC is not required for this certificate.

Trait Implementations

impl<TYPES: Clone + NodeType> Clone for CertificatePair<TYPES>

fn clone(&self) -> CertificatePair<TYPES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TYPES: Debug + NodeType> Debug for CertificatePair<TYPES>

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

Formats the value using the given formatter.

impl<'de, TYPES: NodeType> Deserialize<'de> for CertificatePair<TYPES>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TYPES: NodeType> HasViewNumber<TYPES> for CertificatePair<TYPES>

fn view_number(&self) -> TYPES::View

Returns the view number the type refers to.

impl<TYPES: PartialEq + NodeType> PartialEq for CertificatePair<TYPES>

fn eq(&self, other: &CertificatePair<TYPES>) -> 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<TYPES: NodeType> Serialize for CertificatePair<TYPES>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<TYPES: Eq + NodeType> Eq for CertificatePair<TYPES>

impl<TYPES: NodeType> StructuralPartialEq for CertificatePair<TYPES>