2017-01-25 18:51:41 +01:00
|
|
|
// Copyright 2015-2017 Parity Technologies (UK) Ltd.
|
2017-01-10 12:23:59 +01:00
|
|
|
// This file is part of Parity.
|
|
|
|
|
|
|
|
// Parity 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.
|
|
|
|
|
|
|
|
// Parity 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 Parity. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2017-01-24 10:03:58 +01:00
|
|
|
/// Validator set maintained in a contract, updated using `getValidators` method.
|
|
|
|
/// It can also report validators for misbehaviour with two levels: `reportMalicious` and `reportBenign`.
|
2017-01-10 12:23:59 +01:00
|
|
|
|
|
|
|
use std::sync::Weak;
|
|
|
|
use util::*;
|
2017-04-12 16:15:35 +02:00
|
|
|
|
2017-04-12 16:42:19 +02:00
|
|
|
use futures::Future;
|
2017-04-12 16:15:35 +02:00
|
|
|
use native_contracts::ValidatorReport as Provider;
|
|
|
|
|
2017-04-12 16:42:19 +02:00
|
|
|
use client::{Client, BlockChainClient};
|
|
|
|
use engines::Call;
|
2017-04-12 18:55:38 +02:00
|
|
|
use header::Header;
|
2017-04-12 16:42:19 +02:00
|
|
|
|
2017-01-10 12:23:59 +01:00
|
|
|
use super::ValidatorSet;
|
2017-01-24 10:03:58 +01:00
|
|
|
use super::safe_contract::ValidatorSafeContract;
|
2017-01-10 12:23:59 +01:00
|
|
|
|
2017-04-12 16:15:35 +02:00
|
|
|
/// A validator contract with reporting.
|
2017-01-10 12:23:59 +01:00
|
|
|
pub struct ValidatorContract {
|
2017-03-08 14:41:24 +01:00
|
|
|
validators: ValidatorSafeContract,
|
2017-04-12 16:15:35 +02:00
|
|
|
provider: Provider,
|
|
|
|
client: RwLock<Option<Weak<Client>>>, // TODO [keorn]: remove
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
impl ValidatorContract {
|
|
|
|
pub fn new(contract_address: Address) -> Self {
|
|
|
|
ValidatorContract {
|
2017-03-08 14:41:24 +01:00
|
|
|
validators: ValidatorSafeContract::new(contract_address),
|
2017-04-12 16:15:35 +02:00
|
|
|
provider: Provider::new(contract_address),
|
|
|
|
client: RwLock::new(None),
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-04-12 16:15:35 +02:00
|
|
|
impl ValidatorContract {
|
|
|
|
// could be `impl Trait`.
|
|
|
|
// note: dispatches transactions to network as well as execute.
|
|
|
|
// TODO [keorn]: Make more general.
|
2017-04-12 16:42:19 +02:00
|
|
|
fn transact(&self) -> Box<Call> {
|
2017-04-12 16:15:35 +02:00
|
|
|
let client = self.client.read().clone();
|
|
|
|
Box::new(move |a, d| client.as_ref()
|
|
|
|
.and_then(Weak::upgrade)
|
|
|
|
.ok_or("No client!".into())
|
|
|
|
.and_then(|c| c.transact_contract(a, d).map_err(|e| format!("Transaction import error: {}", e)))
|
|
|
|
.map(|_| Default::default()))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-08 14:41:24 +01:00
|
|
|
impl ValidatorSet for ValidatorContract {
|
2017-04-12 16:42:19 +02:00
|
|
|
fn default_caller(&self, id: ::ids::BlockId) -> Box<Call> {
|
|
|
|
self.validators.default_caller(id)
|
|
|
|
}
|
|
|
|
|
2017-04-18 14:19:10 +02:00
|
|
|
fn is_epoch_end(&self, header: &Header, block: Option<&[u8]>, receipts: Option<&[::receipt::Receipt]>)
|
|
|
|
-> ::engines::EpochChange
|
2017-04-12 18:55:38 +02:00
|
|
|
{
|
2017-04-18 14:19:10 +02:00
|
|
|
self.validators.is_epoch_end(header, block, receipts)
|
2017-04-12 18:55:38 +02:00
|
|
|
}
|
|
|
|
|
2017-04-18 14:19:10 +02:00
|
|
|
fn epoch_proof(&self, header: &Header, caller: &Call) -> Result<Vec<u8>, String> {
|
|
|
|
self.validators.epoch_proof(header, caller)
|
2017-04-12 18:55:38 +02:00
|
|
|
}
|
|
|
|
|
2017-04-19 14:58:19 +02:00
|
|
|
fn epoch_set(&self, header: &Header, proof: &[u8]) -> Result<(u64, super::SimpleList), ::error::Error> {
|
2017-04-18 14:19:10 +02:00
|
|
|
self.validators.epoch_set(header, proof)
|
2017-04-13 20:24:21 +02:00
|
|
|
}
|
|
|
|
|
2017-04-12 16:42:19 +02:00
|
|
|
fn contains_with_caller(&self, bh: &H256, address: &Address, caller: &Call) -> bool {
|
|
|
|
self.validators.contains_with_caller(bh, address, caller)
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
|
|
|
|
2017-04-12 16:42:19 +02:00
|
|
|
fn get_with_caller(&self, bh: &H256, nonce: usize, caller: &Call) -> Address {
|
|
|
|
self.validators.get_with_caller(bh, nonce, caller)
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
|
|
|
|
2017-04-12 16:42:19 +02:00
|
|
|
fn count_with_caller(&self, bh: &H256, caller: &Call) -> usize {
|
|
|
|
self.validators.count_with_caller(bh, caller)
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
|
|
|
|
2017-01-24 10:03:58 +01:00
|
|
|
fn report_malicious(&self, address: &Address) {
|
2017-04-12 16:15:35 +02:00
|
|
|
match self.provider.report_malicious(&*self.transact(), *address).wait() {
|
|
|
|
Ok(_) => warn!(target: "engine", "Reported malicious validator {}", address),
|
|
|
|
Err(s) => warn!(target: "engine", "Validator {} could not be reported {}", address, s),
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
2017-01-24 10:03:58 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
fn report_benign(&self, address: &Address) {
|
2017-04-12 16:15:35 +02:00
|
|
|
match self.provider.report_benign(&*self.transact(), *address).wait() {
|
|
|
|
Ok(_) => warn!(target: "engine", "Reported benign validator misbehaviour {}", address),
|
|
|
|
Err(s) => warn!(target: "engine", "Validator {} could not be reported {}", address, s),
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
2017-01-24 10:03:58 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
fn register_contract(&self, client: Weak<Client>) {
|
|
|
|
self.validators.register_contract(client.clone());
|
2017-04-12 16:15:35 +02:00
|
|
|
*self.client.write() = Some(client);
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use util::*;
|
2017-01-24 10:03:58 +01:00
|
|
|
use rlp::encode;
|
|
|
|
use ethkey::Secret;
|
2017-01-10 12:23:59 +01:00
|
|
|
use spec::Spec;
|
2017-01-24 10:03:58 +01:00
|
|
|
use header::Header;
|
2017-01-10 12:23:59 +01:00
|
|
|
use account_provider::AccountProvider;
|
|
|
|
use miner::MinerService;
|
2017-03-08 14:41:24 +01:00
|
|
|
use types::ids::BlockId;
|
2017-01-24 10:03:58 +01:00
|
|
|
use client::BlockChainClient;
|
2017-01-18 18:49:50 +01:00
|
|
|
use tests::helpers::generate_dummy_client_with_spec_and_accounts;
|
2017-01-10 12:23:59 +01:00
|
|
|
use super::super::ValidatorSet;
|
|
|
|
use super::ValidatorContract;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn fetches_validators() {
|
2017-01-18 18:49:50 +01:00
|
|
|
let client = generate_dummy_client_with_spec_and_accounts(Spec::new_validator_contract, None);
|
2017-01-10 12:23:59 +01:00
|
|
|
let vc = Arc::new(ValidatorContract::new(Address::from_str("0000000000000000000000000000000000000005").unwrap()));
|
2017-01-24 10:03:58 +01:00
|
|
|
vc.register_contract(Arc::downgrade(&client));
|
2017-03-08 14:41:24 +01:00
|
|
|
let last_hash = client.best_block_header().hash();
|
|
|
|
assert!(vc.contains(&last_hash, &Address::from_str("7d577a597b2742b498cb5cf0c26cdcd726d39e6e").unwrap()));
|
|
|
|
assert!(vc.contains(&last_hash, &Address::from_str("82a978b3f5962a5b0957d9ee9eef472ee55b42f1").unwrap()));
|
2017-01-10 12:23:59 +01:00
|
|
|
}
|
2017-03-11 19:58:15 +01:00
|
|
|
|
2017-01-10 12:23:59 +01:00
|
|
|
#[test]
|
2017-01-24 10:03:58 +01:00
|
|
|
fn reports_validators() {
|
2017-01-10 12:23:59 +01:00
|
|
|
let tap = Arc::new(AccountProvider::transient_provider());
|
2017-01-24 10:03:58 +01:00
|
|
|
let v1 = tap.insert_account(Secret::from_slice(&"1".sha3()).unwrap(), "").unwrap();
|
|
|
|
let client = generate_dummy_client_with_spec_and_accounts(Spec::new_validator_contract, Some(tap.clone()));
|
2017-01-10 12:23:59 +01:00
|
|
|
client.engine().register_client(Arc::downgrade(&client));
|
|
|
|
let validator_contract = Address::from_str("0000000000000000000000000000000000000005").unwrap();
|
|
|
|
|
2017-01-24 10:03:58 +01:00
|
|
|
// Make sure reporting can be done.
|
|
|
|
client.miner().set_gas_floor_target(1_000_000.into());
|
|
|
|
|
2017-01-10 12:23:59 +01:00
|
|
|
client.miner().set_engine_signer(v1, "".into()).unwrap();
|
2017-01-24 10:03:58 +01:00
|
|
|
let mut header = Header::default();
|
2017-03-11 19:58:15 +01:00
|
|
|
let seal = vec![encode(&5u8).to_vec(), encode(&(&H520::default() as &[u8])).to_vec()];
|
2017-03-08 14:41:24 +01:00
|
|
|
header.set_seal(seal);
|
2017-01-24 10:03:58 +01:00
|
|
|
header.set_author(v1);
|
2017-03-08 14:41:24 +01:00
|
|
|
header.set_number(2);
|
|
|
|
header.set_parent_hash(client.chain_info().best_block_hash);
|
2017-03-11 19:58:15 +01:00
|
|
|
|
2017-01-24 10:03:58 +01:00
|
|
|
// `reportBenign` when the designated proposer releases block from the future (bad clock).
|
2017-04-13 20:24:21 +02:00
|
|
|
assert!(client.engine().verify_block_external(&header, None).is_err());
|
2017-01-24 10:03:58 +01:00
|
|
|
// Seal a block.
|
|
|
|
client.engine().step();
|
2017-01-10 12:23:59 +01:00
|
|
|
assert_eq!(client.chain_info().best_block_number, 1);
|
2017-01-24 10:03:58 +01:00
|
|
|
// Check if the unresponsive validator is `disliked`.
|
2017-03-08 14:41:24 +01:00
|
|
|
assert_eq!(client.call_contract(BlockId::Latest, validator_contract, "d8f2e0bf".from_hex().unwrap()).unwrap().to_hex(), "0000000000000000000000007d577a597b2742b498cb5cf0c26cdcd726d39e6e");
|
2017-01-24 10:03:58 +01:00
|
|
|
// Simulate a misbehaving validator by handling a double proposal.
|
2017-03-08 14:41:24 +01:00
|
|
|
let header = client.best_block_header().decode();
|
2017-01-24 10:03:58 +01:00
|
|
|
assert!(client.engine().verify_block_family(&header, &header, None).is_err());
|
|
|
|
// Seal a block.
|
|
|
|
client.engine().step();
|
|
|
|
client.engine().step();
|
|
|
|
assert_eq!(client.chain_info().best_block_number, 2);
|
2017-01-10 12:23:59 +01:00
|
|
|
|
2017-01-24 10:03:58 +01:00
|
|
|
// Check if misbehaving validator was removed.
|
|
|
|
client.transact_contract(Default::default(), Default::default()).unwrap();
|
|
|
|
client.engine().step();
|
|
|
|
client.engine().step();
|
2017-01-10 12:23:59 +01:00
|
|
|
assert_eq!(client.chain_info().best_block_number, 2);
|
|
|
|
}
|
|
|
|
}
|