Struct ElectionProviderMultiPhaseQueryApi

pub struct ElectionProviderMultiPhaseQueryApi<'api> { /* private fields */ }

Implementations

impl<'api> ElectionProviderMultiPhaseQueryApi<'api>

pub async fn round(&self) -> Result<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 async fn current_phase(&self) -> Result<Phase<u32>>

Current phase.

pub async fn queued_solution(&self) -> Result<Option<ReadySolution>>

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

pub async fn snapshot(&self) -> Result<Option<RoundSnapshot>>

Snapshot data of the round.

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

pub async fn desired_targets(&self) -> Result<Option<u32>>

Desired number of targets to elect for this round.

Only exists when [Snapshot] is present.

pub async fn snapshot_metadata(&self) -> Result<Option<SolutionOrSnapshotSize>>

The metadata of the [RoundSnapshot]

Only exists when [Snapshot] is present.

pub async fn signed_submission_next_index(&self) -> Result<u32>

The next index to be assigned to an incoming signed submission.

Every accepted submission is assigned a unique index; that index is bound to that particular submission for the duration of the election. On election finalization, the next index is reset to 0.

We can’t just use SignedSubmissionIndices.len(), because that’s a bounded set; past its capacity, it will simply saturate. We can’t just iterate over SignedSubmissionsMap, because iteration is slow. Instead, we store the value here.

pub async fn signed_submission_indices( &self, ) -> Result<Vec<(ElectionScore, u32, u32)>>

A sorted, bounded vector of (score, block_number, index), where each index points to a value in SignedSubmissions.

We never need to process more than a single signed submission at a time. Signed submissions can be quite large, so we’re willing to pay the cost of multiple database accesses to access them one at a time instead of reading and decoding all of them at once.

pub async fn signed_submissions_map( &self, key_0: u32, ) -> Result<Option<SignedSubmission<AccountId, u128, NposSolution16>>>

Unchecked, signed solutions.

Together with SubmissionIndices, this stores a bounded set of SignedSubmissions while allowing us to keep only a single one in memory at a time.

Twox note: the key of the map is an auto-incrementing index which users cannot inspect or affect; we shouldn’t need a cryptographically secure hasher.

pub async fn minimum_untrusted_score(&self) -> Result<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.

Trait Implementations

impl<'api> Clone for ElectionProviderMultiPhaseQueryApi<'api>

fn clone(&self) -> ElectionProviderMultiPhaseQueryApi<'api>

Returns a copy of the value.

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

Performs copy-assignment from source.