Client Service

client/api/Cargo.toml

@@ -17,6 +17,7 @@ codec = { package = "parity-scale-codec", version = "1.3.4", default-features =
 sp-consensus = { version = "0.8.0-rc5", path = "../../primitives/consensus/common" }
 derive_more = { version = "0.99.2" }
 sc-executor = { version = "0.8.0-rc5", path = "../executor" }
+sc-keystore = { version = "2.0.0-rc5", path = "../keystore" }
 sp-externalities = { version = "0.8.0-rc5", path = "../../primitives/externalities" }
 fnv = { version = "1.0.6" }
 futures = { version = "0.3.1" }

client/service/src/builder.rs

@@ -35,7 +35,7 @@ use sp_consensus::{
 };
 use jsonrpc_pubsub::manager::SubscriptionManager;
 use futures::{
-	Future, FutureExt, StreamExt,
+	FutureExt, StreamExt,
 	future::ready,
 	channel::oneshot,
 };
@@ -45,6 +45,7 @@ use sc_keystore::{
 		proxy as keystore_proxy,
 		KeystoreProxy,
 		KeystoreReceiver,
+		KeystoreProxyAdapter,
 	},
 };
 use log::{info, warn, error};
@@ -63,7 +64,7 @@ use sc_telemetry::{telemetry, SUBSTRATE_INFO};
 use sp_transaction_pool::MaintainedTransactionPool;
 use prometheus_endpoint::Registry;
 use sc_client_db::{Backend, DatabaseSettings};
