Struct pallet_election_provider_multi_phase::pallet::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 signed_submissions() -> SignedSubmissions<T>

Self accessor for SignedSubmission<T>.

pub fn finalize_signed_phase() -> bool

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.

This is a self-weighing function, it automatically registers its weight internally when being called.

pub fn finalize_signed_phase_accept_solution( ready_solution: ReadySolution<T::AccountId, T::MaxWinners>, who: &T::AccountId, deposit: BalanceOf<T>, call_fee: 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 solution_weight_of( raw_solution: &RawSolution<SolutionOf<T::MinerConfig>>, size: SolutionOrSnapshotSize, ) -> Weight

The weight of the given raw solution.

pub fn deposit_for( raw_solution: &RawSolution<SolutionOf<T::MinerConfig>>, 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 + CreateInherent<Call<T>>> Pallet<T>

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

Mine a new npos solution.

The Npos Solver type, S, must have the same AccountId and Error type as the crate::Config::Solver in order to create a unified return type.

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::MinerConfig>>, solution_type: &str, ) -> Result<(), MinerError>

pub fn mine_and_check() -> Result<(RawSolution<SolutionOf<T::MinerConfig>>, SolutionOrSnapshotSize, TrimmingStatus), 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 ensure_offchain_repeat_frequency( now: BlockNumberFor<T>, ) -> 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::MinerConfig>>, ) -> 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::MinerConfig>>>, witness: SolutionOrSnapshotSize, ) -> DispatchResult

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::MinerConfig>>>, ) -> 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.

pub fn governance_fallback( origin: OriginFor<T>, maybe_max_voters: Option<u32>, maybe_max_targets: Option<u32>, ) -> DispatchResult

Trigger the governance fallback.

This can only be called when Phase::Emergency is enabled, as an alternative to calling Call::set_emergency_election_result.

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.

pub fn current_phase() -> Phase<BlockNumberFor<T>>

Current phase.

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

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

Always sorted by score.

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

Snapshot data of the round.

This is created at the beginning of the signed phase and cleared upon calling elect. Note: This storage type must only be mutated through SnapshotWrapper.

pub fn desired_targets() -> Option<u32>

Desired number of targets to elect for this round.

Only exists when Snapshot is present. Note: This storage type must only be mutated through SnapshotWrapper.

pub fn snapshot_metadata() -> Option<SolutionOrSnapshotSize>

The metadata of the RoundSnapshot

Only exists when Snapshot is present. Note: This storage type must only be mutated through SnapshotWrapper.

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.

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

Creates the snapshot. Writes new data to:

1. SnapshotMetadata
2. RoundSnapshot
3. DesiredTargets

Returns Ok(()) if operation is okay.

This is a self-weighing function, it will register its own extra weight as [DispatchClass::Mandatory] with the system pallet.

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

Checks the feasibility of a solution.

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

where T: Config + 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<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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

fn ongoing() -> bool

Indicate if this election provider is currently ongoing an asynchronous election or not.

fn elect() -> Result<BoundedSupportsOf<Self>, Self::Error>

Performs the election. This should be implemented as a self-weighing function. The implementor should register its appropriate weight at the end of execution with the system pallet directly.

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

type AccountId = <T as Config>::AccountId

The account identifier type.

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

The block number type.

type Error = ElectionError<T>

The error type that is returned by the provider.

type MaxWinners = <T as Config>::MaxWinners

The upper bound on election winners that can be returned.

type DataProvider = <T as Config>::DataProvider

The data provider of the election.

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

checked call to Self::DataProvider::desired_targets() ensuring the value never exceeds [Self::MaxWinners].

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(now: BlockNumberFor<T>) -> Weight

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

fn offchain_worker(now: BlockNumberFor<T>)

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.

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

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 pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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> 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].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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

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

fn storage_info() -> Vec<StorageInfo>

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

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

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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: 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>