      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
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400

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

    use std::collections::BTreeMap;
    use util::{U256, Address, H256, H2048, Bytes, Itertools};
    use util::stats::Histogram;
    use blockchain::TreeRoute;
    use verification::queue::QueueInfo as BlockQueueInfo;
    use block::{OpenBlock, SealedBlock};
    use header::{BlockNumber};
    use transaction::{LocalizedTransaction, PendingTransaction,
                      SignedTransaction};
    use transaction_import::TransactionImportResult;
    use log_entry::LocalizedLogEntry;
    use filter::Filter;
    use error::{ImportResult, CallError, Error as EthcoreError};
    use receipt::LocalizedReceipt;
    use trace::LocalizedTrace;
    use evm::{Factory as EvmFactory, Schedule};
    use executive::Executed;
    use env_info::LastHashes;
    use block_import_error::BlockImportError;
    use ipc::IpcConfig;
    use types::ids::*;
    use types::trace_filter::Filter as TraceFilter;
    use types::call_analytics::CallAnalytics;
    use types::blockchain_info::BlockChainInfo;
    use types::block_status::BlockStatus;
    use types::mode::Mode;
    use types::pruning_info::PruningInfo;
    use encoded;

    /// Blockchain database client. Owns and manages a blockchain and a block queue.
    pub trait BlockChainClient: Sync + Send {

        /// Should be called by any external-facing interface when actively using the client.
        /// To minimise chatter, there's no need to call more than once every 30s.
        fn keep_alive(&self) { }

        /// Get raw block header data by block id.
        fn block_header(&self, id: BlockId)
        -> Option<encoded::Header>;

        /// Look up the block number for the given block ID.
        fn block_number(&self, id: BlockId)
        -> Option<BlockNumber>;

        /// Get raw block body data by block id.
        /// Block body is an RLP list of two items: uncles and transactions.
        fn block_body(&self, id: BlockId)
        -> Option<encoded::Body>;

        /// Get raw block data by block header hash.
        fn block(&self, id: BlockId)
        -> Option<encoded::Block>;

        /// Get block status by block header hash.
        fn block_status(&self, id: BlockId)
        -> BlockStatus;

        /// Get block total difficulty.
        fn block_total_difficulty(&self, id: BlockId)
        -> Option<U256>;

        /// Attempt to get address nonce at given block.
        /// May not fail on BlockId::Latest.
        fn nonce(&self, address: &Address, id: BlockId)
        -> Option<U256>;

        /// Attempt to get address storage root at given block.
        /// May not fail on BlockId::Latest.
        fn storage_root(&self, address: &Address, id: BlockId)
        -> Option<H256>;

        /// Get address nonce at the latest block's state.
        fn latest_nonce(&self, address: &Address) -> U256 {
            self.nonce(address,
                       BlockId::Latest).expect("nonce will return Some when given BlockId::Latest. nonce was given BlockId::Latest. \
    			Therefore nonce has returned Some; qed")
        }

        /// Get block hash.
        fn block_hash(&self, id: BlockId)
        -> Option<H256>;

        /// Get address code at given block's state.
        fn code(&self, address: &Address, id: BlockId)
        -> Option<Option<Bytes>>;

        /// Get address code at the latest block's state.
        fn latest_code(&self, address: &Address) -> Option<Bytes> {
            self.code(address,
                      BlockId::Latest).expect("code will return Some if given BlockId::Latest; qed")
        }

        /// Get address balance at the given block's state.
        ///
        /// May not return None if given BlockId::Latest.
        /// Returns None if and only if the block's root hash has been pruned from the DB.
        fn balance(&self, address: &Address, id: BlockId)
        -> Option<U256>;

        /// Get address balance at the latest block's state.
        fn latest_balance(&self, address: &Address) -> U256 {
            self.balance(address,
                         BlockId::Latest).expect("balance will return Some if given BlockId::Latest. balance was given BlockId::Latest \
    			Therefore balance has returned Some; qed")
        }

        /// Get value of the storage at given position at the given block's state.
        ///
        /// May not return None if given BlockId::Latest.
        /// Returns None if and only if the block's root hash has been pruned from the DB.
        fn storage_at(&self, address: &Address, position: &H256, id: BlockId)
        -> Option<H256>;

        /// Get value of the storage at given position at the latest block's state.
        fn latest_storage_at(&self, address: &Address, position: &H256) -> H256 {
            self.storage_at(address, position,
                            BlockId::Latest).expect("storage_at will return Some if given BlockId::Latest. storage_at was given BlockId::Latest. \
    			Therefore storage_at has returned Some; qed")
        }

        /// Get a list of all accounts in the block `id`, if fat DB is in operation, otherwise `None`.
        /// If `after` is set the list starts with the following item.
        fn list_accounts(&self, id: BlockId, after: Option<&Address>, count: u64)
        -> Option<Vec<Address>>;

        /// Get a list of all storage keys in the block `id`, if fat DB is in operation, otherwise `None`.
        /// If `after` is set the list starts with the following item.
        fn list_storage(&self, id: BlockId, account: &Address,
                        after: Option<&H256>, count: u64)
        -> Option<Vec<H256>>;

        /// Get transaction with given hash.
        fn transaction(&self, id: TransactionId)
        -> Option<LocalizedTransaction>;

        /// Get the hash of block that contains the transaction, if any.
        fn transaction_block(&self, id: TransactionId)
        -> Option<H256>;

        /// Get uncle with given id.
        fn uncle(&self, id: UncleId)
        -> Option<encoded::Header>;

        /// Get transaction receipt with given hash.
        fn transaction_receipt(&self, id: TransactionId)
        -> Option<LocalizedReceipt>;

        /// Get a tree route between `from` and `to`.
        /// See `BlockChain::tree_route`.
        fn tree_route(&self, from: &H256, to: &H256)
        -> Option<TreeRoute>;

        /// Get all possible uncle hashes for a block.
        fn find_uncles(&self, hash: &H256)
        -> Option<Vec<H256>>;

        /// Get latest state node
        fn state_data(&self, hash: &H256)
        -> Option<Bytes>;

        /// Get raw block receipts data by block header hash.
        fn block_receipts(&self, hash: &H256)
        -> Option<Bytes>;

        /// Import a block into the blockchain.
        fn import_block(&self, bytes: Bytes)
        -> Result<H256, BlockImportError>;

        /// Import a block with transaction receipts. Does no sealing and transaction validation.
        fn import_block_with_receipts(&self, block_bytes: Bytes,
                                      receipts_bytes: Bytes)
        -> Result<H256, BlockImportError>;

        /// Get block queue information.
        fn queue_info(&self)
        -> BlockQueueInfo;

        /// Clear block queue and abort all import activity.
        fn clear_queue(&self);

        /// Get blockchain information.
        fn chain_info(&self)
        -> BlockChainInfo;

        /// Get the registrar address, if it exists.
        fn additional_params(&self)
        -> BTreeMap<String, String>;

        /// Get the best block header.
        fn best_block_header(&self)
        -> encoded::Header;

        /// Returns numbers of blocks containing given bloom.
        fn blocks_with_bloom(&self, bloom: &H2048, from_block: BlockId,
                             to_block: BlockId)
        -> Option<Vec<BlockNumber>>;

        /// Returns logs matching given filter.
        fn logs(&self, filter: Filter)
        -> Vec<LocalizedLogEntry>;

        /// Makes a non-persistent transaction call.
        fn call(&self, t: &SignedTransaction, block: BlockId,
                analytics: CallAnalytics)
        -> Result<Executed, CallError>;

        /// Estimates how much gas will be necessary for a call.
        fn estimate_gas(&self, t: &SignedTransaction, block: BlockId)
        -> Result<U256, CallError>;

        /// Replays a given transaction for inspection.
        fn replay(&self, t: TransactionId, analytics: CallAnalytics)
        -> Result<Executed, CallError>;

        /// Returns traces matching given filter.
        fn filter_traces(&self, filter: TraceFilter)
        -> Option<Vec<LocalizedTrace>>;

        /// Returns trace with given id.
        fn trace(&self, trace: TraceId)
        -> Option<LocalizedTrace>;

        /// Returns traces created by transaction.
        fn transaction_traces(&self, trace: TransactionId)
        -> Option<Vec<LocalizedTrace>>;

        /// Returns traces created by transaction from block.
        fn block_traces(&self, trace: BlockId)
        -> Option<Vec<LocalizedTrace>>;

        /// Get last hashes starting from best block.
        fn last_hashes(&self)
        -> LastHashes;

        /// Queue transactions for importing.
        fn queue_transactions(&self, transactions: Vec<Bytes>, peer_id: usize);

        /// Queue conensus engine message.
        fn queue_consensus_message(&self, message: Bytes);

        /// List all transactions that are allowed into the next block.
        fn ready_transactions(&self)
        -> Vec<PendingTransaction>;

        /// Sorted list of transaction gas prices from at least last sample_size blocks.
        fn gas_price_corpus(&self, sample_size: usize) -> Vec<U256> {
            let mut h = self.chain_info().best_block_hash;
            let mut corpus = Vec::new();
            while corpus.is_empty() {
                for _ in 0..sample_size {
                    let block =
                        self.block(BlockId::Hash(h)).expect("h is either the best_block_hash or an ancestor; qed");
                    let header = block.header_view();
                    if header.number() == 0 { return corpus; }
                    block.transaction_views().iter().foreach(|t|
                                                                 corpus.push(t.gas_price()));
                    h = header.parent_hash().clone();
                }
            }
            corpus.sort();
            corpus
        }

        /// Calculate median gas price from recent blocks if they have any transactions.
        fn gas_price_median(&self, sample_size: usize) -> Option<U256> {
            let corpus = self.gas_price_corpus(sample_size);
            corpus.get(corpus.len() / 2).cloned()
        }

        /// Get the gas price distribution based on recent blocks if they have any transactions.
        fn gas_price_histogram(&self, sample_size: usize, bucket_number: usize)
         -> Option<Histogram> {
            let raw_corpus = self.gas_price_corpus(sample_size);
            let raw_len = raw_corpus.len();
            // Throw out outliers.
            let (corpus, _) = raw_corpus.split_at(raw_len - raw_len / 40);
            Histogram::new(corpus, bucket_number)
        }

        /// Get the preferred network ID to sign on
        fn signing_network_id(&self)
        -> Option<u64>;

        /// Get the mode.
        fn mode(&self)
        -> Mode;

        /// Set the mode.
        fn set_mode(&self, mode: Mode);

        /// Disable the client from importing blocks. This cannot be undone in this session and indicates
        /// that a subsystem has reason to believe this executable incapable of syncing the chain.
        fn disable(&self);

        /// Returns engine-related extra info for `BlockId`.
        fn block_extra_info(&self, id: BlockId)
        -> Option<BTreeMap<String, String>>;

        /// Returns engine-related extra info for `UncleId`.
        fn uncle_extra_info(&self, id: UncleId)
        -> Option<BTreeMap<String, String>>;

        /// Returns information about pruning/data availability.
        fn pruning_info(&self)
        -> PruningInfo;

        /// Like `call`, but with various defaults. Designed to be used for calling contracts.
        fn call_contract(&self, address: Address, data: Bytes)
        -> Result<Bytes, String>;

        /// Import a transaction: used for misbehaviour reporting.
        fn transact_contract(&self, address: Address, data: Bytes)
        -> Result<TransactionImportResult, EthcoreError>;

        /// Get the address of the registry itself.
        fn registrar_address(&self)
        -> Option<Address>;

        /// Get the address of a particular blockchain service, if available.
        fn registry_address(&self, name: String)
        -> Option<Address>;
    }

    impl IpcConfig for BlockChainClient { }

    /// Extended client interface used for mining
    pub trait MiningBlockChainClient: BlockChainClient {
        /// Returns OpenBlock prepared for closing.
        fn prepare_open_block(&self, author: Address,
                              gas_range_target: (U256, U256), extra_data: Bytes)
        -> OpenBlock;

        /// Returns EvmFactory.
        fn vm_factory(&self)
        -> &EvmFactory;

        /// Broadcast a block proposal.
        fn broadcast_proposal_block(&self, block: SealedBlock);

        /// Import sealed block. Skips all verifications.
        fn import_sealed_block(&self, block: SealedBlock)
        -> ImportResult;

        /// Returns latest schedule.
        fn latest_schedule(&self)
        -> Schedule;
    }

    /// Client facilities used by internally sealing Engines.
    pub trait EngineClient: MiningBlockChainClient {
        /// Make a new block and seal it.
        fn update_sealing(&self);

        /// Submit a seal for a block in the mining queue.
        fn submit_seal(&self, block_hash: H256, seal: Vec<Bytes>);

        /// Broadcast a consensus message to the network.
        fn broadcast_consensus_message(&self, message: Bytes);
    }

    /// Extended client interface for providing proofs of the state.
    pub trait ProvingBlockChainClient: BlockChainClient {
        /// Prove account storage at a specific block id.
        ///
        /// Both provided keys assume a secure trie.
        /// Returns a vector of raw trie nodes (in order from the root) proving the storage query.
        /// Nodes after `from_level` may be omitted.
        /// An empty vector indicates unservable query.
        fn prove_storage(&self, key1: H256, key2: H256, from_level: u32,
                         id: BlockId)
        -> Vec<Bytes>;

        /// Prove account existence at a specific block id.
        /// The key is the keccak hash of the account's address.
        /// Returns a vector of raw trie nodes (in order from the root) proving the query.
        /// Nodes after `from_level` may be omitted.
        /// An empty vector indicates unservable query.
        fn prove_account(&self, key1: H256, from_level: u32, id: BlockId)
        -> Vec<Bytes>;

        /// Get code by address hash.
        fn code_by_hash(&self, account_key: H256, id: BlockId)
        -> Bytes;
    }

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