openethereum/bin/evmbin/src/info.rs

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

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

// OpenEthereum 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 OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

//! VM runner.

use ethcore::{
    client::{self, EvmTestClient, EvmTestError, TransactErr, TransactSuccess},
    pod_state, spec, state, state_db, trace, TrieSpec,
};
use ethereum_types::{H256, U256};
use ethjson;
use std::time::{Duration, Instant};
use types::transaction;
use vm::ActionParams;

/// VM execution informant
pub trait Informant: trace::VMTracer {
    /// Sink to use with finish
    type Sink;
    /// Display a single run init message
    fn before_test(&mut self, test: &str, action: &str);
    /// Set initial gas.
    fn set_gas(&mut self, _gas: U256) {}
    /// Clone sink.
    fn clone_sink(&self) -> Self::Sink;
    /// Display final result.
    fn finish(result: RunResult<Self::Output>, &mut Self::Sink);
}

/// Execution finished correctly
#[derive(Debug)]
pub struct Success<T> {
    /// State root
    pub state_root: H256,
    /// Used gas
    pub gas_used: U256,
    /// Output as bytes
    pub output: Vec<u8>,
    /// Time Taken
    pub time: Duration,
    /// Traces
    pub traces: Option<T>,
    /// Optional end state dump
    pub end_state: Option<pod_state::PodState>,
}

/// Execution failed
#[derive(Debug)]
pub struct Failure<T> {
    /// State root
    pub state_root: H256,
    /// Used gas
    pub gas_used: U256,
    /// Internal error
    pub error: EvmTestError,
    /// Duration
    pub time: Duration,
    /// Traces
    pub traces: Option<T>,
    /// Optional end state dump
    pub end_state: Option<pod_state::PodState>,
}

/// EVM Execution result
pub type RunResult<T> = Result<Success<T>, Failure<T>>;

/// Execute given `ActionParams` and return the result.
pub fn run_action<T: Informant>(
    spec: &spec::Spec,
    mut params: ActionParams,
    mut informant: T,
    trie_spec: TrieSpec,
) -> RunResult<T::Output> {
    informant.set_gas(params.gas);

    // if the code is not overwritten from CLI, use code from spec file.
    if params.code.is_none() {
        if let Some(acc) = spec.genesis_state().get().get(&params.code_address) {
            params.code = acc.code.clone().map(::std::sync::Arc::new);
            params.code_hash = None;
        }
    }
    run(
        spec,
        trie_spec,
        params.gas,
        spec.genesis_state(),
        |mut client| {
            let result = match client.call(params, &mut trace::NoopTracer, &mut informant) {
                Ok(r) => (Ok(r.return_data.to_vec()), Some(r.gas_left)),
                Err(err) => (Err(err), None),
            };
            (result.0, 0.into(), None, result.1, informant.drain())
        },
    )
}

/// Execute given Transaction and verify resulting state root.
pub fn run_transaction<T: Informant>(
    name: &str,
    idx: usize,
    spec: &ethjson::spec::ForkSpec,
    pre_state: &pod_state::PodState,
    post_root: H256,
    env_info: &client::EnvInfo,
    transaction: transaction::SignedTransaction,
    mut informant: T,
    trie_spec: TrieSpec,
) {
    let spec_name = format!("{:?}", spec).to_lowercase();
    let spec = match EvmTestClient::spec_from_json(spec) {
        Some(spec) => {
            informant.before_test(&format!("{}:{}:{}", name, spec_name, idx), "starting");
            spec
        }
        None => {
            informant.before_test(
                &format!("{}:{}:{}", name, spec_name, idx),
                "skipping because of missing spec",
            );
            return;
        }
    };

    informant.set_gas(env_info.gas_limit);

    let mut sink = informant.clone_sink();
    let result = run(
        &spec,
        trie_spec,
        transaction.tx().gas,
        pre_state,
        |mut client| {
            let result = client.transact(env_info, transaction, trace::NoopTracer, informant);
            match result {
                Ok(TransactSuccess {
                    state_root,
                    gas_left,
                    output,
                    vm_trace,
                    end_state,
                    ..
                }) => {
                    if state_root != post_root {
                        (
                            Err(EvmTestError::PostCondition(format!(
                                "State root mismatch (got: {:#x}, expected: {:#x})",
                                state_root, post_root,
                            ))),
                            state_root,
                            end_state,
                            Some(gas_left),
                            None,
                        )
                    } else {
                        (Ok(output), state_root, end_state, Some(gas_left), vm_trace)
                    }
                }
                Err(TransactErr {
                    state_root,
                    error,
                    end_state,
                }) => (
                    Err(EvmTestError::PostCondition(format!(
                        "Unexpected execution error: {:?}",
                        error
                    ))),
                    state_root,
                    end_state,
                    None,
                    None,
                ),
            }
        },
    );

    T::finish(result, &mut sink)
}

