pezkuwi-subxt/collator/src/lib.rs

// Copyright 2019 Parity Technologies (UK) Ltd.
// This file is part of Cumulus.

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

//! Cumulus Collator implementation for Substrate.

use cumulus_network::{
	DelayedBlockAnnounceValidator, JustifiedBlockAnnounceValidator, WaitToAnnounce,
};
use cumulus_primitives::{
	inherents::{
		DownwardMessagesType, DOWNWARD_MESSAGES_IDENTIFIER,
		VALIDATION_FUNCTION_PARAMS_IDENTIFIER as VFP_IDENT,
	},
	validation_function_params::ValidationFunctionParams,
	HeadData,
};
use cumulus_runtime::ParachainBlockData;

use sc_client_api::{Backend as BackendT, BlockBackend, Finalizer, StateBackend, UsageProvider};
use sp_blockchain::HeaderBackend;
use sp_consensus::{
	BlockImport, BlockImportParams, BlockOrigin, BlockStatus, Environment, Error as ConsensusError,
	ForkChoiceStrategy, Proposal, Proposer, RecordProof, SyncOracle,
};
use sp_core::traits::SpawnNamed;
use sp_inherents::{InherentData, InherentDataProviders};
use sp_runtime::{
	generic::BlockId,
	traits::{BlakeTwo256, Block as BlockT, Header as HeaderT},
};

use polkadot_collator::{
	BuildParachainContext, Network as CollatorNetwork, ParachainContext, RuntimeApiCollection,
};
use polkadot_primitives::v0::{
	self as parachain, Block as PBlock, BlockData, DownwardMessage, GlobalValidationData,
	Hash as PHash, Id as ParaId, LocalValidationData,
};

use codec::{Decode, Encode};

use log::{debug, error, trace};

use futures::prelude::*;

use std::{marker::PhantomData, pin::Pin, sync::Arc, time::Duration};

use parking_lot::Mutex;

/// The implementation of the Cumulus `Collator`.
pub struct Collator<Block: BlockT, PF, BI, BS> {
	proposer_factory: Arc<Mutex<PF>>,
	_phantom: PhantomData<Block>,
	inherent_data_providers: InherentDataProviders,
	collator_network: Arc<dyn CollatorNetwork>,
	block_import: Arc<Mutex<BI>>,
	block_status: Arc<BS>,
	wait_to_announce: Arc<Mutex<WaitToAnnounce<Block>>>,
}

impl<Block: BlockT, PF, BI, BS> Collator<Block, PF, BI, BS> {
	/// Create a new instance.
	fn new(
		proposer_factory: PF,
		inherent_data_providers: InherentDataProviders,
		collator_network: impl CollatorNetwork + Clone + 'static,
		block_import: BI,
		block_status: Arc<BS>,
		spawner: Arc<dyn SpawnNamed + Send + Sync>,
		announce_block: Arc<dyn Fn(Block::Hash, Vec<u8>) + Send + Sync>,
	) -> Self {
		let collator_network = Arc::new(collator_network);
		let wait_to_announce = Arc::new(Mutex::new(WaitToAnnounce::new(
			spawner,
			announce_block,
			collator_network.clone(),
		)));

		Self {
			proposer_factory: Arc::new(Mutex::new(proposer_factory)),
			inherent_data_providers,
			_phantom: PhantomData,
			collator_network,
			block_import: Arc::new(Mutex::new(block_import)),
			block_status,
			wait_to_announce,
		}
	}

	/// Get the inherent data with validation function parameters injected
	fn inherent_data(
		inherent_providers: InherentDataProviders,
		global_validation: GlobalValidationData,
		local_validation: LocalValidationData,
		downward_messages: DownwardMessagesType,
	) -> Option<InherentData> {
		let mut inherent_data = inherent_providers
			.create_inherent_data()
			.map_err(|e| {
				error!(
					target: "cumulus-collator",
					"Failed to create inherent data: {:?}",
					e,
				)
			})
			.ok()?;

		inherent_data
			.put_data(
				VFP_IDENT,
				&ValidationFunctionParams::from((global_validation, local_validation)),
			)
			.map_err(|e| {
				error!(
					target: "cumulus-collator",
					"Failed to put validation function params into inherent data: {:?}",
					e,
				)
			})
			.ok()?;

		inherent_data
			.put_data(DOWNWARD_MESSAGES_IDENTIFIER, &downward_messages)
			.map_err(|e| {
				error!(
					target: "cumulus-collator",
					"Failed to put downward messages into inherent data: {:?}",
					e,
				)
			})
			.ok()?;

		Some(inherent_data)
	}
}

