Struct pallet_vesting::pallet::Pallet

pub struct Pallet<T>(_);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

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.

Complexity

• O(1).

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.

Complexity

• O(1).

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, BlockNumberFor<T>> ) -> 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.

Complexity

• O(1).

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, BlockNumberFor<T>> ) -> 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.

Complexity

• O(1).

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, BlockNumberFor<T>>, MaxVestingSchedulesGet<T>>>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for Vesting.

Trait Implementations

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

type RuntimeCall = 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>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn integrity_test()

Check the integrity of this pallet’s configuration.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before Hooks::on_finalize).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

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

fn integrity_test()

See Hooks::integrity_test.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See Hooks::on_idle.

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See Hooks::on_initialize.

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

fn on_runtime_upgrade() -> Weight

See Hooks::on_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: BlockNumberFor<T> ) -> 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>::Block as HeaderProvider>::HeaderT as Header>::Number

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: BlockNumberFor<T> ) -> DispatchResult

Checks if add_vesting_schedule would work against who.

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

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>