      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

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

    //! Blockchain DB extras.

    use bloomchain;
    use util::*;
    use rlp::*;
    use header::BlockNumber;
    use receipt::Receipt;
    use db::Key;
    use blooms::{GroupPosition, BloomGroup};

    /// Represents index of extra data in database
    #[derive(Copy, Debug, Hash, Eq, PartialEq, Clone)]
    pub enum ExtrasIndex {
    	/// Block details index
    	BlockDetails = 0,
    	/// Block hash index
    	BlockHash = 1,
    	/// Transaction address index
    	TransactionAddress = 2,
    	/// Block blooms index
    	BlocksBlooms = 3,
    	/// Block receipts index
    	BlockReceipts = 4,
    }

    fn with_index(hash: &H256, i: ExtrasIndex) -> H264 {
    	let mut result = H264::default();
    	result[0] = i as u8;
    	(*result)[1..].clone_from_slice(hash);
    	result
    }

    pub struct BlockNumberKey([u8; 5]);

    impl Deref for BlockNumberKey {
    	type Target = [u8];

    	fn deref(&self) -> &Self::Target {
    		&self.0
    	}
    }

    impl Key<H256> for BlockNumber {
    	type Target = BlockNumberKey;

    	fn key(&self) -> Self::Target {
    		let mut result = [0u8; 5];
    		result[0] = ExtrasIndex::BlockHash as u8;
    		result[1] = (self >> 24) as u8;
    		result[2] = (self >> 16) as u8;
    		result[3] = (self >> 8) as u8;
    		result[4] = *self as u8;
    		BlockNumberKey(result)
    	}
    }

    impl Key<BlockDetails> for H256 {
    	type Target = H264;

    	fn key(&self) -> H264 {
    		with_index(self, ExtrasIndex::BlockDetails)
    	}
    }

    pub struct LogGroupKey([u8; 6]);

    impl Deref for LogGroupKey {
    	type Target = [u8];

    	fn deref(&self) -> &Self::Target {
    		&self.0
    	}
    }

    #[derive(Debug, PartialEq, Eq, Hash, Clone)]
    pub struct LogGroupPosition(GroupPosition);

    impl From<bloomchain::group::GroupPosition> for LogGroupPosition {
    	fn from(position: bloomchain::group::GroupPosition) -> Self {
    		LogGroupPosition(From::from(position))
    	}
    }

    impl HeapSizeOf for LogGroupPosition {
    	fn heap_size_of_children(&self) -> usize {
    		self.0.heap_size_of_children()
    	}
    }

    impl Key<BloomGroup> for LogGroupPosition {
    	type Target = LogGroupKey;

    	fn key(&self) -> Self::Target {
    		let mut result = [0u8; 6];
    		result[0] = ExtrasIndex::BlocksBlooms as u8;
    		result[1] = self.0.level;
    		result[2] = (self.0.index >> 24) as u8;
    		result[3] = (self.0.index >> 16) as u8;
    		result[4] = (self.0.index >> 8) as u8;
    		result[5] = self.0.index as u8;
    		LogGroupKey(result)
    	}
    }

    impl Key<TransactionAddress> for H256 {
    	type Target = H264;

    	fn key(&self) -> H264 {
    		with_index(self, ExtrasIndex::TransactionAddress)
    	}
    }

    impl Key<BlockReceipts> for H256 {
    	type Target = H264;

    	fn key(&self) -> H264 {
    		with_index(self, ExtrasIndex::BlockReceipts)
    	}
    }

    /// Familial details concerning a block
    #[derive(Debug, Clone)]
    pub struct BlockDetails {
    	/// Block number
    	pub number: BlockNumber,
    	/// Total difficulty of the block and all its parents
    	pub total_difficulty: U256,
    	/// Parent block hash
    	pub parent: H256,
    	/// List of children block hashes
    	pub children: Vec<H256>
    }

    impl HeapSizeOf for BlockDetails {
    	fn heap_size_of_children(&self) -> usize {
    		self.children.heap_size_of_children()
    	}
    }

    impl Decodable for BlockDetails {
    	fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
    		let d = decoder.as_rlp();
    		let details = BlockDetails {
    			number: d.val_at(0)?,
    			total_difficulty: d.val_at(1)?,
    			parent: d.val_at(2)?,
    			children: d.val_at(3)?,
    		};
    		Ok(details)
    	}
    }

    impl Encodable for BlockDetails {
    	fn rlp_append(&self, s: &mut RlpStream) {
    		s.begin_list(4);
    		s.append(&self.number);
    		s.append(&self.total_difficulty);
    		s.append(&self.parent);
    		s.append(&self.children);
    	}
    }

    /// Represents address of certain transaction within block
    #[derive(Debug, PartialEq, Clone)]
    pub struct TransactionAddress {
    	/// Block hash
    	pub block_hash: H256,
    	/// Transaction index within the block
    	pub index: usize
    }

    impl HeapSizeOf for TransactionAddress {
    	fn heap_size_of_children(&self) -> usize { 0 }
    }

    impl Decodable for TransactionAddress {
    	fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
    		let d = decoder.as_rlp();
    		let tx_address = TransactionAddress {
    			block_hash: d.val_at(0)?,
    			index: d.val_at(1)?,
    		};

    		Ok(tx_address)
    	}
    }

    impl Encodable for TransactionAddress {
    	fn rlp_append(&self, s: &mut RlpStream) {
    		s.begin_list(2);
    		s.append(&self.block_hash);
    		s.append(&self.index);
    	}
    }

    /// Contains all block receipts.
    #[derive(Clone)]
    pub struct BlockReceipts {
    	pub receipts: Vec<Receipt>,
    }

    impl BlockReceipts {
    	pub fn new(receipts: Vec<Receipt>) -> Self {
    		BlockReceipts {
    			receipts: receipts
    		}
    	}
    }

    impl Decodable for BlockReceipts {
    	fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
    		Ok(BlockReceipts {
    			receipts: Decodable::decode(decoder)?
    		})
    	}
    }

    impl Encodable for BlockReceipts {
    	fn rlp_append(&self, s: &mut RlpStream) {
    		s.append(&self.receipts);
    	}
    }

    impl HeapSizeOf for BlockReceipts {
    	fn heap_size_of_children(&self) -> usize {
    		self.receipts.heap_size_of_children()
    	}
    }

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