Offchain Phragmén BREAKING. (#4517)

* Initial skeleton for offchain phragmen * Basic compact encoding decoding for results * add compact files * Bring back Self::ensure_storage_upgraded(); * Make staking use compact stuff. * First seemingly working version of reduce, full of todos * Everything phragmen related works again. * Signing made easier, still issues. * Signing from offchain compile fine 😎 * make compact work with staked asssignment * Evaluation basics are in place. * Move reduce into crate. Document stuff * move reduce into no_std * Add files * Remove other std deps. Runtime compiles * Seemingly it is al stable; cycle implemented but not integrated. * Add fuzzing code. * Cleanup reduce a bit more. * a metric ton of tests for staking; wip 🔨 * Implement a lot more of the tests. * wip getting the unsigned stuff to work * A bit gleanup for unsigned debug * Clean and finalize compact code. * Document reduce. * Still problems with signing * We officaly duct taped the transaction submission stuff. 🤓 * Deadlock with keys again * Runtime builds * Unsigned test works 🙌 * Some cleanups * Make all the tests compile and stuff * Minor cleanup * fix more merge stuff * Most tests work again. * a very nasty bug in reduce * Fix all integrations * Fix more todos * Revamp everything and everything * Remove bogus test * Some review grumbles. * Some fixes * Fix doc test * loop for submission * Fix cli, keyring etc. * some cleanup * Fix staking tests again * fix per-things; bring patches from benchmarking * better score prediction * Add fuzzer, more patches. * Some fixes * More docs * Remove unused generics * Remove max-nominator footgun * Better fuzzer * Disable it ❌ * Bump. * Another round of self-review * Refactor a lot * More major fixes in perThing * Add new fuzz file * Update lock * fix fuzzing code. * Fix nominator retain test * Add slashing check * Update frame/staking/src/tests.rs Co-Authored-By: Joshy Orndorff <JoshOrndorff@users.noreply.github.com> * Some formatting nits * Review comments. * Fix cargo file * Almost all tests work again * Update frame/staking/src/tests.rs Co-Authored-By: thiolliere <gui.thiolliere@gmail.com> * Fix review comments * More review stuff * Some nits * Fix new staking / session / babe relation * Update primitives/phragmen/src/lib.rs Co-Authored-By: thiolliere <gui.thiolliere@gmail.com> * Update primitives/phragmen/src/lib.rs Co-Authored-By: thiolliere <gui.thiolliere@gmail.com> * Update primitives/phragmen/compact/src/lib.rs Co-Authored-By: thiolliere <gui.thiolliere@gmail.com> * Some doc updates to slashing * Fix derive * Remove imports * Remove unimplemented tests * nits * Remove dbg * Better fuzzing params * Remove unused pref map * Deferred Slashing/Offence for offchain Phragmen (#5151) * Some boilerplate * Add test * One more test * Review comments * Fix build * review comments * fix more * fix build * Some cleanups and self-reviews * More minor self reviews * Final nits * Some merge fixes. * opt comment * Fix build * Fix build again. * Update frame/staking/fuzz/fuzz_targets/submit_solution.rs Co-Authored-By: Gavin Wood <gavin@parity.io> * Update frame/staking/src/slashing.rs Co-Authored-By: Gavin Wood <gavin@parity.io> * Update frame/staking/src/offchain_election.rs Co-Authored-By: Gavin Wood <gavin@parity.io> * Fix review comments * fix test * === 🔑 Revamp without staking key. * final round of changes. * Fix cargo-deny * Update frame/staking/src/lib.rs Co-Authored-By: Gavin Wood <gavin@parity.io> Co-authored-by: Joshy Orndorff <JoshOrndorff@users.noreply.github.com> Co-authored-by: thiolliere <gui.thiolliere@gmail.com> Co-authored-by: Gavin Wood <gavin@parity.io>
2026-06-09 21:21:11 +00:00 · 2020-03-26 15:37:40 +01:00
parent 2a67e6c437
commit 970c5f94f2
64 changed files with 11953 additions and 892 deletions
@@ -0,0 +1,145 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Substrate is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! # Running
+//!
+//! Run with `cargo hfuzz run reduce`. `honggfuzz`.
+//!
+//! # Debugging a panic
+//!
+//! Once a panic is found, it can be debugged with
+//! `cargo hfuzz run-debug reduce hfuzz_workspace/reduce/*.fuzz`.
+
+use honggfuzz::fuzz;
+use sp_phragmen::{StakedAssignment, ExtendedBalance, build_support_map, reduce};
+use rand::{self, Rng};
+
+type Balance = u128;
+type AccountId = u64;
+
+/// Or any other token type.
+const KSM: Balance = 1_000_000_000_000;
+
+fn main() {
+	loop {
+		fuzz!(|_data: _| {
+	 		let (assignments, winners) = generate_random_phragmen_assignment(
+	 			rr(100, 1000),
+	 			rr(100, 2000),
+	 			8,
+	 			8,
+	 		);
+			reduce_and_compare(&assignments, &winners);
+	 	});
+	}
+}
+
+fn generate_random_phragmen_assignment(
+	voter_count: usize,
+	target_count: usize,
+	avg_edge_per_voter: usize,
+	edge_per_voter_var: usize,
+) -> (Vec<StakedAssignment<AccountId>>, Vec<AccountId>) {
+	// random in range of (a, b)
+	let rr_128 = |a: u128, b: u128| -> u128 { rand::thread_rng().gen_range(a, b) };
+
+	// prefix to distinguish the voter and target account ranges.
+	let target_prefix = 1_000_000;
+	// let target_prefix = 1000;
+	assert!(voter_count < target_prefix);
+
+	let mut assignments = Vec::with_capacity(voter_count as usize);
+	let mut winners: Vec<AccountId> = Vec::new();
+
+	let all_targets = (target_prefix..(target_prefix + target_count))
+		.map(|a| a as AccountId)
+		.collect::<Vec<AccountId>>();
+
+	(1..=voter_count).for_each(|acc| {
+		let mut targets_to_chose_from = all_targets.clone();
+		let targets_to_chose = if edge_per_voter_var > 0 { rr(
+			avg_edge_per_voter - edge_per_voter_var,
+			avg_edge_per_voter + edge_per_voter_var,
+		) } else { avg_edge_per_voter };
+
+		let distribution = (0..targets_to_chose).map(|_| {
+			let target = targets_to_chose_from.remove(rr(0, targets_to_chose_from.len()));
+			if winners.iter().find(|w| **w == target).is_none() {
+				winners.push(target.clone());
+			}
+			(target, rr_128(1 * KSM, 100 * KSM))
+		}).collect::<Vec<(AccountId, ExtendedBalance)>>();
+
+		assignments.push(StakedAssignment {
+			who: (acc as AccountId),
+			distribution,
+		});
+	});
+
+	(assignments, winners)
+}
+
+fn assert_assignments_equal(
+	winners: &Vec<AccountId>,
+	ass1: &Vec<StakedAssignment<AccountId>>,
+	ass2: &Vec<StakedAssignment<AccountId>>,
+) {
+
+	let (support_1, _) = build_support_map::<AccountId>(winners, ass1);
+	let (support_2, _) = build_support_map::<AccountId>(winners, ass2);
+
+	for (who, support) in support_1.iter() {
+		assert_eq!(support.total, support_2.get(who).unwrap().total);
+	}
+}
+
+fn reduce_and_compare(
+	assignment: &Vec<StakedAssignment<AccountId>>,
+	winners: &Vec<AccountId>,
+) {
+	let mut altered_assignment = assignment.clone();
+	let n = assignment.len() as u32;
+	let m = winners.len() as u32;
+
+	let edges_before = assignment_len(&assignment);
+	let num_changed = reduce(&mut altered_assignment);
+	let edges_after = edges_before - num_changed;
+
+	assert!(
+		edges_after <= m + n,
+		"reduce bound not satisfied. n = {}, m = {}, edges after reduce = {} (removed {})",
+		n,
+		m,
+		edges_after,
+		num_changed,
+	);
+
+	assert_assignments_equal(
+		winners,
+		&assignment,
+		&altered_assignment,
+	);
+}
+
+fn assignment_len(assignments: &[StakedAssignment<AccountId>]) -> u32 {
+	let mut counter = 0;
+	assignments.iter().for_each(|x| x.distribution.iter().for_each(|_| counter += 1));
+	counter
+}
+
+fn rr(a: usize, b: usize) -> usize {
+	rand::thread_rng().gen_range(a, b)
+}