Rename to sc-service-types

paritytech · Jul 22, 2020 · Jun 30, 2020 · Jun 30, 2020 · Jun 30, 2020 · Jun 30, 2020
commit 03de1c7c094d15e4fb8296db007379daf7979cff
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -51,8 +51,8 @@ members = [
 	"client/rpc",
 	"client/rpc-api",
 	"client/service",
-	"client/service/prelude",
 	"client/service/test",
+	"client/service/types",
 	"client/state-db",
 	"client/telemetry",
 	"client/transaction-pool",

diff --git a/bin/node-template/node/Cargo.toml b/bin/node-template/node/Cargo.toml
@@ -39,7 +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-service-prelude = { version = "0.8.0-rc4", path = "../../../client/service/prelude" }
+sc-service-types = { version = "0.8.0-rc4", path = "../../../client/service/types" }
 
 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
@@ -22,7 +22,7 @@ native_executor_instance!(
 
 mod prelude {
 	use super::*;
-	sc_service_prelude::setup_types!(Block, RuntimeApi, Executor);
+	sc_service_types::setup_types!(Block, RuntimeApi, Executor);
 }
 
 use prelude::full;
@@ -31,7 +31,8 @@ pub fn new_full_params(config: Configuration) -> Result<(
 	sc_service::ServiceParams<
 		Block, full::Client, full::AuraImportQueue, full::BasicPool, (), full::Backend,
 	>,
-	full::LongestChain, sp_inherents::InherentDataProviders, full::GrandpaBlockImport<full::LongestChain>,
+	full::LongestChain, sp_inherents::InherentDataProviders,
+	full::GrandpaBlockImport<full::LongestChain>,
 	full::GrandpaLink<full::LongestChain>
 ), ServiceError> {
 	let inherent_data_providers = sp_inherents::InherentDataProviders::new();

diff --git a/bin/node/cli/Cargo.toml b/bin/node/cli/Cargo.toml
@@ -58,7 +58,6 @@ sp-keyring = { version = "2.0.0-rc4", path = "../../../primitives/keyring" }
 sp-io = { version = "2.0.0-rc4", path = "../../../primitives/io" }
 sp-consensus = { version = "0.8.0-rc4", path = "../../../primitives/consensus/common" }
 sp-transaction-pool = { version = "2.0.0-rc4", path = "../../../primitives/transaction-pool" }
-sp-api = { version = "2.0.0-rc4", path = "../../../primitives/api" }
 
 # client dependencies
 sc-client-api = { version = "2.0.0-rc4", path = "../../../client/api" }
@@ -76,7 +75,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-service-prelude = { version = "0.8.0-rc4", path = "../../../client/service/prelude" }
+sc-service-types = { version = "0.8.0-rc4", path = "../../../client/service/types" }
 
 # 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
@@ -37,6 +37,15 @@ use sp_runtime::traits::Block as BlockT;
 use futures::prelude::*;
 use sc_client_api::{ExecutorProvider, RemoteBackend};
 use sp_core::traits::BareCryptoStorePtr;
+use sc_consensus_babe::BabeLink;
+
+mod prelude {
+	use super::*;
+	use node_executor::Executor;
+	sc_service_types::setup_types!(Block, RuntimeApi, Executor);
+}
+
+use prelude::{full, light};
 
 pub fn new_full_params(config: Configuration) -> Result<(
 	sc_service::ServiceParams<
@@ -45,7 +54,7 @@ pub fn new_full_params(config: Configuration) -> Result<(
 	>,
 	(
 		full::BabeBlockImport<full::GrandpaBlockImport<full::LongestChain>>,
-		full::GrandpaLink<full::LongestChain>, BabeLink
+		full::GrandpaLink<full::LongestChain>, BabeLink<Block>,
 	),
 	grandpa::SharedVoterState,
 	full::LongestChain,
@@ -152,19 +161,11 @@ pub fn new_full_params(config: Configuration) -> Result<(
 	Ok((params, import_setup, rpc_setup, select_chain, inherent_data_providers))
 }
 
-mod prelude {
-	use super::*;
-	use node_executor::Executor;
-	sc_service_prelude::setup_types!(Block, RuntimeApi, Executor);
-}
-
-use prelude::{full, light, BabeLink};
-
 /// Creates a full service from the configuration.
 pub fn new_full_base(
 	config: Configuration,
 	with_startup_data: impl FnOnce(
-		&full::BabeBlockImport<full::GrandpaBlockImport<full::LongestChain>>, &BabeLink,
+		&full::BabeBlockImport<full::GrandpaBlockImport<full::LongestChain>>, &BabeLink<Block>,
 	)
 ) -> Result<(
 	TaskManager, InherentDataProviders, Arc<full::Client>,

diff --git a/client/service/prelude/Cargo.toml b/client/service/prelude/Cargo.toml
diff --git a/client/service/prelude/src/lib.rs b/client/service/prelude/src/lib.rs
diff --git a/client/service/types/Cargo.toml b/client/service/types/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "sc-service-types"
+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 = "..", 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"}
+sc-network = { path = "../../network" }
+sp-api = { path = "../../../primitives/api" }
diff --git a/client/service/types/src/lib.rs b/client/service/types/src/lib.rs
@@ -0,0 +1,92 @@
+// 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 as _service;
+pub use sc_finality_grandpa as _grandpa;
+pub use sc_consensus as _consensus;
+pub use sc_consensus_aura as _aura;
+pub use sc_consensus_babe as _babe;
+pub use sc_transaction_pool as _transaction_pool;
+pub use sc_network as _network;
+pub use sp_api as _sp_api;
+
+#[macro_export]
+macro_rules! setup_types {
+    ($block:ty, $runtime_api:ty, $executor:ty) => {
+        use $crate::{
+            _service as service, _grandpa as grandpa, _consensus as consensus, _aura as aura,
+            _transaction_pool as transaction_pool, _sp_api as sp_api, _network as network,
+            _babe as babe,
+        };
+
+        /// Type definitions for a full client.
+        pub mod full {
+            use super::*;
+
+            /// A full client.
+            pub type Client = service::TFullClient<$block, $runtime_api, $executor>;
+            /// A full backend.
+            pub type Backend = service::TFullBackend<$block>;
+            /// A GRANDPA block import.
+            pub type GrandpaBlockImport<SelectChain> = grandpa::GrandpaBlockImport<
+                Backend, $block, Client, SelectChain
+            >;
+            /// A GRANDPA link. Connects the block import to the GRANDPA service.
+            pub type GrandpaLink<SelectChain> = grandpa ::LinkHalf<
+                $block, Client, SelectChain
+            >;
+            /// A basic select chain implementation.
+            pub type LongestChain = consensus::LongestChain<Backend, $block>;
+            /// A basic transaction pool.
+            pub type BasicPool = transaction_pool::BasicPool<
+                transaction_pool::FullChainApi<Client, $block>, $block
+            >;
+            /// An import queue for AURA.
+            pub type AuraImportQueue = aura::AuraImportQueue<
+                $block, sp_api::TransactionFor<Client, $block>
+            >;
+            /// An import queue for BABE.
+            pub type BabeImportQueue = babe::BabeImportQueue<
+                $block, sp_api::TransactionFor<Client, $block>
+            >;
+            /// A block import for BABE. Wraps around another block import.
+            pub type BabeBlockImport<BlockImport> = babe::BabeBlockImport<
+                $block, Client, BlockImport
+            >;
+        }
+
+        /// Type definitions for a light client.
+        pub mod light {
+            use super::*;
+
+            /// A light client.
+            pub type Client = service::TLightClient<$block, $runtime_api, $executor>;
+            /// A network fetcher for a light client.
+            pub type Fetcher = network::config::OnDemand<$block>;
+            /// A basic transaction pool.
+            pub type BasicPool = transaction_pool::BasicPool<
+                transaction_pool::LightChainApi<Client, Fetcher, $block>, $block
+            >;
+        }       
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    mod prelude {
+        setup_types!((), (), ());
+    }
+}