ElectionProviderMultiPhase¶
Calls¶
governance_fallback¶
See [Pallet::governance_fallback].
Attributes¶
| Name | Type |
|---|---|
| maybe_max_voters | Option<u32> |
| maybe_max_targets | Option<u32> |
Python¶
call = substrate.compose_call(
'ElectionProviderMultiPhase', 'governance_fallback', {
'maybe_max_targets': (None, 'u32'),
'maybe_max_voters': (None, 'u32'),
}
)
set_emergency_election_result¶
See [Pallet::set_emergency_election_result].
Attributes¶
| Name | Type |
|---|---|
| supports | Supports<T::AccountId> |
Python¶
call = substrate.compose_call(
'ElectionProviderMultiPhase', 'set_emergency_election_result', {
'supports': [
(
'AccountId',
{
'total': 'u128',
'voters': [
(
'AccountId',
'u128',
),
],
},
),
],
}
)
set_minimum_untrusted_score¶
See [Pallet::set_minimum_untrusted_score].
Attributes¶
| Name | Type |
|---|---|
| maybe_next_score | Option<ElectionScore> |
Python¶
call = substrate.compose_call(
'ElectionProviderMultiPhase', 'set_minimum_untrusted_score', {
'maybe_next_score': (
None,
{
'minimal_stake': 'u128',
'sum_stake': 'u128',
'sum_stake_squared': 'u128',
},
),
}
)
submit¶
See [Pallet::submit].
Attributes¶
| Name | Type |
|---|---|
| raw_solution | Box<RawSolution<SolutionOf<T::MinerConfig>>> |
Python¶
call = substrate.compose_call(
'ElectionProviderMultiPhase', 'submit', {
'raw_solution': {
'round': 'u32',
'score': {
'minimal_stake': 'u128',
'sum_stake': 'u128',
'sum_stake_squared': 'u128',
},
'solution': {
'votes1': [('u32', 'u16')],
'votes10': [
(
'u32',
"[('u16', 'u16'); 9]",
'u16',
),
],
'votes11': [
(
'u32',
"[('u16', 'u16'); 10]",
'u16',
),
],
'votes12': [
(
'u32',
"[('u16', 'u16'); 11]",
'u16',
),
],
'votes13': [
(
'u32',
"[('u16', 'u16'); 12]",
'u16',
),
],
'votes14': [
(
'u32',
"[('u16', 'u16'); 13]",
'u16',
),
],
'votes15': [
(
'u32',
"[('u16', 'u16'); 14]",
'u16',
),
],
'votes16': [
(
'u32',
"[('u16', 'u16'); 15]",
'u16',
),
],
'votes2': [
('u32', ('u16', 'u16'), 'u16'),
],
'votes3': [
(
'u32',
"[('u16', 'u16'); 2]",
'u16',
),
],
'votes4': [
(
'u32',
"[('u16', 'u16'); 3]",
'u16',
),
],
'votes5': [
(
'u32',
"[('u16', 'u16'); 4]",
'u16',
),
],
'votes6': [
(
'u32',
"[('u16', 'u16'); 5]",
'u16',
),
],
'votes7': [
(
'u32',
"[('u16', 'u16'); 6]",
'u16',
),
],
'votes8': [
(
'u32',
"[('u16', 'u16'); 7]",
'u16',
),
],
'votes9': [
(
'u32',
"[('u16', 'u16'); 8]",
'u16',
),
],
},
},
}
)
submit_unsigned¶
See [Pallet::submit_unsigned].
Attributes¶
| Name | Type |
|---|---|
| raw_solution | Box<RawSolution<SolutionOf<T::MinerConfig>>> |
| witness | SolutionOrSnapshotSize |
Python¶
call = substrate.compose_call(
'ElectionProviderMultiPhase', 'submit_unsigned', {
'raw_solution': {
'round': 'u32',
'score': {
'minimal_stake': 'u128',
'sum_stake': 'u128',
'sum_stake_squared': 'u128',
},
'solution': {
'votes1': [('u32', 'u16')],
'votes10': [
(
'u32',
"[('u16', 'u16'); 9]",
'u16',
),
],
'votes11': [
(
'u32',
"[('u16', 'u16'); 10]",
'u16',
),
],
'votes12': [
(
'u32',
"[('u16', 'u16'); 11]",
'u16',
),
],
'votes13': [
(
'u32',
"[('u16', 'u16'); 12]",
'u16',
),
],
'votes14': [
(
'u32',
"[('u16', 'u16'); 13]",
'u16',
),
],
'votes15': [
(
'u32',
"[('u16', 'u16'); 14]",
'u16',
),
],
'votes16': [
(
'u32',
"[('u16', 'u16'); 15]",
'u16',
),
],
'votes2': [
('u32', ('u16', 'u16'), 'u16'),
],
'votes3': [
(
'u32',
"[('u16', 'u16'); 2]",
'u16',
),
],
'votes4': [
(
'u32',
"[('u16', 'u16'); 3]",
'u16',
),
],
'votes5': [
(
'u32',
"[('u16', 'u16'); 4]",
'u16',
),
],
'votes6': [
(
'u32',
"[('u16', 'u16'); 5]",
'u16',
),
],
'votes7': [
(
'u32',
"[('u16', 'u16'); 6]",
'u16',
),
],
'votes8': [
(
'u32',
"[('u16', 'u16'); 7]",
'u16',
),
],
'votes9': [
(
'u32',
"[('u16', 'u16'); 8]",
'u16',
),
],
},
},
'witness': {
'targets': 'u32',
'voters': 'u32',
},
}
)
Events¶
ElectionFailed¶
An election failed.
Not much can be said about which computes failed in the process.
Attributes¶
No attributes
ElectionFinalized¶
The election has been finalized, with the given computation and score.
Attributes¶
| Name | Type | Composition |
|---|---|---|
| compute | ElectionCompute |
('OnChain', 'Signed', 'Unsigned', 'Fallback', 'Emergency') |
| score | ElectionScore |
{'minimal_stake': 'u128', 'sum_stake': 'u128', 'sum_stake_squared': 'u128'} |
PhaseTransitioned¶
There was a phase transition in a given round.
Attributes¶
| Name | Type | Composition |
|---|---|---|
| from | Phase<BlockNumberFor<T>> |
{'Off': None, 'Signed': None, 'Unsigned': ('bool', 'u32'), 'Emergency': None} |
| to | Phase<BlockNumberFor<T>> |
{'Off': None, 'Signed': None, 'Unsigned': ('bool', 'u32'), 'Emergency': None} |
| round | u32 |
u32 |
Rewarded¶
An account has been rewarded for their signed submission being finalized.
Attributes¶
| Name | Type | Composition |
|---|---|---|
| account | <T as frame_system::Config>::AccountId |
AccountId |
| value | BalanceOf<T> |
u128 |
Slashed¶
An account has been slashed for submitting an invalid signed submission.
Attributes¶
| Name | Type | Composition |
|---|---|---|
| account | <T as frame_system::Config>::AccountId |
AccountId |
| value | BalanceOf<T> |
u128 |
SolutionStored¶
A solution was stored with the given compute.
The origin indicates the origin of the solution. If origin is Some(AccountId),
the stored solution was submited in the signed phase by a miner with the AccountId.
Otherwise, the solution was stored either during the unsigned phase or by
T::ForceOrigin. The bool is true when a previous solution was ejected to make
room for this one.
Attributes¶
| Name | Type | Composition |
|---|---|---|
| compute | ElectionCompute |
('OnChain', 'Signed', 'Unsigned', 'Fallback', 'Emergency') |
| origin | Option<T::AccountId> |
(None, 'AccountId') |
| prev_ejected | bool |
bool |
Storage functions¶
CurrentPhase¶
Current phase.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'CurrentPhase', []
)
Return value¶
{'Emergency': None, 'Off': None, 'Signed': None, 'Unsigned': ('bool', 'u32')}
DesiredTargets¶
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].
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'DesiredTargets', []
)
Return value¶
'u32'
MinimumUntrustedScore¶
The minimum score that each 'untrusted' solution must attain in order to be considered feasible.
Can be set via set_minimum_untrusted_score.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'MinimumUntrustedScore', []
)
Return value¶
{'minimal_stake': 'u128', 'sum_stake': 'u128', 'sum_stake_squared': 'u128'}
QueuedSolution¶
Current best solution, signed or unsigned, queued to be returned upon elect.
Always sorted by score.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'QueuedSolution', []
)
Return value¶
{
'compute': ('OnChain', 'Signed', 'Unsigned', 'Fallback', 'Emergency'),
'score': {
'minimal_stake': 'u128',
'sum_stake': 'u128',
'sum_stake_squared': 'u128',
},
'supports': [
('AccountId', {'total': 'u128', 'voters': [('AccountId', 'u128')]}),
],
}
Round¶
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.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'Round', []
)
Return value¶
'u32'
SignedSubmissionIndices¶
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.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'SignedSubmissionIndices', []
)
Return value¶
[
(
{
'minimal_stake': 'u128',
'sum_stake': 'u128',
'sum_stake_squared': 'u128',
},
'u32',
'u32',
),
]
SignedSubmissionNextIndex¶
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.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'SignedSubmissionNextIndex', []
)
Return value¶
'u32'
SignedSubmissionsMap¶
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.
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'SignedSubmissionsMap', ['u32']
)
Return value¶
{
'call_fee': 'u128',
'deposit': 'u128',
'raw_solution': {
'round': 'u32',
'score': {
'minimal_stake': 'u128',
'sum_stake': 'u128',
'sum_stake_squared': 'u128',
},
'solution': {
'votes1': [('u32', 'u16')],
'votes10': [('u32', "[('u16', 'u16'); 9]", 'u16')],
'votes11': [('u32', "[('u16', 'u16'); 10]", 'u16')],
'votes12': [('u32', "[('u16', 'u16'); 11]", 'u16')],
'votes13': [('u32', "[('u16', 'u16'); 12]", 'u16')],
'votes14': [('u32', "[('u16', 'u16'); 13]", 'u16')],
'votes15': [('u32', "[('u16', 'u16'); 14]", 'u16')],
'votes16': [('u32', "[('u16', 'u16'); 15]", 'u16')],
'votes2': [('u32', ('u16', 'u16'), 'u16')],
'votes3': [('u32', "[('u16', 'u16'); 2]", 'u16')],
'votes4': [('u32', "[('u16', 'u16'); 3]", 'u16')],
'votes5': [('u32', "[('u16', 'u16'); 4]", 'u16')],
'votes6': [('u32', "[('u16', 'u16'); 5]", 'u16')],
'votes7': [('u32', "[('u16', 'u16'); 6]", 'u16')],
'votes8': [('u32', "[('u16', 'u16'); 7]", 'u16')],
'votes9': [('u32', "[('u16', 'u16'); 8]", 'u16')],
},
},
'who': 'AccountId',
}
Snapshot¶
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].
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'Snapshot', []
)
Return value¶
{'targets': ['AccountId'], 'voters': [('AccountId', 'u64', ['AccountId'])]}
SnapshotMetadata¶
The metadata of the [RoundSnapshot]
Only exists when [Snapshot] is present.
Note: This storage type must only be mutated through [SnapshotWrapper].
Python¶
result = substrate.query(
'ElectionProviderMultiPhase', 'SnapshotMetadata', []
)
Return value¶
{'targets': 'u32', 'voters': 'u32'}
Constants¶
BetterSignedThreshold¶
The minimum amount of improvement to the solution score that defines a solution as "better" in the Signed phase.
Value¶
0
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'BetterSignedThreshold')
MaxWinners¶
The maximum number of winners that can be elected by this ElectionProvider
implementation.
Note: This must always be greater or equal to T::DataProvider::desired_targets().
Value¶
1200
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'MaxWinners')
MinerMaxLength¶
Value¶
3538944
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'MinerMaxLength')
MinerMaxVotesPerVoter¶
Value¶
16
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'MinerMaxVotesPerVoter')
MinerMaxWeight¶
Value¶
{'proof_size': 13650590614545068195, 'ref_time': 1466067765000}
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'MinerMaxWeight')
MinerMaxWinners¶
Value¶
1200
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'MinerMaxWinners')
MinerTxPriority¶
The priority of the unsigned transaction submitted in the unsigned-phase
Value¶
16602069666338596453
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'MinerTxPriority')
OffchainRepeat¶
The repeat threshold of the offchain worker.
For example, if it is 5, that means that at least 5 blocks will elapse between attempts to submit the worker's solution.
Value¶
18
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'OffchainRepeat')
SignedDepositByte¶
Per-byte deposit for a signed solution.
Value¶
97656
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedDepositByte')
SignedDepositWeight¶
Per-weight deposit for a signed solution.
Value¶
0
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedDepositWeight')
SignedMaxRefunds¶
The maximum amount of unchecked solutions to refund the call fee for.
Value¶
4
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedMaxRefunds')
SignedMaxSubmissions¶
Maximum number of signed submissions that can be queued.
It is best to avoid adjusting this during an election, as it impacts downstream data
structures. In particular, SignedSubmissionIndices<T> is bounded on this value. If you
update this value during an election, you must ensure that
SignedSubmissionIndices.len() is less than or equal to the new value. Otherwise,
attempts to submit new solutions may cause a runtime panic.
Value¶
16
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedMaxSubmissions')
SignedMaxWeight¶
Maximum weight of a signed solution.
If [Config::MinerConfig] is being implemented to submit signed solutions (outside of
this pallet), then [MinerConfig::solution_weight] is used to compare against
this value.
Value¶
{'proof_size': 13650590614545068195, 'ref_time': 1466067765000}
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedMaxWeight')
SignedPhase¶
Duration of the signed phase.
Value¶
600
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedPhase')
SignedRewardBase¶
Base reward for a signed solution
Value¶
10000000000
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'SignedRewardBase')
UnsignedPhase¶
Duration of the unsigned phase.
Value¶
600
Python¶
constant = substrate.get_constant('ElectionProviderMultiPhase', 'UnsignedPhase')
Errors¶
BoundNotMet¶
Some bound not met
CallNotAllowed¶
The call is not allowed at this point.
FallbackFailed¶
The fallback failed
InvalidSubmissionIndex¶
Self::insert_submission returned an invalid index.
MissingSnapshotMetadata¶
Snapshot metadata should exist but didn't.
OcwCallWrongEra¶
OCW submitted solution for wrong round
PreDispatchDifferentRound¶
Sumission was prepared for a different round.
PreDispatchEarlySubmission¶
Submission was too early.
PreDispatchWeakSubmission¶
Submission was too weak, score-wise.
PreDispatchWrongWinnerCount¶
Wrong number of winners presented.
SignedCannotPayDeposit¶
The origin failed to pay the deposit.
SignedInvalidWitness¶
Witness data to dispatchable is invalid.
SignedQueueFull¶
The queue was full, and the solution was not better than any of the existing ones.
SignedTooMuchWeight¶
The signed submission consumes too much weight
TooManyWinners¶
Submitted solution has too many winners