Struct parachain_staking::pallet::Pallet

pub struct Pallet<T>(_);

Pallet for parachain staking

Implementations

impl<T: Config> Pallet<T>

pub fn set_total_selected( origin: OriginFor<T>, new: u32 ) -> DispatchResultWithPostInfo

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: OriginFor<T>, new: Perbill ) -> DispatchResultWithPostInfo

Set the commission for all collators

pub fn join_candidates( origin: OriginFor<T>, bond: BalanceOf<T>, liquidity_token: CurrencyIdOf<T>, use_balance_from: Option<BondKind>, candidate_count: u32, liquidity_token_count: u32 ) -> DispatchResultWithPostInfo

Join the set of collator candidates

pub fn schedule_leave_candidates( origin: OriginFor<T>, candidate_count: u32 ) -> DispatchResultWithPostInfo

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: OriginFor<T>, candidate: T::AccountId, candidate_delegation_count: u32 ) -> DispatchResultWithPostInfo

Execute leave candidates request

pub fn cancel_leave_candidates( origin: OriginFor<T>, candidate_count: u32 ) -> DispatchResultWithPostInfo

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: OriginFor<T>) -> DispatchResultWithPostInfo

Temporarily leave the set of collator candidates without unbonding

pub fn go_online(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Rejoin the set of collator candidates if previously had called go_offline

pub fn schedule_candidate_bond_more( origin: OriginFor<T>, more: BalanceOf<T>, use_balance_from: Option<BondKind> ) -> DispatchResultWithPostInfo

Request by collator candidate to increase self bond by more

pub fn schedule_candidate_bond_less( origin: OriginFor<T>, less: BalanceOf<T> ) -> DispatchResultWithPostInfo

Request by collator candidate to decrease self bond by less

pub fn execute_candidate_bond_request( origin: OriginFor<T>, candidate: T::AccountId, use_balance_from: Option<BondKind> ) -> DispatchResultWithPostInfo

Execute pending request to adjust the collator candidate self bond

pub fn cancel_candidate_bond_request( origin: OriginFor<T> ) -> DispatchResultWithPostInfo

Cancel pending request to adjust the collator candidate self bond

pub fn delegate( origin: OriginFor<T>, collator: T::AccountId, amount: BalanceOf<T>, use_balance_from: Option<BondKind>, candidate_delegation_count: u32, delegation_count: u32 ) -> DispatchResultWithPostInfo

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

pub fn schedule_leave_delegators( origin: OriginFor<T> ) -> DispatchResultWithPostInfo

Request to leave the set of delegators. If successful, the caller is scheduled to be allowed to exit. Success forbids future delegator actions until the request is invoked or cancelled.

pub fn execute_leave_delegators( origin: OriginFor<T>, delegator: T::AccountId, delegation_count: u32 ) -> DispatchResultWithPostInfo

Execute the right to exit the set of delegators and revoke all ongoing delegations.

pub fn cancel_leave_delegators( origin: OriginFor<T> ) -> DispatchResultWithPostInfo

Cancel a pending request to exit the set of delegators. Success clears the pending exit request (thereby resetting the delay upon another leave_delegators call).

pub fn schedule_revoke_delegation( origin: OriginFor<T>, collator: T::AccountId ) -> DispatchResultWithPostInfo

Request to revoke an existing delegation. If successful, the delegation is scheduled to be allowed to be revoked via the execute_delegation_request extrinsic.

pub fn schedule_delegator_bond_more( origin: OriginFor<T>, candidate: T::AccountId, more: BalanceOf<T>, use_balance_from: Option<BondKind> ) -> DispatchResultWithPostInfo

Request to bond more for delegators wrt a specific collator candidate.

pub fn schedule_delegator_bond_less( origin: OriginFor<T>, candidate: T::AccountId, less: BalanceOf<T> ) -> DispatchResultWithPostInfo

Request bond less for delegators wrt a specific collator candidate.

pub fn execute_delegation_request( origin: OriginFor<T>, delegator: T::AccountId, candidate: T::AccountId, use_balance_from: Option<BondKind> ) -> DispatchResultWithPostInfo

Execute pending request to change an existing delegation

pub fn cancel_delegation_request( origin: OriginFor<T>, candidate: T::AccountId ) -> DispatchResultWithPostInfo

Cancel request to change an existing delegation.

pub fn add_staking_liquidity_token( origin: OriginFor<T>, paired_or_liquidity_token: PairedOrLiquidityToken<CurrencyIdOf<T>>, current_liquidity_tokens: u32 ) -> DispatchResultWithPostInfo

Enables new staking token to be used for staking. Only tokens paired with MGX can be used. Caller can pass the id of token for which MGX paired pool already exists or liquidity token id itself. Root only

pub fn remove_staking_liquidity_token( origin: OriginFor<T>, paired_or_liquidity_token: PairedOrLiquidityToken<CurrencyIdOf<T>>, current_liquidity_tokens: u32 ) -> DispatchResultWithPostInfo

Removes previously added liquidity token

pub fn aggregator_update_metadata( origin: OriginFor<T>, collator_candidates: Vec<T::AccountId>, action: MetadataUpdateAction ) -> DispatchResultWithPostInfo

Modifies aggregator metadata by extending or reducing list of approved candidates Account may only become aggregator only if its not collator or delegator at the moment

pub fn update_candidate_aggregator( origin: OriginFor<T>, maybe_aggregator: Option<T::AccountId> ) -> DispatchResultWithPostInfo

Assigns/replaces the candidate that given collator wants to aggregate under

pub fn payout_collator_rewards( origin: OriginFor<T>, collator: T::AccountId, number_of_sesisons: Option<u32> ) -> DispatchResultWithPostInfo

This extrinsic should be used to distribute rewards for collator and assodiated delegators. As round rewards are processed in random order its impossible predict how many delegators (and assodiated transfer extrinsic calls) will be required so worst case scenario (delegators_count = MaxCollatorCandidates) is assumed.

params:

• collator - account id
• limit - number of rewards periods that should be processed within extrinsic. Note that limit assumes worst case scenario of (delegators_count = MaxCollatorCandidates) so as a result, limit or more session round rewards may be distributed

pub fn payout_delegator_reward( origin: OriginFor<T>, round: u32, collator: T::AccountId, delegator: T::AccountId ) -> DispatchResultWithPostInfo

Payout delegator rewards only for particular round. Collators should rather use Pallet::payout_collator_rewards but if collator is inresponsive one can claim particular delegator rewards manually.

impl<T: Config> Pallet<T>

pub fn payout_reward( round: u32, to: T::AccountId, amt: BalanceOf<T>, kind: RewardKind<T::AccountId> ) -> DispatchResult

pub fn is_delegator(acc: &T::AccountId) -> bool

pub fn is_candidate(acc: &T::AccountId) -> bool

pub fn is_aggregator(acc: &T::AccountId) -> bool

pub fn is_selected_candidate(acc: &T::AccountId) -> bool

pub fn do_update_candidate_aggregator( candidate: &T::AccountId, maybe_aggregator: Option<T::AccountId> ) -> DispatchResult

pub fn calculate_collators_valuations<'a, I>( valuated_bond_it: I ) -> BTreeMap<T::AccountId, BalanceOf<T>>where I: Iterator<Item = (&'a Bond<T::AccountId, BalanceOf<T>, CurrencyIdOf<T>>, BalanceOf<T>)> + Clone,

