criteria.rs 23.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Copyright 2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

//! Assignment criteria VRF generation and checking.

Shawn Tabrizi's avatar
Shawn Tabrizi committed
19
use parity_scale_codec::{Decode, Encode};
20
21
22
23
use polkadot_node_primitives::approval::{
	self as approval_types, AssignmentCert, AssignmentCertKind, DelayTranche, RelayVRFStory,
};
use polkadot_primitives::v1::{
Shawn Tabrizi's avatar
Shawn Tabrizi committed
24
	AssignmentId, AssignmentPair, CandidateHash, CoreIndex, GroupIndex, SessionInfo, ValidatorIndex,
25
26
27
28
29
30
31
};
use sc_keystore::LocalKeystore;
use sp_application_crypto::Public;

use merlin::Transcript;
use schnorrkel::vrf::VRFInOut;

Shawn Tabrizi's avatar
Shawn Tabrizi committed
32
use std::collections::{hash_map::Entry, HashMap};
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use super::LOG_TARGET;

/// Details pertaining to our assignment on a block.
#[derive(Debug, Clone, Encode, Decode, PartialEq)]
pub struct OurAssignment {
	cert: AssignmentCert,
	tranche: DelayTranche,
	validator_index: ValidatorIndex,
	// Whether the assignment has been triggered already.
	triggered: bool,
}

impl OurAssignment {
	pub(crate) fn cert(&self) -> &AssignmentCert {
		&self.cert
	}

	pub(crate) fn tranche(&self) -> DelayTranche {
		self.tranche
	}

	pub(crate) fn validator_index(&self) -> ValidatorIndex {
		self.validator_index
	}

	pub(crate) fn triggered(&self) -> bool {
		self.triggered
	}

	pub(crate) fn mark_triggered(&mut self) {
		self.triggered = true;
	}
}

impl From<crate::approval_db::v1::OurAssignment> for OurAssignment {
	fn from(entry: crate::approval_db::v1::OurAssignment) -> Self {
		OurAssignment {
			cert: entry.cert,
			tranche: entry.tranche,
			validator_index: entry.validator_index,
			triggered: entry.triggered,
		}
	}
}

impl From<OurAssignment> for crate::approval_db::v1::OurAssignment {
	fn from(entry: OurAssignment) -> Self {
		Self {
			cert: entry.cert,
			tranche: entry.tranche,
			validator_index: entry.validator_index,
			triggered: entry.triggered,
		}
	}
}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
90
fn relay_vrf_modulo_transcript(relay_vrf_story: RelayVRFStory, sample: u32) -> Transcript {
91
92
93
94
95
96
97
98
	// combine the relay VRF story with a sample number.
	let mut t = Transcript::new(approval_types::RELAY_VRF_MODULO_CONTEXT);
	t.append_message(b"RC-VRF", &relay_vrf_story.0);
	sample.using_encoded(|s| t.append_message(b"sample", s));

	t
}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
99
fn relay_vrf_modulo_core(vrf_in_out: &VRFInOut, n_cores: u32) -> CoreIndex {
100
101
102
103
104
105
106
	let bytes: [u8; 4] = vrf_in_out.make_bytes(approval_types::CORE_RANDOMNESS_CONTEXT);

	// interpret as little-endian u32.
	let random_core = u32::from_le_bytes(bytes) % n_cores;
	CoreIndex(random_core)
}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
107
fn relay_vrf_delay_transcript(relay_vrf_story: RelayVRFStory, core_index: CoreIndex) -> Transcript {
108
109
110
111
112
113
114
115
116
117
118
119
120
121
	let mut t = Transcript::new(approval_types::RELAY_VRF_DELAY_CONTEXT);
	t.append_message(b"RC-VRF", &relay_vrf_story.0);
	core_index.0.using_encoded(|s| t.append_message(b"core", s));
	t
}

