srml-module: Phragmen election (paritytech#3364)

* phragmen election module.

* Add new files.

* Some doc update

* Update weights.

* bump and a few nits.

* Performance improvement.

* Master.into()

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* Fix build

* Some fixes.

* Fix build.

* Proper outgoing and runner-up managment.

* Bit more sensical weight values.

* Update srml/elections-phragmen/src/lib.rs

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* fix lock file

* Fix build.

* Remove runner-ups

* Some refactors.

* Add support for reporting voters.

* Fix member check.

* Remove equlize.rs

* Update srml/elections-phragmen/src/lib.rs

* Update srml/elections-phragmen/src/lib.rs

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* Bring back runner ups.

* use decode_len

* Better weight values.

* Update bogus doc

* Bump.

* Update srml/elections-phragmen/src/lib.rs

Co-Authored-By: Gavin Wood <[email protected]>

* Review comments.

* One more test

* Fix tests

* Fix build

* .. and fix benchmarks.

* Update srml/elections-phragmen/src/lib.rs

* Version bump

Author: kianenigma

Cargo.lock

@@ -80,6 +80,7 @@ members = [
 	"srml/collective",
 	"srml/democracy",
 	"srml/elections",
+	"srml/elections-phragmen",
 	"srml/example",
 	"srml/executive",
 	"srml/finality-tracker",

Cargo.toml

@@ -110,7 +110,7 @@ fn do_phragmen(
 			let mut supports = <SupportMap<u64>>::new();
 			elected_stashes
 				.iter()
-				.map(|e| (e, to_votes(slashable_balance(e))))
+				.map(|(e, _)| (e, to_votes(slashable_balance(e))))
 				.for_each(|(e, s)| {
 					let item = Support { own: s, total: s, ..Default::default() };
 					supports.insert(e.clone(), item);

core/phragmen/benches/phragmen.rs

@@ -106,9 +106,11 @@ pub struct Edge<AccountId> {
 pub type PhragmenAssignment<AccountId> = (AccountId, ExtendedBalance);
 
 /// Final result of the phragmen election.
+#[cfg_attr(feature = "std", derive(Debug))]
 pub struct PhragmenResult<AccountId> {
-	/// Just winners.
-	pub winners: Vec<AccountId>,
+	/// Just winners zipped with their approval stake. Note that the approval stake is merely the
+	/// sub of their received stake and could be used for very basic sorting and approval voting.
+	pub winners: Vec<(AccountId, ExtendedBalance)>,
 	/// Individual assignments. for each tuple, the first elements is a voter and the second
 	/// is the list of candidates that it supports.
 	pub assignments: Vec<(AccountId, Vec<PhragmenAssignment<AccountId>>)>
@@ -166,7 +168,7 @@ pub fn elect<AccountId, Balance, FS, C>(
 		<C as Convert<Balance, u64>>::convert(b) as ExtendedBalance;
 
 	// return structures
-	let mut elected_candidates: Vec<AccountId>;
+	let mut elected_candidates: Vec<(AccountId, ExtendedBalance)>;
 	let mut assigned: Vec<(AccountId, Vec<PhragmenAssignment<AccountId>>)>;
 
 	// used to cache and access candidates index.
@@ -282,7 +284,7 @@ pub fn elect<AccountId, Balance, FS, C>(
 				}
 			}
 
-			elected_candidates.push(winner.who.clone());
+			elected_candidates.push((winner.who.clone(), winner.approval_stake));
 		} else {
 			break
 		}
@@ -292,8 +294,8 @@ pub fn elect<AccountId, Balance, FS, C>(
 	for n in &mut voters {
 		let mut assignment = (n.who.clone(), vec![]);
 		for e in &mut n.edges {
-			if let Some(c) = elected_candidates.iter().cloned().find(|c| *c == e.who) {
-				if c != n.who {
+			if let Some(c) = elected_candidates.iter().cloned().find(|(c, _)| *c == e.who) {
+				if c.0 != n.who {
 					let ratio = {
 						// Full support. No need to calculate.
 						if *n.load == *e.load { ACCURACY }

core/phragmen/src/lib.rs

@@ -69,7 +69,7 @@ pub(crate) type AccountId = u64;
 
 #[derive(Debug, Clone)]
 pub(crate) struct _PhragmenResult<A: Clone> {
-	pub winners: Vec<A>,
+	pub winners: Vec<(A, Balance)>,
 	pub assignments: Vec<(A, Vec<_PhragmenAssignment<A>>)>
 }
 
@@ -84,7 +84,7 @@ pub(crate) fn elect_float<A, FS>(
 	A: Default + Ord + Member + Copy,
 	for<'r> FS: Fn(&'r A) -> Balance,
 {
-	let mut elected_candidates: Vec<A>;
+	let mut elected_candidates: Vec<(A, Balance)>;
 	let mut assigned: Vec<(A, Vec<_PhragmenAssignment<A>>)>;
 	let mut c_idx_cache = BTreeMap::<A, usize>::new();
 	let num_voters = initial_candidates.len() + initial_voters.len();
@@ -178,7 +178,7 @@ pub(crate) fn elect_float<A, FS>(
 				}
 			}
 
-			elected_candidates.push(winner.who.clone());
+			elected_candidates.push((winner.who.clone(), winner.approval_stake as Balance));
 		} else {
 			break
 		}
@@ -187,7 +187,7 @@ pub(crate) fn elect_float<A, FS>(
 	for n in &mut voters {
 		let mut assignment = (n.who.clone(), vec![]);
 		for e in &mut n.edges {
-			if let Some(c) = elected_candidates.iter().cloned().find(|c| *c == e.who) {
+			if let Some(c) = elected_candidates.iter().cloned().map(|(c, _)| c).find(|c| *c == e.who) {
 				if c != n.who {
 					let ratio = e.load / n.load;
 					assignment.1.push((e.who.clone(), ratio));
@@ -397,7 +397,7 @@ pub(crate) fn build_support_map<FS>(
 	let mut supports = <_SupportMap<AccountId>>::new();
 	result.winners
 		.iter()
-		.map(|e| (e, stake_of(e) as f64))
+		.map(|(e, _)| (e, stake_of(e) as f64))
 		.for_each(|(e, s)| {
 			let item = _Support { own: s, total: s, ..Default::default() };
 			supports.insert(e.clone(), item);

core/phragmen/src/mock.rs

@@ -35,7 +35,7 @@ fn float_phragmen_poc_works() {
 	let winners = phragmen_result.clone().winners;
 	let assignments = phragmen_result.clone().assignments;
 
-	assert_eq_uvec!(winners, vec![2, 3]);
+	assert_eq_uvec!(winners, vec![(2, 40), (3, 50)]);
 	assert_eq_uvec!(
 		assignments,
 		vec![
@@ -86,7 +86,7 @@ fn phragmen_poc_works() {
 		false,
 	).unwrap();
 
-	assert_eq_uvec!(winners, vec![2, 3]);
+	assert_eq_uvec!(winners, vec![(2, 40), (3, 50)]);
 	assert_eq_uvec!(
 		assignments,
 		vec![

core/phragmen/src/tests.rs

@@ -82,8 +82,8 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	// and set impl_version to equal spec_version. If only runtime
 	// implementation changes and behavior does not, then leave spec_version as
 	// is and increment impl_version.
-	spec_version: 158,
-	impl_version: 160,
+	spec_version: 159,
+	impl_version: 159,
 	apis: RUNTIME_API_VERSIONS,
 };
 

node/runtime/src/lib.rs

@@ -0,0 +1,34 @@
+[package]
+name = "srml-elections-phragmen"
+version = "2.0.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+serde = { version = "1.0", optional = true }
+codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false, features = ["derive"] }
+primitives = { package = "substrate-primitives",  path = "../../core/primitives", default-features = false }
+runtime_io = { package = "sr-io", path = "../../core/sr-io", default-features = false }
+sr-primitives = { path = "../../core/sr-primitives", default-features = false }
+phragmen = { package = "substrate-phragmen", path = "../../core/phragmen", default-features = false }
+srml-support = { path = "../support", default-features = false }
+system = { package = "srml-system", path = "../system", default-features = false }
+rstd = { package = "sr-std", path = "../../core/sr-std", default-features = false }
+
+[dev-dependencies]
+hex-literal = "0.2.0"
+balances = { package = "srml-balances", path = "../balances" }
+
+[features]
+default = ["std"]
+std = [
+	"codec/std",
+	"primitives/std",
+	"serde",
+	"runtime_io/std",
+	"srml-support/std",
+	"sr-primitives/std",
+	"phragmen/std",
+	"system/std",
+	"rstd/std",
+]