Validator/authority contract (#3937)

* dir

* simple validator list

* stub validator contract

* make the engine hold Weak<Client> instead of IoChannel

* validator set factory

* register weak client with ValidatorContract

* check chain security

* add address array to generator

* register provider contract

* update validator set on notify

* add validator contract spec

* simple list test

* split update and contract test

* contract change

* use client in tendermint

* fix deadlock

* step duration in params

* adapt tendermint tests

* add storage fields to test spec

* constructor spec

* execute under wrong address

* create under correct address

* revert

* validator contract constructor

* move genesis block lookup

* add removal ability to contract

* validator contract adding validators

* fix basic authority

* validator changing test

* more docs

* update sync tests

* remove env_logger

* another env_logger

* cameltoe

* hold EngineClient instead of Client

* add a comment about lock scope

ethcore/src/client/client.rs

@@ -53,7 +53,7 @@ use verification::queue::BlockQueue;
 use blockchain::{BlockChain, BlockProvider, TreeRoute, ImportRoute};
 use client::{
 	BlockId, TransactionId, UncleId, TraceId, ClientConfig, BlockChainClient,
-	MiningBlockChainClient, TraceFilter, CallAnalytics, BlockImportError, Mode,
+	MiningBlockChainClient, EngineClient, TraceFilter, CallAnalytics, BlockImportError, Mode,
 	ChainNotify, PruningInfo,
 };
 use client::Error as ClientError;
@@ -1315,11 +1315,6 @@ impl BlockChainClient for Client {
 		}
 	}
 
-	fn broadcast_consensus_message(&self, message: Bytes) {
-		self.notify(|notify| notify.broadcast(message.clone()));
-	}
-
-
 	fn signing_network_id(&self) -> Option<u64> {
 		self.engine.signing_network_id(&self.latest_env_info())
 	}
@@ -1414,16 +1409,6 @@ impl MiningBlockChainClient for Client {
 		&self.factories.vm
 	}
 
-	fn update_sealing(&self) {
-		self.miner.update_sealing(self)
-	}
-
-	fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>) {
-		if self.miner.submit_seal(self, block_hash, seal).is_err() {
-			warn!(target: "poa", "Wrong internal seal submission!")
-		}
-	}
-
 	fn broadcast_proposal_block(&self, block: SealedBlock) {
 		self.notify(|notify| {
 			notify.new_blocks(
@@ -1471,6 +1456,22 @@ impl MiningBlockChainClient for Client {
 	}
 }
 
+impl EngineClient for Client {
+	fn update_sealing(&self) {
+		self.miner.update_sealing(self)
+	}
+
+	fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>) {
+		if self.miner.submit_seal(self, block_hash, seal).is_err() {
+			warn!(target: "poa", "Wrong internal seal submission!")
+		}
+	}
+
+	fn broadcast_consensus_message(&self, message: Bytes) {
+		self.notify(|notify| notify.broadcast(message.clone()));
+	}
+}
+
 impl MayPanic for Client {
 	fn on_panic<F>(&self, closure: F) where F: OnPanicListener {
 		self.panic_handler.on_panic(closure);

ethcore/src/client/mod.rs

@@ -28,7 +28,7 @@ pub use self::config::{Mode, ClientConfig, DatabaseCompactionProfile, BlockChain
 pub use self::error::Error;
 pub use self::test_client::{TestBlockChainClient, EachBlockWith};
 pub use self::chain_notify::ChainNotify;
-pub use self::traits::{BlockChainClient, MiningBlockChainClient};
+pub use self::traits::{BlockChainClient, MiningBlockChainClient, EngineClient};
 
 pub use self::traits::ProvingBlockChainClient;
 

ethcore/src/client/test_client.rs

@@ -24,7 +24,7 @@ use devtools::*;
 use transaction::{Transaction, LocalizedTransaction, SignedTransaction, PendingTransaction, Action};
 use blockchain::TreeRoute;
 use client::{
-	BlockChainClient, MiningBlockChainClient, BlockChainInfo, BlockStatus, BlockId,
+	BlockChainClient, MiningBlockChainClient, EngineClient, BlockChainInfo, BlockStatus, BlockId,
 	TransactionId, UncleId, TraceId, TraceFilter, LastHashes, CallAnalytics, BlockImportError,
 };
 use db::{NUM_COLUMNS, COL_STATE};
@@ -372,16 +372,6 @@ impl MiningBlockChainClient for TestBlockChainClient {
 	}
 
 	fn broadcast_proposal_block(&self, _block: SealedBlock) {}
-
-	fn update_sealing(&self) {
-		self.miner.update_sealing(self)
-	}
-
-	fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>) {
-		if self.miner.submit_seal(self, block_hash, seal).is_err() {
-			warn!(target: "poa", "Wrong internal seal submission!")
-		}
-	}
 }
 
 impl BlockChainClient for TestBlockChainClient {
@@ -699,8 +689,6 @@ impl BlockChainClient for TestBlockChainClient {
 		self.spec.engine.handle_message(&message).unwrap();
 	}
 
-	fn broadcast_consensus_message(&self, _message: Bytes) {}
-
 	fn ready_transactions(&self) -> Vec<PendingTransaction> {
 		self.miner.ready_transactions(self.chain_info().best_block_number)
 	}
@@ -727,3 +715,17 @@ impl BlockChainClient for TestBlockChainClient {
 
 	fn registry_address(&self, _name: String) -> Option<Address> { None }
 }
+
+impl EngineClient for TestBlockChainClient {
+	fn update_sealing(&self) {
+		self.miner.update_sealing(self)
+	}
+
+	fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>) {
+		if self.miner.submit_seal(self, block_hash, seal).is_err() {
+			warn!(target: "poa", "Wrong internal seal submission!")
+		}
+	}
+
+	fn broadcast_consensus_message(&self, _message: Bytes) {}
+}

ethcore/src/client/traits.rs

@@ -208,9 +208,6 @@ pub trait BlockChainClient : Sync + Send {
 	/// Queue conensus engine message.
 	fn queue_consensus_message(&self, message: Bytes);
 
-	/// Used by PoA to communicate with peers.
-	fn broadcast_consensus_message(&self, message: Bytes);
-
 	/// List all transactions that are allowed into the next block.
 	fn ready_transactions(&self) -> Vec<PendingTransaction>;
 
@@ -294,12 +291,6 @@ pub trait MiningBlockChainClient: BlockChainClient {
 	/// Returns EvmFactory.
 	fn vm_factory(&self) -> &EvmFactory;
 
-	/// Used by PoA to try sealing on period change.
-	fn update_sealing(&self);
-
-	/// Used by PoA to submit gathered signatures.
-	fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>);
-
 	/// Broadcast a block proposal.
 	fn broadcast_proposal_block(&self, block: SealedBlock);
 
@@ -310,6 +301,18 @@ pub trait MiningBlockChainClient: BlockChainClient {
 	fn latest_schedule(&self) -> Schedule;
 }
 
+/// Client facilities used by internally sealing Engines.
+pub trait EngineClient: MiningBlockChainClient {
+	/// Make a new block and seal it.
+	fn update_sealing(&self);
+
+	/// Submit a seal for a block in the mining queue.
+	fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>);
+
+	/// Broadcast a consensus message to the network.
+	fn broadcast_consensus_message(&self, message: Bytes);
+}
+
 /// Extended client interface for providing proofs of the state.
 pub trait ProvingBlockChainClient: BlockChainClient {
 	/// Prove account storage at a specific block id.