Trait sp_staking::offence::Offence

source · 
pub trait Offence<Offender> {
    type TimeSlot: Clone + Codec + Ord;

    const ID: Kind;

    // Required methods
    fn offenders(&self) -> Vec<Offender> ⓘ;
    fn session_index(&self) -> SessionIndex;
    fn validator_set_count(&self) -> u32;
    fn time_slot(&self) -> Self::TimeSlot;
    fn slash_fraction(&self, offenders_count: u32) -> Perbill;

    // Provided method
    fn disable_strategy(&self) -> DisableStrategy { ... }
}
Expand description

A trait implemented by an offence report.

This trait assumes that the offence is legitimate and was validated already.

Examples of offences include: a BABE equivocation or a GRANDPA unjustified vote.

Required Associated Types§

source

type TimeSlot: Clone + Codec + Ord

A type that represents a point in time on an abstract timescale.

See Offence::time_slot for details. The only requirement is that such timescale could be represented by a single u128 value.

Required Associated Constants§

source

const ID: Kind

Identifier which is unique for this kind of an offence.

Required Methods§

source

fn offenders(&self) -> Vec<Offender> ⓘ

The list of all offenders involved in this incident.

The list has no duplicates, so it is rather a set.

source

fn session_index(&self) -> SessionIndex

The session index that is used for querying the validator set for the slash_fraction function.

This is used for filtering historical sessions.

source

fn validator_set_count(&self) -> u32

Return a validator set count at the time when the offence took place.

source

fn time_slot(&self) -> Self::TimeSlot

A point in time when this offence happened.

This is used for looking up offences that happened at the “same time”.

The timescale is abstract and doesn’t have to be the same across different implementations of this trait. The value doesn’t represent absolute timescale though since it is interpreted along with the session_index. Two offences are considered to happen at the same time iff both session_index and time_slot are equal.

As an example, for GRANDPA timescale could be a round number and for BABE it could be a slot number. Note that for GRANDPA the round number is reset each epoch.

source

fn slash_fraction(&self, offenders_count: u32) -> Perbill

A slash fraction of the total exposure that should be slashed for this particular offence for the offenders_count that happened at a singular TimeSlot.

offenders_count - the count of unique offending authorities for this TimeSlot. It is >0.

Provided Methods§

source

fn disable_strategy(&self) -> DisableStrategy

In which cases this offence needs to disable offenders until the next era starts.

Implementors§