Struct Uptime

pub struct Uptime { /* private fields */ }

Records information on a validator’s uptime.

This structure provides two operations:

• recording that a validator did or did not sign a particular block;
• reporting how many of the last N blocks a validator has missed signing.

Internally, the Uptime uses a bit vector as a ring buffer, with a 1 bit recording that the validator signed the block, and 0 recording that it didn’t. For a new validator, the Uptime::new method initializes the bit vector with all 1s as a grace period to ensure that we don’t need to special-case genesis states, new validators, etc.

Implementations

impl Uptime

pub fn new(initial_block_height: u64, signed_blocks_window_len: usize) -> Self

Initialize an uptime tracker for a new validator.

This method should not be used for existing validators. Instead, deserialize the tracker (that should have been) created when the validator was created.

pub fn mark_height_as_signed(&mut self, height: u64, signed: bool) -> Result<()>

Mark that the validator signed the block at the given height (true), or did not sign (false).

This method errors only if the provided height isn’t one greater than the current block height. This should not happen in normal use (i.e., it’s probably reasonable to expect on the error), but the method takes an explicit height and checks it to flag misuse and detect bugs.

pub fn num_missed_blocks(&self) -> usize

Counts the number of missed blocks over the window.

pub fn missed_blocks( &self, ) -> impl Iterator<Item = u64> + DoubleEndedIterator + '_

Enumerates the missed blocks over the window in terms of absolute block height.

pub fn as_of_height(&self) -> u64

Returns the block height up to which this tracker has recorded.

pub fn missed_blocks_window(&self) -> usize

Returns the size of the window of blocks being recorded.

Trait Implementations

impl Clone for Uptime

fn clone(&self) -> Uptime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Uptime

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Uptime

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for Uptime

type Proto = Uptime

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

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

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl From<Uptime> for Uptime

fn from(val: Uptime) -> Uptime

Converts to this type from the input type.

impl PartialEq for Uptime

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Uptime> for Uptime

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: Uptime) -> Result<Uptime, Self::Error>

Performs the conversion.

impl Eq for Uptime

impl StructuralPartialEq for Uptime