Minimal parachains part 2: Parachain statement and data routing (#173)

* dynamic inclusion threshold calculator * collators interface * collation helpers * initial proposal-creation future * create proposer when asked to propose * remove local_availability duty * statement table tracks includable parachain count * beginnings of timing future * finish proposal logic * remove stray println * extract shared table to separate module * change ordering * includability tracking * fix doc * initial changes to parachains module * initialise dummy block before API calls * give polkadot control over round proposer based on random seed * propose only after enough candidates * flesh out parachains module a bit more * set_heads * actually introduce set_heads to runtime * update block_builder to accept parachains * split block validity errors from real errors in evaluation * update WASM runtimes * polkadot-api methods for parachains additions * delay evaluation until candidates are ready * comments * fix dynamic inclusion with zero initial * test for includability tracker * wasm validation of parachain candidates * move primitives to primitives crate * remove runtime-std dependency from codec * adjust doc * polkadot-parachain-primitives * kill legacy polkadot-validator crate * basic-add test chain * test for basic_add parachain * move to test-chains dir * use wasm-build * new wasm directory layout * reorganize a bit more * Fix for rh-minimal-parachain (#141) * Remove extern "C" We already encountered such behavior (bug?) in pwasm-std, I believe. * Fix `panic_fmt` signature by adding `_col` Wrong `panic_fmt` signature can inhibit some optimizations in LTO mode. * Add linker flags and use wasm-gc in build script Pass --import-memory to LLD to emit wasm binary with imported memory. Also use wasm-gc instead of wasm-build. * Fix effective_max. I'm not sure why it was the way it was actually. * Recompile wasm. * Fix indent * more basic_add tests * validate parachain WASM * produce statements on receiving statements * tests for reactive statement production * fix build * add OOM lang item to runtime-io * use dynamic_inclusion when evaluating as well * fix update_includable_count * remove dead code * grumbles * actually defer round_proposer logic * update wasm * address a few more grumbles * schedule collation work as soon as BFT is started * impl future in collator * fix comment * governance proposals for adding and removing parachains * bump protocol version * tear out polkadot-specific pieces of substrate-network * extract out polkadot-specific stuff from substrate-network * begin polkadot network subsystem * grumbles * update WASM checkins * parse status from polkadot peer * allow invoke of network specialization * begin statement router implementation * remove dependency on tokio-timer * fix sanity check and have proposer factory create communication streams * pull out statement routing from consensus library * fix comments * adjust typedefs * extract consensus_gossip out of main network protocol handler * port substrate-bft to new tokio * port polkadot-consensus to new tokio * fix typo * start message processing task * initial consensus network implementation * remove known tracking from statement-table crate * extract router into separate module * defer statements until later * double signature is invalid * propagating statements * grumbles * request block data * fix compilation * embed new consensus network into service * port demo CLI to tokio * all test crates compile * some tests for fetching block data * whitespace * adjusting some tokio stuff * update exit-future * remove overly noisy warning * clean up collation work a bit * address review grumbles * fix lock order in protocol handler * rebuild wasm artifacts * tag AuthorityId::from_slice for std only * address formatting grumbles * rename event_loop to executor * some more docs for polkadot-network crate
2026-05-30 19:51:02 +00:00 · 2018-07-06 14:17:03 +02:00
parent b8115b257f
commit 6bfcbd6d59
28 changed files with 2212 additions and 1131 deletions
@@ -0,0 +1,204 @@
+// Copyright 2018 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/>.
+
+//! Tests for polkadot and consensus network.
+
+use super::{PolkadotProtocol, Status, CurrentConsensus, Knowledge, Message, FullStatus};
+
+use parking_lot::Mutex;
+use polkadot_consensus::GenericStatement;
+use polkadot_primitives::{Block, Hash, SessionKey};
+use polkadot_primitives::parachain::{CandidateReceipt, HeadData, BlockData};
+use codec::Slicable;
+use substrate_network::{PeerId, PeerInfo, ClientHandle, Context, message::Message as SubstrateMessage, message::Role, specialization::Specialization, generic_message::Message as GenericMessage};
+
+use std::sync::Arc;
+use futures::Future;
+
+#[derive(Default)]
+struct TestContext {
+	disabled: Vec<PeerId>,
+	disconnected: Vec<PeerId>,
+	messages: Vec<(PeerId, SubstrateMessage<Block>)>,
+}
+
+impl Context<Block> for TestContext {
+	fn client(&self) -> &ClientHandle<Block> {
+		unimplemented!()
+	}
+
+	fn disable_peer(&mut self, peer: PeerId) {
+		self.disabled.push(peer);
+	}
+
+	fn disconnect_peer(&mut self, peer: PeerId) {
+		self.disconnected.push(peer);
+	}
+
+	fn peer_info(&self, _peer: PeerId) -> Option<PeerInfo<Block>> {
+		unimplemented!()
+	}
+
+	fn send_message(&mut self, peer_id: PeerId, data: SubstrateMessage<Block>) {
+		self.messages.push((peer_id, data))
+	}
+}
+
+impl TestContext {
+	fn has_message(&self, to: PeerId, message: Message) -> bool {
+		use substrate_network::generic_message::Message as GenericMessage;
+
+		let encoded = ::serde_json::to_vec(&message).unwrap();
+		self.messages.iter().any(|&(ref peer, ref msg)| match msg {
+			GenericMessage::ChainSpecific(ref data) => peer == &to && data == &encoded,
+			_ => false,
+		})
+	}
+}
+
+fn make_status(status: &Status, roles: Vec<Role>) -> FullStatus {
+	FullStatus {
+		version: 1,
+		roles,
+		best_number: 0,
+		best_hash: Default::default(),
+		genesis_hash: Default::default(),
+		chain_status: status.encode(),
+	}
+}
+
+fn make_consensus(parent_hash: Hash, local_key: SessionKey) -> (CurrentConsensus, Arc<Mutex<Knowledge>>) {
+	let knowledge = Arc::new(Mutex::new(Knowledge::new()));
+	let c = CurrentConsensus {
+		knowledge: knowledge.clone(),
+		parent_hash,
+		session_keys: Default::default(),
+		local_session_key: local_key,
+	};
+
+	(c, knowledge)
+}
+
+fn on_message(protocol: &mut PolkadotProtocol, ctx: &mut TestContext, from: PeerId, message: Message) {
+	let encoded = ::serde_json::to_vec(&message).unwrap();
+	protocol.on_message(ctx, from, GenericMessage::ChainSpecific(encoded));
+}
+
+#[test]
+fn sends_session_key() {
+	let mut protocol = PolkadotProtocol::new();
+
+	let peer_a = 1;
+	let peer_b = 2;
+	let parent_hash = [0; 32].into();
+	let local_key = [1; 32].into();
+
+	let status = Status { collating_for: None };
+
+	{
+		let mut ctx = TestContext::default();
+		protocol.on_connect(&mut ctx, peer_a, make_status(&status, vec![Role::Authority]));
+		assert!(ctx.messages.is_empty());
+	}
+
+	{
+		let mut ctx = TestContext::default();
+		let (consensus, _knowledge) = make_consensus(parent_hash, local_key);
+		protocol.new_consensus(&mut ctx, consensus);
+
+		assert!(ctx.has_message(peer_a, Message::SessionKey(parent_hash, local_key)));
+	}
+
+	{
+		let mut ctx = TestContext::default();
+		protocol.on_connect(&mut ctx, peer_b, make_status(&status, vec![Role::Authority]));
+		assert!(ctx.has_message(peer_b, Message::SessionKey(parent_hash, local_key)));
+	}
+}
+
+#[test]
+fn fetches_from_those_with_knowledge() {
+	let mut protocol = PolkadotProtocol::new();
+
+	let peer_a = 1;
+	let peer_b = 2;
+	let parent_hash = [0; 32].into();
+	let local_key = [1; 32].into();
+
+	let block_data = BlockData(vec![1, 2, 3, 4]);
+	let block_data_hash = block_data.hash();
+	let candidate_receipt = CandidateReceipt {
+		parachain_index: 5.into(),
+		collator: [255; 32].into(),
+		head_data: HeadData(vec![9, 9, 9]),
+		balance_uploads: Vec::new(),
+		egress_queue_roots: Vec::new(),
+		fees: 1_000_000,
+		block_data_hash,
+	};
+
+	let candidate_hash = candidate_receipt.hash();
+	let a_key = [3; 32].into();
+	let b_key = [4; 32].into();
+
+	let status = Status { collating_for: None };
+
+	let (consensus, knowledge) = make_consensus(parent_hash, local_key);
+	protocol.new_consensus(&mut TestContext::default(), consensus);
+
+	knowledge.lock().note_statement(a_key, &GenericStatement::Valid(candidate_hash));
+	let recv = protocol.fetch_block_data(&mut TestContext::default(), &candidate_receipt, parent_hash);
+
+	// connect peer A
+	{
+		let mut ctx = TestContext::default();
+		protocol.on_connect(&mut ctx, peer_a, make_status(&status, vec![Role::Authority]));
+		assert!(ctx.has_message(peer_a, Message::SessionKey(parent_hash, local_key)));
+	}
+
+	// peer A gives session key and gets asked for data.
+	{
+		let mut ctx = TestContext::default();
+		on_message(&mut protocol, &mut ctx, peer_a, Message::SessionKey(parent_hash, a_key));
+		assert!(ctx.has_message(peer_a, Message::RequestBlockData(1, candidate_hash)));
+	}
+
+	knowledge.lock().note_statement(b_key, &GenericStatement::Valid(candidate_hash));
+
+	// peer B connects and sends session key. request already assigned to A
+	{
+		let mut ctx = TestContext::default();
+		protocol.on_connect(&mut ctx, peer_b, make_status(&status, vec![Role::Authority]));
+		on_message(&mut protocol, &mut ctx, peer_b, Message::SessionKey(parent_hash, b_key));
+		assert!(!ctx.has_message(peer_b, Message::RequestBlockData(2, candidate_hash)));
+
+	}
+
+	// peer A disconnects, triggering reassignment
+	{
+		let mut ctx = TestContext::default();
+		protocol.on_disconnect(&mut ctx, peer_a);
+		assert!(ctx.has_message(peer_b, Message::RequestBlockData(2, candidate_hash)));
+	}
+
+	// peer B comes back with block data.
+	{
+		let mut ctx = TestContext::default();
+		on_message(&mut protocol, &mut ctx, peer_b, Message::BlockData(2, Some(block_data.clone())));
+		drop(protocol);
+		assert_eq!(recv.wait().unwrap(), block_data);
+	}
+}