Struct hotshot_types::simple_vote::SimpleVote

pub struct SimpleVote<TYPES: NodeType, DATA: Voteable> {
    pub signature: (TYPES::SignatureKey, <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType),
    pub data: DATA,
    pub view_number: TYPES::Time,
}

A simple yes vote over some votable type.

Fields

signature: (TYPES::SignatureKey, <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType)

The signature share associated with this vote

data: DATA

The leaf commitment being voted on.

view_number: TYPES::Time

The view this vote was cast for

Implementations

impl<TYPES: NodeType, DATA: Voteable + 'static> SimpleVote<TYPES, DATA>

pub async fn create_signed_vote<V: Versions>( data: DATA, view: TYPES::Time, pub_key: &TYPES::SignatureKey, private_key: &<TYPES::SignatureKey as SignatureKey>::PrivateKey, upgrade_lock: &UpgradeLock<TYPES, V> ) -> Result<Self>

Creates and signs a simple vote

Errors

If we are unable to sign the data

Trait Implementations

impl<TYPES: Clone + NodeType, DATA: Clone + Voteable> Clone for SimpleVote<TYPES, DATA>

where TYPES::SignatureKey: Clone, TYPES::Time: Clone,

fn clone(&self) -> SimpleVote<TYPES, DATA>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TYPES: Debug + NodeType, DATA: Debug + Voteable> Debug for SimpleVote<TYPES, DATA>

where TYPES::SignatureKey: Debug, TYPES::Time: Debug,

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

Formats the value using the given formatter.

impl<'de, TYPES: NodeType, DATA> Deserialize<'de> for SimpleVote<TYPES, DATA>

where DATA: Deserialize<'de> + Voteable, TYPES::Time: 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, DATA: Voteable + 'static> HasViewNumber<TYPES> for SimpleVote<TYPES, DATA>

fn view_number(&self) -> <TYPES as NodeType>::Time

Returns the view number the type refers to.

impl<TYPES: Hash + NodeType, DATA: Hash + Voteable> Hash for SimpleVote<TYPES, DATA>

where TYPES::SignatureKey: Hash, TYPES::Time: 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, DATA: PartialEq + Voteable> PartialEq for SimpleVote<TYPES, DATA>

where TYPES::SignatureKey: PartialEq, TYPES::Time: PartialEq,

fn eq(&self, other: &SimpleVote<TYPES, DATA>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<TYPES: NodeType, DATA> Serialize for SimpleVote<TYPES, DATA>

where DATA: Serialize + Voteable, TYPES::Time: 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: NodeType, DATA: Voteable + 'static> Vote<TYPES> for SimpleVote<TYPES, DATA>

type Commitment = DATA

Type of data commitment this vote uses.

fn signing_key(&self) -> <TYPES as NodeType>::SignatureKey

Gets the public signature key of the votes creator/sender

fn signature( &self ) -> <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType

Get the signature of the vote sender

fn date(&self) -> &DATA

Gets the data which was voted on by this vote

fn date_commitment(&self) -> Commitment<DATA>

Gets the Data commitment of the vote

impl<TYPES: Eq + NodeType, DATA: Eq + Voteable> Eq for SimpleVote<TYPES, DATA>

where TYPES::SignatureKey: Eq, TYPES::Time: Eq,

impl<TYPES: NodeType, DATA: Voteable> StructuralPartialEq for SimpleVote<TYPES, DATA>