fn relay_vrf_delay_tranche(
	vrf_in_out: &VRFInOut,
	num_delay_tranches: u32,
	zeroth_delay_tranche_width: u32,
) -> DelayTranche {
	let bytes: [u8; 4] = vrf_in_out.make_bytes(approval_types::TRANCHE_RANDOMNESS_CONTEXT);

	// interpret as little-endian u32 and reduce by the number of tranches.
Shawn Tabrizi's avatar
Shawn Tabrizi committed
122
123
	let wide_tranche =
		u32::from_le_bytes(bytes) % (num_delay_tranches + zeroth_delay_tranche_width);
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

	// Consolidate early results to tranche zero so tranche zero is extra wide.
	wide_tranche.saturating_sub(zeroth_delay_tranche_width)
}

fn assigned_core_transcript(core_index: CoreIndex) -> Transcript {
	let mut t = Transcript::new(approval_types::ASSIGNED_CORE_CONTEXT);
	core_index.0.using_encoded(|s| t.append_message(b"core", s));
	t
}

/// Information about the world assignments are being produced in.
#[derive(Clone)]
pub(crate) struct Config {
	/// The assignment public keys for validators.
	assignment_keys: Vec<AssignmentId>,
	/// The groups of validators assigned to each core.
	validator_groups: Vec<Vec<ValidatorIndex>>,
	/// The number of availability cores used by the protocol during this session.
	n_cores: u32,
	/// The zeroth delay tranche width.
	zeroth_delay_tranche_width: u32,
Denis_P's avatar
Denis_P committed
146
	/// The number of samples we do of `relay_vrf_modulo`.
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
	relay_vrf_modulo_samples: u32,
	/// The number of delay tranches in total.
	n_delay_tranches: u32,
}

impl<'a> From<&'a SessionInfo> for Config {
	fn from(s: &'a SessionInfo) -> Self {
		Config {
			assignment_keys: s.assignment_keys.clone(),
			validator_groups: s.validator_groups.clone(),
			n_cores: s.n_cores.clone(),
			zeroth_delay_tranche_width: s.zeroth_delay_tranche_width.clone(),
			relay_vrf_modulo_samples: s.relay_vrf_modulo_samples.clone(),
			n_delay_tranches: s.n_delay_tranches.clone(),
		}
	}
}

/// A trait for producing and checking assignments. Used to mock.
pub(crate) trait AssignmentCriteria {
	fn compute_assignments(
		&self,
		keystore: &LocalKeystore,
		relay_vrf_story: RelayVRFStory,
		config: &Config,
172
		leaving_cores: Vec<(CandidateHash, CoreIndex, GroupIndex)>,
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
	) -> HashMap<CoreIndex, OurAssignment>;

	fn check_assignment_cert(
		&self,
		claimed_core_index: CoreIndex,
		validator_index: ValidatorIndex,
		config: &Config,
		relay_vrf_story: RelayVRFStory,
		assignment: &AssignmentCert,
		backing_group: GroupIndex,
	) -> Result<DelayTranche, InvalidAssignment>;
}

pub(crate) struct RealAssignmentCriteria;

impl AssignmentCriteria for RealAssignmentCriteria {
	fn compute_assignments(
		&self,
		keystore: &LocalKeystore,
		relay_vrf_story: RelayVRFStory,
		config: &Config,
194
		leaving_cores: Vec<(CandidateHash, CoreIndex, GroupIndex)>,
195
	) -> HashMap<CoreIndex, OurAssignment> {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
196
		compute_assignments(keystore, relay_vrf_story, config, leaving_cores)
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
	}

	fn check_assignment_cert(
		&self,
		claimed_core_index: CoreIndex,
		validator_index: ValidatorIndex,
		config: &Config,
		relay_vrf_story: RelayVRFStory,
		assignment: &AssignmentCert,
		backing_group: GroupIndex,
	) -> Result<DelayTranche, InvalidAssignment> {
		check_assignment_cert(
			claimed_core_index,
			validator_index,
			config,
			relay_vrf_story,
			assignment,
			backing_group,
		)
	}
}