impl<Block: BlockT, PF, BI, BS> Clone for Collator<Block, PF, BI, BS> {
	fn clone(&self) -> Self {
		Self {
			proposer_factory: self.proposer_factory.clone(),
			inherent_data_providers: self.inherent_data_providers.clone(),
			_phantom: PhantomData,
			collator_network: self.collator_network.clone(),
			block_import: self.block_import.clone(),
			block_status: self.block_status.clone(),
			wait_to_announce: self.wait_to_announce.clone(),
		}
	}
}

impl<Block, PF, BI, BS> Collator<Block, PF, BI, BS>
where
	Block: BlockT,
	PF: Environment<Block> + 'static + Send,
	PF::Proposer: Send,
	BI: BlockImport<
			Block,
			Error = ConsensusError,
			Transaction = <PF::Proposer as Proposer<Block>>::Transaction,
		> + Send
		+ Sync
		+ 'static,
	BS: BlockBackend<Block>,
{
	/// Checks the status of the given block hash in the Parachain.
	///
	/// Returns `true` if the block could be found and is good to be build on.
	fn check_block_status(&self, hash: Block::Hash) -> bool {
		match self.block_status.block_status(&BlockId::Hash(hash)) {
			Ok(BlockStatus::Queued) => {
				debug!(
					target: "cumulus-collator",
					"Skipping candidate production, because block `{:?}` is still queued for import.", hash,
				);
				false
			}
			Ok(BlockStatus::InChainWithState) => true,
			Ok(BlockStatus::InChainPruned) => {
				error!(
					target: "cumulus-collator",
					"Skipping candidate production, because block `{:?}` is already pruned!", hash,
				);
				false
			}
			Ok(BlockStatus::KnownBad) => {
				error!(
					target: "cumulus-collator",
					"Block `{}` is tagged as known bad and is included in the relay chain! Skipping candidate production!", hash,
				);
				false
			}
			Ok(BlockStatus::Unknown) => {
				debug!(
					target: "cumulus-collator",
					"Skipping candidate production, because block `{:?}` is unknown.", hash,
				);
				false
			}
			Err(e) => {
				error!(target: "cumulus-collator", "Failed to get block status of `{:?}`: {:?}", hash, e);
				false
			}
		}
	}
}

