Struct hotshot_types::simple_certificate::SimpleCertificate

pub struct SimpleCertificate<TYPES: NodeType, VOTEABLE: Voteable<TYPES>, THRESHOLD: Threshold<TYPES>> {
    pub data: VOTEABLE,
    vote_commitment: Commitment<VOTEABLE>,
    pub view_number: TYPES::View,
    pub signatures: Option<<TYPES::SignatureKey as SignatureKey>::QcType>,
    pub _pd: PhantomData<(TYPES, THRESHOLD)>,
}

A certificate which can be created by aggregating many simple votes on the commitment.

Fields

data: VOTEABLE

The data this certificate is for. I.e the thing that was voted on to create this Certificate

vote_commitment: Commitment<VOTEABLE>

commitment of all the votes this cert should be signed over

view_number: TYPES::View

Which view this QC relates to

signatures: Option<<TYPES::SignatureKey as SignatureKey>::QcType>

assembled signature for certificate aggregation

_pd: PhantomData<(TYPES, THRESHOLD)>

phantom data for THRESHOLD and TYPES

Implementations

impl<TYPES: NodeType> SimpleCertificate<TYPES, QuorumData<TYPES>, SuccessThreshold>

pub async fn genesis<V: Versions>( validated_state: &TYPES::ValidatedState, instance_state: &TYPES::InstanceState, ) -> Self

Creat the Genesis certificate

impl<TYPES: NodeType> SimpleCertificate<TYPES, QuorumData2<TYPES>, SuccessThreshold>

pub async fn genesis<V: Versions>( validated_state: &TYPES::ValidatedState, instance_state: &TYPES::InstanceState, ) -> Self

Creat the Genesis certificate

impl<TYPES: NodeType, VOTEABLE: Voteable<TYPES>, THRESHOLD: Threshold<TYPES>> SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

pub fn new( data: VOTEABLE, vote_commitment: Commitment<VOTEABLE>, view_number: TYPES::View, signatures: Option<<TYPES::SignatureKey as SignatureKey>::QcType>, pd: PhantomData<(TYPES, THRESHOLD)>, ) -> Self

Creates a new instance of SimpleCertificate

impl<TYPES: NodeType> SimpleCertificate<TYPES, UpgradeProposalData<TYPES>, UpgradeThreshold>

pub async fn is_relevant( &self, view_number: TYPES::View, decided_upgrade_certificate: Arc<RwLock<Option<Self>>>, ) -> Result<()>

Determines whether or not a certificate is relevant (i.e. we still have time to reach a decide)

Errors

Returns an error when the certificate is no longer relevant

pub async fn validate<V: Versions>( upgrade_certificate: &Option<Self>, membership: &RwLock<TYPES::Membership>, epoch: TYPES::Epoch, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> Result<()>

Validate an upgrade certificate.

Errors

Returns an error when the upgrade certificate is invalid.

pub fn upgrading_in(&self, view: TYPES::View) -> bool

Given an upgrade certificate and a view, tests whether the view is in the period where we are upgrading, which requires that we propose with null blocks.

impl<TYPES: NodeType> SimpleCertificate<TYPES, QuorumData<TYPES>, SuccessThreshold>

pub fn to_qc2(self) -> QuorumCertificate2<TYPES>

Convert a QuorumCertificate into a QuorumCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, QuorumData2<TYPES>, SuccessThreshold>

pub fn to_qc(self) -> QuorumCertificate<TYPES>

Convert a QuorumCertificate2 into a QuorumCertificate

impl<TYPES: NodeType> SimpleCertificate<TYPES, DaData, SuccessThreshold>

pub fn to_dac2(self) -> DaCertificate2<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, DaData2<TYPES>, SuccessThreshold>

pub fn to_dac(self) -> DaCertificate<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, ViewSyncPreCommitData<TYPES>, OneHonestThreshold>

pub fn to_vsc2(self) -> ViewSyncPreCommitCertificate2<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, ViewSyncPreCommitData2<TYPES>, OneHonestThreshold>

pub fn to_vsc(self) -> ViewSyncPreCommitCertificate<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, ViewSyncCommitData<TYPES>, SuccessThreshold>

pub fn to_vsc2(self) -> ViewSyncCommitCertificate2<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, ViewSyncCommitData2<TYPES>, SuccessThreshold>

pub fn to_vsc(self) -> ViewSyncCommitCertificate<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, ViewSyncFinalizeData<TYPES>, SuccessThreshold>

pub fn to_vsc2(self) -> ViewSyncFinalizeCertificate2<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, ViewSyncFinalizeData2<TYPES>, SuccessThreshold>

pub fn to_vsc(self) -> ViewSyncFinalizeCertificate<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, TimeoutData<TYPES>, SuccessThreshold>

pub fn to_vsc2(self) -> TimeoutCertificate2<TYPES>

Convert a DaCertificate into a DaCertificate2

impl<TYPES: NodeType> SimpleCertificate<TYPES, TimeoutData2<TYPES>, SuccessThreshold>

pub fn to_vsc(self) -> TimeoutCertificate<TYPES>

Convert a DaCertificate into a DaCertificate2

Trait Implementations

impl<TYPES: NodeType, THRESHOLD: Threshold<TYPES>> Certificate<TYPES, DaData> for SimpleCertificate<TYPES, DaData, THRESHOLD>

fn stake_table_entry<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, pub_key: &TYPES::SignatureKey, epoch: TYPES::Epoch, ) -> Option<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>