/// Compute the assignments for a given block. Returns a map containing all assignments to cores in
/// the block. If more than one assignment targets the given core, only the earliest assignment is kept.
///
/// The `leaving_cores` parameter indicates all cores within the block where a candidate was included,
/// as well as the group index backing those.
///
/// The current description of the protocol assigns every validator to check every core. But at different times.
/// The idea is that most assignments are never triggered and fall by the wayside.
///
/// This will not assign to anything the local validator was part of the backing group for.
pub(crate) fn compute_assignments(
	keystore: &LocalKeystore,
	relay_vrf_story: RelayVRFStory,
	config: &Config,
233
	leaving_cores: impl IntoIterator<Item = (CandidateHash, CoreIndex, GroupIndex)> + Clone,
234
) -> HashMap<CoreIndex, OurAssignment> {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
235
236
237
238
	if config.n_cores == 0 ||
		config.assignment_keys.is_empty() ||
		config.validator_groups.is_empty()
	{
239
240
241
242
243
244
245
246
		tracing::trace!(
			target: LOG_TARGET,
			n_cores = config.n_cores,
			has_assignment_keys = !config.assignment_keys.is_empty(),
			has_validator_groups = !config.validator_groups.is_empty(),
			"Not producing assignments because config is degenerate",
		);

247
248
249
		return HashMap::new()
	}

250
	let (index, assignments_key): (ValidatorIndex, AssignmentPair) = {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
251
252
		let key = config.assignment_keys.iter().enumerate().find_map(|(i, p)| {
			match keystore.key_pair(p) {
253
				Ok(Some(pair)) => Some((ValidatorIndex(i as _), pair)),
254
				Ok(None) => None,
255
256
				Err(sc_keystore::Error::Unavailable) => None,
				Err(sc_keystore::Error::Io(e)) if e.kind() == std::io::ErrorKind::NotFound => None,
257
258
259
				Err(e) => {
					tracing::warn!(target: LOG_TARGET, "Encountered keystore error: {:?}", e);
					None
Shawn Tabrizi's avatar
Shawn Tabrizi committed
260
261
262
				},
			}
		});
263
264

		match key {
265
266
267
268
			None => {
				tracing::trace!(target: LOG_TARGET, "No assignment key");
				return Default::default()
			},
269
270
271
272
273
			Some(k) => k,
		}
	};

	// Ignore any cores where the assigned group is our own.
Shawn Tabrizi's avatar
Shawn Tabrizi committed
274
275
	let leaving_cores = leaving_cores
		.into_iter()
276
277
		.filter(|&(_, _, ref g)| !is_in_backing_group(&config.validator_groups, index, *g))
		.map(|(c_hash, core, _)| (c_hash, core))
278
279
		.collect::<Vec<_>>();

280
281
282
283
284
285
	tracing::trace!(
		target: LOG_TARGET,
		assignable_cores = leaving_cores.len(),
		"Assigning to candidates from different backing groups"
	);

286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
	let assignments_key: &sp_application_crypto::sr25519::Pair = assignments_key.as_ref();
	let assignments_key: &schnorrkel::Keypair = assignments_key.as_ref();

	let mut assignments = HashMap::new();

	// First run `RelayVRFModulo` for each sample.
	compute_relay_vrf_modulo_assignments(
		&assignments_key,
		index,
		config,
		relay_vrf_story.clone(),
		leaving_cores.iter().cloned(),
		&mut assignments,
	);

	// Then run `RelayVRFDelay` once for the whole block.
	compute_relay_vrf_delay_assignments(
		&assignments_key,
		index,
		config,
		relay_vrf_story,
		leaving_cores,
		&mut assignments,
	);

	assignments
}

