Enum near_primitives::types::validator_stake::ValidatorStake

pub enum ValidatorStake {
    V1(ValidatorStakeV1),
}

Stores validator and its stake.

Variants

V1(ValidatorStakeV1)

Implementations

impl ValidatorStake

pub fn new_v1( account_id: AccountId, public_key: PublicKey, stake: Balance ) -> Self

pub fn new(account_id: AccountId, public_key: PublicKey, stake: Balance) -> Self

pub fn into_v1(self) -> ValidatorStakeV1

pub fn account_and_stake(self) -> (AccountId, Balance)

pub fn destructure(self) -> (AccountId, PublicKey, Balance)

pub fn take_account_id(self) -> AccountId

pub fn account_id(&self) -> &AccountId

pub fn take_public_key(self) -> PublicKey

pub fn public_key(&self) -> &PublicKey

pub fn stake(&self) -> Balance

pub fn stake_mut(&mut self) -> &mut Balance

pub fn get_approval_stake(&self, is_next_epoch: bool) -> ApprovalStake

pub fn num_mandates(&self, stake_per_mandate: Balance) -> u16

Returns the validator’s number of mandates (rounded down) at stake_per_seat.

It returns u16 since it allows infallible conversion to usize and with u16::MAX equalling 65_535 it should be sufficient to hold the number of mandates per validator.

Why u16 should be sufficient

As of October 2023, a recommended lower bound for the stake required per mandate is 25k $NEAR. At this price, the validator with highest stake would have 1_888 mandates, which is well below u16::MAX.

From another point of view, with more than u16::MAX mandates for validators, sampling mandates might become computationally too expensive. This might trigger an increase in the required stake per mandate, bringing down the number of mandates per validator.

Panics

Panics if the number of mandates overflows u16.

pub fn partial_mandate_weight(&self, stake_per_mandate: Balance) -> Balance

Returns the weight attributed to the validator’s partial mandate.

A validator has a partial mandate if its stake cannot be divided evenly by stake_per_mandate. The remainder of that division is the weight of the partial mandate.

Due to this definintion a validator has exactly one partial mandate with 0 <= weight < stake_per_mandate.

Example

Let V be a validator with stake of 12. If stake_per_mandate equals 5 then the weight of V’s partial mandate is 12 % 5 = 2.

Trait Implementations

impl BorshDeserialize for ValidatorStake

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

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

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for ValidatorStake

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for ValidatorStake

fn clone(&self) -> ValidatorStake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatorStake

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

Formats the value using the given formatter.

impl EnumExt for ValidatorStake

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8 ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl From<ValidatorStake> for ValidatorStakeView

fn from(stake: ValidatorStake) -> Self

Converts to this type from the input type.

impl From<ValidatorStakeView> for ValidatorStake

fn from(view: ValidatorStakeView) -> Self

Converts to this type from the input type.

impl PartialEq for ValidatorStake

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ValidatorStake

impl StructuralPartialEq for ValidatorStake