Enum Call

pub enum Call<T: Config> {
    claim {},
    transfer {
        dest: <T::Lookup as StaticLookup>::Source,
        schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>,
    },
    update_release_schedules {
        who: <T::Lookup as StaticLookup>::Source,
        release_schedules: Vec<ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>>,
    },
    claim_for {
        dest: <T::Lookup as StaticLookup>::Source,
    },
    schedule_named_transfer {
        id: ScheduleName,
        dest: <T::Lookup as StaticLookup>::Source,
        schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>,
        when: BlockNumberFor<T>,
    },
    cancel_scheduled_named_transfer {
        id: ScheduleName,
    },
    execute_scheduled_named_transfer {
        id: ScheduleName,
        dest: <T::Lookup as StaticLookup>::Source,
        schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

claim

Claim thawed balances.

Events

• Event::Claimed

transfer

Add a new release schedule for an account.

Events

• `Event::ReleaseScheduleAdded

Errors

• `Error::InsufficientBalanceToFreeze - Insufficient amount of balance to freeze.
• `Error::MaxReleaseSchedulesExceeded - Failed because the maximum release schedules was exceeded-
• [`ArithmeticError::Overflow] - Failed because of an overflow.

Fields

dest: <T::Lookup as StaticLookup>::Source

schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>

update_release_schedules

Update all release schedules under an account, root origin required.

Events

• `Event::ReleaseSchedulesUpdated - Updated release schedules.

Errors

• `Error::InsufficientBalanceToFreeze - Insufficient amount of balance to freeze.
• `Error::MaxReleaseSchedulesExceeded - Failed because the maximum release schedules was exceeded-
• [`ArithmeticError::Overflow] - Failed because of an overflow.

Fields

who: <T::Lookup as StaticLookup>::Source

release_schedules: Vec<ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>>

claim_for

Claim thawed balances on behalf for an account.

Events

• Event::Claimed

Fields

dest: <T::Lookup as StaticLookup>::Source

schedule_named_transfer

This function schedules a transfer by calling the Scheduler pallet’s schedule function. The transfer will be executed at the specified block number.

• Error::InsufficientBalanceToFreeze - Insufficient amount of balance to freeze.
• Error::MaxReleaseSchedulesExceeded - Failed because the maximum release schedules was exceeded-
• [`ArithmeticError::Overflow] - Failed because of an overflow.

Fields

id: ScheduleName

dest: <T::Lookup as StaticLookup>::Source

schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>

when: BlockNumberFor<T>

cancel_scheduled_named_transfer

Cancels a scheduled transfer by its unique identifier. Releases any funds held for the specified transfer.

Fields

id: ScheduleName

execute_scheduled_named_transfer

Execute a scheduled transfer

This function is called to execute a transfer that was previously scheduled. It ensures that the origin is valid, the destination account exists, and the release schedule is valid. It then finalizes the vesting transfer from the hold balance and emits an event indicating that the release schedule was added.

Arguments

• origin - The origin of the call, which must be the TimeRelease origin.
• dest - The destination account to which the funds will be transferred.
• schedule - The release schedule that specifies the amount and timing of the transfer.

Errors

• [ArithmeticError::Overflow] - If the total amount in the schedule overflows.
• Error::InsufficientBalanceToFreeze - If the hold balance is insufficient.
• Error::ZeroReleasePeriod - If the release period is zero.
• Error::ZeroReleasePeriodCount - If the release period count is zero.
• Error::AmountLow - If the total amount is below the minimum release transfer amount.

Events

• Event::ReleaseScheduleAdded - Indicates that a new release schedule was added.

Fields

id: ScheduleName

dest: <T::Lookup as StaticLookup>::Source

schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_claim() -> Self

Create a call with the variant claim.

pub fn new_call_variant_transfer( dest: <T::Lookup as StaticLookup>::Source, schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>, ) -> Self

Create a call with the variant transfer.

pub fn new_call_variant_update_release_schedules( who: <T::Lookup as StaticLookup>::Source, release_schedules: Vec<ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>>, ) -> Self

Create a call with the variant update_release_schedules.

pub fn new_call_variant_claim_for( dest: <T::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant claim_for.

pub fn new_call_variant_schedule_named_transfer( id: ScheduleName, dest: <T::Lookup as StaticLookup>::Source, schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>, when: BlockNumberFor<T>, ) -> Self

Create a call with the variant schedule_named_transfer.

pub fn new_call_variant_cancel_scheduled_named_transfer( id: ScheduleName, ) -> Self

Create a call with the variant cancel_scheduled_named_transfer.

pub fn new_call_variant_execute_scheduled_named_transfer( id: ScheduleName, dest: <T::Lookup as StaticLookup>::Source, schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>, ) -> Self

Create a call with the variant execute_scheduled_named_transfer.

Trait Implementations

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

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

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 decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where 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> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

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 in the same order as [GetCallIndex].

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> PartialEq for Call<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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::Lookup as StaticLookup>::Source: TypeInfo + 'static, ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>: TypeInfo + 'static, Vec<ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>>: TypeInfo + 'static, BlockNumberFor<T>: 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> DecodeWithMemTracking for Call<T>

where <T::Lookup as StaticLookup>::Source: DecodeWithMemTracking, ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>: DecodeWithMemTracking, Vec<ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>>: DecodeWithMemTracking, BlockNumberFor<T>: DecodeWithMemTracking,

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

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