55 releases (major breaking)
new 39.0.0 | Jan 13, 2025 |
---|---|
38.0.0 | Sep 26, 2024 |
37.0.0 | Jul 18, 2024 |
36.0.0 | Jul 12, 2024 |
2.0.0-alpha.5 | Mar 24, 2020 |
#20 in Magic Beans
66,230 downloads per month
Used in 87 crates
(7 directly)
2.5MB
41K
SLoC
Vesting Module
Overview
A simple module providing a means of placing a linear curve on an account's locked balance. This
module ensures that there is a lock in place preventing the balance to drop below the unvested
amount for reason other than the ones specified in UnvestedFundsAllowedWithdrawReasons
configuration value.
As the amount vested increases over time, the amount unvested reduces. However, locks remain in
place and explicit action is needed on behalf of the user to ensure that the amount locked is
equivalent to the amount remaining to be vested. This is done through a dispatchable function,
either vest
(in typical case where the sender is calling on their own behalf) or vest_other
in case the sender is calling on another account's behalf.
Interface
This module implements the VestingSchedule
trait.
Dispatchable Functions
vest
- Update the lock, reducing it in line with the amount "vested" so far.vest_other
- Update the lock of another account, reducing it in line with the amount "vested" so far.
License: Apache-2.0
Release
Polkadot SDK Stable 2412
Dependencies
~18–33MB
~542K SLoC