Make substrate generic

polkadot/service/src/lib.rs

@@ -28,16 +28,14 @@ extern crate polkadot_api;
 extern crate polkadot_consensus as consensus;
 extern crate polkadot_transaction_pool as transaction_pool;
 extern crate polkadot_keystore as keystore;
-extern crate substrate_client as client;
 extern crate substrate_runtime_io as runtime_io;
 extern crate substrate_primitives as primitives;
 extern crate substrate_network as network;
 extern crate substrate_codec as codec;
-extern crate substrate_client_db as client_db;
 extern crate substrate_executor;
 
-extern crate exit_future;
 extern crate tokio_core;
+extern crate substrate_client as client;
 
 #[macro_use]
 extern crate error_chain;
@@ -65,21 +63,20 @@ use polkadot_api::PolkadotApi;
 use polkadot_runtime::{GenesisConfig, ConsensusConfig, CouncilConfig, DemocracyConfig,
  SessionConfig, StakingConfig, BuildExternalities};
 use client::{genesis, BlockchainEvents};
+use client::in_mem::Backend as InMemory;
 use network::ManageNetwork;
-use exit_future::Signal;
 
 pub use self::error::{ErrorKind, Error};
 pub use config::{Configuration, Role, ChainSpec};
 
-type Client = client::Client<client_db::Backend, NativeExecutor<LocalDispatch>>;
+type Client = client::Client<InMemory, NativeExecutor<LocalDispatch>>;
 
 /// Polkadot service.
 pub struct Service {
  thread: Option<thread::JoinHandle<()>>,
  client: Arc<Client>,
  network: Arc<network::Service>,
  transaction_pool: Arc<Mutex<TransactionPool>>,
- signal: Option<Signal>,
  _consensus: Option<consensus::Service>,
 }
 
