Struct pallet_election_provider_multi_phase::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn signed_submissions() -> SignedSubmissions<T>

Self accessor for SignedSubmission<T>.

pub fn finalize_signed_phase() -> (bool, Weight)

Finish the signed phase. Process the signed submissions from best to worse until a valid one is found, rewarding the best one and slashing the invalid ones along the way.

Returns true if we have a good solution in the signed phase.

This drains the SignedSubmissions, potentially storing the best valid one in QueuedSolution.

pub fn finalize_signed_phase_accept_solution(
    ready_solution: ReadySolution<T::AccountId>,
    who: &T::AccountId,
    deposit: BalanceOf<T>,
    reward: BalanceOf<T>
)

Helper function for the case where a solution is accepted in the signed phase.

Extracted to facilitate with weight calculation.

Infallible

pub fn finalize_signed_phase_reject_solution(
    who: &T::AccountId,
    deposit: BalanceOf<T>
)

Helper function for the case where a solution is accepted in the rejected phase.

Extracted to facilitate with weight calculation.

Infallible

pub fn feasibility_weight_of(
    raw_solution: &RawSolution<SolutionOf<T>>,
    size: SolutionOrSnapshotSize
) -> Weight

The feasibility weight of the given raw solution.

pub fn deposit_for(
    raw_solution: &RawSolution<SolutionOf<T>>,
    size: SolutionOrSnapshotSize
) -> BalanceOf<T>

Collect a sufficient deposit to store this solution.

The deposit is composed of 3 main elements:

1. base deposit, fixed for all submissions.
2. a per-byte deposit, for renting the state usage.
3. a per-weight deposit, for the potential weight usage in an upcoming on_initialize

impl<T: Config> Pallet<T>

pub fn restore_or_compute_then_maybe_submit() -> Result<(), MinerError>

Attempt to restore a solution from cache. Otherwise, compute it fresh. Either way, submit if our call’s score is greater than that of the cached solution.

pub fn mine_check_save_submit() -> Result<(), MinerError>

Mine a new solution, cache it, and submit it back to the chain as an unsigned transaction.

pub fn mine_checked_call() -> Result<Call<T>, MinerError>

Mine a new solution as a call. Performs all checks.

pub fn basic_checks(
    raw_solution: &RawSolution<SolutionOf<T>>,
    solution_type: &str
) -> Result<(), MinerError>

pub fn mine_and_check(
    iters: usize
) -> Result<(RawSolution<SolutionOf<T>>, SolutionOrSnapshotSize), MinerError>

Mine a new npos solution, with all the relevant checks to make sure that it will be accepted to the chain.

If you want an unchecked solution, use Pallet::mine_solution. If you want a checked solution and submit it at the same time, use Pallet::mine_check_save_submit.

pub fn mine_solution(
    iters: usize
) -> Result<(RawSolution<SolutionOf<T>>, SolutionOrSnapshotSize), MinerError>

Mine a new npos solution.

pub fn prepare_election_result(
    election_result: ElectionResult<T::AccountId, SolutionAccuracyOf<T>>
) -> Result<(RawSolution<SolutionOf<T>>, SolutionOrSnapshotSize), MinerError>

Convert a raw solution from sp_npos_elections::ElectionResult to RawSolution, which is ready to be submitted to the chain.

Will always reduce the solution as well.

pub fn get_balancing_iters() -> usize

Get a random number of iterations to run the balancing in the OCW.

Uses the offchain seed to generate a random number, maxed with Config::MinerMaxIterations.

pub fn trim_assignments_weight(
    desired_targets: u32,
    size: SolutionOrSnapshotSize,
    max_weight: Weight,
    assignments: &mut Vec<IndexAssignmentOf<T>>
)

Greedily reduce the size of the solution to fit into the block w.r.t. weight.

The weight of the solution is foremost a function of the number of voters (i.e. assignments.len()). Aside from this, the other components of the weight are invariant. The number of winners shall not be changed (otherwise the solution is invalid) and the ElectionSize is merely a representation of the total number of stakers.

