      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

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

    //! Execution environment substate.
    use std::collections::HashSet;
    use util::{Address, U256};
    use log_entry::LogEntry;
    use evm::Schedule;
    use super::CleanupMode;

    /// State changes which should be applied in finalize,
    /// after transaction is fully executed.
    #[derive(Debug, Default)]
    pub struct Substate {
    	/// Any accounts that have suicided.
    	pub suicides: HashSet<Address>,

    	/// Any accounts that are tagged for garbage collection.
    	pub garbage: HashSet<Address>,

    	/// Any logs.
    	pub logs: Vec<LogEntry>,

    	/// Refund counter of SSTORE nonzero -> zero.
    	pub sstore_clears_count: U256,

    	/// Created contracts.
    	pub contracts_created: Vec<Address>,
    }

    impl Substate {
    	/// Creates new substate.
    	pub fn new() -> Self {
    		Substate::default()
    	}

    	/// Merge secondary substate `s` into self, accruing each element correspondingly.
    	pub fn accrue(&mut self, s: Substate) {
    		self.suicides.extend(s.suicides.into_iter());
    		self.garbage.extend(s.garbage.into_iter());
    		self.logs.extend(s.logs.into_iter());
    		self.sstore_clears_count = self.sstore_clears_count + s.sstore_clears_count;
    		self.contracts_created.extend(s.contracts_created.into_iter());
    	}

    	/// Get the cleanup mode object from this.
    	#[cfg_attr(feature="dev", allow(wrong_self_convention))]
    	pub fn to_cleanup_mode(&mut self, schedule: &Schedule) -> CleanupMode {
    		match (schedule.no_empty, schedule.kill_empty) {
    			(false, _) => CleanupMode::ForceCreate,
    			(true, false) => CleanupMode::NoEmpty,
    			(true, true) => CleanupMode::KillEmpty(&mut self.garbage),
    		}
    	}
    }

    #[cfg(test)]
    mod tests {
    	use super::Substate;
    	use log_entry::LogEntry;

    	#[test]
    	fn created() {
    		let sub_state = Substate::new();
    		assert_eq!(sub_state.suicides.len(), 0);
    	}

    	#[test]
    	fn accrue() {
    		let mut sub_state = Substate::new();
    		sub_state.contracts_created.push(1u64.into());
    		sub_state.logs.push(LogEntry {
    			address: 1u64.into(),
    			topics: vec![],
    			data: vec![]
    		});
    		sub_state.sstore_clears_count = 5.into();
    		sub_state.suicides.insert(10u64.into());

    		let mut sub_state_2 = Substate::new();
    		sub_state_2.contracts_created.push(2u64.into());
    		sub_state_2.logs.push(LogEntry {
    			address: 1u64.into(),
    			topics: vec![],
    			data: vec![]
    		});
    		sub_state_2.sstore_clears_count = 7.into();

    		sub_state.accrue(sub_state_2);
    		assert_eq!(sub_state.contracts_created.len(), 2);
    		assert_eq!(sub_state.sstore_clears_count, 12.into());
    		assert_eq!(sub_state.suicides.len(), 1);
    	}
    }

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