[][src]Crate orml_vesting

Vesting Module

Overview

Vesting module provides a means of scheduled balance lock on an account. It uses the graded vesting way, which unlocks a specific amount of balance every period of time, until all balance unlocked.

Vesting Schedule

The schedule of a vesting is described by data structure VestingSchedule: from the block number of start, for every period amount of blocks, per_period amount of balance would unlocked, until number of periods period_count reached. Note in vesting schedules, time is measured by block number. All VestingSchedules under an account could be queried in chain state.

Interface

Dispatchable Functions

  • add_vesting_schedule - Add a new vesting schedule for an account.
  • claim - Claim unlocked balances.
  • update_vesting_schedules - Update all vesting schedules under an account, root origin required.

Structs

GenesisConfig

Genesis config for the module, allow to build genesis storage.

Module
VestingSchedule

The vesting schedule.

VestingSchedules

Vesting schedules of an account.

Enums

Call

Dispatchable calls.

Error

Error for vesting module.

RawEvent

Events for this module.

Traits

Trait

Type Definitions

BalanceOf
Event

RawEvent specialized for the configuration Trait

ScheduledItem
VestingScheduleOf