@@ -260,10 +257,6 @@ fn local_testnet_config() -> ChainConfig {
 impl Service {
  /// Creates and register protocol with the network service
  pub fn new(mut config: Configuration) -> Result<Service, error::Error> {
- use std::sync::Barrier;
-
- let (signal, exit) = ::exit_future::signal();
-
  // Create client
  let executor = polkadot_executor::Executor::new();
  let mut storage = Default::default();
@@ -291,12 +284,7 @@ impl Service {
  (primitives::block::Header::decode(&mut block.header.encode().as_ref()).expect("to_vec() always gives a valid serialisation; qed"), storage.into_iter().collect())
  };
 
- let db_settings = client_db::DatabaseSettings {
- cache_size: None,
- path: config.database_path.into(),
- };
-
- let client = Arc::new(client_db::new_client(db_settings, executor, prepare_genesis)?);
+ let client = Arc::new(client::new_in_mem(executor, prepare_genesis)?);
  let best_header = client.best_block_header()?;
  info!("Starting Polkadot. Best block is #{}", best_header.number);
  let transaction_pool = Arc::new(Mutex::new(TransactionPool::new(config.transaction_pool)));
@@ -312,39 +300,7 @@ impl Service {
  chain: client.clone(),
  transaction_pool: transaction_pool_adapter,
  };
-
  let network = network::Service::new(network_params)?;
- let barrier = ::std::sync::Arc::new(Barrier::new(2));
-
- let thread = {
- let client = client.clone();
- let network = network.clone();
- let txpool = transaction_pool.clone();
-
- let thread_barrier = barrier.clone();
- thread::spawn(move || {
- network.start_network();
-
- thread_barrier.wait();
- let mut core = Core::new().expect("tokio::Core could not be created");
- let events = client.import_notification_stream().for_each(move |notification| {
- network.on_block_imported(notification.hash, &notification.header);
- prune_imported(&*client, &*txpool, notification.hash);
-
- Ok(())
- });
-
- core.handle().spawn(events);
- if let Err(e) = core.run(exit) {
- debug!("Polkadot service event loop shutdown with {:?}", e);
- }
- debug!("Polkadot service shutdown");
- })
- };
-
- // wait for the network to start up before starting the consensus
- // service.
- barrier.wait();
 
  // Spin consensus service if configured
  let consensus_service = if config.roles & Role::VALIDATOR == Role::VALIDATOR {
@@ -356,12 +312,28 @@ impl Service {
  None
  };
 
+ let thread_client = client.clone();
+ let thread_network = network.clone();
+ let thread_txpool = transaction_pool.clone();
+ let thread = thread::spawn(move || {
+ thread_network.start_network();
+ let mut core = Core::new().expect("tokio::Core could not be created");
+ let events = thread_client.import_notification_stream().for_each(|notification| {
+ thread_network.on_block_imported(notification.hash, &notification.header);
+ prune_imported(&*thread_client, &*thread_txpool, notification.hash);
+
+ Ok(())
+ });
+ if let Err(e) = core.run(events) {
+ debug!("Polkadot service event loop shutdown with {:?}", e);
+ }
+ debug!("Polkadot service shutdown");
+ });
  Ok(Service {
  thread: Some(thread),
  client: client,
  network: network,
  transaction_pool: transaction_pool,
- signal: Some(signal),
  _consensus: consensus_service,
  })
  }
@@ -401,12 +373,8 @@ pub fn prune_imported(client: &Client, pool: &Mutex<TransactionPool>, hash: Head
 
 impl Drop for Service {
  fn drop(&mut self) {
+ self.client.stop_notifications();
  self.network.stop_network();
-
- if let Some(signal) = self.signal.take() {
- signal.fire();
- }
-
  if let Some(thread) = self.thread.take() {
  thread.join().expect("The service thread has panicked");
  }

substrate/client/Cargo.toml

@@ -17,6 +17,7 @@ substrate-executor = { path = "../executor" }
 substrate-primitives = { path = "../primitives" }
 substrate-runtime-io = { path = "../runtime-io" }
 substrate-runtime-support = { path = "../runtime-support" }
+substrate-runtime-primitives = { path = "../runtime/primitives" }
 substrate-state-machine = { path = "../state-machine" }
 substrate-keyring = { path = "../../substrate/keyring" }
 

substrate/client/src/backend.rs

@@ -18,18 +18,19 @@
 
 use state_machine::backend::Backend as StateBackend;
 use error;
-use primitives::block::{self, Id as BlockId};
-use primitives;
+use primitives::bft::Justification;
+use runtime_primitives::traits::Block as BlockT;
+use runtime_primitives::generic::BlockId;
 
 /// Block insertion operation. Keeps hold if the inserted block state and data.
-pub trait BlockImportOperation {
+pub trait BlockImportOperation<Block: BlockT> {
  /// Associated state backend type.
  type State: StateBackend;
 
  /// Returns pending state.
  fn state(&self) -> error::Result<&Self::State>;
  /// Append block data to the transaction.
- fn set_block_data(&mut self, header: block::Header, body: Option<block::Body>, justification: Option<primitives::bft::Justification>, is_new_best: bool) -> error::Result<()>;
+ fn set_block_data(&mut self, header: Block::Header, body: Option<Vec<Block::Extrinsic>>, justification: Option<Justification>, is_new_best: bool) -> error::Result<()>;
  /// Inject storage data into the database.
  fn update_storage(&mut self, update: <Self::State as StateBackend>::Transaction) -> error::Result<()>;
  /// Inject storage data into the database replacing any existing data.
@@ -44,21 +45,21 @@ pub trait BlockImportOperation {
 ///
 /// The same applies for live `BlockImportOperation`s: while an import operation building on a parent `P`
 /// is alive, the state for `P` should not be pruned.
-pub trait Backend {
+pub trait Backend<Block: BlockT> {
  /// Associated block insertion operation type.
- type BlockImportOperation: BlockImportOperation;
+ type BlockImportOperation: BlockImportOperation<Block>;
  /// Associated blockchain backend type.
- type Blockchain: ::blockchain::Backend;
+ type Blockchain: ::blockchain::Backend<Block>;
  /// Associated state backend type.
  type State: StateBackend;
 
  /// Begin a new block insertion transaction with given parent block id.
  /// When constructing the genesis, this is called with all-zero hash.
- fn begin_operation(&self, block: BlockId) -> error::Result<Self::BlockImportOperation>;
+ fn begin_operation(&self, block: BlockId<Block>) -> error::Result<Self::BlockImportOperation>;
  /// Commit block insertion.
  fn commit_operation(&self, transaction: Self::BlockImportOperation) -> error::Result<()>;
  /// Returns reference to blockchain backend.
  fn blockchain(&self) -> &Self::Blockchain;
  /// Returns state backend with post-state of given block.
- fn state_at(&self, block: BlockId) -> error::Result<Self::State>;
+ fn state_at(&self, block: BlockId<Block>) -> error::Result<Self::State>;
 }

substrate/client/src/block_builder.rs

@@ -17,74 +17,77 @@
 //! Utility struct to build a block.
 
 use std::vec::Vec;
+use std::marker::PhantomData;
 use codec::{Joiner, Slicable};
 use state_machine::{self, CodeExecutor};
-use primitives::{Header, Block};
-use primitives::block::{Id as BlockId, Extrinsic};
+use runtime_primitives::traits::{Header as HeaderT, Hashing as HashingT, Block as BlockT};
+use runtime_primitives::generic::BlockId;
 use {backend, error, Client};
-use triehash::ordered_trie_root;
 
-/// Utility for building new (valid) blocks from a stream of transactions.
-pub struct BlockBuilder<B, E> where
- B: backend::Backend,
+/// Utility for building new (valid) blocks from a stream of extrinsics.
+pub struct BlockBuilder<B, E, Block, Hashing> where
+ B: backend::Backend<Block>,
  E: CodeExecutor + Clone,
- error::Error: From<<<B as backend::Backend>::State as state_machine::backend::Backend>::Error>,
+ Block: BlockT,
+ Hashing: HashingT<Output = <<Block as BlockT>::Header as HeaderT>::Hash>,
+ error::Error: From<<<B as backend::Backend<Block>>::State as state_machine::backend::Backend>::Error>,
 {
- header: Header,
- transactions: Vec<Extrinsic>,
+ header: <Block as BlockT>::Header,
+ extrinsics: Vec<<Block as BlockT>::Extrinsic>,
  executor: E,
  state: B::State,
  changes: state_machine::OverlayedChanges,
+ dummy: PhantomData<Hashing>,
 }
 
-impl<B, E> BlockBuilder<B, E> where
- B: backend::Backend,
+impl<B, E, Block, Hashing> BlockBuilder<B, E, Block, Hashing> where
+ B: backend::Backend<Block>,
  E: CodeExecutor + Clone,
- error::Error: From<<<B as backend::Backend>::State as state_machine::backend::Backend>::Error>,
+ Block: BlockT,
+ Hashing: HashingT<Output = <<Block as BlockT>::Header as HeaderT>::Hash>,
+ error::Error: From<<<B as backend::Backend<Block>>::State as state_machine::backend::Backend>::Error>,
 {
  /// Create a new instance of builder from the given client, building on the latest block.
- pub fn new(client: &Client<B, E>) -> error::Result<Self> {
- client.info().and_then(|i| Self::at_block(&BlockId::Hash(i.chain.best_hash), client))
+ pub fn new(client: &Client<B, E, Block, Hashing>) -> error::Result<Self> {
+ client.info().and_then(|i| Self::at_block(&BlockId::<Block>::Hash(i.chain.best_hash), client))
  }
 
  /// Create a new instance of builder from the given client using a particular block's ID to
  /// build upon.
- pub fn at_block(block_id: &BlockId, client: &Client<B, E>) -> error::Result<Self> {
+ pub fn at_block(block_id: &BlockId<Block>, client: &Client<B, E, Block, Hashing>) -> error::Result<Self> {
  Ok(BlockBuilder {
- header: Header {
- number: client.block_number_from_id(block_id)?.ok_or(error::ErrorKind::UnknownBlock(*block_id))? + 1,
- parent_hash: client.block_hash_from_id(block_id)?.ok_or(error::ErrorKind::UnknownBlock(*block_id))?,
- state_root: Default::default(),
- extrinsics_root: Default::default(),
- digest: Default::default(),
- },
- transactions: Default::default(),
+ header: <<Block as BlockT>::Header as HeaderT>::new(
+ client.block_number_from_id(block_id)?.ok_or(error::ErrorKind::UnknownBlock(Box::new(block_id.clone())))? + 1,
+ Default::default(),
+ Default::default(),
+ client.block_hash_from_id(block_id)?.ok_or(error::ErrorKind::UnknownBlock(Box::new(block_id.clone())))?,
+ Default::default()
+ ),
+ extrinsics: Default::default(),
  executor: client.clone_executor(),
  state: client.state_at(block_id)?,
  changes: Default::default(),
+ dummy: Default::default(),
  })
  }
 
- /// Push a transaction onto the block's list of transactions. This will ensure the transaction
+ /// Push a transaction onto the block's list of extrinsics. This will ensure the transaction
  /// can be validly executed (by executing it); if it is invalid, it'll be returned along with
  /// the error. Otherwise, it will return a mutable reference to self (in order to chain).
- pub fn push(&mut self, tx: Extrinsic) -> error::Result<()> {
+ pub fn push(&mut self, xt: <Block as BlockT>::Extrinsic) -> error::Result<()> {
  let (output, _) = state_machine::execute(&self.state, &mut self.changes, &self.executor, "execute_transaction",
- &vec![].and(&self.header).and(&tx))?;
- self.header = Header::decode(&mut &output[..]).expect("Header came straight out of runtime so must be valid");
- self.transactions.push(tx);
+ &vec![].and(&self.header).and(&xt))?;
+ self.header = <<Block as BlockT>::Header as Slicable>::decode(&mut &output[..]).expect("Header came straight out of runtime so must be valid");
+ self.extrinsics.push(xt);
  Ok(())
  }
 
- /// Consume the builder to return a valid `Block` containing all pushed transactions.
+ /// Consume the builder to return a valid `Block` containing all pushed extrinsics.
  pub fn bake(mut self) -> error::Result<Block> {
- self.header.extrinsics_root = ordered_trie_root(self.transactions.iter().map(Slicable::encode)).0.into();
+ self.header.extrinsics_root = Hashing::ordered_trie_root(self.extrinsics.iter().map(Slicable::encode));
  let (output, _) = state_machine::execute(&self.state, &mut self.changes, &self.executor, "finalise_block",
  &self.header.encode())?;
- self.header = Header::decode(&mut &output[..]).expect("Header came straight out of runtime so must be valid");
- Ok(Block {
- header: self.header,
- transactions: self.transactions,
- })
+ self.header = <<Block as BlockT>::Header as Slicable>::decode(&mut &output[..]).expect("Header came straight out of runtime so must be valid");
+ Ok(<Block as BlockT>::new(self.header, self.extrinsics))
  }
 }

substrate/client/src/blockchain.rs

@@ -16,24 +16,26 @@
 
 //! Polkadot blockchain trait
 
-use primitives::block::{self, Id as BlockId};
-use primitives;
+use runtime_primitives::traits::{Block as BlockT, Header as HeaderT};
+use runtime_primitives::generic::BlockId;
+use primitives::bft::Justification;
+
 use error::Result;
 
 /// Blockchain database backend. Does not perform any validation.
-pub trait Backend: Send + Sync {
+pub trait Backend<Block: BlockT>: Send + Sync {
  /// Get block header. Returns `None` if block is not found.
- fn header(&self, id: BlockId) -> Result<Option<block::Header>>;
+ fn header(&self, id: BlockId<Block>) -> Result<Option<<Block as BlockT>::Header>>;
  /// Get block body. Returns `None` if block is not found.
- fn body(&self, id: BlockId) -> Result<Option<block::Body>>;
+ fn body(&self, id: BlockId<Block>) -> Result<Option<Vec<<Block as BlockT>::Extrinsic>>>;
  /// Get block justification. Returns `None` if justification does not exist.
- fn justification(&self, id: BlockId) -> Result<Option<primitives::bft::Justification>>;
+ fn justification(&self, id: BlockId<Block>) -> Result<Option<Justification>>;
  /// Get blockchain info.
- fn info(&self) -> Result<Info>;
+ fn info(&self) -> Result<Info<Block>>;
  /// Get block status.
- fn status(&self, id: BlockId) -> Result<BlockStatus>;
+ fn status(&self, id: BlockId<Block>) -> Result<BlockStatus>;
  /// Get block hash by number. Returns `None` if the header is not in the chain.
- fn hash(&self, number: block::Number) -> Result<Option<block::HeaderHash>>;
+ fn hash(&self, number: <<Block as BlockT>::Header as HeaderT>::Number) -> Result<Option<<<Block as BlockT>::Header as HeaderT>::Hash>>;
 }
 
 /// Block import outcome
@@ -50,13 +52,13 @@ pub enum ImportResult<E> {
 
 /// Blockchain info
 #[derive(Debug)]
-pub struct Info {
+pub struct Info<Block: BlockT> {
  /// Best block hash.
- pub best_hash: block::HeaderHash,
+ pub best_hash: <<Block as BlockT>::Header as HeaderT>::Hash,
  /// Best block number.
- pub best_number: block::Number,
+ pub best_number: <<Block as BlockT>::Header as HeaderT>::Number,
  /// Genesis block hash.
- pub genesis_hash: block::HeaderHash,
+ pub genesis_hash: <<Block as BlockT>::Header as HeaderT>::Hash,
 }
 
 /// Block status.