Struct Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn stake( origin: OriginFor<T>, target: MessageSourceId, amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

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

pub fn withdraw_unstaked(origin: OriginFor<T>) -> DispatchResult

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.

pub fn unstake( origin: OriginFor<T>, target: MessageSourceId, requested_amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

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

pub fn set_epoch_length( origin: OriginFor<T>, length: BlockNumberFor<T>, ) -> DispatchResult

Sets the epoch period length (in blocks).

Requires

• Root Origin

Errors

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

pub fn change_staking_target( origin: OriginFor<T>, from: MessageSourceId, to: MessageSourceId, amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

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.

pub fn provider_boost( origin: OriginFor<T>, target: MessageSourceId, amount: <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

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

pub fn claim_staking_rewards(origin: OriginFor<T>) -> DispatchResult

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.

impl<T: Config> Pallet<T>

pub fn set_capacity_for( target: MessageSourceId, capacity_details: CapacityDetails<<<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, T::EpochNumber>, )

Sets targets Capacity.

pub fn list_unclaimed_rewards( account: &T::AccountId, ) -> Result<BoundedVec<UnclaimedRewardInfo<<<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance, BlockNumberFor<T>>, T::ProviderBoostHistoryLimit>, DispatchError>

Get all unclaimed rewards information for each eligible Reward Era. If no unclaimed rewards, returns empty list.

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<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> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> DispatchViewFunction for Pallet<T>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

impl<T: Config> GetStorageVersion for Pallet<T>

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(current: BlockNumberFor<T>) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> Nontransferable for Pallet<T>

Nontransferable functions are intended for capacity spend and recharge. Implementations of Nontransferable MUST NOT be concerned with StakingType.

fn balance(msa_id: MessageSourceId) -> Self::Balance

Return the remaining capacity for the Provider MSA Id

fn deduct( msa_id: MessageSourceId, amount: Self::Balance, ) -> Result<(), DispatchError>

Spend capacity: reduce remaining capacity by the given amount

fn deposit( msa_id: MessageSourceId, token_amount: Self::Balance, capacity_amount: Self::Balance, ) -> Result<(), DispatchError>

Increase all totals for the MSA’s CapacityDetails.

type Balance = <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

Scalar type for representing balance of an account.

fn replenishable_balance(msa_id: MessageSourceId) -> Self::Balance

The replenishable Capacity for an MSA (the total capacity currently issued)

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<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: Config> ProviderBoostRewardsProvider<T> for Pallet<T>

fn era_staking_reward( era_amount_staked: Self::Balance, era_total_staked: Self::Balance, era_reward_pool_size: Self::Balance, ) -> Self::Balance

Calculate the reward for a single era. We don’t care about the era number, just the values.

fn capacity_boost(amount: Self::Balance) -> Self::Balance

How much, as a percentage of staked token, to boost a targeted Provider when staking.

type Balance = <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

The type for currency

fn reward_pool_size(_total_staked: Self::Balance) -> Self::Balance

Return the size of the reward pool using the current economic model

impl<T: Config> Replenishable for Pallet<T>

fn replenish_by_amount( msa_id: MessageSourceId, amount: Self::Balance, ) -> Result<(), DispatchError>

Change: now calls new fn replenish_by_amount on the capacity_details, which does what this (actually Self::deposit) used to do Currently unused.

type Balance = <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

Scalar type for representing balance of an account.

fn replenish_all_for(msa_id: MessageSourceId) -> Result<(), DispatchError>

Replenish all Capacity balance for an MSA.

fn can_replenish(msa_id: MessageSourceId) -> bool

Checks if an account can be replenished.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> ViewFunctionIdPrefix for Pallet<T>

fn prefix() -> [u8; 16]

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>