      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

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

    //! Receipt

    use util::{H256, U256, Address};
    use util::HeapSizeOf;
    use rlp::*;

    use basic_types::LogBloom;
    use header::BlockNumber;
    use log_entry::{LogEntry, LocalizedLogEntry};

    /// Information describing execution of a transaction.
    #[derive(Default, Debug, Clone)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Receipt {
    	/// The state root after executing the transaction. Optional since EIP98
    	pub state_root: Option<H256>,
    	/// The total gas used in the block following execution of the transaction.
    	pub gas_used: U256,
    	/// The OR-wide combination of all logs' blooms for this transaction.
    	pub log_bloom: LogBloom,
    	/// The logs stemming from this transaction.
    	pub logs: Vec<LogEntry>,
    }

    impl Receipt {
    	/// Create a new receipt.
    	pub fn new(state_root: Option<H256>, gas_used: U256, logs: Vec<LogEntry>) -> Receipt {
    		Receipt {
    			state_root: state_root,
    			gas_used: gas_used,
    			log_bloom: logs.iter().fold(LogBloom::default(), |mut b, l| { b = &b | &l.bloom(); b }), //TODO: use |= operator
    			logs: logs,
    		}
    	}
    }

    impl Encodable for Receipt {
    	fn rlp_append(&self, s: &mut RlpStream) {
    		if let Some(ref root) = self.state_root {
    			s.begin_list(4);
    			s.append(root);
    		} else {
    			s.begin_list(3);
    		}
    		s.append(&self.gas_used);
    		s.append(&self.log_bloom);
    		s.append(&self.logs);
    	}
    }

    impl Decodable for Receipt {
    	fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
    		let d = decoder.as_rlp();
    		if d.item_count() == 3 {
    			Ok(Receipt {
    				state_root: None,
    				gas_used: d.val_at(0)?,
    				log_bloom: d.val_at(1)?,
    				logs: d.val_at(2)?,
    			})
    		} else {
    			Ok(Receipt {
    				state_root: d.val_at(0)?,
    				gas_used: d.val_at(1)?,
    				log_bloom: d.val_at(2)?,
    				logs: d.val_at(3)?,
    			})
    		}
    	}
    }

    impl HeapSizeOf for Receipt {
    	fn heap_size_of_children(&self) -> usize {
    		self.logs.heap_size_of_children()
    	}
    }

    /// Receipt with additional info.
    #[derive(Debug, Clone, PartialEq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct RichReceipt {
    	/// Transaction hash.
    	pub transaction_hash: H256,
    	/// Transaction index.
    	pub transaction_index: usize,
    	/// The total gas used in the block following execution of the transaction.
    	pub cumulative_gas_used: U256,
    	/// The gas used in the execution of the transaction. Note the difference of meaning to `Receipt::gas_used`.
    	pub gas_used: U256,
    	/// Contract address.
    	pub contract_address: Option<Address>,
    	/// Logs
    	pub logs: Vec<LogEntry>,
    	/// Logs bloom
    	pub log_bloom: LogBloom,
    	/// State root
    	pub state_root: Option<H256>,
    }

    /// Receipt with additional info.
    #[derive(Debug, Clone, PartialEq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct LocalizedReceipt {
    	/// Transaction hash.
    	pub transaction_hash: H256,
    	/// Transaction index.
    	pub transaction_index: usize,
    	/// Block hash.
    	pub block_hash: H256,
    	/// Block number.
    	pub block_number: BlockNumber,
    	/// The total gas used in the block following execution of the transaction.
    	pub cumulative_gas_used: U256,
    	/// The gas used in the execution of the transaction. Note the difference of meaning to `Receipt::gas_used`.
    	pub gas_used: U256,
    	/// Contract address.
    	pub contract_address: Option<Address>,
    	/// Logs
    	pub logs: Vec<LocalizedLogEntry>,
    	/// Logs bloom
    	pub log_bloom: LogBloom,
    	/// State root
    	pub state_root: Option<H256>,
    }

    #[test]
    fn test_no_state_root() {
    	let expected = ::rustc_serialize::hex::FromHex::from_hex(" ").unwrap();
    	let r = Receipt::new(
    		None,
    		0x40cae.into(),
    		vec![LogEntry {
    			address: "dcf421d093428b096ca501a7cd1a740855a7976f".into(),
    			topics: vec![],
    			data: vec![0u8; 32]
    		}]
    	);
    	assert_eq!(&encode(&r)[..], &expected[..]);
    }

    #[test]
    fn test_basic() {
    	let expected = ::rustc_serialize::hex::FromHex::from_hex(" ").unwrap();
    	let r = Receipt::new(
    		Some("2f697d671e9ae4ee24a43c4b0d7e15f1cb4ba6de1561120d43b9a4e8c4a8a6ee".into()),
    		0x40cae.into(),
    		vec![LogEntry {
    			address: "dcf421d093428b096ca501a7cd1a740855a7976f".into(),
    			topics: vec![],
    			data: vec![0u8; 32]
    		}]
    	);
    	assert_eq!(&encode(&r)[..], &expected[..]);
    }

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