Enum Call

pub enum Call<T: Config> {
    transfer_bonds_back_to_treasury {
        derivation_path: u32,
        hold_reason: T::RuntimeHoldReason,
    },
    transfer_fees_to_recipient {
        derivation_path: u32,
        hold_reason: T::RuntimeHoldReason,
        fee_asset: AssetId,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

transfer_bonds_back_to_treasury

Transfer bonded tokens back to the treasury if conditions are met.

Description

This extrinsic allows transferring bonded tokens back to the treasury account when either:

• The release block number has been reached for time-locked bonds
• Or immediately if the release type is set to Refunded

The function will release all tokens held under the specified hold reason and transfer them, including the existential deposit, back to the treasury account. If sub-account has all the tokens unbonded, it will transfer everything including ED back to the treasury

Parameters

• origin - The origin of the call. Must be signed. Can be anyone.
• derivation_path - The derivation path used to calculate the bonding sub-account
• hold_reason - The reason for which the tokens were held

Errors

• Error::ReleaseTypeNotSet - If no release type is configured for the given derivation path and hold reason
• Error::TooEarlyToUnlock - If the current block is before the configured release block for locked bonds

Events

• Event::BondsTransferredBackToTreasury - When tokens are successfully transferred back to treasury

Fields

derivation_path: u32

hold_reason: T::RuntimeHoldReason

transfer_fees_to_recipient

Transfer collected fees to the designated fee recipient.

Description

This extrinsic transfers all collected fees in the specified fee asset from the bonding sub-account to the configured fee recipient. This operation is only allowed when the release type is set to Locked, indicating that the bonds are being held legitimately rather than awaiting refund.

Parameters

• origin - The origin of the call. Must be signed. Can be anyone.
• derivation_path - The derivation path used to calculate the bonding sub-account
• hold_reason - The reason for which the tokens were held
• fee_asset - The asset ID of the fee token to transfer

Errors

• Error::ReleaseTypeNotSet - If no release type is configured for the given derivation path and hold reason
• Error::FeeToRecipientDisallowed - If the release type is set to Refunded, which means fees should be refunded instead

Events

• Event::FeesTransferredToFeeRecipient - When fees are successfully transferred to the recipient

Fields

derivation_path: u32

hold_reason: T::RuntimeHoldReason

fee_asset: AssetId

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_transfer_bonds_back_to_treasury( derivation_path: u32, hold_reason: T::RuntimeHoldReason, ) -> Self

Create a call with the variant transfer_bonds_back_to_treasury.

pub fn new_call_variant_transfer_fees_to_recipient( derivation_path: u32, hold_reason: T::RuntimeHoldReason, fee_asset: AssetId, ) -> Self

Create a call with the variant transfer_fees_to_recipient.

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::RuntimeHoldReason: 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 for Call<T>

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