fn compute_relay_vrf_modulo_assignments(
	assignments_key: &schnorrkel::Keypair,
	validator_index: ValidatorIndex,
	config: &Config,
	relay_vrf_story: RelayVRFStory,
319
	leaving_cores: impl IntoIterator<Item = (CandidateHash, CoreIndex)> + Clone,
320
321
322
323
324
325
326
327
328
329
330
331
332
	assignments: &mut HashMap<CoreIndex, OurAssignment>,
) {
	for rvm_sample in 0..config.relay_vrf_modulo_samples {
		let mut core = Default::default();

		let maybe_assignment = {
			// Extra scope to ensure borrowing instead of moving core
			// into closure.
			let core = &mut core;
			assignments_key.vrf_sign_extra_after_check(
				relay_vrf_modulo_transcript(relay_vrf_story.clone(), rvm_sample),
				|vrf_in_out| {
					*core = relay_vrf_modulo_core(&vrf_in_out, config.n_cores);
Shawn Tabrizi's avatar
Shawn Tabrizi committed
333
334
					if let Some((candidate_hash, _)) =
						leaving_cores.clone().into_iter().find(|(_, c)| c == core)
335
336
337
338
339
340
341
342
343
344
					{
						tracing::trace!(
							target: LOG_TARGET,
							?candidate_hash,
							?core,
							?validator_index,
							tranche = 0,
							"RelayVRFModulo Assignment."
						);

345
346
347
348
						Some(assigned_core_transcript(*core))
					} else {
						None
					}
Shawn Tabrizi's avatar
Shawn Tabrizi committed
349
				},
350
351
352
353
354
355
356
357
			)
		};

		if let Some((vrf_in_out, vrf_proof, _)) = maybe_assignment {
			// Sanity: `core` is always initialized to non-default here, as the closure above
			// has been executed.
			let cert = AssignmentCert {
				kind: AssignmentCertKind::RelayVRFModulo { sample: rvm_sample },
Shawn Tabrizi's avatar
Shawn Tabrizi committed
358
359
360
361
				vrf: (
					approval_types::VRFOutput(vrf_in_out.to_output()),
					approval_types::VRFProof(vrf_proof),
				),
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
			};

			// All assignments of type RelayVRFModulo have tranche 0.
			assignments.entry(core).or_insert(OurAssignment {
				cert,
				tranche: 0,
				validator_index,
				triggered: false,
			});
		}
	}
}

fn compute_relay_vrf_delay_assignments(
	assignments_key: &schnorrkel::Keypair,
	validator_index: ValidatorIndex,
	config: &Config,
	relay_vrf_story: RelayVRFStory,
380
	leaving_cores: impl IntoIterator<Item = (CandidateHash, CoreIndex)>,
381
382
	assignments: &mut HashMap<CoreIndex, OurAssignment>,
) {
383
	for (candidate_hash, core) in leaving_cores {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
384
385
		let (vrf_in_out, vrf_proof, _) =
			assignments_key.vrf_sign(relay_vrf_delay_transcript(relay_vrf_story.clone(), core));
386
387
388
389
390
391
392
393
394

		let tranche = relay_vrf_delay_tranche(
			&vrf_in_out,
			config.n_delay_tranches,
			config.zeroth_delay_tranche_width,
		);

		let cert = AssignmentCert {
			kind: AssignmentCertKind::RelayVRFDelay { core_index: core },
Shawn Tabrizi's avatar
Shawn Tabrizi committed
395
396
397
398
			vrf: (
				approval_types::VRFOutput(vrf_in_out.to_output()),
				approval_types::VRFProof(vrf_proof),
			),
399
400
		};

Shawn Tabrizi's avatar
Shawn Tabrizi committed
401
		let our_assignment = OurAssignment { cert, tranche, validator_index, triggered: false };
402

403
		let used = match assignments.entry(core) {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
404
405
			Entry::Vacant(e) => {
				let _ = e.insert(our_assignment);
406
				true
407
			},
Shawn Tabrizi's avatar
Shawn Tabrizi committed
408
409
410
411
412
413
414
			Entry::Occupied(mut e) =>
				if e.get().tranche > our_assignment.tranche {
					e.insert(our_assignment);
					true
				} else {
					false
				},
415
416
417
418
419
420
421
422
423
424
425
		};

		if used {
			tracing::trace!(
				target: LOG_TARGET,
				?candidate_hash,
				?core,
				?validator_index,
				tranche,
				"RelayVRFDelay Assignment",
			);
426
427
428
429
430
431
432
433
434
435
436
437
438
439
		}
	}
}

/// Assignment invalid.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct InvalidAssignment;

impl std::fmt::Display for InvalidAssignment {
	fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
		write!(f, "Invalid Assignment")
	}
}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
440
impl std::error::Error for InvalidAssignment {}
441
442
443
444
445
446
447
448
449
450
451