pub fn calculate_aggregators_collator_info<'a, I>( valuated_bond_it: I ) -> BTreeMap<T::AccountId, BTreeMap<T::AccountId, BalanceOf<T>>>where I: Iterator<Item = (&'a Bond<T::AccountId, BalanceOf<T>, CurrencyIdOf<T>>, BalanceOf<T>)>,

pub fn calculate_valuations_and_aggregation_info( ) -> (BTreeMap<T::AccountId, BalanceOf<T>>, BTreeMap<T::AccountId, BTreeMap<T::AccountId, BalanceOf<T>>>)

pub fn compute_top_candidates( ) -> (Vec<(T::AccountId, BalanceOf<T>)>, Vec<(T::AccountId, BalanceOf<T>)>, BTreeMap<T::AccountId, BTreeMap<T::AccountId, BalanceOf<T>>>)

Compute the top TotalSelected candidates in the CandidatePool and return a vec of their AccountIds (in the order of selection)

pub fn staking_liquidity_tokens_snapshot()

pub fn select_top_candidates(now: u32) -> (u32, u32, BalanceOf<T>)

Best as in most cumulatively supported in terms of stake Returns [collator_count, delegation_count, total staked]

flowchart A[Start] --> B{for all candidates} B -- Is aggregating under Aggregator? --> C[increase Aggreagator valuation] B -- Is solo collator? --> D[increase collator valuation] C --> E[collect final valuations of solo collators and aggregators] D --> E E -- list of solo collators and aggregators only--> F[pick top N valuated accounts] F --> G{for every block author} G -- author --> Z[persist into SelectedCandidates runtime storage] G -- author --> Y{Is solo collator or Aggregator} Y -- is solo collator --> I[emit CollatorChosen event] Y -- is aggregator --> H{for every associated collator} H --> I

impl<T: Config> Pallet<T>

