Enum Call

pub enum Call<T: Config> {
    stake {
        target: MessageSourceId,
        amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance,
    },
    withdraw_unstaked {},
    unstake {
        target: MessageSourceId,
        requested_amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance,
    },
    set_epoch_length {
        length: BlockNumberFor<T>,
    },
    change_staking_target {
        from: MessageSourceId,
        to: MessageSourceId,
        amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance,
    },
    provider_boost {
        target: MessageSourceId,
        amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance,
    },
    claim_staking_rewards {},
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

stake

Stakes some amount of tokens to the network and generates Capacity.

Errors

• Returns Error::InvalidTarget if attempting to stake to an invalid target.
• Returns Error::StakingAmountBelowMinimum if attempting to stake an amount below the minimum amount.
• Returns Error::CannotChangeStakingType if the staking account is a ProviderBoost account

Fields

target: MessageSourceId

amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance

withdraw_unstaked

Removes all thawed UnlockChunks from caller’s UnstakeUnlocks and thaws(unfreezes) the sum of the thawed values in the caller’s token account.

Errors

• Returns Error::NoUnstakedTokensAvailable if the account has no unstaking chunks.
• Returns Error::NoThawedTokenAvailable if there are unstaking chunks, but none are thawed.

unstake

Schedules an amount of the stake to be unlocked.

Errors

• Returns Error::UnstakedAmountIsZero if amount is not greater than zero.
• Returns Error::MaxUnlockingChunksExceeded if attempting to unlock more times than config::MaxUnlockingChunks.
• Returns Error::AmountToUnstakeExceedsAmountStaked if amount exceeds the amount currently staked.
• Returns Error::InvalidTarget if target is not a valid staking target (not a Provider)
• Returns Error::NotAStakingAccount if origin has nothing staked at all
• Returns Error::StakerTargetRelationshipNotFound if origin has nothing staked to target

Fields

target: MessageSourceId

requested_amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance

set_epoch_length

Sets the epoch period length (in blocks).

Requires

• Root Origin

Errors

• Returns Error::MaxEpochLengthExceeded if length is greater than T::MaxEpochLength.

Fields

length: BlockNumberFor<T>

change_staking_target

Sets the target of the staking capacity to a new target. This adds a chunk to StakingDetails.stake_change_unlocking chunks, up to T::MaxUnlockingChunks. The staked amount and Capacity generated by amount originally targeted to the from MSA Id is reassigned to the to MSA Id. Does not affect unstaking process or additional stake amounts. Changing a staking target to a Provider when Origin has nothing staked them will retain the staking type. Changing a staking target to a Provider when Origin has any amount staked to them will error if the staking types are not the same.

Errors

• Error::MaxUnlockingChunksExceeded if stake_change_unlocking_chunks == T::MaxUnlockingChunks
• Error::StakerTargetRelationshipNotFound if from is not a target for Origin’s staking account.
• Error::StakingAmountBelowMinimum if amount to retarget is below the minimum staking amount.
• Error::InsufficientStakingBalance if amount to retarget exceeds what the staker has targeted to from MSA Id.
• Error::InvalidTarget if to does not belong to a registered Provider.
• Error::MaxRetargetsExceeded if origin has reached the maximimum number of retargets for the current RewardEra.

Fields

from: MessageSourceId

to: MessageSourceId

amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance

provider_boost

Stakes some amount of tokens to the network and generates a comparatively small amount of Capacity for the target, and gives periodic rewards to origin.

Errors

• Error::InvalidTarget if attempting to stake to an invalid target.
• Error::StakingAmountBelowMinimum if attempting to stake an amount below the minimum amount.
• Error::CannotChangeStakingType if the staking account exists and staking_type is MaximumCapacity

Fields

target: MessageSourceId

amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance

claim_staking_rewards

Claim all outstanding Provider Boost rewards, up to ProviderBoostHistoryLimit Reward Eras in the past. Accounts should check for unclaimed rewards before calling this extrinsic to avoid needless transaction fees.

Errors:

• NotAProviderBoostAccount: if Origin has nothing staked for ProviderBoost
• NoRewardsEligibleToClaim: if Origin has no unclaimed rewards to pay out.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_stake( target: MessageSourceId, amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant stake.

pub fn new_call_variant_withdraw_unstaked() -> Self

Create a call with the variant withdraw_unstaked.

pub fn new_call_variant_unstake( target: MessageSourceId, requested_amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant unstake.

pub fn new_call_variant_set_epoch_length(length: BlockNumberFor<T>) -> Self

Create a call with the variant set_epoch_length.

pub fn new_call_variant_change_staking_target( from: MessageSourceId, to: MessageSourceId, amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant change_staking_target.

pub fn new_call_variant_provider_boost( target: MessageSourceId, amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant provider_boost.

pub fn new_call_variant_claim_staking_rewards() -> Self

Create a call with the variant claim_staking_rewards.

Trait Implementations

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

fn authorize( &self, source: TransactionSource, ) -> Option<Result<(ValidTransaction, Weight), TransactionValidityError>>

The authorize function.

fn weight_of_authorize(&self) -> Weight

The weight of the authorization function.

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