Proxy’s to Membership.stake

fn stake_table<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>

Proxy’s to Membership.da_stake_table

fn total_nodes<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> usize

Proxy’s to Membership.da_total_nodes

type Voteable = DaData

The data commitment this certificate certifies.

type Threshold = THRESHOLD

Threshold Functions

fn create_signed_certificate<V: Versions>( vote_commitment: Commitment<VersionedVoteData<TYPES, DaData, V>>, data: Self::Voteable, sig: <TYPES::SignatureKey as SignatureKey>::QcType, view: TYPES::View, ) -> Self

Build a certificate from the data commitment and the quorum of signers

async fn is_valid_cert<V: Versions>( &self, stake_table: Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>, threshold: NonZeroU64, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> bool

Checks if the cert is valid in the given epoch

fn threshold<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> u64

Returns the amount of stake needed to create this certificate

fn data(&self) -> &Self::Voteable

Get the commitment which was voted on

async fn data_commitment<V: Versions>( &self, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> Result<Commitment<VersionedVoteData<TYPES, DaData, V>>>

Get the vote commitment which the votes commit to

impl<TYPES: NodeType, THRESHOLD: Threshold<TYPES>> Certificate<TYPES, DaData2<TYPES>> for SimpleCertificate<TYPES, DaData2<TYPES>, THRESHOLD>

fn stake_table_entry<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, pub_key: &TYPES::SignatureKey, epoch: TYPES::Epoch, ) -> Option<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>

Proxy’s to Membership.stake

fn stake_table<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>

Proxy’s to Membership.da_stake_table

fn total_nodes<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> usize

Proxy’s to Membership.da_total_nodes

type Voteable = DaData2<TYPES>

The data commitment this certificate certifies.

type Threshold = THRESHOLD

Threshold Functions

fn create_signed_certificate<V: Versions>( vote_commitment: Commitment<VersionedVoteData<TYPES, DaData2<TYPES>, V>>, data: Self::Voteable, sig: <TYPES::SignatureKey as SignatureKey>::QcType, view: TYPES::View, ) -> Self

Build a certificate from the data commitment and the quorum of signers

async fn is_valid_cert<V: Versions>( &self, stake_table: Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>, threshold: NonZeroU64, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> bool

Checks if the cert is valid in the given epoch

fn threshold<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> u64

Returns the amount of stake needed to create this certificate

fn data(&self) -> &Self::Voteable

Get the commitment which was voted on

async fn data_commitment<V: Versions>( &self, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> Result<Commitment<VersionedVoteData<TYPES, DaData2<TYPES>, V>>>

Get the vote commitment which the votes commit to

impl<TYPES: NodeType, VOTEABLE: Voteable<TYPES> + 'static + QuorumMarker, THRESHOLD: Threshold<TYPES>> Certificate<TYPES, VOTEABLE> for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

fn total_nodes<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> usize

Proxy’s to Membership.total_nodes

type Voteable = VOTEABLE

The data commitment this certificate certifies.

type Threshold = THRESHOLD

Threshold Functions

fn create_signed_certificate<V: Versions>( vote_commitment: Commitment<VersionedVoteData<TYPES, VOTEABLE, V>>, data: Self::Voteable, sig: <TYPES::SignatureKey as SignatureKey>::QcType, view: TYPES::View, ) -> Self

Build a certificate from the data commitment and the quorum of signers

async fn is_valid_cert<V: Versions>( &self, stake_table: Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>, threshold: NonZeroU64, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> bool

Checks if the cert is valid in the given epoch

fn threshold<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> u64

Returns the amount of stake needed to create this certificate

fn stake_table_entry<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, pub_key: &TYPES::SignatureKey, epoch: TYPES::Epoch, ) -> Option<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>

Get StakeTableEntry from Membership implementation.

fn stake_table<MEMBERSHIP: Membership<TYPES>>( membership: &MEMBERSHIP, epoch: TYPES::Epoch, ) -> Vec<<TYPES::SignatureKey as SignatureKey>::StakeTableEntry>

Get Stake Table from Membership implementation.

fn data(&self) -> &Self::Voteable

Get the commitment which was voted on

async fn data_commitment<V: Versions>( &self, upgrade_lock: &UpgradeLock<TYPES, V>, ) -> Result<Commitment<VersionedVoteData<TYPES, VOTEABLE, V>>>

Get the vote commitment which the votes commit to

impl<TYPES: Clone + NodeType, VOTEABLE: Clone + Voteable<TYPES>, THRESHOLD: Clone + Threshold<TYPES>> Clone for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where TYPES::View: Clone, TYPES::SignatureKey: Clone,

fn clone(&self) -> SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TYPES: NodeType, VOTEABLE: Voteable<TYPES> + Committable, THRESHOLD: Threshold<TYPES>> Committable for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

fn commit(&self) -> Commitment<Self>

Create a binding commitment to self.

fn tag() -> String

Tag that should be used when serializing commitments to this type.

impl<TYPES: Debug + NodeType, VOTEABLE: Debug + Voteable<TYPES>, THRESHOLD: Debug + Threshold<TYPES>> Debug for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where TYPES::View: Debug, TYPES::SignatureKey: Debug,

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

Formats the value using the given formatter.

impl<'de, TYPES: NodeType, VOTEABLE, THRESHOLD: Threshold<TYPES>> Deserialize<'de> for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where VOTEABLE: Deserialize<'de> + Voteable<TYPES>, TYPES::View: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TYPES: NodeType, VOTEABLE: Voteable<TYPES> + 'static, THRESHOLD: Threshold<TYPES>> HasViewNumber<TYPES> for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

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

Returns the view number the type refers to.

impl<TYPES: Hash + NodeType, VOTEABLE: Hash + Voteable<TYPES>, THRESHOLD: Hash + Threshold<TYPES>> Hash for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where TYPES::View: Hash, TYPES::SignatureKey: Hash,

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<TYPES: PartialEq + NodeType, VOTEABLE: PartialEq + Voteable<TYPES>, THRESHOLD: PartialEq + Threshold<TYPES>> PartialEq for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where TYPES::View: PartialEq, TYPES::SignatureKey: PartialEq,

fn eq(&self, other: &SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>) -> 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, VOTEABLE, THRESHOLD: Threshold<TYPES>> Serialize for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where VOTEABLE: Serialize + Voteable<TYPES>, TYPES::View: Serialize,

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, VOTEABLE: Eq + Voteable<TYPES>, THRESHOLD: Eq + Threshold<TYPES>> Eq for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>

where TYPES::View: Eq, TYPES::SignatureKey: Eq,

impl<TYPES: NodeType, VOTEABLE: Voteable<TYPES>, THRESHOLD: Threshold<TYPES>> StructuralPartialEq for SimpleCertificate<TYPES, VOTEABLE, THRESHOLD>