Struct pallet_vesting::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn vest(origin: OriginFor<T>) -> DispatchResult

Unlock any vested funds of the sender account.

The dispatch origin for this call must be Signed and the sender must have funds still locked under this pallet.

Emits either VestingCompleted or VestingUpdated.

• O(1).
• DbWeight: 2 Reads, 2 Writes
  • Reads: Vesting Storage, Balances Locks, [Sender Account]
  • Writes: Vesting Storage, Balances Locks, [Sender Account]

pub fn vest_other(
    origin: OriginFor<T>,
    target: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult

Unlock any vested funds of a target account.

The dispatch origin for this call must be Signed.

• target: The account whose vested funds should be unlocked. Must have funds still locked under this pallet.

Emits either VestingCompleted or VestingUpdated.

• O(1).
• DbWeight: 3 Reads, 3 Writes
  • Reads: Vesting Storage, Balances Locks, Target Account
  • Writes: Vesting Storage, Balances Locks, Target Account

pub fn vested_transfer(
    origin: OriginFor<T>,
    target: <<T as Config>::Lookup as StaticLookup>::Source,
    schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>
) -> DispatchResult

Create a vested transfer.

The dispatch origin for this call must be Signed.

• target: The account receiving the vested funds.
• schedule: The vesting schedule attached to the transfer.

Emits VestingCreated.

NOTE: This will unlock all schedules through the current block.

• O(1).
• DbWeight: 3 Reads, 3 Writes
  • Reads: Vesting Storage, Balances Locks, Target Account, [Sender Account]
  • Writes: Vesting Storage, Balances Locks, Target Account, [Sender Account]

pub fn force_vested_transfer(
    origin: OriginFor<T>,
    source: <<T as Config>::Lookup as StaticLookup>::Source,
    target: <<T as Config>::Lookup as StaticLookup>::Source,
    schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>
) -> DispatchResult

Force a vested transfer.

The dispatch origin for this call must be Root.

• source: The account whose funds should be transferred.
• target: The account that should be transferred the vested funds.
• schedule: The vesting schedule attached to the transfer.

Emits VestingCreated.

NOTE: This will unlock all schedules through the current block.

• O(1).
• DbWeight: 4 Reads, 4 Writes
  • Reads: Vesting Storage, Balances Locks, Target Account, Source Account
  • Writes: Vesting Storage, Balances Locks, Target Account, Source Account

pub fn merge_schedules(
    origin: OriginFor<T>,
    schedule1_index: u32,
    schedule2_index: u32
) -> DispatchResult

Merge two vesting schedules together, creating a new vesting schedule that unlocks over the highest possible start and end blocks. If both schedules have already started the current block will be used as the schedule start; with the caveat that if one schedule is finished by the current block, the other will be treated as the new merged schedule, unmodified.

NOTE: If schedule1_index == schedule2_index this is a no-op. NOTE: This will unlock all schedules through the current block prior to merging. NOTE: If both schedules have ended by the current block, no new schedule will be created and both will be removed.

Merged schedule attributes:

• starting_block: MAX(schedule1.starting_block, scheduled2.starting_block, current_block).
• ending_block: MAX(schedule1.ending_block, schedule2.ending_block).
• locked: schedule1.locked_at(current_block) + schedule2.locked_at(current_block).

The dispatch origin for this call must be Signed.

• schedule1_index: index of the first schedule to merge.
• schedule2_index: index of the second schedule to merge.

impl<T: Config> Pallet<T>

pub fn vesting<KArg>(
    k: KArg
) -> Option<BoundedVec<VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>, MaxVestingSchedulesGet<T>>>where
    KArg: EncodeLike<T::AccountId>,

Information regarding the vesting of a given account.

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn integrity_test()

Run integrity test.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> 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<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> VestingSchedule<<T as Config>::AccountId> for Pallet<T>where
    <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: MaybeSerializeDeserialize + Debug,

fn vesting_balance(
    who: &T::AccountId
) -> Option<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

Get the amount that is currently being vested and cannot be transferred out of this account.

fn add_vesting_schedule(
    who: &T::AccountId,
    locked: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    per_block: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    starting_block: T::BlockNumber
) -> DispatchResult

Adds a vesting schedule to a given account.

If the account has MaxVestingSchedules, an Error is returned and nothing is updated.

On success, a linearly reducing amount of funds will be locked. In order to realise any reduction of the lock over time as it diminishes, the account owner must use vest or vest_other.

Is a no-op if the amount to be vested is zero.

NOTE: This doesn’t alter the free balance of the account.

fn remove_vesting_schedule(
    who: &T::AccountId,
    schedule_index: u32
) -> DispatchResult

Remove a vesting schedule for a given account.

type Currency = <T as Config>::Currency

The currency that this schedule applies to.

type Moment = <T as Config>::BlockNumber

The quantity used to denote time; usually just a BlockNumber.

fn can_add_vesting_schedule(
    who: &T::AccountId,
    locked: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    per_block: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    starting_block: T::BlockNumber
) -> DispatchResult

Checks if add_vesting_schedule would work against who.

impl<T> Eq for Pallet<T>