      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

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

    //! LES request types.

    use util::H256;

    /// Either a hash or a number.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub enum HashOrNumber {
    	/// Block hash variant.
    	Hash(H256),
    	/// Block number variant.
    	Number(u64),
    }

    impl From<H256> for HashOrNumber {
    	fn from(hash: H256) -> Self {
    		HashOrNumber::Hash(hash)
    	}
    }

    impl From<u64> for HashOrNumber {
    	fn from(num: u64) -> Self {
    		HashOrNumber::Number(num)
    	}
    }

    /// A request for block headers.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Headers {
    	/// Starting block number or hash.
    	pub start: HashOrNumber,
    	/// The maximum amount of headers which can be returned.
    	pub max: usize,
    	/// The amount of headers to skip between each response entry.
    	pub skip: u64,
    	/// Whether the headers should proceed in falling number from the initial block.
    	pub reverse: bool,
    }

    /// A request for specific block bodies.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Bodies {
    	/// Hashes which bodies are being requested for.
    	pub block_hashes: Vec<H256>
    }

    /// A request for transaction receipts.
    ///
    /// This request is answered with a list of transaction receipts for each block
    /// requested.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Receipts {
    	/// Block hashes to return receipts for.
    	pub block_hashes: Vec<H256>,
    }

    /// A request for a state proof
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct StateProof {
    	/// Block hash to query state from.
    	pub block: H256,
    	/// Key of the state trie -- corresponds to account hash.
    	pub key1: H256,
    	/// Key in that account's storage trie; if empty, then the account RLP should be
    	/// returned.
    	pub key2: Option<H256>,
    	/// if greater than zero, trie nodes beyond this level may be omitted.
    	pub from_level: u32, // could even safely be u8; trie w/ 32-byte key can be at most 64-levels deep.
    }

    /// A request for state proofs.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct StateProofs {
    	/// All the proof requests.
    	pub requests: Vec<StateProof>,
    }

    /// A request for contract code.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct ContractCode {
    	/// Block hash
    	pub block_hash: H256,
    	/// Account key (== sha3(address))
    	pub account_key: H256,
    }

    /// A request for contract code.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct ContractCodes {
    	/// Block hash and account key (== sha3(address)) pairs to fetch code for.
    	pub code_requests: Vec<ContractCode>,
    }

    /// A request for a header proof from the Canonical Hash Trie.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct HeaderProof {
    	/// Number of the CHT.
    	pub cht_number: u64,
    	/// Block number requested. May not be 0: genesis isn't included in any CHT.
    	pub block_number: u64,
    	/// If greater than zero, trie nodes beyond this level may be omitted.
    	pub from_level: u32,
    }

    /// A request for header proofs from the CHT.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct HeaderProofs {
    	/// All the proof requests.
    	pub requests: Vec<HeaderProof>,
    }

    /// Kinds of requests.
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub enum Kind {
    	/// Requesting headers.
    	Headers,
    	/// Requesting block bodies.
    	Bodies,
    	/// Requesting transaction receipts.
    	Receipts,
    	/// Requesting proofs of state trie nodes.
    	StateProofs,
    	/// Requesting contract code by hash.
    	Codes,
    	/// Requesting header proofs (from the CHT).
    	HeaderProofs,
    }

    /// Encompasses all possible types of requests in a single structure.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub enum Request {
    	/// Requesting headers.
    	Headers(Headers),
    	/// Requesting block bodies.
    	Bodies(Bodies),
    	/// Requesting transaction receipts.
    	Receipts(Receipts),
    	/// Requesting state proofs.
    	StateProofs(StateProofs),
    	/// Requesting contract codes.
    	Codes(ContractCodes),
    	/// Requesting header proofs.
    	HeaderProofs(HeaderProofs),
    }

    impl Request {
    	/// Get the kind of request this is.
    	pub fn kind(&self) -> Kind {
    		match *self {
    			Request::Headers(_) => Kind::Headers,
    			Request::Bodies(_) => Kind::Bodies,
    			Request::Receipts(_) => Kind::Receipts,
    			Request::StateProofs(_) => Kind::StateProofs,
    			Request::Codes(_) => Kind::Codes,
    			Request::HeaderProofs(_) => Kind::HeaderProofs,
    		}
    	}

    	/// Get the amount of requests being made.
    	pub fn amount(&self) -> usize {
    		match *self {
    			Request::Headers(ref req) => req.max,
    			Request::Bodies(ref req) => req.block_hashes.len(),
    			Request::Receipts(ref req) => req.block_hashes.len(),
    			Request::StateProofs(ref req) => req.requests.len(),
    			Request::Codes(ref req) => req.code_requests.len(),
    			Request::HeaderProofs(ref req) => req.requests.len(),
    		}
    	}
    }

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