/// Checks the crypto of an assignment cert. Failure conditions:
///   * Validator index out of bounds
///   * VRF signature check fails
///   * VRF output doesn't match assigned core
///   * Core is not covered by extra data in signature
///   * Core index out of bounds
///   * Sample is out of bounds
///   * Validator is present in backing group.
///
/// This function does not check whether the core is actually a valid assignment or not. That should be done
452
/// outside the scope of this function.
453
454
455
456
457
458
459
460
pub(crate) fn check_assignment_cert(
	claimed_core_index: CoreIndex,
	validator_index: ValidatorIndex,
	config: &Config,
	relay_vrf_story: RelayVRFStory,
	assignment: &AssignmentCert,
	backing_group: GroupIndex,
) -> Result<DelayTranche, InvalidAssignment> {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
461
462
	let validator_public = config
		.assignment_keys
463
		.get(validator_index.0 as usize)
464
465
466
467
468
469
		.ok_or(InvalidAssignment)?;

	let public = schnorrkel::PublicKey::from_bytes(validator_public.as_slice())
		.map_err(|_| InvalidAssignment)?;

	if claimed_core_index.0 >= config.n_cores {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
470
		return Err(InvalidAssignment)
471
472
473
474
	}

	// Check that the validator was not part of the backing group
	// and not already assigned.
Shawn Tabrizi's avatar
Shawn Tabrizi committed
475
476
	let is_in_backing =
		is_in_backing_group(&config.validator_groups, validator_index, backing_group);
477
478

	if is_in_backing {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
479
		return Err(InvalidAssignment)
480
481
482
483
484
485
	}

	let &(ref vrf_output, ref vrf_proof) = &assignment.vrf;
	match assignment.kind {
		AssignmentCertKind::RelayVRFModulo { sample } => {
			if sample >= config.relay_vrf_modulo_samples {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
486
				return Err(InvalidAssignment)
487
488
			}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
489
490
491
492
493
494
495
496
			let (vrf_in_out, _) = public
				.vrf_verify_extra(
					relay_vrf_modulo_transcript(relay_vrf_story, sample),
					&vrf_output.0,
					&vrf_proof.0,
					assigned_core_transcript(claimed_core_index),
				)
				.map_err(|_| InvalidAssignment)?;
497
498
499
500
501
502
503

			// ensure that the `vrf_in_out` actually gives us the claimed core.
			if relay_vrf_modulo_core(&vrf_in_out, config.n_cores) == claimed_core_index {
				Ok(0)
			} else {
				Err(InvalidAssignment)
			}
Shawn Tabrizi's avatar
Shawn Tabrizi committed
504
		},
505
506
		AssignmentCertKind::RelayVRFDelay { core_index } => {
			if core_index != claimed_core_index {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
507
				return Err(InvalidAssignment)
508
509
			}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
510
511
512
513
514
515
516
			let (vrf_in_out, _) = public
				.vrf_verify(
					relay_vrf_delay_transcript(relay_vrf_story, core_index),
					&vrf_output.0,
					&vrf_proof.0,
				)
				.map_err(|_| InvalidAssignment)?;
517
518
519
520
521
522

			Ok(relay_vrf_delay_tranche(
				&vrf_in_out,
				config.n_delay_tranches,
				config.zeroth_delay_tranche_width,
			))
Shawn Tabrizi's avatar
Shawn Tabrizi committed
523
		},
524
525
526
527
528
529
530
531
532
533
534
535
536
537
	}
}

fn is_in_backing_group(
	validator_groups: &[Vec<ValidatorIndex>],
	validator: ValidatorIndex,
	group: GroupIndex,
) -> bool {
	validator_groups.get(group.0 as usize).map_or(false, |g| g.contains(&validator))
}

#[cfg(test)]
mod tests {
	use super::*;
Shawn Tabrizi's avatar
Shawn Tabrizi committed
538
539
	use polkadot_node_primitives::approval::{VRFOutput, VRFProof};
	use polkadot_primitives::v1::{Hash, ASSIGNMENT_KEY_TYPE_ID};
540
541
	use sp_application_crypto::sr25519;
	use sp_core::crypto::Pair as PairT;
Shawn Tabrizi's avatar
Shawn Tabrizi committed
542
543
	use sp_keyring::sr25519::Keyring as Sr25519Keyring;
	use sp_keystore::CryptoStore;
544
545
546
547
548
549

