Struct RateData

pub struct RateData {
    pub identity_key: IdentityKey,
    pub validator_reward_rate: Amount,
    pub validator_exchange_rate: Amount,
}

Describes a validator’s reward rate and voting power in some epoch.

Fields

identity_key: IdentityKey

The validator’s identity key.

validator_reward_rate: Amount

The validator-specific reward rate.

validator_exchange_rate: Amount

The validator-specific exchange rate.

Implementations

impl RateData

pub fn next_epoch( &self, next_base_rate: &BaseRateData, funding_streams: &[FundingStream], validator_state: &State, ) -> RateData

Compute the validator rate data for the next epoch.

Panics

This method panics if the validator’s funding streams exceed 100%. The stateless checks in the Definition action handler should prevent this from happening.

pub fn delegation_amount(&self, unbonded_amount: Amount) -> Amount

Computes the amount of delegation tokens corresponding to the given amount of unbonded stake.

Warning

Given a pair (delegation_amount, unbonded_amount) and rate_data, it’s possible to have

delegation_amount == rate_data.delegation_amount(unbonded_amount)

or

unbonded_amount == rate_data.unbonded_amount(delegation_amount)

but in general not both, because the computation involves rounding.

pub fn slash(&self, penalty: Penalty) -> Self

pub fn unbonded_amount(&self, delegation_amount: Amount) -> Amount

Computes the amount of unbonded stake corresponding to the given amount of delegation tokens.

Warning

Given a pair (delegation_amount, unbonded_amount) and rate_data, it’s possible to have

delegation_amount == rate_data.delegation_amount(unbonded_amount)

or

unbonded_amount == rate_data.unbonded_amount(delegation_amount)

but in general not both, because the computation involves rounding.

pub fn voting_power(&self, delegation_pool_size: Amount) -> Amount

Compute the voting power of the validator given the size of its delegation pool.

pub fn build_delegate(&self, epoch: Epoch, unbonded_amount: Amount) -> Delegate

Uses this RateData to build a Delegate transaction action that delegates unbonded_amount of the staking token.

pub fn build_undelegate( &self, start_epoch: Epoch, delegation_amount: Amount, ) -> Undelegate

Uses this RateData to build an Undelegate transaction action that undelegates delegation_amount of the validator’s delegation tokens.

Trait Implementations

impl Clone for RateData

fn clone(&self) -> RateData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for RateData

type Proto = RateData

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<RateData> for CurrentValidatorRateResponse

fn from(r: RateData) -> Self

Converts to this type from the input type.

impl From<RateData> for RateData

fn from(v: RateData) -> Self

Converts to this type from the input type.

impl PartialEq for RateData

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CurrentValidatorRateResponse> for RateData

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RateData> for RateData

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: RateData) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for RateData

impl StructuralPartialEq for RateData