Struct substrate_gen::runtime::election_provider_multi_phase::storage::StorageApi

pub struct StorageApi;

Implementations

impl StorageApi

pub fn round(&self) -> StaticStorageAddress<DecodeStaticType<u32>, Yes, Yes, ()>

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( &self ) -> StaticStorageAddress<DecodeStaticType<Phase<u32>>, Yes, Yes, ()>

Current phase.

pub fn queued_solution( &self ) -> StaticStorageAddress<DecodeStaticType<ReadySolution>, Yes, (), ()>

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

pub fn snapshot( &self ) -> StaticStorageAddress<DecodeStaticType<RoundSnapshot>, Yes, (), ()>

Snapshot data of the round.

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

pub fn desired_targets( &self ) -> StaticStorageAddress<DecodeStaticType<u32>, Yes, (), ()>

Desired number of targets to elect for this round.

Only exists when [Snapshot] is present.

pub fn snapshot_metadata( &self ) -> StaticStorageAddress<DecodeStaticType<SolutionOrSnapshotSize>, Yes, (), ()>

The metadata of the [RoundSnapshot]

Only exists when [Snapshot] is present.

pub fn signed_submission_next_index( &self ) -> StaticStorageAddress<DecodeStaticType<u32>, Yes, Yes, ()>

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 fn signed_submission_indices( &self ) -> StaticStorageAddress<DecodeStaticType<Vec<(ElectionScore, u32, u32)>>, Yes, Yes, ()>

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 fn signed_submissions_map( &self, _0: impl Borrow<u32> ) -> StaticStorageAddress<DecodeStaticType<SignedSubmission<AccountId32, u128, NposCompactSolution24>>, Yes, (), Yes>

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 fn signed_submissions_map_root( &self ) -> StaticStorageAddress<DecodeStaticType<SignedSubmission<AccountId32, u128, NposCompactSolution24>>, (), (), Yes>

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 fn minimum_untrusted_score( &self ) -> StaticStorageAddress<DecodeStaticType<ElectionScore>, Yes, (), ()>

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

Can be set via set_minimum_untrusted_score.