      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282

    // Copyright 2015-2017 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 <http://www.gnu.org/licenses/>.

    //! Test implementation of miner service.

    use util::{Address, H256, Bytes, U256, FixedHash, Uint};
    use util::standard::*;
    use ethcore::error::{Error, CallError};
    use ethcore::client::{MiningBlockChainClient, Executed, CallAnalytics};
    use ethcore::block::{ClosedBlock, IsBlock};
    use ethcore::header::BlockNumber;
    use ethcore::transaction::{UnverifiedTransaction, SignedTransaction, PendingTransaction};
    use ethcore::receipt::{Receipt, RichReceipt};
    use ethcore::miner::{MinerService, MinerStatus, TransactionImportResult, LocalTransactionStatus};
    use ethcore::account_provider::SignError as AccountError;

    /// Test miner service.
    pub struct TestMinerService {
    	/// Imported transactions.
    	pub imported_transactions: Mutex<Vec<SignedTransaction>>,
    	/// Latest closed block.
    	pub latest_closed_block: Mutex<Option<ClosedBlock>>,
    	/// Pre-existed pending transactions
    	pub pending_transactions: Mutex<HashMap<H256, SignedTransaction>>,
    	/// Pre-existed local transactions
    	pub local_transactions: Mutex<BTreeMap<H256, LocalTransactionStatus>>,
    	/// Pre-existed pending receipts
    	pub pending_receipts: Mutex<BTreeMap<H256, Receipt>>,
    	/// Last nonces.
    	pub last_nonces: RwLock<HashMap<Address, U256>>,
    	/// Password held by Engine.
    	pub password: RwLock<String>,

    	min_gas_price: RwLock<U256>,
    	gas_range_target: RwLock<(U256, U256)>,
    	author: RwLock<Address>,
    	extra_data: RwLock<Bytes>,
    	limit: RwLock<usize>,
    	tx_gas_limit: RwLock<U256>,
    }

    impl Default for TestMinerService {
    	fn default() -> TestMinerService {
    		TestMinerService {
    			imported_transactions: Mutex::new(Vec::new()),
    			latest_closed_block: Mutex::new(None),
    			pending_transactions: Mutex::new(HashMap::new()),
    			local_transactions: Mutex::new(BTreeMap::new()),
    			pending_receipts: Mutex::new(BTreeMap::new()),
    			last_nonces: RwLock::new(HashMap::new()),
    			min_gas_price: RwLock::new(U256::from(20_000_000)),
    			gas_range_target: RwLock::new((U256::from(12345), U256::from(54321))),
    			author: RwLock::new(Address::zero()),
    			password: RwLock::new(String::new()),
    			extra_data: RwLock::new(vec![1, 2, 3, 4]),
    			limit: RwLock::new(1024),
    			tx_gas_limit: RwLock::new(!U256::zero()),
    		}
    	}
    }

    impl MinerService for TestMinerService {

    	/// Returns miner's status.
    	fn status(&self) -> MinerStatus {
    		MinerStatus {
    			transactions_in_pending_queue: 0,
    			transactions_in_future_queue: 0,
    			transactions_in_pending_block: 1
    		}
    	}

    	fn set_author(&self, author: Address) {
    		*self.author.write() = author;
    	}

    	fn set_engine_signer(&self, address: Address, password: String) -> Result<(), AccountError> {
    		*self.author.write() = address;
    		*self.password.write() = password;
    		Ok(())
    	}

    	fn set_extra_data(&self, extra_data: Bytes) {
    		*self.extra_data.write() = extra_data;
    	}

    	/// Set the lower gas limit we wish to target when sealing a new block.
    	fn set_gas_floor_target(&self, target: U256) {
    		self.gas_range_target.write().0 = target;
    	}

    	/// Set the upper gas limit we wish to target when sealing a new block.
    	fn set_gas_ceil_target(&self, target: U256) {
    		self.gas_range_target.write().1 = target;
    	}

    	fn set_minimal_gas_price(&self, min_gas_price: U256) {
    		*self.min_gas_price.write() = min_gas_price;
    	}

    	fn set_transactions_limit(&self, limit: usize) {
    		*self.limit.write() = limit;
    	}

    	fn set_tx_gas_limit(&self, limit: U256) {
    		*self.tx_gas_limit.write() = limit;
    	}

    	fn transactions_limit(&self) -> usize {
    		*self.limit.read()
    	}

    	fn author(&self) -> Address {
    		*self.author.read()
    	}

    	fn minimal_gas_price(&self) -> U256 {
    		*self.min_gas_price.read()
    	}

    	fn extra_data(&self) -> Bytes {
    		self.extra_data.read().clone()
    	}

    	fn gas_floor_target(&self) -> U256 {
    		self.gas_range_target.read().0
    	}

    	fn gas_ceil_target(&self) -> U256 {
    		self.gas_range_target.read().1
    	}

    	/// Imports transactions to transaction queue.
    	fn import_external_transactions(&self, _chain: &MiningBlockChainClient, transactions: Vec<UnverifiedTransaction>) ->
    		Vec<Result<TransactionImportResult, Error>> {
    		// lets assume that all txs are valid
    		let transactions: Vec<_> = transactions.into_iter().map(|tx| SignedTransaction::new(tx).unwrap()).collect();
    		self.imported_transactions.lock().extend_from_slice(&transactions);

    		for sender in transactions.iter().map(|tx| tx.sender()) {
    			let nonce = self.last_nonce(&sender).expect("last_nonce must be populated in tests");
    			self.last_nonces.write().insert(sender, nonce + U256::from(1));
    		}
    		transactions
    			.iter()
    			.map(|_| Ok(TransactionImportResult::Current))
    			.collect()
    	}

    	/// Imports transactions to transaction queue.
    	fn import_own_transaction(&self, chain: &MiningBlockChainClient, pending: PendingTransaction) ->
    		Result<TransactionImportResult, Error> {

    		// keep the pending nonces up to date
    		let sender = pending.transaction.sender();
    		let nonce = self.last_nonce(&sender).unwrap_or(chain.latest_nonce(&sender));
    		self.last_nonces.write().insert(sender, nonce + U256::from(1));

    		// lets assume that all txs are valid
    		self.imported_transactions.lock().push(pending.transaction);

    		Ok(TransactionImportResult::Current)
    	}

    	/// Returns hashes of transactions currently in pending
    	fn pending_transactions_hashes(&self, _best_block: BlockNumber) -> Vec<H256> {
    		vec![]
    	}

    	/// Removes all transactions from the queue and restart mining operation.
    	fn clear_and_reset(&self, _chain: &MiningBlockChainClient) {
    		unimplemented!();
    	}

    	/// Called when blocks are imported to chain, updates transactions queue.
    	fn chain_new_blocks(&self, _chain: &MiningBlockChainClient, _imported: &[H256], _invalid: &[H256], _enacted: &[H256], _retracted: &[H256]) {
    		unimplemented!();
    	}

    	/// New chain head event. Restart mining operation.
    	fn update_sealing(&self, _chain: &MiningBlockChainClient) {
    		unimplemented!();
    	}

    	fn map_sealing_work<F, T>(&self, chain: &MiningBlockChainClient, f: F) -> Option<T> where F: FnOnce(&ClosedBlock) -> T {
    		let open_block = chain.prepare_open_block(self.author(), *self.gas_range_target.write(), self.extra_data());
    		Some(f(&open_block.close()))
    	}

    	fn transaction(&self, _best_block: BlockNumber, hash: &H256) -> Option<SignedTransaction> {
    		self.pending_transactions.lock().get(hash).cloned()
    	}

    	fn pending_transactions(&self) -> Vec<PendingTransaction> {
    		self.pending_transactions.lock().values().cloned().map(Into::into).collect()
    	}

    	fn local_transactions(&self) -> BTreeMap<H256, LocalTransactionStatus> {
    		self.local_transactions.lock().iter().map(|(hash, stats)| (*hash, stats.clone())).collect()
    	}

    	fn ready_transactions(&self, _best_block: BlockNumber) -> Vec<PendingTransaction> {
    		self.pending_transactions.lock().values().cloned().map(Into::into).collect()
    	}

    	fn future_transactions(&self) -> Vec<PendingTransaction> {
    		vec![]
    	}

    	fn pending_receipt(&self, _best_block: BlockNumber, hash: &H256) -> Option<RichReceipt> {
    		// Not much point implementing this since the logic is complex and the only thing it relies on is pending_receipts, which is already tested.
    		self.pending_receipts(0).get(hash).map(|r|
    			RichReceipt {
    				transaction_hash: Default::default(),
    				transaction_index: Default::default(),
    				cumulative_gas_used: r.gas_used.clone(),
    				gas_used: r.gas_used.clone(),
    				contract_address: None,
    				logs: r.logs.clone(),
    				log_bloom: r.log_bloom,
    				state_root: r.state_root,
    			}
    		)
    	}

    	fn pending_receipts(&self, _best_block: BlockNumber) -> BTreeMap<H256, Receipt> {
    		self.pending_receipts.lock().clone()
    	}

    	fn last_nonce(&self, address: &Address) -> Option<U256> {
    		self.last_nonces.read().get(address).cloned()
    	}

    	fn is_sealing(&self) -> bool {
    		false
    	}

    	/// Submit `seal` as a valid solution for the header of `pow_hash`.
    	/// Will check the seal, but not actually insert the block into the chain.
    	fn submit_seal(&self, _chain: &MiningBlockChainClient, _pow_hash: H256, _seal: Vec<Bytes>) -> Result<(), Error> {
    		unimplemented!();
    	}

    	fn balance(&self, _chain: &MiningBlockChainClient, address: &Address) -> U256 {
    		self.latest_closed_block.lock().as_ref().map_or_else(U256::zero, |b| b.block().fields().state.balance(address).clone())
    	}

    	fn call(&self, _chain: &MiningBlockChainClient, _t: &SignedTransaction, _analytics: CallAnalytics) -> Result<Executed, CallError> {
    		unimplemented!();
    	}

    	fn storage_at(&self, _chain: &MiningBlockChainClient, address: &Address, position: &H256) -> H256 {
    		self.latest_closed_block.lock().as_ref().map_or_else(H256::default, |b| b.block().fields().state.storage_at(address, position).clone())
    	}

    	fn nonce(&self, _chain: &MiningBlockChainClient, address: &Address) -> U256 {
    		// we assume all transactions are in a pending block, ignoring the
    		// reality of gas limits.
    		self.last_nonce(address).unwrap_or(U256::zero())
    	}

    	fn code(&self, _chain: &MiningBlockChainClient, address: &Address) -> Option<Bytes> {
    		self.latest_closed_block.lock().as_ref().map_or(None, |b| b.block().fields().state.code(address).map(|c| (*c).clone()))
    	}

    	fn sensible_gas_price(&self) -> U256 {
    		20000000000u64.into()
    	}
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)