-use sp_core::traits::{CodeExecutor, SpawnNamed};
+use sp_core::traits::{CodeExecutor, SpawnNamed, SyncCryptoStore};
 use sp_runtime::BuildStorage;
 use sc_client_api::{
 	BlockBackend, BlockchainEvents,
@@ -72,7 +73,6 @@ use sc_client_api::{
 	execution_extensions::ExecutionExtensions
 };
 use sp_blockchain::{HeaderMetadata, HeaderBackend};
-use sp_core::storage::Storage;
 
 /// A utility trait for building an RPC extension given a `DenyUnsafe` instance.
 /// This is useful since at service definition time we don't know whether the
@@ -169,16 +169,16 @@ pub type TLightCallExecutor<TBl, TExecDisp> = sc_light::GenesisCallExecutor<
 type TFullParts<TBl, TRtApi, TExecDisp> = (
 	TFullClient<TBl, TRtApi, TExecDisp>,
 	Arc<TFullBackend<TBl>>,
-	Arc<RwLock<sc_keystore::Store>>,
-	Arc<KeystoreProxy>,
-	KeystoreReceiver,
+	KeystoreParams,
+	KeystoreReceiver<Keystore>,
 	TaskManager,
 );
 
 type TLightParts<TBl, TRtApi, TExecDisp> = (
 	Arc<TLightClient<TBl, TRtApi, TExecDisp>>,
 	Arc<TLightBackend<TBl>>,
-	Arc<RwLock<sc_keystore::Store>>,
+	KeystoreParams,
+	KeystoreReceiver<Keystore>,
 	TaskManager,
 	Arc<OnDemand<TBl>>,
 );
@@ -200,6 +200,51 @@ pub type TLightClientWithBackend<TBl, TRtApi, TExecDisp, TBackend> = Client<
 	TRtApi,
 >;
 
+/// Construct and hold different layers of Keystore wrappers
+pub struct KeystoreParams {
+	keystore: Arc<RwLock<KeystoreProxyAdapter>>,
+	proxy: Arc<KeystoreProxy>,
+	sync_keystore: Arc<SyncCryptoStore>,
+}
+
+impl KeystoreParams {
+	/// Construct KeystoreParams
+	pub fn new(config: &KeystoreConfig) -> Result<(Self, KeystoreReceiver<Keystore>), Error> {
+		let keystore = match config {
+			KeystoreConfig::Path { path, password } => Keystore::open(
+				path.clone(),
+				password.clone()
+			)?,
+			KeystoreConfig::InMemory => Keystore::new_in_memory(),
+		};
+		let (keystore_proxy, keystore_receiver) = keystore_proxy(keystore);
+		let keystore_proxy = Arc::new(keystore_proxy);
+		let keystore = Arc::new(RwLock::new(KeystoreProxyAdapter::new(keystore_proxy.clone())));
+		let sync_keystore = Arc::new(SyncCryptoStore::new(keystore.clone()));
+
+		Ok((Self {
+			keystore,
+			sync_keystore,
+			proxy: keystore_proxy,
+		}, keystore_receiver))
+	}
+
+	/// Returns an adapter to the asynchronous keystore that implements `BareCryptoStore`
+	pub fn keystore(&self) -> Arc<RwLock<KeystoreProxyAdapter>> {
+		self.keystore.clone()
+	}
+
+	/// Returns the asynchronous keystore proxy
+	pub fn proxy(&self) -> Arc<KeystoreProxy> {
+		self.proxy.clone()
+	}
+
+	/// Returns the synchrnous keystore wrapper
+	pub fn sync_keystore(&self) -> Arc<SyncCryptoStore> {
+		self.sync_keystore.clone()
+	}
+}
+
 /// Creates a new full client for the given config.
 pub fn new_full_client<TBl, TRtApi, TExecDisp>(
 	config: &Configuration,
@@ -217,15 +262,7 @@ pub fn new_full_parts<TBl, TRtApi, TExecDisp>(
 	TBl: BlockT,
 	TExecDisp: NativeExecutionDispatch + 'static,
 {
-	let keystore = match &config.keystore {
-		KeystoreConfig::Path { path, password } => Keystore::open(
-			path.clone(),
-			password.clone()
-		)?,
-		KeystoreConfig::InMemory => Keystore::new_in_memory(),
-	};
-	let (keystore_proxy, keystore_receiver) = keystore_proxy(keystore.clone());
-	let keystore_proxy = Arc::new(keystore_proxy);
+	let (keystore_container, keystore_receiver) = KeystoreParams::new(&config.keystore)?;
 
 	let task_manager = {
 		let registry = config.prometheus_config.as_ref().map(|cfg| &cfg.registry);
@@ -258,8 +295,7 @@ pub fn new_full_parts<TBl, TRtApi, TExecDisp>(
 
 		let extensions = sc_client_api::execution_extensions::ExecutionExtensions::new(
 			config.execution_strategies.clone(),
-			Some(keystore.clone()),
-			Some(keystore_proxy.clone()),
+			Some(keystore_container.sync_keystore()),
 		);
 
 		new_client(
@@ -278,7 +314,13 @@ pub fn new_full_parts<TBl, TRtApi, TExecDisp>(
 		)?
 	};
 
-	Ok((client, backend, keystore, keystore_proxy, keystore_receiver, task_manager))
+	Ok((
+		client,
+		backend,
+		keystore_container,
+		keystore_receiver,
+		task_manager
+	))
 }
 
 /// Create the initial parts of a light node.
@@ -294,13 +336,7 @@ pub fn new_light_parts<TBl, TRtApi, TExecDisp>(
 		TaskManager::new(config.task_executor.clone(), registry)?
 	};
 
-	let keystore = match &config.keystore {
-		KeystoreConfig::Path { path, password } => Keystore::open(
-			path.clone(),
-			password.clone()
-		)?,
-		KeystoreConfig::InMemory => Keystore::new_in_memory(),
-	};
+	let (keystore_params, keystore_receiver) = KeystoreParams::new(&config.keystore)?;
 
 	let executor = NativeExecutor::<TExecDisp>::new(
 		config.wasm_method,
@@ -336,7 +372,7 @@ pub fn new_light_parts<TBl, TRtApi, TExecDisp>(
 		config.prometheus_config.as_ref().map(|config| config.registry.clone()),
 	)?);
 
-	Ok((client, backend, keystore, task_manager, on_demand))
+	Ok((client, backend, keystore_params, keystore_receiver, task_manager, on_demand))
 }
 
 /// Create an instance of db-backed client.
@@ -395,7 +431,7 @@ pub struct SpawnTasksParams<'a, TBl: BlockT, TCl, TExPool, TRpc, Backend> {
 	/// A task manager returned by `new_full_parts`/`new_light_parts`.
 	pub task_manager: &'a mut TaskManager,
 	/// A shared keystore returned by `new_full_parts`/`new_light_parts`.
-	pub keystore: Arc<RwLock<Keystore>>,
+	pub keystore: Arc<SyncCryptoStore>,
 	/// An optional, shared data fetcher for light clients.
 	pub on_demand: Option<Arc<OnDemand<TBl>>>,
 	/// A shared transaction pool.
@@ -721,7 +757,7 @@ fn gen_handler<TBl, TBackend, TExPool, TRpc, TCl>(
 	spawn_handle: SpawnTaskHandle,
 	client: Arc<TCl>,
 	transaction_pool: Arc<TExPool>,
-	keystore: Arc<RwLock<Keystore>>,
+	keystore: Arc<SyncCryptoStore>,
 	on_demand: Option<Arc<OnDemand<TBl>>>,
 	remote_blockchain: Option<Arc<dyn RemoteBlockchain<TBl>>>,
 	rpc_extensions_builder: &(dyn RpcExtensionBuilder<Output = TRpc> + Send),

client/service/src/client/client.rs

@@ -32,7 +32,13 @@ use sp_core::{
 	storage::{well_known_keys, ChildInfo, PrefixedStorageKey, StorageData, StorageKey},
 	ChangesTrieConfiguration, ExecutionContext, NativeOrEncoded,
 };
-use sc_keystore::proxy::proxy as keystore_proxy;
+#[cfg(feature="test-helpers")]
+use sp_core::traits::SyncCryptoStore;
+#[cfg(feature="test-helpers")]
+use sc_keystore::proxy::{
+	proxy as keystore_proxy,
+	KeystoreProxyAdapter,
+};
 use sc_telemetry::{telemetry, SUBSTRATE_INFO};
 use sp_runtime::{
 	Justification, BuildStorage,
@@ -145,10 +151,10 @@ impl<H> PrePostHeader<H> {
 
 /// Create an instance of in-memory client.
 #[cfg(feature="test-helpers")]
-pub fn new_in_mem<E, Block, S, RA>(
+pub fn new_in_mem<E, Block, S, RA, TStore>(
 	executor: E,
 	genesis_storage: &S,
-	keystore: Option<sp_core::traits::BareCryptoStorePtr>,
+	keystore: Option<TStore>,
 	prometheus_registry: Option<Registry>,
 	spawn_handle: Box<dyn SpawnNamed>,
 	config: ClientConfig,
@@ -161,6 +167,7 @@ pub fn new_in_mem<E, Block, S, RA>(
 	E: CodeExecutor + RuntimeInfo,
 	S: BuildStorage,
 	Block: BlockT,
+	TStore: sp_core::traits::BareCryptoStore + 'static,
 {
 	new_with_backend(
 		Arc::new(in_mem::Backend::new()),
@@ -185,11 +192,11 @@ pub struct ClientConfig {
 /// Create a client with the explicitly provided backend.
 /// This is useful for testing backend implementations.
 #[cfg(feature="test-helpers")]
-pub fn new_with_backend<B, E, Block, S, RA>(
+pub fn new_with_backend<B, E, Block, S, RA, TStore>(
 	backend: Arc<B>,
 	executor: E,
 	build_genesis_storage: &S,
-	keystore: Option<sp_core::traits::BareCryptoStorePtr>,
+	keystore: Option<TStore>,
 	spawn_handle: Box<dyn SpawnNamed>,
 	prometheus_registry: Option<Registry>,
 	config: ClientConfig,
@@ -199,17 +206,21 @@ pub fn new_with_backend<B, E, Block, S, RA>(
 		S: BuildStorage,
 		Block: BlockT,
 		B: backend::LocalBackend<Block> + 'static,
+		TStore: sp_core::traits::BareCryptoStore + 'static,
 {
-	let keystore_proxy = match keystore.clone() {
+	let sync_keystore = match keystore {
 		Some(store) => {
-			let (keystore_proxy, _) = keystore_proxy(store.clone());
-			Some(Arc::new(keystore_proxy))
+			let (keystore_proxy, _) = keystore_proxy(store);
+			let keystore_proxy = Arc::new(keystore_proxy);
+			let keystore = Arc::new(RwLock::new(KeystoreProxyAdapter::new(keystore_proxy.clone())));
+			let sync_keystore = Arc::new(SyncCryptoStore::new(keystore.clone()));
+			Some(sync_keystore)
 		},
-		None => None,
+		None => None
 	};
 
 	let call_executor = LocalCallExecutor::new(backend.clone(), executor, spawn_handle, config.clone());
-	let extensions = ExecutionExtensions::new(Default::default(), keystore, keystore_proxy);
+	let extensions = ExecutionExtensions::new(Default::default(), sync_keystore);
 	Client::new(
 		backend,
 		call_executor,

client/service/src/lib.rs

@@ -53,9 +53,9 @@ use sp_utils::{status_sinks, mpsc::{tracing_unbounded, TracingUnboundedReceiver,
 pub use self::error::Error;
 pub use self::builder::{
 	new_full_client, new_client, new_full_parts, new_light_parts,
-	spawn_tasks, build_network, BuildNetworkParams, NetworkStarter, build_offchain_workers,
-	SpawnTasksParams, TFullClient, TLightClient, TFullBackend, TLightBackend,
-	TLightBackendWithHash, TLightClientWithBackend,
+	spawn_tasks, build_network, build_offchain_workers,
+	BuildNetworkParams, KeystoreParams, NetworkStarter, SpawnTasksParams, TFullClient, TLightClient,
+	TFullBackend, TLightBackend, TLightBackendWithHash, TLightClientWithBackend,
 	TFullCallExecutor, TLightCallExecutor, RpcExtensionBuilder, NoopRpcExtensionBuilder,
 };
 pub use config::{
@@ -81,7 +81,7 @@ pub use task_manager::SpawnTaskHandle;
 pub use task_manager::TaskManager;
 pub use sp_consensus::import_queue::ImportQueue;
 use sc_client_api::BlockchainEvents;
-pub use sc_keystore::KeyStorePtr as KeyStore;
+use sc_keystore::{Store as Keystore, proxy::KeystoreReceiver};
 
 const DEFAULT_PROTOCOL_ID: &str = "sup";
 
@@ -162,7 +162,9 @@ pub struct PartialComponents<Client, Backend, SelectChain, ImportQueue, Transact
 	/// The chain task manager.
 	pub task_manager: TaskManager,
 	/// A shared keystore instance.
-	pub keystore: KeyStore,
+	pub keystore_params: KeystoreParams,
+	/// A shared keystore instance.
+	pub keystore_receiver: KeystoreReceiver<Keystore>,
 	/// A chain selection algorithm instance.
 	pub select_chain: SelectChain,
 	/// An import queue.

client/service/test/Cargo.toml

@@ -40,5 +40,6 @@ substrate-test-runtime-client = { version = "2.0.0-rc5", path = "../../../test-u
 sc-client-api = { version = "2.0.0-rc5", path = "../../api" }
 sc-block-builder = { version = "0.8.0-rc5", path = "../../block-builder" }
 sc-executor = { version = "0.8.0-rc5", path = "../../executor" }
+sc-keystore = { version = "2.0.0-rc5", path = "../../keystore" }
 sp-panic-handler = { version = "2.0.0-rc5", path = "../../../primitives/panic-handler" }
 parity-scale-codec = "1.3.4"

client/service/test/src/client/mod.rs

@@ -50,6 +50,7 @@ use sp_consensus::{
 use sp_storage::StorageKey;
 use sp_trie::{TrieConfiguration, trie_types::Layout};
 use sp_runtime::{generic::BlockId, DigestItem};
+use sc_keystore::Store;
 use hex_literal::hex;
 
 mod light;
@@ -1737,7 +1738,8 @@ fn cleans_up_closed_notification_sinks_on_block_import() {
 			_,
 			substrate_test_runtime_client::runtime::Block,
 			_,
-			substrate_test_runtime_client::runtime::RuntimeApi
+			substrate_test_runtime_client::runtime::RuntimeApi,
+			Store,
 		>(
 			substrate_test_runtime_client::new_native_executor(),
 			&substrate_test_runtime_client::GenesisParameters::default().genesis_storage(),