Enum pallet_vesting::pallet::Call

pub enum Call<T: Config> {
    vest {},
    vest_other {
        target: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    vested_transfer {
        target: <<T as Config>::Lookup as StaticLookup>::Source,
        schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>,
    },
    force_vested_transfer {
        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>,
    },
    merge_schedules {
        schedule1_index: u32,
        schedule2_index: u32,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

vest

Fields

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]

vest_other

Fields

target: <<T as Config>::Lookup as StaticLookup>::Source

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

vested_transfer

Fields

target: <<T as Config>::Lookup as StaticLookup>::Source

schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>

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]

force_vested_transfer

Fields

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>

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

merge_schedules

Fields

schedule1_index: u32

schedule2_index: u32

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.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_vest() -> Self

Create a call with the variant vest.

pub fn new_call_variant_vest_other(
    target: <<T as Config>::Lookup as StaticLookup>::Source
) -> Self

Create a call with the variant vest_other.

pub fn new_call_variant_vested_transfer(
    target: <<T as Config>::Lookup as StaticLookup>::Source,
    schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>
) -> Self

Create a call with the variant vested_transfer.

pub fn new_call_variant_force_vested_transfer(
    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>
) -> Self

Create a call with the variant force_vested_transfer.

pub fn new_call_variant_merge_schedules(
    schedule1_index: u32,
    schedule2_index: u32
) -> Self

Create a call with the variant merge_schedules.

Trait Implementations

impl<T: Config> Clone for Call<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: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

👎Deprecated: Trait has moved to frame_support::dispatch

impl<T: Config> PartialEq<Call<T>> for Call<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> TypeInfo for Call<T>where
    PhantomData<(T,)>: TypeInfo + 'static,
    <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>: TypeInfo + 'static,
    T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter(
    self,
    origin: Self::RuntimeOrigin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>