Struct ExtBytecode

pub struct ExtBytecode {
    pub action: Option<InterpreterAction>,
    /* private fields */
}

Extended bytecode structure that wraps base bytecode with additional execution metadata.

Fields

action: Option<InterpreterAction>

Actions that the EVM should do. It contains return value of the Interpreter or inputs for CALL or CREATE instructions. For RETURN or REVERT instructions it contains the result of the instruction.

Implementations

impl ExtBytecode

pub fn new(base: Bytecode) -> Self

Create new extended bytecode and set the instruction pointer to the start of the bytecode.

The bytecode hash will not be calculated.

pub fn new_with_hash(base: Bytecode, hash: B256) -> Self

Creates new ExtBytecode with the given hash.

pub fn new_with_optional_hash(base: Bytecode, hash: Option<B256>) -> Self

Creates new ExtBytecode with the given hash.

pub fn calculate_hash(&mut self) -> B256

Re-calculates the bytecode hash.

Prefer get_or_calculate_hash if you just need to get the hash.

pub fn hash(&mut self) -> Option<B256>

Returns the bytecode hash.

pub fn get_or_calculate_hash(&mut self) -> B256

Returns the bytecode hash or calculates it if it is not set.

Methods from Deref<Target = Bytecode>

pub fn legacy_jump_table(&self) -> Option<&JumpTable>

Returns jump table if bytecode is analyzed.

pub fn hash_slow(&self) -> FixedBytes<32>

Calculates hash of the bytecode.

pub fn is_eip7702(&self) -> bool

Returns true if bytecode is EIP-7702.

pub fn bytecode(&self) -> &Bytes

Returns a reference to the bytecode.

pub fn bytecode_ptr(&self) -> *const u8

Pointer to the executable bytecode.

pub fn bytes(&self) -> Bytes

Returns bytes.

pub fn bytes_ref(&self) -> &Bytes

Returns raw bytes reference.

pub fn bytes_slice(&self) -> &[u8]

Returns raw bytes slice.

pub fn original_bytes(&self) -> Bytes

Returns the original bytecode.

pub fn original_byte_slice(&self) -> &[u8]

Returns the original bytecode as a byte slice.

pub fn len(&self) -> usize

Returns the length of the original bytes.

pub fn is_empty(&self) -> bool

Returns whether the bytecode is empty.

pub fn iter_opcodes(&self) -> BytecodeIterator<'_>

Returns an iterator over the opcodes in this bytecode, skipping immediates. This is useful if you want to ignore immediates and just see what opcodes are inside.

Trait Implementations

impl Debug for ExtBytecode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExtBytecode

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ExtBytecode

type Target = Bytecode

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ExtBytecode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Immediates for ExtBytecode

fn read_u16(&self) -> u16

Reads next 16 bits as unsigned integer from the bytecode.

fn read_u8(&self) -> u8

Reads next 8 bits as unsigned integer from the bytecode.

fn read_slice(&self, len: usize) -> &[u8]

Reads next len bytes from the bytecode.

fn read_offset_u16(&self, offset: isize) -> u16

Reads next 16 bits as unsigned integer from the bytecode at given offset.

fn read_i16(&self) -> i16

Reads next 16 bits as signed integer from the bytecode.

fn read_i8(&self) -> i8

Reads next 8 bits as signed integer from the bytecode.

fn read_offset_i16(&self, offset: isize) -> i16

Reads next 16 bits as signed integer from the bytecode at given offset.

impl Jumps for ExtBytecode

fn relative_jump(&mut self, offset: isize)

Relative jumps does not require checking for overflow.

fn absolute_jump(&mut self, offset: usize)

Absolute jumps require checking for overflow and if target is a jump destination from jump table.

fn is_valid_legacy_jump(&mut self, offset: usize) -> bool

Check legacy jump destination from jump table.

fn opcode(&self) -> u8

Returns instruction opcode.

fn pc(&self) -> usize

Returns current program counter.

impl LegacyBytecode for ExtBytecode

fn bytecode_len(&self) -> usize

Returns current bytecode original length. Used in [bytecode::opcode::CODESIZE] opcode.

fn bytecode_slice(&self) -> &[u8]

Returns current bytecode original slice. Used in [bytecode::opcode::CODECOPY] opcode.

impl LoopControl for ExtBytecode

fn is_not_end(&self) -> bool

Returns true if the loop should continue.

fn reset_action(&mut self)

Sets the end flag internally. Action should be taken after.

fn set_action(&mut self, action: InterpreterAction)

Set return action.

fn action(&mut self) -> &mut Option<InterpreterAction>

Returns the current action.

fn is_end(&self) -> bool

Is end of the loop.

fn instruction_result(&mut self) -> Option<InstructionResult>

Returns instruction result

impl Serialize for ExtBytecode

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.