Add sc-prelude

paritytech · Jul 22, 2020 · Jun 30, 2020 · Jun 30, 2020 · Jun 30, 2020 · Jun 30, 2020
commit c0dc11dd55b3f43988bccd56db4e0c3d7509adee
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -46,6 +46,7 @@ members = [
 	"client/network-gossip",
 	"client/offchain",
 	"client/peerset",
+	"client/prelude",
 	"client/proposer-metrics",
 	"client/rpc-servers",
 	"client/rpc",

diff --git a/bin/node-template/node/Cargo.toml b/bin/node-template/node/Cargo.toml
@@ -39,6 +39,7 @@ sc-client-api = { version = "2.0.0-rc4", path = "../../../client/api" }
 sp-runtime = { version = "2.0.0-rc4", path = "../../../primitives/runtime" }
 sc-basic-authorship = { path = "../../../client/basic-authorship", version = "0.8.0-rc4"}
 sp-api = { version = "2.0.0-rc4", path = "../../../primitives/api" }
+sc-prelude = { version = "0.8.0-rc4", path = "../../../client/prelude" }
 
 node-template-runtime = { version = "2.0.0-rc4", path = "../runtime" }
 

diff --git a/bin/node-template/node/src/service.rs b/bin/node-template/node/src/service.rs
@@ -20,23 +20,19 @@ native_executor_instance!(
 	node_template_runtime::native_version,
 );
 
-type FullClient = sc_service::TFullClient<Block, RuntimeApi, Executor>;
-type FullBackend = sc_service::TFullBackend<Block>;
-type GrandpaBlockImport = sc_finality_grandpa::GrandpaBlockImport<
-	FullBackend, Block, FullClient, SelectChain
->;
-type SelectChain = sc_consensus::LongestChain<FullBackend, Block>;
-type GrandpaLink = sc_finality_grandpa::LinkHalf<Block, FullClient, SelectChain>;
-type FullPool = sc_transaction_pool::BasicPool<
-	sc_transaction_pool::FullChainApi<FullClient, Block>, Block
->;
-type ImportQueue = sc_consensus_aura::AuraImportQueue<Block, sp_api::TransactionFor<FullClient, Block>>;
+mod prelude {
+	use super::*;
+	sc_prelude::prelude!(Block, RuntimeApi, Executor);
+}
+
+use prelude::*;
 
 pub fn new_full_params(config: Configuration) -> Result<(
 	sc_service::ServiceParams<
-		Block, FullClient, ImportQueue, FullPool, (), FullBackend,
+		Block, FullClient, FullAuraImportQueue, FullBasicPool, (), FullBackend,
 	>,
-	SelectChain, sp_inherents::InherentDataProviders, GrandpaBlockImport, GrandpaLink
+	FullLongestChain, sp_inherents::InherentDataProviders, FullGrandpaBlockImport<FullLongestChain>,
+	FullGrandpaLink<FullLongestChain>
 ), ServiceError> {
 	let inherent_data_providers = sp_inherents::InherentDataProviders::new();
 

diff --git a/bin/node/cli/Cargo.toml b/bin/node/cli/Cargo.toml
@@ -76,6 +76,7 @@ sc-service = { version = "0.8.0-rc4", default-features = false, path = "../../..
 sc-tracing = { version = "2.0.0-rc4", path = "../../../client/tracing" }
 sc-telemetry = { version = "2.0.0-rc4", path = "../../../client/telemetry" }
 sc-authority-discovery = { version = "0.8.0-rc4",  path = "../../../client/authority-discovery" }
+sc-prelude = { version = "0.8.0-rc4", path = "../../../client/prelude" }
 
 # frame dependencies
 pallet-indices = { version = "2.0.0-rc4", path = "../../../frame/indices" }

diff --git a/bin/node/cli/src/service.rs b/bin/node/cli/src/service.rs
@@ -41,11 +41,11 @@ use sp_core::traits::BareCryptoStorePtr;
 
 pub fn new_full_params(config: Configuration) -> Result<(
 	sc_service::ServiceParams<
-		Block, FullClient, ImportQueue, FullPool, node_rpc::IoHandler, FullBackend
+		Block, FullClient, FullBabeImportQueue, FullBasicPool, node_rpc::IoHandler, FullBackend
 	>,
-	(BabeBlockImport, GrandpaLink, BabeLink),
+	(FullBabeBlockImport<FullGrandpaBlockImport<FullLongestChain>>, FullGrandpaLink<FullLongestChain>, BabeLink),
 	grandpa::SharedVoterState,
-	sc_consensus::LongestChain<FullBackend, Block>,
+	FullLongestChain,
 	InherentDataProviders
 ), ServiceError> {
 	use node_executor::Executor;
@@ -149,23 +149,20 @@ pub fn new_full_params(config: Configuration) -> Result<(
 	Ok((params, import_setup, rpc_setup, select_chain, inherent_data_providers))
 }
 
-type FullClient = sc_service::TFullClient<Block, RuntimeApi, node_executor::Executor>;
-type FullBackend = sc_service::TFullBackend<Block>;
-type GrandpaBlockImport = grandpa::GrandpaBlockImport<FullBackend, Block, FullClient, SelectChain>;
-type SelectChain = sc_consensus::LongestChain<FullBackend, Block>;
-type GrandpaLink = grandpa::LinkHalf<Block, FullClient, SelectChain>;
-type BabeLink = sc_consensus_babe::BabeLink<Block>;
-type BabeBlockImport = sc_consensus_babe::BabeBlockImport<Block, FullClient, GrandpaBlockImport>;
-type FullPool = sc_transaction_pool::BasicPool<sc_transaction_pool::FullChainApi<FullClient, Block>, Block>;
-type ImportQueue = sc_consensus_babe::BabeImportQueue<Block, sp_api::TransactionFor<FullClient, Block>>;
+mod prelude {
+	use super::*;
+	sc_prelude::prelude!(Block, RuntimeApi, node_executor::Executor);
+}
+
+use prelude::*;
 
 /// Creates a full service from the configuration.
 pub fn new_full_base(
 	config: Configuration,
-	with_startup_data: impl FnOnce(&BabeBlockImport, &BabeLink)
+	with_startup_data: impl FnOnce(&FullBabeBlockImport<FullGrandpaBlockImport<FullLongestChain>>, &BabeLink)
 ) -> Result<(
 	TaskManager, InherentDataProviders, Arc<FullClient>,
-	Arc<NetworkService<Block, <Block as BlockT>::Hash>>, Arc<FullPool>
+	Arc<NetworkService<Block, <Block as BlockT>::Hash>>, Arc<FullBasicPool>
 ), ServiceError> {
 	let (params, import_setup, rpc_setup, select_chain, inherent_data_providers)
 		= new_full_params(config)?;

diff --git a/client/prelude/Cargo.toml b/client/prelude/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "sc-prelude"
+version = "0.8.0-rc4"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
+homepage = "https://substrate.dev"
+repository = "https://github.com/paritytech/substrate/"
+description = "Easy to use type definitions"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+sc-service = { path = "../service", version = "0.8.0-rc4"}
+sc-finality-grandpa = { path = "../finality-grandpa", version = "0.8.0-rc4"}
+sc-consensus = { path = "../consensus/common", version = "0.8.0-rc4"}
+sc-consensus-aura = { path = "../consensus/aura", version = "0.8.0-rc4"}
+sc-consensus-babe = { path = "../consensus/babe", version = "0.8.0-rc4"}
+sc-transaction-pool = { path = "../transaction-pool", version = "2.0.0-rc4"}
diff --git a/client/prelude/src/lib.rs b/client/prelude/src/lib.rs
@@ -0,0 +1,64 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+pub use sc_service;
+pub use sc_finality_grandpa;
+pub use sc_consensus;
+pub use sc_consensus_aura;
+pub use sc_transaction_pool;
+pub use sc_consensus_babe;
+
+#[macro_export]
+macro_rules! prelude {
+    ($block:ty, $runtime_api:ty, $executor:ty) => {
+        pub type FullClient = $crate::sc_service::TFullClient<$block, $runtime_api, $executor>;
+        pub type FullBackend = $crate::sc_service::TFullBackend<$block>;
+        pub type FullGrandpaBlockImport<SelectChain> = $crate::sc_finality_grandpa::GrandpaBlockImport<
+            FullBackend, $block, FullClient, SelectChain
+        >;
+        pub type FullGrandpaLink<SelectChain> = $crate::sc_finality_grandpa::LinkHalf<
+            $block, FullClient, SelectChain
+        >;
+        pub type FullLongestChain = $crate::sc_consensus::LongestChain<FullBackend, $block>;
+
+        pub type FullBasicPool = $crate::sc_transaction_pool::BasicPool<
+            sc_transaction_pool::FullChainApi<FullClient, $block>, $block
+        >;
+
+        pub type FullAuraImportQueue = $crate::sc_consensus_aura::AuraImportQueue<
+            $block, sp_api::TransactionFor<FullClient, $block>
+        >;
+
+        pub type FullBabeImportQueue = $crate::sc_consensus_babe::BabeImportQueue<
+            $block, sp_api::TransactionFor<FullClient, $block>
+        >;
+
+        pub type FullBabeBlockImport<BlockImport> = $crate::sc_consensus_babe::BabeBlockImport<
+            $block, FullClient, BlockImport
+        >;
+
+        pub type BabeLink = $crate::sc_consensus_babe::BabeLink<$block>;
+
+        pub type LightClient = $crate::sc_service::TLightClient<$block, $runtime_api, $executor>;
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    mod prelude {
+        prelude!((), (), ());
+    }
+}