Add candidate info to OccupiedCore (#2134)

* guide: add candidate information to OccupiedCore

* add descriptor and hash to occupied core type

* guide: add candidate hash to inclusion

* runtime: return candidate info in core state

* bitfield signing: stop querying runtime as much

* minimize going to runtime in availability distribution

* fix availability distribution tests

* guide: remove para ID from Occupied core

* get all crates compiling

polkadot/node/network/availability-distribution/src/lib.rs

@@ -36,7 +36,7 @@ use polkadot_node_network_protocol::{
 };
 use polkadot_node_subsystem_util::metrics::{self, prometheus};
 use polkadot_primitives::v1::{
-	BlakeTwo256, CommittedCandidateReceipt, CoreState, ErasureChunk, Hash, HashT, Id as ParaId,
+	BlakeTwo256, CoreState, ErasureChunk, Hash, HashT,
 	SessionIndex, ValidatorId, ValidatorIndex, PARACHAIN_KEY_TYPE_ID, CandidateHash,
 	CandidateDescriptor,
 };
@@ -62,11 +62,6 @@ const LOG_TARGET: &'static str = "availability_distribution";
 
 #[derive(Debug, Error)]
 enum Error {
-	#[error("Response channel to obtain PendingAvailability failed")]
-	QueryPendingAvailabilityResponseChannel(#[source] oneshot::Canceled),
-	#[error("RuntimeAPI to obtain PendingAvailability failed")]
-	QueryPendingAvailability(#[source] RuntimeApiError),
-
 	#[error("Response channel to obtain StoreChunk failed")]
 	StoreChunkResponseChannel(#[source] oneshot::Canceled),
 
@@ -795,19 +790,12 @@ where
 			e => e.or_default(),
 		};
 
-		for para in query_para_ids(ctx, relay_parent).await? {
-			if let Some(ccr) = query_pending_availability(ctx, relay_parent, para).await? {
-				let receipt_hash = ccr.hash();
-				let descriptor = ccr.descriptor().clone();
-
-				// unfortunately we have no good way of telling the candidate was
-				// cached until now. But we don't clobber a `Cached` entry if there
-				// is one already.
-				live_candidates.entry(receipt_hash)
-					.or_insert(FetchedLiveCandidate::Fresh(descriptor));
-
-				receipts_for.insert(receipt_hash);
-			}
+		for (receipt_hash, descriptor) in query_pending_availability(ctx, relay_parent).await? {
+			// unfortunately we have no good way of telling the candidate was
+			// cached until now. But we don't clobber a `Cached` entry if there
+			// is one already.
+			live_candidates.entry(receipt_hash).or_insert(FetchedLiveCandidate::Fresh(descriptor));
+			receipts_for.insert(receipt_hash);
 		}
 	}
 
@@ -850,9 +838,10 @@ where
 	Ok((live_candidates, ancestors))
 }
 
-/// Query all para IDs that are occupied under a given relay-parent.
+/// Query all hashes and descriptors of candidates pending availability at a particular block.
 #[tracing::instrument(level = "trace", skip(ctx), fields(subsystem = LOG_TARGET))]
-async fn query_para_ids<Context>(ctx: &mut Context, relay_parent: Hash) -> Result<Vec<ParaId>>
+async fn query_pending_availability<Context>(ctx: &mut Context, relay_parent: Hash)
+	-> Result<Vec<(CandidateHash, CandidateDescriptor)>>
 where
 	Context: SubsystemContext<Message = AvailabilityDistributionMessage>,
 {
@@ -863,22 +852,18 @@ where
 	)))
 	.await;
 
-	let all_para_ids = rx
+	let cores: Vec<_> = rx
 		.await
 		.map_err(|e| Error::AvailabilityCoresResponseChannel(e))?
 		.map_err(|e| Error::AvailabilityCores(e))?;
 
-	let occupied_para_ids = all_para_ids
-		.into_iter()
-		.filter_map(|core_state| {
-			if let CoreState::Occupied(occupied) = core_state {
-				Some(occupied.para_id)
-			} else {
-				None
-			}
+	Ok(cores.into_iter()
+		.filter_map(|core_state| if let CoreState::Occupied(occupied) = core_state {
+			Some((occupied.candidate_hash, occupied.candidate_descriptor))
+		} else {
+			None
 		})
-		.collect();
-	Ok(occupied_para_ids)
+		.collect())
 }
 
 /// Modify the reputation of a peer based on its behavior.
@@ -954,27 +939,6 @@ where
 	rx.await.map_err(|e| Error::StoreChunkResponseChannel(e))
 }
 
-/// Request the head data for a particular para.
-#[tracing::instrument(level = "trace", skip(ctx), fields(subsystem = LOG_TARGET))]
-async fn query_pending_availability<Context>(
-	ctx: &mut Context,
-	relay_parent: Hash,
-	para: ParaId,
-) -> Result<Option<CommittedCandidateReceipt>>
-where
-	Context: SubsystemContext<Message = AvailabilityDistributionMessage>,
-{
-	let (tx, rx) = oneshot::channel();
-	ctx.send_message(AllMessages::RuntimeApi(RuntimeApiMessage::Request(
-		relay_parent,
-		RuntimeApiRequest::CandidatePendingAvailability(para, tx),
-	))).await;
-
-	rx.await
-		.map_err(|e| Error::QueryPendingAvailabilityResponseChannel(e))?
-		.map_err(|e| Error::QueryPendingAvailability(e))
-}
-
 /// Query the validator set.
 #[tracing::instrument(level = "trace", skip(ctx), fields(subsystem = LOG_TARGET))]
 async fn query_validators<Context>(

polkadot/node/network/availability-distribution/src/tests.rs

@@ -21,7 +21,8 @@ use polkadot_node_network_protocol::{view, ObservedRole};
 use polkadot_node_subsystem_util::TimeoutExt;
 use polkadot_primitives::v1::{
 	AvailableData, BlockData, CandidateCommitments, CandidateDescriptor, GroupIndex,
-	GroupRotationInfo, HeadData, OccupiedCore, PersistedValidationData, PoV, ScheduledCore,
+	GroupRotationInfo, HeadData, OccupiedCore, PersistedValidationData, PoV, ScheduledCore, Id as ParaId,
+	CommittedCandidateReceipt,
 };
 use polkadot_subsystem_testhelpers as test_helpers;
 
@@ -29,6 +30,7 @@ use futures::{executor, future, Future};
 use sc_keystore::LocalKeystore;
 use sp_application_crypto::AppKey;
 use sp_keystore::{SyncCryptoStore, SyncCryptoStorePtr};
+use sp_keyring::Sr25519Keyring;
 use std::{sync::Arc, time::Duration};
 use maplit::hashmap;
 
@@ -95,20 +97,19 @@ async fn overseer_recv(
 	msg
 }
 
-fn dummy_occupied_core(para: ParaId) -> CoreState {
+fn occupied_core_from_candidate(receipt: &CommittedCandidateReceipt) -> CoreState {
 	CoreState::Occupied(OccupiedCore {
-		para_id: para,
 		next_up_on_available: None,
 		occupied_since: 0,
 		time_out_at: 5,
 		next_up_on_time_out: None,
 		availability: Default::default(),
 		group_responsible: GroupIndex::from(0),
+		candidate_hash: receipt.hash(),
+		candidate_descriptor: receipt.descriptor().clone(),
 	})
 }
 
-use sp_keyring::Sr25519Keyring;
-
 #[derive(Clone)]
 struct TestState {
 	chain_ids: Vec<ParaId>,
@@ -388,7 +389,6 @@ async fn change_our_view(
 	ancestors: Vec<Hash>,
 	session_per_relay_parent: HashMap<Hash, SessionIndex>,
 	availability_cores_per_relay_parent: HashMap<Hash, Vec<CoreState>>,
-	candidate_pending_availabilities_per_relay_parent: HashMap<Hash, Vec<CommittedCandidateReceipt>>,
 	data_availability: HashMap<CandidateHash, bool>,
 	chunk_data_per_candidate: HashMap<CandidateHash, (PoV, PersistedValidationData)>,
 	send_chunks_to: HashMap<CandidateHash, Vec<PeerId>>,
@@ -436,7 +436,7 @@ async fn change_our_view(
 	}
 
 	for _ in 0..availability_cores_per_relay_parent.len() {
-		let relay_parent = assert_matches!(
+		assert_matches!(
 			overseer_recv(virtual_overseer).await,
 			AllMessages::RuntimeApi(RuntimeApiMessage::Request(
 				relay_parent,
@@ -446,30 +446,8 @@ async fn change_our_view(
 					.expect(&format!("Availability core for relay parent {:?} does not exist", relay_parent));
 
 				tx.send(Ok(cores.clone())).unwrap();
-				relay_parent
 			}
 		);
-
-		let pending_availability = candidate_pending_availabilities_per_relay_parent.get(&relay_parent)
-			.expect(&format!("Candidate pending availability for relay parent {:?} does not exist", relay_parent));
-
-		for _ in 0..pending_availability.len() {
-			assert_matches!(
-				overseer_recv(virtual_overseer).await,
-				AllMessages::RuntimeApi(RuntimeApiMessage::Request(
-					hash,
-					RuntimeApiRequest::CandidatePendingAvailability(para, tx)
-				)) => {
-					assert_eq!(relay_parent, hash);
-
-					let candidate = pending_availability.iter()
-						.find(|c| c.descriptor.para_id == para)
-						.expect(&format!("Pending candidate for para {} does not exist", para));
-
-					tx.send(Ok(Some(candidate.clone()))).unwrap();
-				}
-			);
-		}
 	}
 
 	for _ in 0..data_availability.len() {
@@ -571,7 +549,6 @@ fn check_views() {
 		let mut virtual_overseer = test_harness.virtual_overseer;
 
 		let TestState {
-			chain_ids,
 			validator_public,
 			relay_parent: current,
 			ancestors,
@@ -588,36 +565,37 @@ fn check_views() {
 			vec![ancestors[0], genesis],
 			hashmap! { current => 1, genesis => 1 },
 			hashmap! {
-				ancestors[0] => vec![dummy_occupied_core(chain_ids[0]), dummy_occupied_core(chain_ids[1])],
+				ancestors[0] => vec![
+					occupied_core_from_candidate(&candidates[0]),
+					occupied_core_from_candidate(&candidates[1]),
+				],
 				current => vec![
 					CoreState::Occupied(OccupiedCore {
-						para_id: chain_ids[0].clone(),
 						next_up_on_available: None,
 						occupied_since: 0,
 						time_out_at: 10,
 						next_up_on_time_out: None,
 						availability: Default::default(),
 						group_responsible: GroupIndex::from(0),
+						candidate_hash: candidates[0].hash(),
+						candidate_descriptor: candidates[0].descriptor().clone(),
 					}),
 					CoreState::Free,
 					CoreState::Free,
 					CoreState::Occupied(OccupiedCore {
-						para_id: chain_ids[1].clone(),
 						next_up_on_available: None,
 						occupied_since: 1,
 						time_out_at: 7,
 						next_up_on_time_out: None,
 						availability: Default::default(),
 						group_responsible: GroupIndex::from(0),
+						candidate_hash: candidates[1].hash(),
+						candidate_descriptor: candidates[1].descriptor().clone(),
 					}),
 					CoreState::Free,
 					CoreState::Free,
 				]
 			},
-			hashmap! {
-				ancestors[0] => vec![candidates[0].clone(), candidates[1].clone()],
-				current => vec![candidates[0].clone(), candidates[1].clone()],
-			},
 			hashmap! {
 				candidates[0].hash() => true,
 				candidates[1].hash() => false,
@@ -690,11 +668,10 @@ fn reputation_verification() {
 			hashmap! { current => 1 },
 			hashmap! {
 				current => vec![
-					dummy_occupied_core(candidates[0].descriptor.para_id),
-					dummy_occupied_core(candidates[1].descriptor.para_id)
+					occupied_core_from_candidate(&candidates[0]),
+					occupied_core_from_candidate(&candidates[1]),
 				],
 			},
-			hashmap! { current => vec![candidates[0].clone(), candidates[1].clone()] },
 			hashmap! { candidates[0].hash() => true, candidates[1].hash() => false },
 			hashmap! { candidates[0].hash() => (pov_blocks[0].clone(), test_state.persisted_validation_data.clone())},
 			hashmap! {},
@@ -783,10 +760,9 @@ fn not_a_live_candidate_is_detected() {
 			hashmap! { current => 1 },
 			hashmap! {
 				current => vec![
-					dummy_occupied_core(candidates[0].descriptor.para_id),
+					occupied_core_from_candidate(&candidates[0]),
 				],
 			},
-			hashmap! { current => vec![candidates[0].clone()] },
 			hashmap! { candidates[0].hash() => true },
 			hashmap! { candidates[0].hash() => (pov_blocks[0].clone(), test_state.persisted_validation_data.clone())},
 			hashmap! {},
@@ -832,10 +808,9 @@ fn peer_change_view_before_us() {
 			hashmap! { current => 1 },
 			hashmap! {
 				current => vec![
-					dummy_occupied_core(candidates[0].descriptor.para_id),
+					occupied_core_from_candidate(&candidates[0]),
 				],
 			},
-			hashmap! { current => vec![candidates[0].clone()] },
 			hashmap! { candidates[0].hash() => true },
 			hashmap! { candidates[0].hash() => (pov_blocks[0].clone(), test_state.persisted_validation_data.clone())},
 			hashmap! { candidates[0].hash() => vec![peer_a.clone()] },
@@ -880,10 +855,9 @@ fn candidate_chunks_are_put_into_message_vault_when_candidate_is_first_seen() {
 			hashmap! { ancestors[0] => 1 },
 			hashmap! {
 				ancestors[0] => vec![
-					dummy_occupied_core(candidates[0].descriptor.para_id),
+					occupied_core_from_candidate(&candidates[0]),
 				],
 			},
-			hashmap! { ancestors[0] => vec![candidates[0].clone()] },
 			hashmap! { candidates[0].hash() => true },
 			hashmap! { candidates[0].hash() => (pov_blocks[0].clone(), test_state.persisted_validation_data.clone())},
 			hashmap! {},
@@ -897,10 +871,9 @@ fn candidate_chunks_are_put_into_message_vault_when_candidate_is_first_seen() {
 			hashmap! { current => 1 },
 			hashmap! {
 				current => vec![
-					dummy_occupied_core(candidates[0].descriptor.para_id),
+					occupied_core_from_candidate(&candidates[0]),
 				],
 			},
-			hashmap! { current => vec![candidates[0].clone()] },
 			hashmap! { candidates[0].hash() => true },
 			hashmap! {},
 			hashmap! {},
@@ -1168,50 +1141,28 @@ fn query_pending_availability_at_pulls_from_and_updates_receipts() {
 			) if r == hash_b => {
 				let _ = tx.send(Ok(vec![
 					CoreState::Occupied(OccupiedCore {
-						para_id: para_b,
 						next_up_on_available: None,
 						occupied_since: 0,
 						time_out_at: 0,
 						next_up_on_time_out: None,
 						availability: Default::default(),
 						group_responsible: GroupIndex::from(0),
+						candidate_hash: candidate_hash_b,
+						candidate_descriptor: candidate_b.descriptor.clone(),
 					}),
 					CoreState::Occupied(OccupiedCore {
-						para_id: para_c,
 						next_up_on_available: None,
 						occupied_since: 0,
 						time_out_at: 0,
 						next_up_on_time_out: None,
 						availability: Default::default(),
 						group_responsible: GroupIndex::from(0),
+						candidate_hash: candidate_hash_c,
+						candidate_descriptor: candidate_c.descriptor.clone(),
 					}),
 				]));
 			}
 		);
-
-		assert_matches!(
-			overseer_recv(&mut virtual_overseer).await,
-			AllMessages::RuntimeApi(
-				RuntimeApiMessage::Request(
-					r,
-					RuntimeApiRequest::CandidatePendingAvailability(p, tx),
-				)
-			) if r == hash_b && p == para_b => {
-				let _ = tx.send(Ok(Some(candidate_b)));
-			}
-		);
-
-		assert_matches!(
-			overseer_recv(&mut virtual_overseer).await,
-			AllMessages::RuntimeApi(
-				RuntimeApiMessage::Request(
-					r,
-					RuntimeApiRequest::CandidatePendingAvailability(p, tx),
-				)
-			) if r == hash_b && p == para_c => {
-				let _ = tx.send(Ok(Some(candidate_c)));
-			}
-		);
 	};
 
 	futures::pin_mut!(test_fut);
@@ -1256,11 +1207,10 @@ fn new_peer_gets_all_chunks_send() {
 			hashmap! { current => 1 },
 			hashmap! {
 				current => vec![
-					dummy_occupied_core(candidates[0].descriptor.para_id),
-					dummy_occupied_core(candidates[1].descriptor.para_id)
+					occupied_core_from_candidate(&candidates[0]),
+					occupied_core_from_candidate(&candidates[1])
 				],
 			},
-			hashmap! { current => vec![candidates[0].clone(), candidates[1].clone()] },
 			hashmap! { candidates[0].hash() => true, candidates[1].hash() => false },
 			hashmap! { candidates[0].hash() => (pov_blocks[0].clone(), test_state.persisted_validation_data.clone())},
 			hashmap! {},