fn dump_state(state: &state::State<state_db::StateDB>) -> Option<pod_state::PodState> {
    state.to_pod_full().ok()
}

/// Execute VM with given `ActionParams`
pub fn run<'a, F, X>(
    spec: &'a spec::Spec,
    trie_spec: TrieSpec,
    initial_gas: U256,
    pre_state: &'a pod_state::PodState,
    run: F,
) -> RunResult<X>
where
    F: FnOnce(
        EvmTestClient,
    ) -> (
        Result<Vec<u8>, EvmTestError>,
        H256,
        Option<pod_state::PodState>,
        Option<U256>,
        Option<X>,
    ),
{
    let do_dump = trie_spec == TrieSpec::Fat;

    let mut test_client =
        EvmTestClient::from_pod_state_with_trie(spec, pre_state.clone(), trie_spec).map_err(
            |error| Failure {
                gas_used: 0.into(),
                error,
                time: Duration::from_secs(0),
                traces: None,
                state_root: H256::default(),
                end_state: None,
            },
        )?;

    if do_dump {
        test_client.set_dump_state_fn(dump_state);
    }

    let start = Instant::now();
    let result = run(test_client);
    let time = start.elapsed();

    match result {
        (Ok(output), state_root, end_state, gas_left, traces) => Ok(Success {
            state_root,
            gas_used: gas_left
                .map(|gas_left| initial_gas - gas_left)
                .unwrap_or(initial_gas),
            output,
            time,
            traces,
            end_state,
        }),
        (Err(error), state_root, end_state, gas_left, traces) => Err(Failure {
            gas_used: gas_left
                .map(|gas_left| initial_gas - gas_left)
                .unwrap_or(initial_gas),
            error,
            time,
            traces,
            state_root,
            end_state,
        }),
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;
    use rustc_hex::FromHex;
    use std::sync::Arc;
    use tempdir::TempDir;

    pub fn run_test<T, I, F>(informant: I, compare: F, code: &str, gas: T, expected: &str)
    where
        T: Into<U256>,
        I: Informant,
        F: FnOnce(Option<I::Output>, &str),
    {
        let mut params = ActionParams::default();
        params.code = Some(Arc::new(code.from_hex().unwrap()));
        params.gas = gas.into();

        let tempdir = TempDir::new("").unwrap();
        let spec = ::ethcore::ethereum::new_foundation(&tempdir.path());
        let result = run_action(&spec, params, informant, TrieSpec::Secure);
        match result {
            Ok(Success { traces, .. }) => compare(traces, expected),
            Err(Failure { traces, .. }) => compare(traces, expected),
        }
    }

    #[test]
    fn should_call_account_from_spec() {
        use display::std_json::tests::informant;

        let (inf, res) = informant();
        let mut params = ActionParams::default();
        params.code_address = 0x20.into();
        params.gas = 0xffff.into();

        let spec = ::ethcore::ethereum::load(None, include_bytes!("../res/testchain.json"));
        let _result = run_action(&spec, params, inf, TrieSpec::Secure);

        assert_eq!(
            &String::from_utf8_lossy(&**res.lock().unwrap()),
            r#"{"depth":1,"gas":"0xffff","op":98,"opName":"PUSH3","pc":0,"stack":[],"storage":{}}
{"depth":1,"gas":"0xfffc","op":96,"opName":"PUSH1","pc":4,"stack":["0xaaaaaa"],"storage":{}}
{"depth":1,"gas":"0xfff9","op":96,"opName":"PUSH1","pc":6,"stack":["0xaaaaaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xfff6","op":80,"opName":"POP","pc":8,"stack":["0xaaaaaa","0xaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xfff4","op":96,"opName":"PUSH1","pc":9,"stack":["0xaaaaaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xfff1","op":96,"opName":"PUSH1","pc":11,"stack":["0xaaaaaa","0xaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xffee","op":96,"opName":"PUSH1","pc":13,"stack":["0xaaaaaa","0xaa","0xaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xffeb","op":96,"opName":"PUSH1","pc":15,"stack":["0xaaaaaa","0xaa","0xaa","0xaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xffe8","op":96,"opName":"PUSH1","pc":17,"stack":["0xaaaaaa","0xaa","0xaa","0xaa","0xaa","0xaa"],"storage":{}}
{"depth":1,"gas":"0xffe5","op":96,"opName":"PUSH1","pc":19,"stack":["0xaaaaaa","0xaa","0xaa","0xaa","0xaa","0xaa","0xaa"],"storage":{}}
"#
        );
    }
}