Thus, we reside to stripping away some voters from the assignments.

Note that the solution is already computed, and the winners are elected based on the merit of the entire stake in the system. Nonetheless, some of the voters will be removed further down the line.

Indeed, the score must be computed after this step. If this step reduces the score too much or remove a winner, then the solution must be discarded after this step.

pub fn trim_assignments_length(
    max_allowed_length: u32,
    assignments: &mut Vec<IndexAssignmentOf<T>>,
    encoded_size_of: impl Fn(&[IndexAssignmentOf<T>]) -> Result<usize, Error>
) -> Result<(), MinerError>

Greedily reduce the size of the solution to fit into the block w.r.t length.

The length of the solution is largely a function of the number of voters. The number of winners cannot be changed. Thus, to reduce the solution size, we need to strip voters.

Note that this solution is already computed, and winners are elected based on the merit of the total stake in the system. Nevertheless, some of the voters may be removed here.

Sometimes, removing a voter can cause a validator to also be implicitly removed, if that voter was the only backer of that winner. In such cases, this solution is invalid, which will be caught prior to submission.

The score must be computed after this step. If this step reduces the score too much, then the solution must be discarded.

pub fn maximum_voter_for_weight<W: WeightInfo>(
    desired_winners: u32,
    size: SolutionOrSnapshotSize,
    max_weight: Weight
) -> u32

Find the maximum len that a solution can have in order to fit into the block weight.

This only returns a value between zero and size.nominators.

pub fn ensure_offchain_repeat_frequency(
    now: T::BlockNumber
) -> Result<(), MinerError>

Checks if an execution of the offchain worker is permitted at the given block number, or not.

This makes sure that

1. we don’t run on previous blocks in case of a re-org
2. we don’t run twice within a window of length T::OffchainRepeat.

Returns Ok(()) if offchain worker limit is respected, Err(reason) otherwise. If Ok() is returned, now is written in storage and will be used in further calls as the baseline.

pub fn unsigned_pre_dispatch_checks(
    raw_solution: &RawSolution<SolutionOf<T>>
) -> DispatchResult

Do the basics checks that MUST happen during the validation and pre-dispatch of an unsigned transaction.

Can optionally also be called during dispatch, if needed.

NOTE: Ideally, these tests should move more and more outside of this and more to the miner’s code, so that we do less and less storage reads here.

impl<T: Config> Pallet<T>

pub fn submit_unsigned(
    origin: OriginFor<T>,
    raw_solution: Box<RawSolution<SolutionOf<T>>>,
    witness: SolutionOrSnapshotSize
) -> DispatchResultWithPostInfo

Submit a solution for the unsigned phase.

The dispatch origin fo this call must be none.

This submission is checked on the fly. Moreover, this unsigned solution is only validated when submitted to the pool from the local node. Effectively, this means that only active validators can submit this transaction when authoring a block (similar to an inherent).

To prevent any incorrect solution (and thus wasted time/weight), this transaction will panic if the solution submitted by the validator is invalid in any way, effectively putting their authoring reward at risk.

No deposit or reward is associated with this submission.

pub fn set_minimum_untrusted_score(
    origin: OriginFor<T>,
    maybe_next_score: Option<ElectionScore>
) -> DispatchResult

Set a new value for MinimumUntrustedScore.

Dispatch origin must be aligned with T::ForceOrigin.

This check can be turned off by setting the value to None.

pub fn set_emergency_election_result(
    origin: OriginFor<T>,
    supports: Supports<T::AccountId>
) -> DispatchResult

Set a solution in the queue, to be handed out to the client of this pallet in the next call to ElectionProvider::elect.

This can only be set by T::ForceOrigin, and only when the phase is Emergency.

The solution is not checked for any feasibility and is assumed to be trustworthy, as any feasibility check itself can in principle cause the election process to fail (due to memory/weight constrains).

pub fn submit(
    origin: OriginFor<T>,
    raw_solution: Box<RawSolution<SolutionOf<T>>>,
    num_signed_submissions: u32
) -> DispatchResult

Submit a solution for the signed phase.

