Struct pallet_capacity::types::CapacityDetails

pub struct CapacityDetails<Balance, EpochNumber> {
    pub remaining_capacity: Balance,
    pub total_tokens_staked: Balance,
    pub total_capacity_issued: Balance,
    pub last_replenished_epoch: EpochNumber,
}

The type for storing Registered Provider Capacity balance:

Fields

remaining_capacity: Balance

The Capacity remaining for the last_replenished_epoch.

total_tokens_staked: Balance

The amount of tokens staked to an MSA.

total_capacity_issued: Balance

The total Capacity issued to an MSA.

last_replenished_epoch: EpochNumber

The last Epoch that an MSA was replenished with Capacity.

Implementations

impl<Balance, EpochNumber> CapacityDetails<Balance, EpochNumber>

where Balance: Saturating + Copy + CheckedAdd + CheckedSub, EpochNumber: Clone + PartialOrd + PartialEq,

pub fn deposit(&mut self, amount: &Balance, capacity: &Balance) -> Option<()>

Increase a targets total Tokens staked and Capacity total issuance by an amount. To be called on a stake

pub fn can_replenish(&self, current_epoch: EpochNumber) -> bool

Return whether capacity can be replenished, given the current epoch.

pub fn replenish_all(&mut self, current_epoch: &EpochNumber)

Completely refill all available capacity. To be called lazily when a Capacity message is sent in a new epoch.

pub fn replenish_by_amount( &mut self, amount: Balance, current_epoch: &EpochNumber )

Replenish remaining capacity by the provided amount and touch last_replenished_epoch with the current epoch.

pub fn deduct_capacity_by_amount( &mut self, amount: Balance ) -> Result<(), ArithmeticError>

Deduct the given amount from the remaining capacity that can be used to pay for messages. To be called when a message is paid for with capacity.

pub fn withdraw( &mut self, capacity_deduction: Balance, tokens_staked_deduction: Balance )

Decrease a target’s total available capacity. To be called on an unstake.

Trait Implementations

impl<Balance: Clone, EpochNumber: Clone> Clone for CapacityDetails<Balance, EpochNumber>

fn clone(&self) -> CapacityDetails<Balance, EpochNumber>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Balance, EpochNumber> Debug for CapacityDetails<Balance, EpochNumber>

where Balance: Debug, EpochNumber: Debug,

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

Formats the value using the given formatter.

impl<Balance, EpochNumber> Decode for CapacityDetails<Balance, EpochNumber>

where Balance: Decode, EpochNumber: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<Balance: Default, EpochNumber: Default> Default for CapacityDetails<Balance, EpochNumber>

fn default() -> CapacityDetails<Balance, EpochNumber>

Returns the “default value” for a type.

impl<Balance, EpochNumber> Encode for CapacityDetails<Balance, EpochNumber>

where Balance: Encode, EpochNumber: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<Balance, EpochNumber> MaxEncodedLen for CapacityDetails<Balance, EpochNumber>

where Balance: MaxEncodedLen, EpochNumber: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<Balance: PartialEq, EpochNumber: PartialEq> PartialEq for CapacityDetails<Balance, EpochNumber>

fn eq(&self, other: &CapacityDetails<Balance, EpochNumber>) -> 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<Balance, EpochNumber> TypeInfo for CapacityDetails<Balance, EpochNumber>

where Balance: TypeInfo + 'static, EpochNumber: TypeInfo + 'static,

type Identity = CapacityDetails<Balance, EpochNumber>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Balance, EpochNumber> EncodeLike for CapacityDetails<Balance, EpochNumber>

where Balance: Encode, EpochNumber: Encode,

impl<Balance: Eq, EpochNumber: Eq> Eq for CapacityDetails<Balance, EpochNumber>

impl<Balance, EpochNumber> StructuralEq for CapacityDetails<Balance, EpochNumber>

impl<Balance, EpochNumber> StructuralPartialEq for CapacityDetails<Balance, EpochNumber>