	// sets up a keystore with the given keyring accounts.
	async fn make_keystore(accounts: &[Sr25519Keyring]) -> LocalKeystore {
		let store = LocalKeystore::in_memory();

		for s in accounts.iter().copied().map(|k| k.to_seed()) {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
550
551
552
553
			store
				.sr25519_generate_new(ASSIGNMENT_KEY_TYPE_ID, Some(s.as_str()))
				.await
				.unwrap();
554
555
556
557
558
559
560
561
562
		}

		store
	}

	fn assignment_keys(accounts: &[Sr25519Keyring]) -> Vec<AssignmentId> {
		assignment_keys_plus_random(accounts, 0)
	}

Shawn Tabrizi's avatar
Shawn Tabrizi committed
563
564
565
566
567
568
	fn assignment_keys_plus_random(
		accounts: &[Sr25519Keyring],
		random: usize,
	) -> Vec<AssignmentId> {
		let gen_random =
			(0..random).map(|_| AssignmentId::from(sr25519::Pair::generate().0.public()));
569

Shawn Tabrizi's avatar
Shawn Tabrizi committed
570
571
		accounts
			.iter()
572
573
574
575
576
577
578
579
580
581
			.map(|k| AssignmentId::from(k.public()))
			.chain(gen_random)
			.collect()
	}

	fn basic_groups(n_validators: usize, n_groups: usize) -> Vec<Vec<ValidatorIndex>> {
		let size = n_validators / n_groups;
		let big_groups = n_validators % n_groups;
		let scraps = n_groups * size;

Shawn Tabrizi's avatar
Shawn Tabrizi committed
582
583
584
585
586
587
588
589
		(0..n_groups)
			.map(|i| {
				(i * size..(i + 1) * size)
					.chain(if i < big_groups { Some(scraps + i) } else { None })
					.map(|j| ValidatorIndex(j as _))
					.collect::<Vec<_>>()
			})
			.collect()
590
591
592
593
594
595
596
597
598
599
600
601
602
	}

	// used for generating assignments where the validity of the VRF doesn't matter.
	fn garbage_vrf() -> (VRFOutput, VRFProof) {
		let key = Sr25519Keyring::Alice.pair();
		let key: &schnorrkel::Keypair = key.as_ref();

		let (o, p, _) = key.vrf_sign(Transcript::new(b"test-garbage"));
		(VRFOutput(o.to_output()), VRFProof(p))
	}

	#[test]
	fn assignments_produced_for_non_backing() {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
603
		let keystore = futures::executor::block_on(make_keystore(&[Sr25519Keyring::Alice]));
604

605
606
607
		let c_a = CandidateHash(Hash::repeat_byte(0));
		let c_b = CandidateHash(Hash::repeat_byte(1));

608
609
610
611
612
613
614
615
616
617
		let relay_vrf_story = RelayVRFStory([42u8; 32]);
		let assignments = compute_assignments(
			&keystore,
			relay_vrf_story,
			&Config {
				assignment_keys: assignment_keys(&[
					Sr25519Keyring::Alice,
					Sr25519Keyring::Bob,
					Sr25519Keyring::Charlie,
				]),
Shawn Tabrizi's avatar
Shawn Tabrizi committed
618
619
620
621
				validator_groups: vec![
					vec![ValidatorIndex(0)],
					vec![ValidatorIndex(1), ValidatorIndex(2)],
				],
622
623
624
625
626
				n_cores: 2,
				zeroth_delay_tranche_width: 10,
				relay_vrf_modulo_samples: 3,
				n_delay_tranches: 40,
			},
627
			vec![(c_a, CoreIndex(0), GroupIndex(1)), (c_b, CoreIndex(1), GroupIndex(0))],
628
629
630
631
632
633
634
635
636
637
		);

		// Note that alice is in group 0, which was the backing group for core 1.
		// Alice should have self-assigned to check core 0 but not 1.
		assert_eq!(assignments.len(), 1);
		assert!(assignments.get(&CoreIndex(0)).is_some());
	}

