evm-interpreter 1.1.0

The interpreter part of Ethereum Virtual Machine
Documentation 
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

mod etable;
mod valids;

use alloc::{boxed::Box, vec::Vec};

pub use self::etable::EtableInterpreter;
pub use self::valids::Valids;

use crate::{Capture, ExitError, ExitResult};

/// Control state.
#[derive(Eq, PartialEq, Debug)]
pub enum Control<Trap> {
	/// No action.
	NoAction,
	/// Continue the execution, increase the PC by N.
	Continue(usize),
	/// Exit the execution.
	Exit(ExitResult),
	/// Jump to the specified PC.
	Jump(usize),
	/// Trapping the execution with the possibility to resume.
	Trap(Box<Trap>),
}

/// An interpreter.
pub trait Interpreter<H> {
	/// Interpreter state.
	type State;
	/// Interpreter trap.
	type Trap;

	/// Deconstruct the interpreter.
	fn deconstruct(self) -> (Self::State, Vec<u8>);
	/// Get a reference to the internal state.
	fn state(&self) -> &Self::State;
	/// Get a mutable reference to the internal state.
	fn state_mut(&mut self) -> &mut Self::State;
	/// Run the interpreter.
	fn run(&mut self, handle: &mut H) -> Capture<ExitResult, Self::Trap>;
}

/// Trap feedback for an interpreter.
pub trait FeedbackInterpreter<H, Feedback>: Interpreter<H> {
	/// Feedback to the interpreter.
	fn feedback(&mut self, feedback: Feedback, handler: &mut H) -> Result<(), ExitError>;
}

/// An interpreter that allows single stepping.
pub trait StepInterpreter<H>: Interpreter<H> {
	/// Step the interpreter.
	fn step(&mut self, handle: &mut H) -> Result<(), Capture<ExitResult, Self::Trap>>;
}