// Copyright 2015, 2016 Parity Technologies (UK) Ltd. // 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 . //! Test client. use std::sync::atomic::{AtomicUsize, Ordering as AtomicOrder}; use util::*; use rlp::*; use ethkey::{Generator, Random}; use devtools::*; use transaction::{Transaction, LocalizedTransaction, SignedTransaction, Action}; use blockchain::TreeRoute; use client::{ BlockChainClient, MiningBlockChainClient, BlockChainInfo, BlockStatus, BlockId, TransactionId, UncleId, TraceId, TraceFilter, LastHashes, CallAnalytics, BlockImportError, }; use db::{NUM_COLUMNS, COL_STATE}; use header::{Header as BlockHeader, BlockNumber}; use filter::Filter; use log_entry::LocalizedLogEntry; use receipt::{Receipt, LocalizedReceipt}; use blockchain::extras::BlockReceipts; use error::{ImportResult}; use evm::{Factory as EvmFactory, VMType, Schedule}; use miner::{Miner, MinerService, TransactionImportResult}; use spec::Spec; use types::mode::Mode; use types::pruning_info::PruningInfo; use views::BlockView; use verification::queue::QueueInfo; use block::{OpenBlock, SealedBlock}; use executive::Executed; use error::CallError; use trace::LocalizedTrace; use state_db::StateDB; /// Test client. pub struct TestBlockChainClient { /// Blocks. pub blocks: RwLock>, /// Mapping of numbers to hashes. pub numbers: RwLock>, /// Genesis block hash. pub genesis_hash: H256, /// Last block hash. pub last_hash: RwLock, /// Extra data do set for each block pub extra_data: Bytes, /// Difficulty. pub difficulty: RwLock, /// Balances. pub balances: RwLock>, /// Nonces. pub nonces: RwLock>, /// Storage. pub storage: RwLock>, /// Code. pub code: RwLock>, /// Execution result. pub execution_result: RwLock>>, /// Transaction receipts. pub receipts: RwLock>, /// Logs pub logs: RwLock>, /// Block queue size. pub queue_size: AtomicUsize, /// Miner pub miner: Arc, /// Spec pub spec: Spec, /// VM Factory pub vm_factory: EvmFactory, /// Timestamp assigned to latest sealed block pub latest_block_timestamp: RwLock, /// Ancient block info. pub ancient_block: RwLock>, /// First block info. pub first_block: RwLock>, } /// Used for generating test client blocks. #[derive(Clone)] pub enum EachBlockWith { /// Plain block. Nothing, /// Block with an uncle. Uncle, /// Block with a transaction. Transaction, /// Block with an uncle and transaction. UncleAndTransaction } impl Default for TestBlockChainClient { fn default() -> Self { TestBlockChainClient::new() } } impl TestBlockChainClient { /// Creates new test client. pub fn new() -> Self { Self::new_with_extra_data(Bytes::new()) } /// Creates new test client with specified extra data for each block pub fn new_with_extra_data(extra_data: Bytes) -> Self { let spec = Spec::new_test(); TestBlockChainClient::new_with_spec_and_extra(spec, extra_data) } /// Create test client with custom spec. pub fn new_with_spec(spec: Spec) -> Self { TestBlockChainClient::new_with_spec_and_extra(spec, Bytes::new()) } /// Create test client with custom spec and extra data. pub fn new_with_spec_and_extra(spec: Spec, extra_data: Bytes) -> Self { let mut client = TestBlockChainClient { blocks: RwLock::new(HashMap::new()), numbers: RwLock::new(HashMap::new()), genesis_hash: H256::new(), extra_data: extra_data, last_hash: RwLock::new(H256::new()), difficulty: RwLock::new(From::from(0)), balances: RwLock::new(HashMap::new()), nonces: RwLock::new(HashMap::new()), storage: RwLock::new(HashMap::new()), code: RwLock::new(HashMap::new()), execution_result: RwLock::new(None), receipts: RwLock::new(HashMap::new()), logs: RwLock::new(Vec::new()), queue_size: AtomicUsize::new(0), miner: Arc::new(Miner::with_spec(&spec)), spec: spec, vm_factory: EvmFactory::new(VMType::Interpreter, 1024 * 1024), latest_block_timestamp: RwLock::new(10_000_000), ancient_block: RwLock::new(None), first_block: RwLock::new(None), }; client.add_blocks(1, EachBlockWith::Nothing); // add genesis block client.genesis_hash = client.last_hash.read().clone(); client } /// Set the transaction receipt result pub fn set_transaction_receipt(&self, id: TransactionId, receipt: LocalizedReceipt) { self.receipts.write().insert(id, receipt); } /// Set the execution result. pub fn set_execution_result(&self, result: Result) { *self.execution_result.write() = Some(result); } /// Set the balance of account `address` to `balance`. pub fn set_balance(&self, address: Address, balance: U256) { self.balances.write().insert(address, balance); } /// Set nonce of account `address` to `nonce`. pub fn set_nonce(&self, address: Address, nonce: U256) { self.nonces.write().insert(address, nonce); } /// Set `code` at `address`. pub fn set_code(&self, address: Address, code: Bytes) { self.code.write().insert(address, code); } /// Set storage `position` to `value` for account `address`. pub fn set_storage(&self, address: Address, position: H256, value: H256) { self.storage.write().insert((address, position), value); } /// Set block queue size for testing pub fn set_queue_size(&self, size: usize) { self.queue_size.store(size, AtomicOrder::Relaxed); } /// Set timestamp assigned to latest sealed block pub fn set_latest_block_timestamp(&self, ts: u64) { *self.latest_block_timestamp.write() = ts; } /// Set logs to return for each logs call. pub fn set_logs(&self, logs: Vec) { *self.logs.write() = logs; } /// Add blocks to test client. pub fn add_blocks(&self, count: usize, with: EachBlockWith) { let len = self.numbers.read().len(); for n in len..(len + count) { let mut header = BlockHeader::new(); header.set_difficulty(From::from(n)); header.set_parent_hash(self.last_hash.read().clone()); header.set_number(n as BlockNumber); header.set_gas_limit(U256::from(1_000_000)); header.set_extra_data(self.extra_data.clone()); let uncles = match with { EachBlockWith::Uncle | EachBlockWith::UncleAndTransaction => { let mut uncles = RlpStream::new_list(1); let mut uncle_header = BlockHeader::new(); uncle_header.set_difficulty(From::from(n)); uncle_header.set_parent_hash(self.last_hash.read().clone()); uncle_header.set_number(n as BlockNumber); uncles.append(&uncle_header); header.set_uncles_hash(uncles.as_raw().sha3()); uncles }, _ => RlpStream::new_list(0) }; let txs = match with { EachBlockWith::Transaction | EachBlockWith::UncleAndTransaction => { let mut txs = RlpStream::new_list(1); let keypair = Random.generate().unwrap(); // Update nonces value self.nonces.write().insert(keypair.address(), U256::one()); let tx = Transaction { action: Action::Create, value: U256::from(100), data: "3331600055".from_hex().unwrap(), gas: U256::from(100_000), gas_price: U256::one(), nonce: U256::zero() }; let signed_tx = tx.sign(keypair.secret(), None); txs.append(&signed_tx); txs.out() }, _ => ::rlp::EMPTY_LIST_RLP.to_vec() }; let mut rlp = RlpStream::new_list(3); rlp.append(&header); rlp.append_raw(&txs, 1); rlp.append_raw(uncles.as_raw(), 1); self.import_block(rlp.as_raw().to_vec()).unwrap(); } } /// Make a bad block by setting invalid extra data. pub fn corrupt_block(&self, n: BlockNumber) { let hash = self.block_hash(BlockId::Number(n)).unwrap(); let mut header: BlockHeader = decode(&self.block_header(BlockId::Number(n)).unwrap()); header.set_extra_data(b"This extra data is way too long to be considered valid".to_vec()); let mut rlp = RlpStream::new_list(3); rlp.append(&header); rlp.append_raw(&::rlp::NULL_RLP, 1); rlp.append_raw(&::rlp::NULL_RLP, 1); self.blocks.write().insert(hash, rlp.out()); } /// Make a bad block by setting invalid parent hash. pub fn corrupt_block_parent(&self, n: BlockNumber) { let hash = self.block_hash(BlockId::Number(n)).unwrap(); let mut header: BlockHeader = decode(&self.block_header(BlockId::Number(n)).unwrap()); header.set_parent_hash(H256::from(42)); let mut rlp = RlpStream::new_list(3); rlp.append(&header); rlp.append_raw(&::rlp::NULL_RLP, 1); rlp.append_raw(&::rlp::NULL_RLP, 1); self.blocks.write().insert(hash, rlp.out()); } /// TODO: pub fn block_hash_delta_minus(&mut self, delta: usize) -> H256 { let blocks_read = self.numbers.read(); let index = blocks_read.len() - delta; blocks_read[&index].clone() } fn block_hash(&self, id: BlockId) -> Option { match id { BlockId::Hash(hash) => Some(hash), BlockId::Number(n) => self.numbers.read().get(&(n as usize)).cloned(), BlockId::Earliest => self.numbers.read().get(&0).cloned(), BlockId::Latest | BlockId::Pending => self.numbers.read().get(&(self.numbers.read().len() - 1)).cloned() } } /// Inserts a transaction to miners transactions queue. pub fn insert_transaction_to_queue(&self) { let keypair = Random.generate().unwrap(); let tx = Transaction { action: Action::Create, value: U256::from(100), data: "3331600055".from_hex().unwrap(), gas: U256::from(100_000), gas_price: U256::one(), nonce: U256::zero() }; let signed_tx = tx.sign(keypair.secret(), None); self.set_balance(signed_tx.sender().unwrap(), 10_000_000.into()); let res = self.miner.import_external_transactions(self, vec![signed_tx]); let res = res.into_iter().next().unwrap().expect("Successful import"); assert_eq!(res, TransactionImportResult::Current); } } pub fn get_temp_state_db() -> GuardedTempResult { let temp = RandomTempPath::new(); let db = Database::open(&DatabaseConfig::with_columns(NUM_COLUMNS), temp.as_str()).unwrap(); let journal_db = journaldb::new(Arc::new(db), journaldb::Algorithm::EarlyMerge, COL_STATE); let state_db = StateDB::new(journal_db, 1024 * 1024); GuardedTempResult { _temp: temp, result: Some(state_db) } } impl MiningBlockChainClient for TestBlockChainClient { fn latest_schedule(&self) -> Schedule { Schedule::new_post_eip150(24576, true, true, true) } fn prepare_open_block(&self, author: Address, gas_range_target: (U256, U256), extra_data: Bytes) -> OpenBlock { let engine = &*self.spec.engine; let genesis_header = self.spec.genesis_header(); let mut db_result = get_temp_state_db(); let mut db = db_result.take(); self.spec.ensure_db_good(&mut db, &TrieFactory::default()).unwrap(); let last_hashes = vec![genesis_header.hash()]; let mut open_block = OpenBlock::new( engine, Default::default(), false, db, &genesis_header, Arc::new(last_hashes), author, gas_range_target, extra_data ).expect("Opening block for tests will not fail."); // TODO [todr] Override timestamp for predictability (set_timestamp_now kind of sucks) open_block.set_timestamp(*self.latest_block_timestamp.read()); open_block } fn vm_factory(&self) -> &EvmFactory { &self.vm_factory } fn import_sealed_block(&self, _block: SealedBlock) -> ImportResult { Ok(H256::default()) } } impl BlockChainClient for TestBlockChainClient { fn call(&self, _t: &SignedTransaction, _block: BlockId, _analytics: CallAnalytics) -> Result { self.execution_result.read().clone().unwrap() } fn replay(&self, _id: TransactionId, _analytics: CallAnalytics) -> Result { self.execution_result.read().clone().unwrap() } fn block_total_difficulty(&self, _id: BlockId) -> Option { Some(U256::zero()) } fn block_hash(&self, id: BlockId) -> Option { Self::block_hash(self, id) } fn nonce(&self, address: &Address, id: BlockId) -> Option { match id { BlockId::Latest => Some(self.nonces.read().get(address).cloned().unwrap_or(self.spec.params.account_start_nonce)), _ => None, } } fn storage_root(&self, _address: &Address, _id: BlockId) -> Option { None } fn latest_nonce(&self, address: &Address) -> U256 { self.nonce(address, BlockId::Latest).unwrap() } fn code(&self, address: &Address, id: BlockId) -> Option> { match id { BlockId::Latest => Some(self.code.read().get(address).cloned()), _ => None, } } fn balance(&self, address: &Address, id: BlockId) -> Option { if let BlockId::Latest = id { Some(self.balances.read().get(address).cloned().unwrap_or_else(U256::zero)) } else { None } } fn latest_balance(&self, address: &Address) -> U256 { self.balance(address, BlockId::Latest).unwrap() } fn storage_at(&self, address: &Address, position: &H256, id: BlockId) -> Option { if let BlockId::Latest = id { Some(self.storage.read().get(&(address.clone(), position.clone())).cloned().unwrap_or_else(H256::new)) } else { None } } fn list_accounts(&self, _id: BlockId, _after: Option<&Address>, _count: u64) -> Option> { None } fn list_storage(&self, _id: BlockId, _account: &Address, _after: Option<&H256>, _count: u64) -> Option> { None } fn transaction(&self, _id: TransactionId) -> Option { None // Simple default. } fn transaction_block(&self, _id: TransactionId) -> Option { None // Simple default. } fn uncle(&self, _id: UncleId) -> Option { None // Simple default. } fn uncle_extra_info(&self, _id: UncleId) -> Option> { None } fn transaction_receipt(&self, id: TransactionId) -> Option { self.receipts.read().get(&id).cloned() } fn blocks_with_bloom(&self, _bloom: &H2048, _from_block: BlockId, _to_block: BlockId) -> Option> { unimplemented!(); } fn logs(&self, filter: Filter) -> Vec { let mut logs = self.logs.read().clone(); let len = logs.len(); match filter.limit { Some(limit) if limit <= len => logs.split_off(len - limit), _ => logs, } } fn last_hashes(&self) -> LastHashes { unimplemented!(); } fn best_block_header(&self) -> Bytes { self.block_header(BlockId::Hash(self.chain_info().best_block_hash)).expect("Best block always have header.") } fn block_header(&self, id: BlockId) -> Option { self.block_hash(id).and_then(|hash| self.blocks.read().get(&hash).map(|r| Rlp::new(r).at(0).as_raw().to_vec())) } fn block_body(&self, id: BlockId) -> Option { self.block_hash(id).and_then(|hash| self.blocks.read().get(&hash).map(|r| { let mut stream = RlpStream::new_list(2); stream.append_raw(Rlp::new(r).at(1).as_raw(), 1); stream.append_raw(Rlp::new(r).at(2).as_raw(), 1); stream.out() })) } fn block(&self, id: BlockId) -> Option { self.block_hash(id).and_then(|hash| self.blocks.read().get(&hash).cloned()) } fn block_extra_info(&self, id: BlockId) -> Option> { self.block(id) .map(|block| BlockView::new(&block).header()) .map(|header| self.spec.engine.extra_info(&header)) } fn block_status(&self, id: BlockId) -> BlockStatus { match id { BlockId::Number(number) if (number as usize) < self.blocks.read().len() => BlockStatus::InChain, BlockId::Hash(ref hash) if self.blocks.read().get(hash).is_some() => BlockStatus::InChain, _ => BlockStatus::Unknown } } // works only if blocks are one after another 1 -> 2 -> 3 fn tree_route(&self, from: &H256, to: &H256) -> Option { Some(TreeRoute { ancestor: H256::new(), index: 0, blocks: { let numbers_read = self.numbers.read(); let mut adding = false; let mut blocks = Vec::new(); for (_, hash) in numbers_read.iter().sort_by(|tuple1, tuple2| tuple1.0.cmp(tuple2.0)) { if hash == to { if adding { blocks.push(hash.clone()); } adding = false; break; } if hash == from { adding = true; } if adding { blocks.push(hash.clone()); } } if adding { Vec::new() } else { blocks } } }) } fn find_uncles(&self, _hash: &H256) -> Option> { None } // TODO: returns just hashes instead of node state rlp(?) fn state_data(&self, hash: &H256) -> Option { // starts with 'f' ? if *hash > H256::from("f000000000000000000000000000000000000000000000000000000000000000") { let mut rlp = RlpStream::new(); rlp.append(&hash.clone()); return Some(rlp.out()); } None } fn block_receipts(&self, hash: &H256) -> Option { // starts with 'f' ? if *hash > H256::from("f000000000000000000000000000000000000000000000000000000000000000") { let receipt = BlockReceipts::new(vec![Receipt::new( H256::zero(), U256::zero(), vec![])]); let mut rlp = RlpStream::new(); rlp.append(&receipt); return Some(rlp.out()); } None } fn import_block(&self, b: Bytes) -> Result { let header = Rlp::new(&b).val_at::(0); let h = header.hash(); let number: usize = header.number() as usize; if number > self.blocks.read().len() { panic!("Unexpected block number. Expected {}, got {}", self.blocks.read().len(), number); } if number > 0 { match self.blocks.read().get(header.parent_hash()) { Some(parent) => { let parent = Rlp::new(parent).val_at::(0); if parent.number() != (header.number() - 1) { panic!("Unexpected block parent"); } }, None => { panic!("Unknown block parent {:?} for block {}", header.parent_hash(), number); } } } let len = self.numbers.read().len(); if number == len { { let mut difficulty = self.difficulty.write(); *difficulty = *difficulty + header.difficulty().clone(); } mem::replace(&mut *self.last_hash.write(), h.clone()); self.blocks.write().insert(h.clone(), b); self.numbers.write().insert(number, h.clone()); let mut parent_hash = header.parent_hash().clone(); if number > 0 { let mut n = number - 1; while n > 0 && self.numbers.read()[&n] != parent_hash { *self.numbers.write().get_mut(&n).unwrap() = parent_hash.clone(); n -= 1; parent_hash = Rlp::new(&self.blocks.read()[&parent_hash]).val_at::(0).parent_hash().clone(); } } } else { self.blocks.write().insert(h.clone(), b.to_vec()); } Ok(h) } fn import_block_with_receipts(&self, b: Bytes, _r: Bytes) -> Result { self.import_block(b) } fn queue_info(&self) -> QueueInfo { QueueInfo { verified_queue_size: self.queue_size.load(AtomicOrder::Relaxed), unverified_queue_size: 0, verifying_queue_size: 0, max_queue_size: 0, max_mem_use: 0, mem_used: 0, } } fn clear_queue(&self) { } fn additional_params(&self) -> BTreeMap { Default::default() } fn chain_info(&self) -> BlockChainInfo { BlockChainInfo { total_difficulty: *self.difficulty.read(), pending_total_difficulty: *self.difficulty.read(), genesis_hash: self.genesis_hash.clone(), best_block_hash: self.last_hash.read().clone(), best_block_number: self.blocks.read().len() as BlockNumber - 1, first_block_hash: self.first_block.read().as_ref().map(|x| x.0), first_block_number: self.first_block.read().as_ref().map(|x| x.1), ancient_block_hash: self.ancient_block.read().as_ref().map(|x| x.0), ancient_block_number: self.ancient_block.read().as_ref().map(|x| x.1) } } fn filter_traces(&self, _filter: TraceFilter) -> Option> { unimplemented!(); } fn trace(&self, _trace: TraceId) -> Option { unimplemented!(); } fn transaction_traces(&self, _trace: TransactionId) -> Option> { unimplemented!(); } fn block_traces(&self, _trace: BlockId) -> Option> { unimplemented!(); } fn queue_transactions(&self, transactions: Vec) { // import right here let txs = transactions.into_iter().filter_map(|bytes| UntrustedRlp::new(&bytes).as_val().ok()).collect(); self.miner.import_external_transactions(self, txs); } fn pending_transactions(&self) -> Vec { self.miner.pending_transactions(self.chain_info().best_block_number) } fn signing_network_id(&self) -> Option { None } fn mode(&self) -> Mode { Mode::Active } fn set_mode(&self, _: Mode) { unimplemented!(); } fn pruning_info(&self) -> PruningInfo { PruningInfo { earliest_chain: 1, earliest_state: 1, } } }