Struct pallet_vesting::Module

pub struct Module<T: Config>(_);

Vesting module declaration.

Implementations

impl<T: Config + 'static> Module<T>

pub fn vesting<K: EncodeLike<T::AccountId>>(
    key: K
) -> Option<VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>>

Information regarding the vesting of a given account.

impl<T: Config> Module<T>

Can also be called using Call.

pub fn vested_transfer(
    origin: T::Origin,
    target: <T::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 that should be transferred the vested funds.
• amount: The amount of funds to transfer and will be vested.
• schedule: The vesting schedule attached to the transfer.

Emits VestingCreated.

• 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]

NOTE: Calling this function will bypass origin filters.

pub fn force_vested_transfer(
    origin: T::Origin,
    source: <T::Lookup as StaticLookup>::Source,
    target: <T::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.
• amount: The amount of funds to transfer and will be vested.
• schedule: The vesting schedule attached to the transfer.

Emits VestingCreated.

• 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

NOTE: Calling this function will bypass origin filters.

Trait Implementations

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

type Call = Call<T>

impl<T: Clone + Config> Clone for Module<T>

fn clone(&self) -> Module<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Config> Copy for Module<T>

impl<T: Config> Debug for Module<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: Eq + Config> Eq for Module<T>

impl<T: Config> GetPalletVersion for Module<T>

fn current_version() -> PalletVersion

Returns the current version of the pallet.

fn storage_version() -> Option<PalletVersion>

Returns the version of the pallet that is stored in storage.

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

pub fn integrity_test()

Run integrity test.

impl<T: Config> ModuleErrorMetadata for Module<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config + Config> OffchainWorker<<T as Config>::BlockNumber> for Module<T>

pub fn offchain_worker(_n: BlockNumber)

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

impl<T: Config + Config> OnFinalize<<T as Config>::BlockNumber> for Module<T>

pub fn on_finalize(_n: BlockNumber)

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config + Config> OnInitialize<<T as Config>::BlockNumber> for Module<T>

pub fn on_initialize(_n: BlockNumber) -> u64

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

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: PartialEq + Config> PartialEq<Module<T>> for Module<T>

fn eq(&self, other: &Module<T>) -> bool

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

fn ne(&self, other: &Module<T>) -> bool

This method tests for !=.

impl<T: Config> StructuralEq for Module<T>

impl<T: Config> StructuralPartialEq for Module<T>

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

type Moment = T::BlockNumber

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

type Currency = T::Currency

The currency that this schedule applies to.

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 there already exists a vesting schedule for the given account, an Err 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.

fn remove_vesting_schedule(who: &T::AccountId)

Remove a vesting schedule for a given account.