pub fn collator_commission() -> Perbill

An auto-generated getter for CollatorCommission.

impl<T: Config> Pallet<T>

pub fn total_selected() -> u32

An auto-generated getter for TotalSelected.

impl<T: Config> Pallet<T>

pub fn round() -> RoundInfo<BlockNumberFor<T>>

An auto-generated getter for Round.

impl<T: Config> Pallet<T>

pub fn delegator_state<KArg>( k: KArg ) -> Option<Delegator<T::AccountId, BalanceOf<T>, CurrencyIdOf<T>>>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for DelegatorState.

impl<T: Config> Pallet<T>

pub fn candidate_state<KArg>( k: KArg ) -> Option<CollatorCandidate<T::AccountId, BalanceOf<T>, CurrencyIdOf<T>>>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for CandidateState.

impl<T: Config> Pallet<T>

pub fn selected_candidates() -> Vec<T::AccountId>

An auto-generated getter for SelectedCandidates.

impl<T: Config> Pallet<T>

pub fn total<KArg>(k: KArg) -> BalanceOf<T>where KArg: EncodeLike<CurrencyIdOf<T>>,

An auto-generated getter for Total.

impl<T: Config> Pallet<T>

pub fn candidate_pool( ) -> OrderedSet<Bond<T::AccountId, BalanceOf<T>, CurrencyIdOf<T>>>

An auto-generated getter for CandidatePool.

impl<T: Config> Pallet<T>

pub fn at_stake<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> CollatorSnapshot<T::AccountId, BalanceOf<T>, CurrencyIdOf<T>>where KArg1: EncodeLike<u32>, KArg2: EncodeLike<T::AccountId>,

An auto-generated getter for AtStake.

impl<T: Config> Pallet<T>

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

An auto-generated getter for Points.

impl<T: Config> Pallet<T>

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

An auto-generated getter for AwardedPts.

impl<T: Config> Pallet<T>

pub fn staking_liquidity_tokens( ) -> BTreeMap<CurrencyIdOf<T>, Option<(BalanceOf<T>, BalanceOf<T>)>>

An auto-generated getter for StakingLiquidityTokens.

impl<T: Config> Pallet<T>

pub fn get_candidate_aggregator() -> BTreeMap<T::AccountId, T::AccountId>

An auto-generated getter for CandidateAggregator.

impl<T: Config> Pallet<T>

pub fn get_aggregator_metadata<KArg>( k: KArg ) -> Option<AggregatorMetadataType<T::AccountId, CurrencyIdOf<T>>>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for AggregatorMetadata.

impl<T: Config> Pallet<T>

pub fn get_round_aggregator_info<KArg>( k: KArg ) -> Option<BTreeMap<T::AccountId, BTreeMap<T::AccountId, BalanceOf<T>>>>where KArg: EncodeLike<u32>,

An auto-generated getter for RoundAggregatorInfo.

impl<T: Config> Pallet<T>

pub fn get_round_collator_reward_info<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<RoundCollatorRewardInfoType<T::AccountId, BalanceOf<T>>>where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<u32>,

An auto-generated getter for RoundCollatorRewardInfo.

Trait Implementations

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> EstimateNextSessionRotation<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn average_session_length() -> BlockNumberFor<T>

Return the average length of a session.

fn estimate_current_session_progress( now: BlockNumberFor<T> ) -> (Option<Permill>, Weight)

Return an estimate of the current session progress.

fn estimate_next_session_rotation( _now: BlockNumberFor<T> ) -> (Option<BlockNumberFor<T>>, Weight)

Return the block number at which the next session rotation is estimated to happen.

impl<T: Config> EventHandler<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

Add reward points to block authors:

• 20 points to the block producer for producing a block in the chain

fn note_author(author: T::AccountId)

Note that the given account ID is the author of the current block.

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

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

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

fn on_idle(_now: BlockNumberFor<T>, 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_initialize(_n: BlockNumber) -> 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_runtime_upgrade() -> Weight

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

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 wasm runtime.

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

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

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

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: Config> SessionManager<<T as Config>::AccountId> for Pallet<T>

fn new_session(_: SessionIndex) -> Option<Vec<T::AccountId>>

Plan a new session, and optionally provide the new validator set.

fn start_session(session_index: SessionIndex)

Start an already planned session.

fn end_session(_: SessionIndex)

End the session.

fn new_session_genesis(new_index: u32) -> Option<Vec<ValidatorId, Global>>

Same as new_session, but it this should only be called at genesis.

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

fn should_end_session(now: BlockNumberFor<T>) -> bool

Return true if the session should be ended.

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

fn storage_info() -> Vec<StorageInfo>

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>