Struct Penalty

pub struct Penalty(/* private fields */);

Tracks slashing penalties applied to a validator in some epoch.

You do not need to know how the penalty is represented.

If you insist on knowing, it’s represented as a U128x128 between 0 and 1, which denotes the amount kept after applying a penalty. e.g. a 1% penalty would be 0.99.

Implementations

impl Penalty

pub fn from_percent(percent: u64) -> Self

Create a Penalty from a percentage e.g. Penalty::from_percent(1) is a 1% penalty. Penalty::from_percent(100) is a 100% penalty.

pub fn from_bps(bps: u64) -> Self

Create a Penalty from a basis point e.g. Penalty::from_bps(1) is a 1 bps penalty. Penalty::from_bps(100) is a 100 bps penalty.

pub fn from_bps_squared(bps_squared: u64) -> Self

Create a Penalty from a basis point squared e.g. Penalty::from_bps(1_0000_0000) is a 100% penalty.

pub fn kept_rate(&self) -> U128x128

A rate representing how much of an asset remains after applying a penalty.

e.g. a 1% penalty will yield a rate of 0.99 here.

pub fn compound(&self, other: Penalty) -> Penalty

Compound this Penalty with another Penalty.

pub fn apply_to_amount(&self, amount: Amount) -> Amount

Apply this Penalty to an Amount of unbonding tokens.

pub fn apply_to(&self, amount: impl Into<U128x128>) -> U128x128

Apply this Penalty to some fraction.

pub fn balance_for_claim( &self, unbonding_id: Id, unbonding_amount: Amount, ) -> Balance

Helper method to compute the effect of an UndelegateClaim on the transaction’s value balance, used in planning and (transparent) proof verification.

This method takes the unbonding_id rather than the UnbondingToken so that it can be used in mock proof verification, where computation of the unbonding token’s asset ID happens outside of the circuit.

Trait Implementations

impl Clone for Penalty

fn clone(&self) -> Penalty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Penalty

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Penalty

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for Penalty

type Proto = Penalty

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<Penalty> for [u8; 32]

fn from(value: Penalty) -> Self

Converts to this type from the input type.

impl From<Penalty> for Penalty

fn from(v: Penalty) -> Self

Converts to this type from the input type.

impl Ord for Penalty

fn cmp(&self, other: &Penalty) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Penalty

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

fn partial_cmp(&self, other: &Penalty) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Penalty

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToConstraintField<Fq> for Penalty

fn to_field_elements(&self) -> Option<Vec<Fq>>

impl<'a> TryFrom<&'a [u8]> for Penalty

type Error = <U128x128 as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Penalty> for Penalty

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Penalty

impl Eq for Penalty

impl StructuralPartialEq for Penalty