	#[test]
	fn assign_to_nonzero_core() {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
638
		let keystore = futures::executor::block_on(make_keystore(&[Sr25519Keyring::Alice]));
639

640
641
642
		let c_a = CandidateHash(Hash::repeat_byte(0));
		let c_b = CandidateHash(Hash::repeat_byte(1));

643
644
645
646
647
648
649
650
651
652
		let relay_vrf_story = RelayVRFStory([42u8; 32]);
		let assignments = compute_assignments(
			&keystore,
			relay_vrf_story,
			&Config {
				assignment_keys: assignment_keys(&[
					Sr25519Keyring::Alice,
					Sr25519Keyring::Bob,
					Sr25519Keyring::Charlie,
				]),
Shawn Tabrizi's avatar
Shawn Tabrizi committed
653
654
655
656
				validator_groups: vec![
					vec![ValidatorIndex(0)],
					vec![ValidatorIndex(1), ValidatorIndex(2)],
				],
657
658
659
660
661
				n_cores: 2,
				zeroth_delay_tranche_width: 10,
				relay_vrf_modulo_samples: 3,
				n_delay_tranches: 40,
			},
662
			vec![(c_a, CoreIndex(0), GroupIndex(0)), (c_b, CoreIndex(1), GroupIndex(1))],
663
664
665
666
667
668
		);

		assert_eq!(assignments.len(), 1);
		assert!(assignments.get(&CoreIndex(1)).is_some());
	}

669
670
	#[test]
	fn succeeds_empty_for_0_cores() {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
671
		let keystore = futures::executor::block_on(make_keystore(&[Sr25519Keyring::Alice]));
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694

		let relay_vrf_story = RelayVRFStory([42u8; 32]);
		let assignments = compute_assignments(
			&keystore,
			relay_vrf_story,
			&Config {
				assignment_keys: assignment_keys(&[
					Sr25519Keyring::Alice,
					Sr25519Keyring::Bob,
					Sr25519Keyring::Charlie,
				]),
				validator_groups: vec![],
				n_cores: 0,
				zeroth_delay_tranche_width: 10,
				relay_vrf_modulo_samples: 3,
				n_delay_tranches: 40,
			},
			vec![],
		);

		assert!(assignments.is_empty());
	}

695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
	struct MutatedAssignment {
		core: CoreIndex,
		cert: AssignmentCert,
		group: GroupIndex,
		own_group: GroupIndex,
		val_index: ValidatorIndex,
		config: Config,
	}

	// This fails if the closure requests to skip everything.
	fn check_mutated_assignments(
		n_validators: usize,
		n_cores: usize,
		rotation_offset: usize,
		f: impl Fn(&mut MutatedAssignment) -> Option<bool>, // None = skip
	) {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
711
		let keystore = futures::executor::block_on(make_keystore(&[Sr25519Keyring::Alice]));
712
713
714
715

		let group_for_core = |i| GroupIndex(((i + rotation_offset) % n_cores) as _);

		let config = Config {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
716
717
718
719
			assignment_keys: assignment_keys_plus_random(
				&[Sr25519Keyring::Alice],
				n_validators - 1,
			),
720
721
722
723
724
725
726
727
728
729
730
731
732
			validator_groups: basic_groups(n_validators, n_cores),
			n_cores: n_cores as u32,
			zeroth_delay_tranche_width: 10,
			relay_vrf_modulo_samples: 3,
			n_delay_tranches: 40,
		};

		let relay_vrf_story = RelayVRFStory([42u8; 32]);
		let assignments = compute_assignments(
			&keystore,
			relay_vrf_story.clone(),
			&config,
			(0..n_cores)
Shawn Tabrizi's avatar
Shawn Tabrizi committed
733
734
735
736
737
738
739
				.map(|i| {
					(
						CandidateHash(Hash::repeat_byte(i as u8)),
						CoreIndex(i as u32),
						group_for_core(i),
					)
				})
740
741
742
743
744
745
746
747
748
749
				.collect::<Vec<_>>(),
		);

		let mut counted = 0;
		for (core, assignment) in assignments {
			let mut mutated = MutatedAssignment {
				core,
				group: group_for_core(core.0 as _),
				cert: assignment.cert,
				own_group: GroupIndex(0),
750
				val_index: ValidatorIndex(0),
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
				config: config.clone(),
			};

			let expected = match f(&mut mutated) {
				None => continue,
				Some(e) => e,
			};

			counted += 1;

			let is_good = check_assignment_cert(
				mutated.core,
				mutated.val_index,
				&mutated.config,
				relay_vrf_story.clone(),
				&mutated.cert,
				mutated.group,
Shawn Tabrizi's avatar
Shawn Tabrizi committed
768
769
			)
			.is_ok();
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800

			assert_eq!(expected, is_good)
		}

		assert!(counted > 0);
	}

