334 lines
12 KiB
Rust
334 lines
12 KiB
Rust
// Copyright 2015-2020 Parity Technologies (UK) Ltd.
|
|
// This file is part of OpenEthereum.
|
|
|
|
// OpenEthereum 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.
|
|
|
|
// OpenEthereum 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 OpenEthereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/// Validator set changing at fork blocks.
|
|
use std::collections::BTreeMap;
|
|
use std::sync::Weak;
|
|
|
|
use bytes::Bytes;
|
|
use ethereum_types::{Address, H256};
|
|
use parking_lot::RwLock;
|
|
use types::{header::Header, ids::BlockId, BlockNumber};
|
|
|
|
use super::{SystemCall, ValidatorSet};
|
|
use client::EngineClient;
|
|
use error::Error as EthcoreError;
|
|
use machine::{AuxiliaryData, Call, EthereumMachine};
|
|
|
|
type BlockNumberLookup =
|
|
Box<dyn Fn(BlockId) -> Result<BlockNumber, String> + Send + Sync + 'static>;
|
|
|
|
pub struct Multi {
|
|
sets: BTreeMap<BlockNumber, Box<dyn ValidatorSet>>,
|
|
block_number: RwLock<BlockNumberLookup>,
|
|
}
|
|
|
|
impl Multi {
|
|
pub fn new(set_map: BTreeMap<BlockNumber, Box<dyn ValidatorSet>>) -> Self {
|
|
assert!(
|
|
set_map.get(&0u64).is_some(),
|
|
"ValidatorSet has to be specified from block 0."
|
|
);
|
|
Multi {
|
|
sets: set_map,
|
|
block_number: RwLock::new(Box::new(move |_| Err("No client!".into()))),
|
|
}
|
|
}
|
|
|
|
fn map_children<T, F>(&self, header: &Header, mut func: F) -> Result<T, EthcoreError>
|
|
where
|
|
F: FnMut(&dyn ValidatorSet, bool) -> Result<T, EthcoreError>,
|
|
{
|
|
let (set_block, set) = self.correct_set_by_number(header.number());
|
|
let first = set_block == header.number();
|
|
func(set, first)
|
|
}
|
|
|
|
fn correct_set(&self, id: BlockId) -> Option<&dyn ValidatorSet> {
|
|
match self.block_number.read()(id)
|
|
.map(|parent_block| self.correct_set_by_number(parent_block))
|
|
{
|
|
Ok((_, set)) => Some(set),
|
|
Err(e) => {
|
|
debug!(target: "engine", "ValidatorSet could not be recovered: {}", e);
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
// get correct set by block number, along with block number at which
|
|
// this set was activated.
|
|
fn correct_set_by_number(&self, parent_block: BlockNumber) -> (BlockNumber, &dyn ValidatorSet) {
|
|
let (block, set) = self.sets.iter()
|
|
.rev()
|
|
.find(|&(block, _)| *block <= parent_block + 1)
|
|
.expect("constructor validation ensures that there is at least one validator set for block 0;
|
|
block 0 is less than any uint;
|
|
qed");
|
|
|
|
trace!(target: "engine", "Multi ValidatorSet retrieved for block {}.", block);
|
|
(*block, &**set)
|
|
}
|
|
}
|
|
|
|
impl ValidatorSet for Multi {
|
|
fn default_caller(&self, block_id: BlockId) -> Box<Call> {
|
|
self.correct_set(block_id)
|
|
.map(|set| set.default_caller(block_id))
|
|
.unwrap_or_else(|| Box::new(|_, _| Err("No validator set for given ID.".into())))
|
|
}
|
|
|
|
fn generate_engine_transactions(
|
|
&self,
|
|
_first: bool,
|
|
header: &Header,
|
|
call: &mut SystemCall,
|
|
) -> Result<Vec<(Address, Bytes)>, EthcoreError> {
|
|
self.map_children(header, &mut |set: &dyn ValidatorSet, first| {
|
|
set.generate_engine_transactions(first, header, call)
|
|
})
|
|
}
|
|
fn on_close_block(&self, header: &Header, address: &Address) -> Result<(), EthcoreError> {
|
|
self.map_children(header, &mut |set: &dyn ValidatorSet, _first| {
|
|
set.on_close_block(header, address)
|
|
})
|
|
}
|
|
|
|
fn on_epoch_begin(
|
|
&self,
|
|
_first: bool,
|
|
header: &Header,
|
|
call: &mut SystemCall,
|
|
) -> Result<(), EthcoreError> {
|
|
self.map_children(header, &mut |set: &dyn ValidatorSet, first| {
|
|
set.on_epoch_begin(first, header, call)
|
|
})
|
|
}
|
|
|
|
fn genesis_epoch_data(&self, header: &Header, call: &Call) -> Result<Vec<u8>, String> {
|
|
self.correct_set_by_number(0)
|
|
.1
|
|
.genesis_epoch_data(header, call)
|
|
}
|
|
|
|
fn is_epoch_end(&self, _first: bool, chain_head: &Header) -> Option<Vec<u8>> {
|
|
let (set_block, set) = self.correct_set_by_number(chain_head.number());
|
|
let first = set_block == chain_head.number();
|
|
|
|
set.is_epoch_end(first, chain_head)
|
|
}
|
|
|
|
fn signals_epoch_end(
|
|
&self,
|
|
_first: bool,
|
|
header: &Header,
|
|
aux: AuxiliaryData,
|
|
) -> ::engines::EpochChange<EthereumMachine> {
|
|
let (set_block, set) = self.correct_set_by_number(header.number());
|
|
let first = set_block == header.number();
|
|
|
|
set.signals_epoch_end(first, header, aux)
|
|
}
|
|
|
|
fn epoch_set(
|
|
&self,
|
|
_first: bool,
|
|
machine: &EthereumMachine,
|
|
number: BlockNumber,
|
|
proof: &[u8],
|
|
) -> Result<(super::SimpleList, Option<H256>), ::error::Error> {
|
|
let (set_block, set) = self.correct_set_by_number(number);
|
|
let first = set_block == number;
|
|
|
|
set.epoch_set(first, machine, number, proof)
|
|
}
|
|
|
|
fn contains_with_caller(&self, bh: &H256, address: &Address, caller: &Call) -> bool {
|
|
self.correct_set(BlockId::Hash(*bh))
|
|
.map_or(false, |set| set.contains_with_caller(bh, address, caller))
|
|
}
|
|
|
|
fn get_with_caller(&self, bh: &H256, nonce: usize, caller: &Call) -> Address {
|
|
self.correct_set(BlockId::Hash(*bh))
|
|
.map_or_else(Default::default, |set| {
|
|
set.get_with_caller(bh, nonce, caller)
|
|
})
|
|
}
|
|
|
|
fn count_with_caller(&self, bh: &H256, caller: &Call) -> usize {
|
|
self.correct_set(BlockId::Hash(*bh))
|
|
.map_or_else(usize::max_value, |set| set.count_with_caller(bh, caller))
|
|
}
|
|
|
|
fn report_malicious(
|
|
&self,
|
|
validator: &Address,
|
|
set_block: BlockNumber,
|
|
block: BlockNumber,
|
|
proof: Bytes,
|
|
) {
|
|
self.correct_set_by_number(set_block)
|
|
.1
|
|
.report_malicious(validator, set_block, block, proof);
|
|
}
|
|
|
|
fn report_benign(&self, validator: &Address, set_block: BlockNumber, block: BlockNumber) {
|
|
self.correct_set_by_number(set_block)
|
|
.1
|
|
.report_benign(validator, set_block, block);
|
|
}
|
|
|
|
fn register_client(&self, client: Weak<dyn EngineClient>) {
|
|
for set in self.sets.values() {
|
|
set.register_client(client.clone());
|
|
}
|
|
*self.block_number.write() = Box::new(move |id| {
|
|
client
|
|
.upgrade()
|
|
.ok_or_else(|| "No client!".into())
|
|
.and_then(|c| c.block_number(id).ok_or_else(|| "Unknown block".into()))
|
|
});
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use accounts::AccountProvider;
|
|
use client::{
|
|
traits::{ForceUpdateSealing, TransactionRequest},
|
|
BlockChainClient, BlockInfo, ChainInfo, ImportBlock,
|
|
};
|
|
use crypto::publickey::Secret;
|
|
use engines::{validator_set::ValidatorSet, EpochChange};
|
|
use ethereum_types::Address;
|
|
use hash::keccak;
|
|
use miner::{self, MinerService};
|
|
use spec::Spec;
|
|
use std::{collections::BTreeMap, sync::Arc};
|
|
use test_helpers::generate_dummy_client_with_spec;
|
|
use types::{header::Header, ids::BlockId};
|
|
use verification::queue::kind::blocks::Unverified;
|
|
|
|
use super::Multi;
|
|
|
|
#[test]
|
|
fn uses_current_set() {
|
|
let tap = Arc::new(AccountProvider::transient_provider());
|
|
let s0: Secret = keccak("0").into();
|
|
let v0 = tap.insert_account(s0.clone(), &"".into()).unwrap();
|
|
let v1 = tap.insert_account(keccak("1").into(), &"".into()).unwrap();
|
|
let client = generate_dummy_client_with_spec(Spec::new_validator_multi);
|
|
client
|
|
.engine()
|
|
.register_client(Arc::downgrade(&client) as _);
|
|
|
|
// Make sure txs go through.
|
|
client
|
|
.miner()
|
|
.set_gas_range_target((1_000_000.into(), 1_000_000.into()));
|
|
|
|
// Wrong signer for the first block.
|
|
let signer = Box::new((tap.clone(), v1, "".into()));
|
|
client.miner().set_author(miner::Author::Sealer(signer));
|
|
client
|
|
.transact(TransactionRequest::call(
|
|
Default::default(),
|
|
Default::default(),
|
|
))
|
|
.unwrap();
|
|
::client::EngineClient::update_sealing(&*client, ForceUpdateSealing::No);
|
|
assert_eq!(client.chain_info().best_block_number, 0);
|
|
// Right signer for the first block.
|
|
let signer = Box::new((tap.clone(), v0, "".into()));
|
|
client.miner().set_author(miner::Author::Sealer(signer));
|
|
::client::EngineClient::update_sealing(&*client, ForceUpdateSealing::No);
|
|
assert_eq!(client.chain_info().best_block_number, 1);
|
|
// This time v0 is wrong.
|
|
client
|
|
.transact(TransactionRequest::call(
|
|
Default::default(),
|
|
Default::default(),
|
|
))
|
|
.unwrap();
|
|
::client::EngineClient::update_sealing(&*client, ForceUpdateSealing::No);
|
|
assert_eq!(client.chain_info().best_block_number, 1);
|
|
let signer = Box::new((tap.clone(), v1, "".into()));
|
|
client.miner().set_author(miner::Author::Sealer(signer));
|
|
::client::EngineClient::update_sealing(&*client, ForceUpdateSealing::No);
|
|
assert_eq!(client.chain_info().best_block_number, 2);
|
|
// v1 is still good.
|
|
client
|
|
.transact(TransactionRequest::call(
|
|
Default::default(),
|
|
Default::default(),
|
|
))
|
|
.unwrap();
|
|
::client::EngineClient::update_sealing(&*client, ForceUpdateSealing::No);
|
|
assert_eq!(client.chain_info().best_block_number, 3);
|
|
|
|
// Check syncing.
|
|
let sync_client = generate_dummy_client_with_spec(Spec::new_validator_multi);
|
|
sync_client
|
|
.engine()
|
|
.register_client(Arc::downgrade(&sync_client) as _);
|
|
for i in 1..4 {
|
|
sync_client
|
|
.import_block(
|
|
Unverified::from_rlp(client.block(BlockId::Number(i)).unwrap().into_inner())
|
|
.unwrap(),
|
|
)
|
|
.unwrap();
|
|
}
|
|
sync_client.flush_queue();
|
|
assert_eq!(sync_client.chain_info().best_block_number, 3);
|
|
}
|
|
|
|
#[test]
|
|
fn transition_to_fixed_list_instant() {
|
|
use super::super::SimpleList;
|
|
|
|
let mut map: BTreeMap<_, Box<dyn ValidatorSet>> = BTreeMap::new();
|
|
let list1: Vec<_> = (0..10).map(|_| Address::random()).collect();
|
|
let list2 = {
|
|
let mut list = list1.clone();
|
|
list.push(Address::random());
|
|
list
|
|
};
|
|
|
|
map.insert(0, Box::new(SimpleList::new(list1)));
|
|
map.insert(500, Box::new(SimpleList::new(list2)));
|
|
|
|
let multi = Multi::new(map);
|
|
|
|
let mut header = Header::new();
|
|
header.set_number(499);
|
|
|
|
match multi.signals_epoch_end(false, &header, Default::default()) {
|
|
EpochChange::No => {}
|
|
_ => panic!("Expected no epoch signal change."),
|
|
}
|
|
assert!(multi.is_epoch_end(false, &header).is_none());
|
|
|
|
header.set_number(500);
|
|
|
|
match multi.signals_epoch_end(false, &header, Default::default()) {
|
|
EpochChange::No => {}
|
|
_ => panic!("Expected no epoch signal change."),
|
|
}
|
|
assert!(multi.is_epoch_end(false, &header).is_some());
|
|
}
|
|
}
|