impl<Block, PF, BI, BS> ParachainContext for Collator<Block, PF, BI, BS>
where
	Block: BlockT,
	PF: Environment<Block> + 'static + Send,
	PF::Proposer: Send,
	BI: BlockImport<
			Block,
			Error = ConsensusError,
			Transaction = <PF::Proposer as Proposer<Block>>::Transaction,
		> + Send
		+ Sync
		+ 'static,
	BS: BlockBackend<Block>,
{
	type ProduceCandidate =
		Pin<Box<dyn Future<Output = Option<(BlockData, parachain::HeadData)>> + Send>>;

	fn produce_candidate(
		&mut self,
		relay_chain_parent: PHash,
		global_validation: GlobalValidationData,
		local_validation: LocalValidationData,
		downward_messages: Vec<DownwardMessage>,
	) -> Self::ProduceCandidate {
		let factory = self.proposer_factory.clone();
		let inherent_providers = self.inherent_data_providers.clone();
		let block_import = self.block_import.clone();

		trace!(target: "cumulus-collator", "Producing candidate");

		let last_head = match HeadData::<Block>::decode(&mut &local_validation.parent_head.0[..]) {
			Ok(x) => x,
			Err(e) => {
				error!(target: "cumulus-collator", "Could not decode the head data: {:?}", e);
				return Box::pin(future::ready(None));
			}
		};

		if !self.check_block_status(last_head.header.hash()) {
			return future::ready(None).boxed();
		}

		let proposer_future = factory.lock().init(&last_head.header);

		let wait_to_announce = self.wait_to_announce.clone();

		Box::pin(async move {
			let proposer = proposer_future
				.await
				.map_err(|e| {
					error!(
						target: "cumulus-collator",
						"Could not create proposer: {:?}",
						e,
					)
				})
				.ok()?;

			let inherent_data = Self::inherent_data(
				inherent_providers,
				global_validation,
				local_validation,
				downward_messages,
			)?;

			let Proposal {
				block,
				storage_changes,
				proof,
			} = proposer
				.propose(
					inherent_data,
					Default::default(),
					//TODO: Fix this.
					Duration::from_millis(500),
					RecordProof::Yes,
				)
				.await
				.map_err(|e| {
					error!(
						target: "cumulus-collator",
						"Proposing failed: {:?}",
						e,
					)
				})
				.ok()?;

			let proof = match proof {
				Some(proof) => proof,
				None => {
					error!(
						target: "cumulus-collator",
						"Proposer did not return the requested proof.",
					);

					return None;
				}
			};

			let (header, extrinsics) = block.deconstruct();

			// Create the parachain block data for the validators.
			let b = ParachainBlockData::<Block>::new(header.clone(), extrinsics, proof);

			let mut block_import_params = BlockImportParams::new(BlockOrigin::Own, header);
			block_import_params.body = Some(b.extrinsics().to_vec());
			// Best block is determined by the relay chain.
			block_import_params.fork_choice = Some(ForkChoiceStrategy::Custom(false));
			block_import_params.storage_changes = Some(storage_changes);

			if let Err(err) = block_import
				.lock()
				.import_block(block_import_params, Default::default())
			{
				error!(
					target: "cumulus-collator",
					"Error importing build block (at {:?}): {:?}",
					b.header().parent_hash(),
					err,
				);

				return None;
			}

			let block_data = BlockData(b.encode());
			let header = b.into_header();
			let encoded_header = header.encode();
			let hash = header.hash();
			let head_data = HeadData::<Block> { header };

			let candidate = (block_data, parachain::HeadData(head_data.encode()));

			wait_to_announce
				.lock()
				.wait_to_announce(hash, relay_chain_parent, encoded_header);

			trace!(target: "cumulus-collator", "Produced candidate: {:?}", candidate);

			Some(candidate)
		})
	}
}

/// Implements `BuildParachainContext` to build a collator instance.
pub struct CollatorBuilder<Block: BlockT, PF, BI, Backend, Client, BS> {
	proposer_factory: PF,
	inherent_data_providers: InherentDataProviders,
	block_import: BI,
	block_status: Arc<BS>,
	para_id: ParaId,
	client: Arc<Client>,
	announce_block: Arc<dyn Fn(Block::Hash, Vec<u8>) + Send + Sync>,
	delayed_block_announce_validator: DelayedBlockAnnounceValidator<Block>,
	_marker: PhantomData<(Block, Backend)>,
}

impl<Block: BlockT, PF, BI, Backend, Client, BS>
	CollatorBuilder<Block, PF, BI, Backend, Client, BS>
{
	/// Create a new instance of self.
	pub fn new(
		proposer_factory: PF,
		inherent_data_providers: InherentDataProviders,
		block_import: BI,
		block_status: Arc<BS>,
		para_id: ParaId,
		client: Arc<Client>,
		announce_block: Arc<dyn Fn(Block::Hash, Vec<u8>) + Send + Sync>,
		delayed_block_announce_validator: DelayedBlockAnnounceValidator<Block>,
	) -> Self {
		Self {
			proposer_factory,
			inherent_data_providers,
			block_import,
			block_status,
			para_id,
			client,
			announce_block,
			delayed_block_announce_validator,
			_marker: PhantomData,
		}
	}
}