The dispatch origin fo this call must be signed.

The solution is potentially queued, based on the claimed score and processed at the end of the signed phase.

A deposit is reserved and recorded for the solution. Based on the outcome, the solution might be rewarded, slashed, or get all or a part of the deposit back.

Queue size must be provided as witness data.

impl<T: Config> Pallet<T>

pub fn round() -> u32

Internal counter for the number of rounds.

This is useful for de-duplication of transactions submitted to the pool, and general diagnostics of the pallet.

This is merely incremented once per every time that an upstream elect is called.

impl<T: Config> Pallet<T>

pub fn current_phase() -> Phase<T::BlockNumber>

Current phase.

impl<T: Config> Pallet<T>

pub fn queued_solution() -> Option<ReadySolution<T::AccountId>>

Current best solution, signed or unsigned, queued to be returned upon elect.

impl<T: Config> Pallet<T>

pub fn snapshot() -> Option<RoundSnapshot<T::AccountId>>

Snapshot data of the round.

This is created at the beginning of the signed phase and cleared upon calling elect.

impl<T: Config> Pallet<T>

pub fn desired_targets() -> Option<u32>

Desired number of targets to elect for this round.

Only exists when Snapshot is present.

impl<T: Config> Pallet<T>

pub fn snapshot_metadata() -> Option<SolutionOrSnapshotSize>

The metadata of the RoundSnapshot

Only exists when Snapshot is present.

impl<T: Config> Pallet<T>

pub fn minimum_untrusted_score() -> Option<ElectionScore>

The minimum score that each ‘untrusted’ solution must attain in order to be considered feasible.

Can be set via set_minimum_untrusted_score.

impl<T: Config> Pallet<T>

pub fn on_initialize_open_signed() -> Result<Weight, ElectionError>

Logic for [<Pallet as Hooks>::on_initialize] when signed phase is being opened.

This is decoupled for easy weight calculation.

Returns Ok(snapshot_weight) if success, where snapshot_weight is the weight that needs to recorded for the creation of snapshot.

pub fn on_initialize_open_unsigned(
    need_snapshot: bool,
    enabled: bool,
    now: T::BlockNumber
) -> Result<Weight, ElectionError>

Logic for [<Pallet as Hooks<T>>::on_initialize] when unsigned phase is being opened.

This is decoupled for easy weight calculation.

Returns Ok(snapshot_weight) if success, where snapshot_weight is the weight that needs to recorded for the creation of snapshot.

pub fn create_snapshot() -> Result<Weight, ElectionError>

Creates the snapshot. Writes new data to:

1. SnapshotMetadata
2. RoundSnapshot
3. DesiredTargets

Returns Ok(consumed_weight) if operation is okay.

pub fn kill_snapshot()

Kill everything created by Pallet::create_snapshot.

pub fn feasibility_check(
    raw_solution: RawSolution<SolutionOf<T>>,
    compute: ElectionCompute
) -> Result<ReadySolution<T::AccountId>, FeasibilityError>

Checks the feasibility of a solution.

Trait Implementations

impl<T: Config> Benchmarking<BenchmarkResults> for Pallet<T> where
    T: Config, 

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResults>, &'static str>

Run the benchmarks for this pallet.

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

type Call = 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> ElectionProvider<<T as Config>::AccountId, <T as Config>::BlockNumber> for Pallet<T>

type Error = ElectionError

The error type that is returned by the provider.

type DataProvider = T::DataProvider

The data provider of the election.

fn elect() -> Result<(Supports<T::AccountId>, Weight), Self::Error>

Elect a new set of winners.

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

fn current_storage_version() -> StorageVersion

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

fn on_initialize(now: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn offchain_worker(now: T::BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> u64

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

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

fn integrity_test()

Run integrity test.

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

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a 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.

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 !=.

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

fn storage_info() -> Vec<StorageInfo>

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

type Call = Call<T>

The call to validate

fn validate_unsigned(
    source: TransactionSource,
    call: &Self::Call
) -> TransactionValidity

Return the validity of the call

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

impl<T> Eq for Pallet<T>