fixes for comments

This commit is contained in:
Nikita Khateev
2023-12-15 18:52:07 +04:00
parent 82df66a996
commit f9bb2c0bdb
3 changed files with 10 additions and 10 deletions
@@ -8,15 +8,15 @@ Branch/Release: `release-polkadot-v1.3.0`
== Purpose
This pallet is needed to manage the set of collators for each session and to provision the next session with actual list of collators.
This pallet is needed to manage the set of collators for each session and to provision the next session with the actual list of collators.
== Glossary
- _Collator_ — a node that gathers collation information and communicates it to relay chain to make a block.
- _Pot_ — stake that will reward block authors. Block author will get a half of the current stake.
- _Pot_ — stake that will reward block authors. Block author will get half of the current stake.
- _Candidate_ — a self-promoted collator, who deposited a candidacy bond to participate in collation process
- _Candidacy Bond_ — fixed amount to deposit to become a collator
- _Invulnerable_ — permissioned collator, that will always be the part of collation process.
- _Invulnerable_ — permissioned collator, that will always be part of the collation process.
== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.3.0/cumulus/pallets/collator-selection/src/lib.rs#L118[{github-icon},role=heading-link]
@@ -24,7 +24,7 @@ This pallet is needed to manage the set of collators for each session and to pro
** `UpdateOrigin` — defines the list of origins that are able to modify the settings of collators (e.g. set and remove list of invulnerables, desired candidates, candidacy bond). This type should implement the trait `EnsureOrigin`.
** `PotId` — id of account that will hold a Pot.
** `MaxCandidates` — maximum number of candidates
** `MinEligibleCollators` — minimal number of collators to collect for the session
** `MinEligibleCollators` — minimum number of collators to collect for the session
** `MaxInvulnerables` — maximum number of invulnerables
** `KickThreshold` — number of blocks that should pass since the last block produced by a candidate collator for it to be removed from a candidates list and not participate in collation for the next session.
** `ValidatorId` — type for validator id
@@ -44,7 +44,7 @@ This pallet is needed to manage the set of collators for each session and to pro
----
pub fn set_invulnerables(new: Vec<T::AccountId>)
----
Sets a new list of of invulnerable collators. The call must be signed and origin of the call must fulfill the EnsureOrigin check.
Sets a new list of invulnerable collators. The call must be signed and origin of the call must fulfill the EnsureOrigin check.
IMPORTANT: This call does not maintain the mutual exclusiveness of candidates and invulnerables lists.
@@ -131,8 +131,8 @@ Register the caller as a collator candidate. Caller should be signed, have regis
- `CandidateAdded(account_id, deposit)`
[.contract-item]
[[register_as_candidate]]
==== `[.contract-item-name]#++register_as_candidate++#`
[[leave_intent]]
==== `[.contract-item-name]#++leave_intent++#`
[source,rust]
----
pub fn leave_intent()