Type Alias moonbeam_runtime::ParachainStaking

impl<T> Pallet<T>
where T: Config,

pub fn delegation_request_exists( collator: &<T as Config>::AccountId, delegator: &<T as Config>::AccountId ) -> bool

Returns true if a ScheduledRequest exists for a given delegation

pub fn delegation_request_revoke_exists( collator: &<T as Config>::AccountId, delegator: &<T as Config>::AccountId ) -> bool

Returns true if a DelegationAction::Revoke ScheduledRequest exists for a given delegation

impl<T> Pallet<T>
where T: Config,

pub fn set_staking_expectations( origin: <T as Config>::RuntimeOrigin, expectations: Range<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance> ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Set the expectations for total staked. These expectations determine the issuance for the round according to logic in fn compute_issuance

pub fn set_inflation( origin: <T as Config>::RuntimeOrigin, schedule: Range<Perbill> ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Set the annual inflation rate to derive per-round inflation

pub fn set_parachain_bond_account( origin: <T as Config>::RuntimeOrigin, new: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Deprecated: please use set_inflation_distribution_config instead.

Set the account that will hold funds set aside for parachain bond

pub fn set_parachain_bond_reserve_percent( origin: <T as Config>::RuntimeOrigin, new: Percent ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Deprecated: please use set_inflation_distribution_config instead.

Set the percent of inflation set aside for parachain bond

pub fn set_total_selected( origin: <T as Config>::RuntimeOrigin, new: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Set the total number of collator candidates selected per round

changes are not applied until the start of the next round

pub fn set_collator_commission( origin: <T as Config>::RuntimeOrigin, new: Perbill ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Set the commission for all collators

pub fn set_blocks_per_round( origin: <T as Config>::RuntimeOrigin, new: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Set blocks per round

if called with new less than length of current round, will transition immediately in the next block
also updates per-round inflation config

pub fn join_candidates( origin: <T as Config>::RuntimeOrigin, bond: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, candidate_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Join the set of collator candidates

pub fn schedule_leave_candidates( origin: <T as Config>::RuntimeOrigin, candidate_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Request to leave the set of candidates. If successful, the account is immediately removed from the candidate pool to prevent selection as a collator.

pub fn execute_leave_candidates( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId, candidate_delegation_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Execute leave candidates request

pub fn cancel_leave_candidates( origin: <T as Config>::RuntimeOrigin, candidate_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Cancel open request to leave candidates

only callable by collator account
result upon successful call is the candidate is active in the candidate pool

pub fn go_offline( origin: <T as Config>::RuntimeOrigin ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Temporarily leave the set of collator candidates without unbonding

pub fn go_online( origin: <T as Config>::RuntimeOrigin ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Rejoin the set of collator candidates if previously had called go_offline

pub fn candidate_bond_more( origin: <T as Config>::RuntimeOrigin, more: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Increase collator candidate self bond by more

pub fn schedule_candidate_bond_less( origin: <T as Config>::RuntimeOrigin, less: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Request by collator candidate to decrease self bond by less

pub fn execute_candidate_bond_less( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Execute pending request to adjust the collator candidate self bond

pub fn cancel_candidate_bond_less( origin: <T as Config>::RuntimeOrigin ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Cancel pending request to adjust the collator candidate self bond

pub fn delegate_with_auto_compound( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId, amount: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, auto_compound: Percent, candidate_delegation_count: u32, candidate_auto_compounding_delegation_count: u32, delegation_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

If caller is not a delegator and not a collator, then join the set of delegators If caller is a delegator, then makes delegation to change their delegation state Sets the auto-compound config for the delegation

pub fn schedule_revoke_delegation( origin: <T as Config>::RuntimeOrigin, collator: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Request to revoke an existing delegation. If successful, the delegation is scheduled to be allowed to be revoked via the execute_delegation_request extrinsic. The delegation receives no rewards for the rounds while a revoke is pending. A revoke may not be performed if any other scheduled request is pending.

pub fn delegator_bond_more( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId, more: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Bond more for delegators wrt a specific collator candidate.

pub fn schedule_delegator_bond_less( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId, less: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Request bond less for delegators wrt a specific collator candidate. The delegation’s rewards for rounds while the request is pending use the reduced bonded amount. A bond less may not be performed if any other scheduled request is pending.

pub fn execute_delegation_request( origin: <T as Config>::RuntimeOrigin, delegator: <T as Config>::AccountId, candidate: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Execute pending request to change an existing delegation

pub fn cancel_delegation_request( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Cancel request to change an existing delegation.

pub fn set_auto_compound( origin: <T as Config>::RuntimeOrigin, candidate: <T as Config>::AccountId, value: Percent, candidate_auto_compounding_delegation_count_hint: u32, delegation_count_hint: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Sets the auto-compounding reward percentage for a delegation.

pub fn hotfix_remove_delegation_requests_exited_candidates( origin: <T as Config>::RuntimeOrigin, candidates: Vec<<T as Config>::AccountId> ) -> Result<(), DispatchError>

Hotfix to remove existing empty entries for candidates that have left.

pub fn notify_inactive_collator( origin: <T as Config>::RuntimeOrigin, collator: <T as Config>::AccountId ) -> Result<(), DispatchError>

Notify a collator is inactive during MaxOfflineRounds

pub fn enable_marking_offline( origin: <T as Config>::RuntimeOrigin, value: bool ) -> Result<(), DispatchError>

Enable/Disable marking offline feature

pub fn force_join_candidates( origin: <T as Config>::RuntimeOrigin, account: <T as Config>::AccountId, bond: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, candidate_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Force join the set of collator candidates. It will skip the minimum required bond check.

pub fn set_inflation_distribution_config( origin: <T as Config>::RuntimeOrigin, new: InflationDistributionConfig<<T as Config>::AccountId> ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Set the inflation distribution configuration.

pub fn join_candidates_inner( acc: <T as Config>::AccountId, bond: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, candidate_count: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

pub fn go_offline_inner( collator: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

pub fn go_online_inner( collator: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

pub fn candidate_bond_more_inner( collator: <T as Config>::AccountId, more: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

pub fn execute_candidate_bond_less_inner( candidate: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

pub fn execute_leave_candidates_inner( candidate: <T as Config>::AccountId ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

pub fn get_delegator_stakable_balance( acc: &<T as Config>::AccountId ) -> <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

Returns an account’s stakable balance which is not locked in delegation staking

pub fn get_collator_stakable_free_balance( acc: &<T as Config>::AccountId ) -> <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

Returns an account’s free balance which is not locked in collator staking

pub fn delegation_auto_compound( candidate: &<T as Config>::AccountId, delegator: &<T as Config>::AccountId ) -> Percent

Returns a delegations auto-compound value.

pub fn compute_top_candidates() -> Vec<<T as Config>::AccountId>

Compute the top TotalSelected candidates in the CandidatePool and return a vec of their AccountIds (sorted by AccountId).

If the returned vec is empty, the previous candidates should be used.

pub fn delegation_bond_more_without_event( delegator: <T as Config>::AccountId, candidate: <T as Config>::AccountId, more: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Result<(bool, Weight), DispatchErrorWithPostInfo<PostDispatchInfo>>

This function exists as a helper to delegator_bond_more & auto_compound functionality. Any changes to this function must align with both user-initiated bond increases and auto-compounding bond increases. Any feature-specific preconditions should be validated before this function is invoked. Any feature-specific events must be emitted after this function is invoked.

pub fn mint( amt: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, to: <T as Config>::AccountId )

Mint a specified reward amount to the beneficiary account. Emits the [Rewarded] event.

pub fn mint_collator_reward( _paid_for_round: u32, collator_id: <T as Config>::AccountId, amt: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance ) -> Weight

Mint a specified reward amount to the collator’s account. Emits the [Rewarded] event.

pub fn mint_and_compound( amt: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, compound_percent: Percent, candidate: <T as Config>::AccountId, delegator: <T as Config>::AccountId )

Mint and compound delegation rewards. The function mints the amount towards the delegator and tries to compound a specified percent of it back towards the delegation. If a scheduled delegation revoke exists, then the amount is only minted, and nothing is compounded. Emits the [Compounded] event.

pub fn mark_collators_as_inactive(cur: u32) -> Weight

Marks collators as inactive for the previous round if they received zero awarded points.

impl<T> Pallet<T>
where T: Config,

pub fn collator_commission() -> Perbill

An auto-generated getter for CollatorCommission.

impl<T> Pallet<T>
where T: Config,

pub fn total_selected() -> u32

An auto-generated getter for TotalSelected.

impl<T> Pallet<T>
where T: Config,

pub fn inflation_distribution_info( ) -> InflationDistributionConfig<<T as Config>::AccountId>

An auto-generated getter for InflationDistributionInfo.

impl<T> Pallet<T>
where T: Config,

pub fn round( ) -> RoundInfo<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>

An auto-generated getter for Round.

impl<T> Pallet<T>
where T: Config,

pub fn delegator_state<KArg>( k: KArg ) -> Option<Delegator<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for DelegatorState.

impl<T> Pallet<T>
where T: Config,

pub fn candidate_info<KArg>( k: KArg ) -> Option<CandidateMetadata<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for CandidateInfo.

impl<T> Pallet<T>
where T: Config,

pub fn delegation_scheduled_requests<KArg>( k: KArg ) -> BoundedVec<ScheduledRequest<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>, AddGet<<T as Config>::MaxTopDelegationsPerCandidate, <T as Config>::MaxBottomDelegationsPerCandidate>>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for DelegationScheduledRequests.

impl<T> Pallet<T>
where T: Config,

pub fn auto_compounding_delegations<KArg>( k: KArg ) -> BoundedVec<AutoCompoundConfig<<T as Config>::AccountId>, AddGet<<T as Config>::MaxTopDelegationsPerCandidate, <T as Config>::MaxBottomDelegationsPerCandidate>>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for AutoCompoundingDelegations.

impl<T> Pallet<T>
where T: Config,

pub fn top_delegations<KArg>( k: KArg ) -> Option<Delegations<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for TopDelegations.

impl<T> Pallet<T>
where T: Config,

pub fn bottom_delegations<KArg>( k: KArg ) -> Option<Delegations<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for BottomDelegations.

impl<T> Pallet<T>
where T: Config,

pub fn selected_candidates( ) -> BoundedVec<<T as Config>::AccountId, <T as Config>::MaxCandidates>

An auto-generated getter for SelectedCandidates.

impl<T> Pallet<T>
where T: Config,

pub fn total( ) -> <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

An auto-generated getter for Total.

impl<T> Pallet<T>
where T: Config,

pub fn candidate_pool( ) -> BoundedOrderedSet<Bond<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>, <T as Config>::MaxCandidates>

An auto-generated getter for CandidatePool.

impl<T> Pallet<T>
where T: Config,

pub fn at_stake<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<CollatorSnapshot<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>
where KArg1: EncodeLike<u32>, KArg2: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for AtStake.

impl<T> Pallet<T>
where T: Config,

pub fn was_inactive<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<()>
where KArg1: EncodeLike<u32>, KArg2: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for WasInactive.

impl<T> Pallet<T>
where T: Config,

pub fn delayed_payouts<KArg>( k: KArg ) -> Option<DelayedPayout<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>
where KArg: EncodeLike<u32>,

An auto-generated getter for DelayedPayouts.

impl<T> Pallet<T>
where T: Config,

pub fn inflation_config( ) -> InflationInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

An auto-generated getter for InflationConfig.

impl<T> Pallet<T>
where T: Config,

pub fn points<KArg>(k: KArg) -> u32
where KArg: EncodeLike<u32>,

An auto-generated getter for Points.

impl<T> Pallet<T>
where T: Config,

pub fn awarded_pts<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> u32
where KArg1: EncodeLike<u32>, KArg2: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for AwardedPts.

impl<T> Pallet<T>
where T: Config,

pub fn marking_offline() -> bool

An auto-generated getter for EnableMarkingOffline.

Trait Implementations

impl<T> Get<Vec<<T as Config>::AccountId>> for Pallet<T>
where T: Config,

fn get() -> Vec<<T as Config>::AccountId>

Return the current value.

impl<T> CanAuthor<<T as Config>::AccountId> for Pallet<T>
where T: Config,

fn can_author(account: &<T as Config>::AccountId, _slot: &u32) -> bool

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

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

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

Formats the value using the given formatter. Read more

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

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> GetStorageVersion for Pallet<T>
where T: Config,

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro. Read more

fn in_code_storage_version( ) -> <Pallet<T> as GetStorageVersion>::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. Read more

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

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

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight ) -> Weight

See [Hooks::on_idle].

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number ) -> Weight

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

fn on_finalize( _n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

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

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]). Read more

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

A hook to run logic after inherent application. Read more

fn on_runtime_upgrade() -> Weight

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

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. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

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

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number ) -> Weight

See [Hooks::on_initialize].

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

See [Hooks::on_finalize].

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

type RuntimeCall = Call<T>

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter )

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Pallet<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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> Eq for Pallet<T>

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

fn storage_info() -> Vec<StorageInfo>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

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