Consolidate file structure in sc_tendermint

substrate/tendermint/client/src/lib.rs

@@ -1,5 +1,19 @@
-mod types;
-pub use types::{TendermintClientMinimal, TendermintValidator};
+use std::sync::Arc;
+
+use sp_inherents::CreateInherentDataProviders;
+use sp_runtime::traits::{Header, Block};
+use sp_blockchain::HeaderBackend;
+use sp_api::{StateBackend, StateBackendFor, TransactionFor, ApiExt, ProvideRuntimeApi};
+use sp_consensus::{Error, Environment};
+
+use sc_client_api::{BlockBackend, Backend, Finalizer};
+use sc_consensus::{BlockImport, BasicQueue};
+use sc_network::NetworkBlock;
+use sc_network_gossip::Network;
+
+use sp_tendermint::TendermintApi;
+
+use substrate_prometheus_endpoint::Registry;
 
 mod validators;
 
@@ -7,14 +21,103 @@ pub(crate) mod tendermint;
 pub use tendermint::TendermintImport;
 
 mod block_import;
-mod import_queue;
-pub use import_queue::{TendermintImportQueue, import_queue};
+pub use block_import::TendermintSelectChain;
 
-pub(crate) mod gossip;
 pub(crate) mod authority;
 pub use authority::TendermintAuthority;
 
-mod select_chain;
-pub use select_chain::TendermintSelectChain;
-
 const CONSENSUS_ID: [u8; 4] = *b"tend";
+
+/// Trait consolidating all generics required by sc_tendermint for processing.
+pub trait TendermintClient: Send + Sync + 'static {
+  const BLOCK_TIME_IN_SECONDS: u32;
+
+  type Block: Block;
+  type Backend: Backend<Self::Block> + 'static;
+
+  /// TransactionFor<Client, Block>
+  type BackendTransaction: Send + Sync + 'static;
+  /// StateBackendFor<Client, Block>
+  type StateBackend: StateBackend<
+    <<Self::Block as Block>::Header as Header>::Hashing,
+    Transaction = Self::BackendTransaction,
+  >;
+  // Client::Api
+  type Api: ApiExt<Self::Block, StateBackend = Self::StateBackend> + TendermintApi<Self::Block>;
+  type Client: Send
+    + Sync
+    + HeaderBackend<Self::Block>
+    + BlockBackend<Self::Block>
+    + BlockImport<Self::Block, Transaction = Self::BackendTransaction>
+    + Finalizer<Self::Block, Self::Backend>
+    + ProvideRuntimeApi<Self::Block, Api = Self::Api>
+    + 'static;
+}
+
+/// Trait implementable on firm types to automatically provide a full TendermintClient impl.
+pub trait TendermintClientMinimal: Send + Sync + 'static {
+  const BLOCK_TIME_IN_SECONDS: u32;
+
+  type Block: Block;
+  type Backend: Backend<Self::Block> + 'static;
+  type Api: ApiExt<Self::Block> + TendermintApi<Self::Block>;
+  type Client: Send
+    + Sync
+    + HeaderBackend<Self::Block>
+    + BlockBackend<Self::Block>
+    + BlockImport<Self::Block, Transaction = TransactionFor<Self::Client, Self::Block>>
+    + Finalizer<Self::Block, Self::Backend>
+    + ProvideRuntimeApi<Self::Block, Api = Self::Api>
+    + 'static;
+}
+
+impl<T: TendermintClientMinimal> TendermintClient for T
+where
+  <T::Client as ProvideRuntimeApi<T::Block>>::Api: TendermintApi<T::Block>,
+  TransactionFor<T::Client, T::Block>: Send + Sync + 'static,
+{
+  const BLOCK_TIME_IN_SECONDS: u32 = T::BLOCK_TIME_IN_SECONDS;
+
+  type Block = T::Block;
+  type Backend = T::Backend;
+
+  type BackendTransaction = TransactionFor<T::Client, T::Block>;
+  type StateBackend = StateBackendFor<T::Client, T::Block>;
+  type Api = <T::Client as ProvideRuntimeApi<T::Block>>::Api;
+  type Client = T::Client;
+}
+
+/// Trait consolidating additional generics required by sc_tendermint for authoring.
+pub trait TendermintValidator: TendermintClient {
+  type CIDP: CreateInherentDataProviders<Self::Block, ()> + 'static;
+  type Environment: Send + Sync + Environment<Self::Block> + 'static;
+
+  type Network: Clone
+    + Send
+    + Sync
+    + Network<Self::Block>
+    + NetworkBlock<<Self::Block as Block>::Hash, <<Self::Block as Block>::Header as Header>::Number>
+    + 'static;
+}
+
+pub type TendermintImportQueue<Block, Transaction> = BasicQueue<Block, Transaction>;
+
+pub fn import_queue<T: TendermintValidator>(
+  spawner: &impl sp_core::traits::SpawnEssentialNamed,
+  client: Arc<T::Client>,
+  registry: Option<&Registry>,
+) -> (TendermintImport<T>, TendermintImportQueue<T::Block, T::BackendTransaction>)
+where
+  Arc<T::Client>: BlockImport<T::Block, Transaction = T::BackendTransaction>,
+  <Arc<T::Client> as BlockImport<T::Block>>::Error: Into<Error>,
+{
+  let import = TendermintImport::<T>::new(client);
+
+  let boxed = Box::new(import.clone());
+  // Use None for the justification importer since justifications always come with blocks
+  // Therefore, they're never imported after the fact, which is what mandates an importer
+  let queue = || BasicQueue::new(import.clone(), boxed.clone(), None, spawner, registry);
+
+  *futures::executor::block_on(import.queue.write()) = Some(queue());
+  (import.clone(), queue())
+}