      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

    // 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/>.

    #![warn(missing_docs)]
    #![cfg_attr(all(nightly, feature="dev"), feature(plugin))]
    #![cfg_attr(all(nightly, feature="dev"), plugin(clippy))]

    //! Miner module
    //! Keeps track of transactions and mined block.
    //!
    //! Usage example:
    //!
    //! ```rust
    //! extern crate ethcore_util as util;
    //! extern crate ethcore;
    //! use std::env;
    //! use ethcore::ethereum;
    //! use ethcore::client::{Client, ClientConfig};
    //! use ethcore::miner::{Miner, MinerService};
    //!
    //! fn main() {
    //!		let miner: Miner = Miner::with_spec(&ethereum::new_frontier());
    //!		// get status
    //!		assert_eq!(miner.status().transactions_in_pending_queue, 0);
    //!
    //!		// Check block for sealing
    //!		//assert!(miner.sealing_block(&*client).lock().is_some());
    //! }
    //! ```

    mod banning_queue;
    mod external;
    mod local_transactions;
    mod miner;
    mod price_info;
    mod service_transaction_checker;
    mod transaction_queue;
    mod work_notify;
    mod stratum;

    pub use self::external::{ExternalMiner, ExternalMinerService};

    pub use self::miner::{Miner, MinerOptions, Banning, PendingSet, GasPricer, GasPriceCalibratorOptions, GasLimit};
    pub use self::transaction_queue::{TransactionQueue, TransactionDetailsProvider as TransactionQueueDetailsProvider,
    	PrioritizationStrategy, AccountDetails, TransactionOrigin};
    pub use self::local_transactions::{Status as LocalTransactionStatus};
    pub use client::TransactionImportResult;
    pub use self::work_notify::NotifyWork;
    pub use self::stratum::{Stratum, Error as StratumError, Options as StratumOptions};

    use std::collections::BTreeMap;
    use util::{H256, U256, Address, Bytes};
    use client::{MiningBlockChainClient, Executed, CallAnalytics};
    use block::ClosedBlock;
    use header::BlockNumber;
    use receipt::{RichReceipt, Receipt};
    use error::{Error, CallError};
    use transaction::{UnverifiedTransaction, PendingTransaction, SignedTransaction};

    /// Miner client API
    pub trait MinerService : Send + Sync {

    	/// Returns miner's status.
    	fn status(&self) -> MinerStatus;

    	/// Get the author that we will seal blocks as.
    	fn author(&self) -> Address;

    	/// Set the author that we will seal blocks as.
    	fn set_author(&self, author: Address);

    	/// Set info necessary to sign consensus messages.
    	fn set_engine_signer(&self, address: Address, password: String) -> Result<(), ::account_provider::SignError>;

    	/// Get the extra_data that we will seal blocks with.
    	fn extra_data(&self) -> Bytes;

    	/// Set the extra_data that we will seal blocks with.
    	fn set_extra_data(&self, extra_data: Bytes);

    	/// Get current minimal gas price for transactions accepted to queue.
    	fn minimal_gas_price(&self) -> U256;

    	/// Set minimal gas price of transaction to be accepted for mining.
    	fn set_minimal_gas_price(&self, min_gas_price: U256);

    	/// Get the lower bound of the gas limit we wish to target when sealing a new block.
    	fn gas_floor_target(&self) -> U256;

    	/// Get the upper bound of the gas limit we wish to target when sealing a new block.
    	fn gas_ceil_target(&self) -> U256;

    	// TODO: coalesce into single set_range function.
    	/// Set the lower bound of gas limit we wish to target when sealing a new block.
    	fn set_gas_floor_target(&self, target: U256);

    	/// Set the upper bound of gas limit we wish to target when sealing a new block.
    	fn set_gas_ceil_target(&self, target: U256);

    	/// Get current transactions limit in queue.
    	fn transactions_limit(&self) -> usize;

    	/// Set maximal number of transactions kept in the queue (both current and future).
    	fn set_transactions_limit(&self, limit: usize);

    	/// Set maximum amount of gas allowed for any single transaction to mine.
    	fn set_tx_gas_limit(&self, limit: U256);

    	/// Imports transactions to transaction queue.
    	fn import_external_transactions(&self, chain: &MiningBlockChainClient, transactions: Vec<UnverifiedTransaction>) ->
    		Vec<Result<TransactionImportResult, Error>>;

    	/// Imports own (node owner) transaction to queue.
    	fn import_own_transaction(&self, chain: &MiningBlockChainClient, transaction: PendingTransaction) ->
    		Result<TransactionImportResult, Error>;

    	/// Returns hashes of transactions currently in pending
    	fn pending_transactions_hashes(&self, best_block: BlockNumber) -> Vec<H256>;

    	/// Removes all transactions from the queue and restart mining operation.
    	fn clear_and_reset(&self, chain: &MiningBlockChainClient);

    	/// 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]);

    	/// New chain head event. Restart mining operation.
    	fn update_sealing(&self, chain: &MiningBlockChainClient);

    	/// 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>;

    	/// Get the sealing work package and if `Some`, apply some transform.
    	fn map_sealing_work<F, T>(&self, chain: &MiningBlockChainClient, f: F) -> Option<T>
    		where F: FnOnce(&ClosedBlock) -> T, Self: Sized;

    	/// Query pending transactions for hash.
    	fn transaction(&self, best_block: BlockNumber, hash: &H256) -> Option<SignedTransaction>;

    	/// Get a list of all pending transactions in the queue.
    	fn pending_transactions(&self) -> Vec<PendingTransaction>;

    	/// Get a list of all transactions that can go into the given block.
    	fn ready_transactions(&self, best_block: BlockNumber) -> Vec<PendingTransaction>;

    	/// Get a list of all future transactions.
    	fn future_transactions(&self) -> Vec<PendingTransaction>;

    	/// Get a list of local transactions with statuses.
    	fn local_transactions(&self) -> BTreeMap<H256, LocalTransactionStatus>;

    	/// Get a list of all pending receipts.
    	fn pending_receipts(&self, best_block: BlockNumber) -> BTreeMap<H256, Receipt>;

    	/// Get a particular reciept.
    	fn pending_receipt(&self, best_block: BlockNumber, hash: &H256) -> Option<RichReceipt>;

    	/// Returns highest transaction nonce for given address.
    	fn last_nonce(&self, address: &Address) -> Option<U256>;

    	/// Is it currently sealing?
    	fn is_sealing(&self) -> bool;

    	/// Suggested gas price.
    	fn sensible_gas_price(&self) -> U256;

    	/// Suggested gas limit.
    	fn sensible_gas_limit(&self) -> U256 { 21000.into() }

    	/// Latest account balance in pending state.
    	fn balance(&self, chain: &MiningBlockChainClient, address: &Address) -> U256;

    	/// Call into contract code using pending state.
    	fn call(&self, chain: &MiningBlockChainClient, t: &SignedTransaction, analytics: CallAnalytics) -> Result<Executed, CallError>;

    	/// Get storage value in pending state.
    	fn storage_at(&self, chain: &MiningBlockChainClient, address: &Address, position: &H256) -> H256;

    	/// Get account nonce in pending state.
    	fn nonce(&self, chain: &MiningBlockChainClient, address: &Address) -> U256;

    	/// Get contract code in pending state.
    	fn code(&self, chain: &MiningBlockChainClient, address: &Address) -> Option<Bytes>;
    }

    /// Mining status
    #[derive(Debug)]
    pub struct MinerStatus {
    	/// Number of transactions in queue with state `pending` (ready to be included in block)
    	pub transactions_in_pending_queue: usize,
    	/// Number of transactions in queue with state `future` (not yet ready to be included in block)
    	pub transactions_in_future_queue: usize,
    	/// Number of transactions included in currently mined block
    	pub transactions_in_pending_block: usize,
    }

# 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`)