openethereum/ethcore/src/substate.rs

114 lines
3.5 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +01:00
// Copyright 2015, 2016 Ethcore (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/>.
2016-02-02 15:29:53 +01:00
//! Execution environment substate.
2016-01-15 14:22:46 +01:00
use common::*;
/// State changes which should be applied in finalize,
/// after transaction is fully executed.
#[derive(Debug)]
2016-01-15 14:22:46 +01:00
pub struct Substate {
/// Any accounts that have suicided.
pub suicides: HashSet<Address>,
2016-01-15 14:22:46 +01:00
/// Any logs.
pub logs: Vec<LogEntry>,
2016-01-16 07:46:36 +01:00
/// Refund counter of SSTORE nonzero -> zero.
pub sstore_clears_count: U256,
2016-01-15 14:22:46 +01:00
/// Created contracts.
pub contracts_created: Vec<Address>,
2016-01-15 14:22:46 +01:00
/// The trace during this execution or `None` if we're not tracing.
pub subtraces: Option<Vec<Trace>>,
2016-03-11 10:57:58 +01:00
}
2016-01-15 14:22:46 +01:00
impl Substate {
/// Creates new substate.
pub fn new(tracing: bool) -> Self {
Substate {
suicides: Default::default(),
logs: Default::default(),
sstore_clears_count: Default::default(),
contracts_created: Default::default(),
subtraces: if tracing {Some(vec![])} else {None},
}
2016-01-15 14:22:46 +01:00
}
/// Merge tracing information from substate `s` if enabled.
pub fn accrue_trace(&mut self, subs: Option<Vec<Trace>>, maybe_info: Option<(TraceAction, usize)>) {
// it failed, so we don't bother accrueing any protocol-level stuff, only the
// trace info.
2016-03-19 14:35:09 +01:00
if let Some(info) = maybe_info {
self.subtraces.as_mut().expect("maybe_action is Some: so we must be tracing: qed").push(Trace {
2016-03-19 14:35:09 +01:00
action: info.0,
depth: info.1,
subs: subs.expect("maybe_action is Some: so we must be tracing: qed"),
});
}
}
/// Merge secondary substate `s` into self, accruing each element correspondingly; will merge
/// tracing information too, if enabled.
pub fn accrue(&mut self, s: Substate, maybe_info: Option<(TraceAction, usize)>) {
self.suicides.extend(s.suicides.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());
self.accrue_trace(s.subtraces, maybe_info);
}
}
2016-01-30 14:15:37 +01:00
#[cfg(test)]
mod tests {
use super::*;
2016-02-01 13:29:12 +01:00
use common::*;
2016-01-30 14:15:37 +01:00
2016-02-09 15:28:27 +01:00
#[test]
fn created() {
2016-03-19 13:07:49 +01:00
let sub_state = Substate::new(false);
2016-02-09 15:28:27 +01:00
assert_eq!(sub_state.suicides.len(), 0);
}
2016-01-30 14:15:37 +01:00
#[test]
fn accrue() {
2016-03-19 13:07:49 +01:00
let mut sub_state = Substate::new(false);
sub_state.contracts_created.push(address_from_u64(1u64));
sub_state.logs.push(LogEntry {
2016-03-11 10:57:58 +01:00
address: address_from_u64(1u64),
topics: vec![],
data: vec![]
});
2016-02-01 13:29:12 +01:00
sub_state.sstore_clears_count = x!(5);
sub_state.suicides.insert(address_from_u64(10u64));
2016-03-19 13:07:49 +01:00
let mut sub_state_2 = Substate::new(false);
sub_state_2.contracts_created.push(address_from_u64(2u64));
sub_state_2.logs.push(LogEntry {
2016-03-11 10:57:58 +01:00
address: address_from_u64(1u64),
topics: vec![],
data: vec![]
});
2016-02-01 13:29:12 +01:00
sub_state_2.sstore_clears_count = x!(7);
sub_state.accrue(sub_state_2, None);
assert_eq!(sub_state.contracts_created.len(), 2);
2016-02-01 13:29:12 +01:00
assert_eq!(sub_state.sstore_clears_count, x!(12));
assert_eq!(sub_state.suicides.len(), 1);
2016-01-30 14:15:37 +01:00
}
2016-02-02 15:29:53 +01:00
}