	#[test]
	fn computed_assignments_pass_checks() {
		check_mutated_assignments(200, 100, 25, |_| Some(true));
	}

	#[test]
	fn check_rejects_claimed_core_out_of_bounds() {
		check_mutated_assignments(200, 100, 25, |m| {
			m.core.0 += 100;
			Some(false)
		});
	}

	#[test]
	fn check_rejects_in_backing_group() {
		check_mutated_assignments(200, 100, 25, |m| {
			m.group = m.own_group;
			Some(false)
		});
	}

	#[test]
	fn check_rejects_nonexistent_key() {
		check_mutated_assignments(200, 100, 25, |m| {
801
			m.val_index.0 += 200;
802
803
804
805
806
807
808
809
810
811
812
			Some(false)
		});
	}

	#[test]
	fn check_rejects_delay_bad_vrf() {
		check_mutated_assignments(40, 10, 8, |m| {
			match m.cert.kind.clone() {
				AssignmentCertKind::RelayVRFDelay { .. } => {
					m.cert.vrf = garbage_vrf();
					Some(false)
Shawn Tabrizi's avatar
Shawn Tabrizi committed
813
				},
814
815
816
817
818
819
820
821
822
823
824
825
				_ => None, // skip everything else.
			}
		});
	}

	#[test]
	fn check_rejects_modulo_bad_vrf() {
		check_mutated_assignments(200, 100, 25, |m| {
			match m.cert.kind.clone() {
				AssignmentCertKind::RelayVRFModulo { .. } => {
					m.cert.vrf = garbage_vrf();
					Some(false)
Shawn Tabrizi's avatar
Shawn Tabrizi committed
826
				},
827
828
829
830
831
832
833
834
835
836
837
838
				_ => None, // skip everything else.
			}
		});
	}

	#[test]
	fn check_rejects_modulo_sample_out_of_bounds() {
		check_mutated_assignments(200, 100, 25, |m| {
			match m.cert.kind.clone() {
				AssignmentCertKind::RelayVRFModulo { sample } => {
					m.config.relay_vrf_modulo_samples = sample;
					Some(false)
Shawn Tabrizi's avatar
Shawn Tabrizi committed
839
				},
840
841
842
843
844
845
846
847
848
849
850
851
				_ => None, // skip everything else.
			}
		});
	}

	#[test]
	fn check_rejects_delay_claimed_core_wrong() {
		check_mutated_assignments(200, 100, 25, |m| {
			match m.cert.kind.clone() {
				AssignmentCertKind::RelayVRFDelay { .. } => {
					m.core = CoreIndex((m.core.0 + 1) % 100);
					Some(false)
Shawn Tabrizi's avatar
Shawn Tabrizi committed
852
				},
853
854
855
856
857
858
859
860
861
862
863
864
				_ => None, // skip everything else.
			}
		});
	}

	#[test]
	fn check_rejects_modulo_core_wrong() {
		check_mutated_assignments(200, 100, 25, |m| {
			match m.cert.kind.clone() {
				AssignmentCertKind::RelayVRFModulo { .. } => {
					m.core = CoreIndex((m.core.0 + 1) % 100);
					Some(false)
Shawn Tabrizi's avatar
Shawn Tabrizi committed
865
				},
866
867
868
869
870
				_ => None, // skip everything else.
			}
		});
	}
}