type TransactionFor<E, Block> =
	<<E as Environment<Block>>::Proposer as Proposer<Block>>::Transaction;

impl<Block: BlockT, PF, BI, Backend, Client, BS> BuildParachainContext
	for CollatorBuilder<Block, PF, BI, Backend, Client, BS>
where
	PF: Environment<Block> + Send + 'static,
	BI: BlockImport<Block, Error = sp_consensus::Error, Transaction = TransactionFor<PF, Block>>
		+ Send
		+ Sync
		+ 'static,
	Backend: sc_client_api::Backend<Block> + 'static,
	Client: Finalizer<Block, Backend>
		+ UsageProvider<Block>
		+ HeaderBackend<Block>
		+ Send
		+ Sync
		+ BlockBackend<Block>
		+ 'static,
	for<'a> &'a Client: BlockImport<Block>,
	BS: BlockBackend<Block>,
{
	type ParachainContext = Collator<Block, PF, BI, BS>;

	fn build<Spawner, PClient, PBackend, PNetwork>(
		self,
		polkadot_client: Arc<PClient>,
		spawner: Spawner,
		polkadot_network: PNetwork,
	) -> Result<Self::ParachainContext, ()>
	where
		Spawner: SpawnNamed + Clone + Send + Sync + 'static,
		PBackend: BackendT<PBlock>,
		PBackend::State: StateBackend<BlakeTwo256>,
		PClient: polkadot_service::AbstractClient<PBlock, PBackend> + 'static,
		PClient::Api: RuntimeApiCollection<StateBackend = PBackend::State>,
		PNetwork: CollatorNetwork + SyncOracle + Clone + 'static,
	{
		let CollatorBuilder {
			proposer_factory,
			inherent_data_providers,
			block_import,
			block_status,
			para_id,
			client,
			announce_block,
			delayed_block_announce_validator,
			_marker,
		} = self;
		delayed_block_announce_validator.set(Box::new(JustifiedBlockAnnounceValidator::new(
			polkadot_client.clone(),
			para_id,
			Box::new(polkadot_network.clone()),
		)));

		let follow = match cumulus_consensus::follow_polkadot(
			para_id,
			client,
			polkadot_client,
			announce_block.clone(),
		) {
			Ok(follow) => follow,
			Err(e) => {
				return Err(error!("Could not start following polkadot: {:?}", e));
			}
		};

		spawner.spawn("cumulus-follow-polkadot", follow.map(|_| ()).boxed());

		Ok(Collator::new(
			proposer_factory,
			inherent_data_providers,
			polkadot_network,
			block_import,
			block_status,
			Arc::new(spawner),
			announce_block,
		))
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use std::time::Duration;

	use polkadot_collator::{collate, SignedStatement};
	use polkadot_primitives::v0::Id as ParaId;

	use sp_blockchain::Result as ClientResult;
	use sp_core::testing::TaskExecutor;
	use sp_inherents::InherentData;
	use sp_keyring::Sr25519Keyring;
	use sp_runtime::traits::{DigestFor, Header as HeaderT};
	use sp_state_machine::StorageProof;
	use substrate_test_client::{NativeExecutor, WasmExecutionMethod::Interpreted};

	use test_client::{DefaultTestClientBuilderExt, TestClientBuilder, TestClientBuilderExt};
	use test_runtime::{Block, Header};

	use futures::{future, Stream};

	#[derive(Debug)]
	struct Error;

	impl From<sp_consensus::Error> for Error {
		fn from(_: sp_consensus::Error) -> Self {
			unimplemented!("Not required in tests")
		}
	}

	struct DummyFactory;

	impl Environment<Block> for DummyFactory {
		type Proposer = DummyProposer;
		type Error = Error;
		type CreateProposer = Pin<
			Box<dyn Future<Output = Result<Self::Proposer, Self::Error>> + Send + Unpin + 'static>,
		>;

		fn init(&mut self, _: &Header) -> Self::CreateProposer {
			Box::pin(future::ready(Ok(DummyProposer)))
		}
	}

	struct DummyProposer;

	impl Proposer<Block> for DummyProposer {
		type Error = Error;
		type Proposal = future::Ready<Result<Proposal<Block, Self::Transaction>, Error>>;
		type Transaction = sc_client_api::TransactionFor<test_client::Backend, Block>;

		fn propose(
			self,
			_: InherentData,
			digest: DigestFor<Block>,
			_: Duration,
			_: RecordProof,
		) -> Self::Proposal {
			let header = Header::new(
				1337,
				Default::default(),
				Default::default(),
				Default::default(),
				digest,
			);

			future::ready(Ok(Proposal {
				block: Block::new(header, Vec::new()),
				storage_changes: Default::default(),
				proof: Some(StorageProof::empty()),
			}))
		}
	}

	#[derive(Clone)]
	struct DummyCollatorNetwork;

	impl CollatorNetwork for DummyCollatorNetwork {
		fn checked_statements(
			&self,
			_: PHash,
		) -> Pin<Box<dyn Stream<Item = SignedStatement> + Send>> {
			unimplemented!("Not required in tests")
		}
	}

	impl SyncOracle for DummyCollatorNetwork {
		fn is_major_syncing(&mut self) -> bool {
			unimplemented!("Not required in tests")
		}

		fn is_offline(&mut self) -> bool {
			unimplemented!("Not required in tests")
		}
	}

	#[derive(Clone)]
	struct DummyPolkadotClient;

	impl cumulus_consensus::PolkadotClient for DummyPolkadotClient {
		type Error = Error;
		type HeadStream = Box<dyn futures::Stream<Item = Vec<u8>> + Send + Unpin>;

		fn new_best_heads(&self, _: ParaId) -> ClientResult<Self::HeadStream> {
			unimplemented!("Not required in tests")
		}

		fn finalized_heads(&self, _: ParaId) -> ClientResult<Self::HeadStream> {
			unimplemented!("Not required in tests")
		}

		fn parachain_head_at(
			&self,
			_: &BlockId<PBlock>,
			_: ParaId,
		) -> ClientResult<Option<Vec<u8>>> {
			unimplemented!("Not required in tests")
		}
	}

	#[test]
	fn collates_produces_a_block() {
		let id = ParaId::from(100);
		let _ = env_logger::try_init();
		let spawner = TaskExecutor::new();
		let announce_block = |_, _| ();
		let block_announce_validator = DelayedBlockAnnounceValidator::new();
		let client = Arc::new(TestClientBuilder::new().build());

		let builder = CollatorBuilder::new(
			DummyFactory,
			InherentDataProviders::default(),
			client.clone(),
			client.clone(),
			id,
			client.clone(),
			Arc::new(announce_block),
			block_announce_validator,
		);
		let context = builder
			.build::<_, _, polkadot_service::FullBackend, _>(
				Arc::new(
					substrate_test_client::TestClientBuilder::<_, _, _, ()>::default()
						.build_with_native_executor::<polkadot_service::polkadot_runtime::RuntimeApi, _>(
							Some(NativeExecutor::<polkadot_service::PolkadotExecutor>::new(
								Interpreted,
								None,
								1,
							)),
						)
						.0,
				),
				spawner,
				DummyCollatorNetwork,
			)
			.expect("Creates parachain context");

		let header = client.header(&BlockId::Number(0)).unwrap().unwrap();

		let collation = collate(
			Default::default(),
			id,
			GlobalValidationData {
				block_number: 0,
				max_code_size: 0,
				max_head_data_size: 0,
			},
			LocalValidationData {
				parent_head: parachain::HeadData(HeadData::<Block> { header }.encode()),
				balance: 10,
				code_upgrade_allowed: None,
			},
			Vec::new(),
			context,
			Arc::new(Sr25519Keyring::Alice.pair().into()),
		);

		let collation = futures::executor::block_on(collation).unwrap();

		let block_data = collation.pov.block_data;

		let block = Block::decode(&mut &block_data.0[..]).expect("Is a valid block");

		assert_eq!(1337, *block.header().number());
	}
}