48 releases (stable)

36.2.0 May 22, 2025
35.1.0 May 21, 2025
35.0.0 Jan 7, 2025
34.0.0 Jul 18, 2024
2.0.0-rc5 Jul 24, 2020

#796 in Magic Beans

Download history 32492/week @ 2025-02-07 39417/week @ 2025-02-14 18116/week @ 2025-02-21 5476/week @ 2025-02-28 6299/week @ 2025-03-07 5547/week @ 2025-03-14 5309/week @ 2025-03-21 4966/week @ 2025-03-28 6170/week @ 2025-04-04 5200/week @ 2025-04-11 5766/week @ 2025-04-18 8265/week @ 2025-04-25 5645/week @ 2025-05-02 3956/week @ 2025-05-09 4872/week @ 2025-05-16 3506/week @ 2025-05-23

19,660 downloads per month
Used in 150 crates (13 directly)

Apache-2.0

1.5MB
22K SLoC

sp-npos-elections

A set of election algorithms to be used with a Substrate runtime, typically within the staking sub-system. Notable implementation include:

  • seq_phragmen: Implements the Phragmén Sequential Method. An un-ranked, relatively fast election method that ensures PJR, but does not provide a constant factor approximation of the maximin problem.
  • phragmms: Implements a hybrid approach inspired by Phragmén which is executed faster but it can achieve a constant factor approximation of the maximin problem, similar to that of the MMS algorithm.
  • balance_solution: Implements the star balancing algorithm. This iterative process can push a solution toward being more balanced, which in turn can increase its score.

Terminology

This crate uses context-independent words, not to be confused with staking. This is because the election algorithms of this crate, while designed for staking, can be used in other contexts as well.

Voter: The entity casting some votes to a number of Targets. This is the same as Nominator in the context of staking. Target: The entities eligible to be voted upon. This is the same as Validator in the context of staking. Edge: A mapping from a Voter to a Target.

The goal of an election algorithm is to provide an ElectionResult. A data composed of:

  • winners: A flat list of identifiers belonging to those who have won the election, usually ordered in some meaningful way. They are zipped with their total backing stake.
  • assignment: A mapping from each voter to their winner-only targets, zipped with a ration denoting the amount of support given to that particular target.
// the winners.
let winners = vec![(1, 100), (2, 50)];
let assignments = vec![
    // A voter, giving equal backing to both 1 and 2.
    Assignment {
		who: 10,
		distribution: vec![(1, Perbill::from_percent(50)), (2, Perbill::from_percent(50))],
	},
    // A voter, Only backing 1.
    Assignment { who: 20, distribution: vec![(1, Perbill::from_percent(100))] },
];

// the combination of the two makes the election result.
let election_result = ElectionResult { winners, assignments };

The Assignment field of the election result is voter-major, i.e. it is from the perspective of the voter. The struct that represents the opposite is called a Support. This struct is usually accessed in a map-like manner, i.e. keyed by voters, therefore it is stored as a mapping called SupportMap.

Moreover, the support is built from absolute backing values, not ratios like the example above. A struct similar to Assignment that has stake value instead of ratios is called an StakedAssignment.

More information can be found at: https://arxiv.org/abs/2004.12990

License: Apache-2.0

Dependencies

~17–30MB
~501K SLoC