Struct orml_vesting::VestingSchedule

pub struct VestingSchedule<BlockNumber, Balance: HasCompact> {
    pub start: BlockNumber,
    pub period: BlockNumber,
    pub period_count: u32,
    pub per_period: Balance,
}

The vesting schedule.

Benefits would be granted gradually, per_period amount every period of blocks after start.

Fields

start: BlockNumber

Vesting starting block

period: BlockNumber

Number of blocks between vest

period_count: u32

Number of vest

per_period: Balance

Amount of tokens to release per vest

Implementations

impl<BlockNumber: AtLeast32Bit + Copy, Balance: AtLeast32Bit + Copy> VestingSchedule<BlockNumber, Balance>

pub fn end(&self) -> Option<BlockNumber>

Returns the end of all periods, None if calculation overflows.

pub fn total_amount(&self) -> Option<Balance>

Returns all locked amount, None if calculation overflows.

pub fn locked_amount(&self, time: BlockNumber) -> Balance

Returns locked amount for a given time.

Note this func assumes schedule is a valid one(non-zero period and non-overflow total amount), and it should be guaranteed by callers.

Trait Implementations

impl<BlockNumber: Clone, Balance: Clone + HasCompact> Clone for VestingSchedule<BlockNumber, Balance>

fn clone(&self) -> VestingSchedule<BlockNumber, Balance>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BlockNumber, Balance: HasCompact> Debug for VestingSchedule<BlockNumber, Balance> where
    BlockNumber: Debug,
    Balance: Debug, 

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

Formats the value using the given formatter.

impl<BlockNumber, Balance: HasCompact> Decode for VestingSchedule<BlockNumber, Balance> where
    BlockNumber: Decode,
    BlockNumber: Decode,
    BlockNumber: Decode,
    BlockNumber: Decode,
    Balance: HasCompact, 

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<BlockNumber, Balance: HasCompact> Encode for VestingSchedule<BlockNumber, Balance> where
    BlockNumber: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    Balance: HasCompact, 

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

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

pub fn size_hint(&self) -> usize

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

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub 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.

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<BlockNumber, Balance: HasCompact> EncodeLike<VestingSchedule<BlockNumber, Balance>> for VestingSchedule<BlockNumber, Balance> where
    BlockNumber: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    Balance: HasCompact, 

impl<BlockNumber: Eq, Balance: Eq + HasCompact> Eq for VestingSchedule<BlockNumber, Balance>

impl<BlockNumber: PartialEq, Balance: PartialEq + HasCompact> PartialEq<VestingSchedule<BlockNumber, Balance>> for VestingSchedule<BlockNumber, Balance>

fn eq(&self, other: &VestingSchedule<BlockNumber, Balance>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VestingSchedule<BlockNumber, Balance>) -> bool

This method tests for !=.

impl<BlockNumber, Balance: HasCompact> StructuralEq for VestingSchedule<BlockNumber, Balance>

impl<BlockNumber, Balance: HasCompact> StructuralPartialEq for VestingSchedule<BlockNumber, Balance>