Struct Vote

pub struct Vote {
    pub vote_type: Type,
    pub height: Height,
    pub round: Round,
    pub block_id: Option<Id>,
    pub timestamp: Option<Time>,
    pub validator_address: Id,
    pub validator_index: ValidatorIndex,
    pub signature: Option<Signature>,
    pub extension: Vec<u8>,
    pub extension_signature: Option<Signature>,
}

Votes are signed messages from validators for a particular block which include information about the validator signing it.

https://github.com/tendermint/spec/blob/d46cd7f573a2c6a2399fcab2cde981330aa63f37/spec/core/data_structures.md#vote

Fields

vote_type: Type

Type of vote (prevote or precommit)

height: Height

Block height

round: Round

Round

block_id: Option<Id>

Block ID

timestamp: Option<Time>

Timestamp

validator_address: Id

Validator address

validator_index: ValidatorIndex

Validator index

signature: Option<Signature>

Signature

extension: Vec<u8>

Vote extension provided by the application. Only valid for precommit messages.

This field has been added in CometBFT 0.38 and will be ignored when encoding into earlier protocol versions.

extension_signature: Option<Signature>

Vote extension signature by the validator Only valid for precommit messages.

This field has been added in CometBFT 0.38 and will be ignored when encoding into earlier protocol versions.

Implementations

impl Vote

pub fn is_prevote(&self) -> bool

Is this vote a prevote?

pub fn is_precommit(&self) -> bool

Is this vote a precommit?

pub fn header_hash(&self) -> Option<Hash>

Returns block_id.hash

pub fn to_signable_bytes<B>( &self, chain_id: ChainId, sign_bytes: &mut B, ) -> Result<bool, ProtobufError>

where B: BufMut,

Create signable bytes from Vote.

pub fn into_signable_vec(self, chain_id: ChainId) -> Vec<u8>

Create signable vector from Vote.

pub fn consensus_state(&self) -> State

👎Deprecated since 0.17.0: This seems unnecessary, please raise it to the team, if you need it.

Consensus state from this vote - This doesn’t seem to be used anywhere.

Trait Implementations

impl Clone for Vote

fn clone(&self) -> Vote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vote

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Vote

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Vote> for Vote

fn from(value: Vote) -> Self

Converts to this type from the input type.

impl From<Vote> for Vote

fn from(value: Vote) -> Self

Converts to this type from the input type.

impl From<Vote> for Vote

fn from(value: Vote) -> Self

Converts to this type from the input type.

impl PartialEq for Vote

fn eq(&self, other: &Vote) -> 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 Protobuf<Vote> for Vote

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

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

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

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

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Protobuf<Vote> for Vote

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

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

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

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

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Protobuf<Vote> for Vote

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

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

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

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

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for Vote

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vote> for Vote

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RawVote) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vote> for Vote

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RawVote) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vote> for Vote

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RawVote) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Vote

impl StructuralPartialEq for Vote