lib.rs

/* EVMC: Ethereum Client-VM Connector API.
 * Copyright 2019 The EVMC Authors.
 * Licensed under the Apache License, Version 2.0.
 */

//! Rust bindings for EVMC (Ethereum Client-VM Connector API).
//!
//! Have a look at evmc-declare to declare an EVMC compatible VM.
//! This crate documents how to use certain data types.

mod container;
mod types;

pub use container::EvmcContainer;
pub use evmc_sys as ffi;
pub use types::*;

/// Trait EVMC VMs have to implement.
pub trait EvmcVm {
    /// This is called once at initialisation time.
    fn init() -> Self;
    /// This is called for every incoming message.
    fn execute<'a>(
        &self,
        revision: ffi::evmc_revision,
        code: &'a [u8],
        message: &'a ExecutionMessage,
        context: &'a mut ExecutionContext<'a>,
    ) -> ExecutionResult;
}

/// EVMC result structure.
#[derive(Debug)]
pub struct ExecutionResult {
    status_code: ffi::evmc_status_code,
    gas_left: i64,
    output: Option<Vec<u8>>,
    create_address: Option<Address>,
}

/// EVMC execution message structure.
#[derive(Debug)]
pub struct ExecutionMessage {
    kind: ffi::evmc_call_kind,
    flags: u32,
    depth: i32,
    gas: i64,
    destination: Address,
    sender: Address,
    input: Option<Vec<u8>>,
    value: Uint256,
    create2_salt: Bytes32,
}

/// EVMC transaction context structure.
pub type ExecutionTxContext = ffi::evmc_tx_context;

/// EVMC context structure. Exposes the EVMC host functions, message data, and transaction context
/// to the executing VM.
pub struct ExecutionContext<'a> {
    context: &'a mut ffi::evmc_context,
    tx_context: ExecutionTxContext,
}

impl ExecutionResult {
    /// Manually create a result.
    pub fn new(
        _status_code: ffi::evmc_status_code,
        _gas_left: i64,
        _output: Option<&[u8]>,
    ) -> Self {
        ExecutionResult {
            status_code: _status_code,
            gas_left: _gas_left,
            output: if _output.is_some() {
                Some(_output.unwrap().to_vec())
            } else {
                None
            },
            create_address: None,
        }
    }

    /// Create failure result.
    pub fn failure() -> Self {
        ExecutionResult::new(ffi::evmc_status_code::EVMC_FAILURE, 0, None)
    }

    /// Create a revert result.
    pub fn revert(_gas_left: i64, _output: Option<&[u8]>) -> Self {
        ExecutionResult::new(ffi::evmc_status_code::EVMC_REVERT, _gas_left, _output)
    }

    /// Create a successful result.
    pub fn success(_gas_left: i64, _output: Option<&[u8]>) -> Self {
        ExecutionResult::new(ffi::evmc_status_code::EVMC_SUCCESS, _gas_left, _output)
    }

    /// Read the status code.
    pub fn status_code(&self) -> ffi::evmc_status_code {
        self.status_code
    }

    /// Read the amount of gas left.
    pub fn gas_left(&self) -> i64 {
        self.gas_left
    }

    /// Read the output returned.
    pub fn output(&self) -> Option<&Vec<u8>> {
        self.output.as_ref()
    }

    /// Read the address of the created account. This will likely be set when
    /// returned from a CREATE/CREATE2.
    pub fn create_address(&self) -> Option<&Address> {
        self.create_address.as_ref()
    }
}

impl ExecutionMessage {
    pub fn new(
        kind: ffi::evmc_call_kind,
        flags: u32,
        depth: i32,
        gas: i64,
        destination: Address,
        sender: Address,
        input: Option<&[u8]>,
        value: Uint256,
        create2_salt: Bytes32,
    ) -> Self {
        ExecutionMessage {
            kind,
            flags,
            depth,
            gas,
            destination,
            sender,
            input: if input.is_some() {
                Some(input.unwrap().to_vec())
            } else {
                None
            },
            value,
            create2_salt,
        }
    }

    /// Read the message kind.
    pub fn kind(&self) -> ffi::evmc_call_kind {
        self.kind
    }

    /// Read the message flags.
    pub fn flags(&self) -> u32 {
        self.flags
    }

    /// Read the call depth.
    pub fn depth(&self) -> i32 {
        self.depth
    }

    /// Read the gas limit supplied with the message.
    pub fn gas(&self) -> i64 {
        self.gas
    }

    /// Read the destination address of the message.
    pub fn destination(&self) -> &Address {
        &self.destination
    }

    /// Read the sender address of the message.
    pub fn sender(&self) -> &Address {
        &self.sender
    }

    /// Read the optional input message.
    pub fn input(&self) -> Option<&Vec<u8>> {
        self.input.as_ref()
    }

    /// Read the value of the message.
    pub fn value(&self) -> &Uint256 {
        &self.value
    }

    /// Read the salt for CREATE2. Only valid if the message kind is CREATE2.
    pub fn create2_salt(&self) -> &Bytes32 {
        &self.create2_salt
    }
}

impl<'a> ExecutionContext<'a> {
    pub fn new(_context: &'a mut ffi::evmc_context) -> Self {
        assert!(_context.host != std::ptr::null());
        let _tx_context = unsafe {
            assert!((*(_context.host)).get_tx_context.is_some());
            (*(_context.host)).get_tx_context.unwrap()(_context as *mut ffi::evmc_context)
        };

        ExecutionContext {
            context: _context,
            tx_context: _tx_context,
        }
    }

    /// Retrieve the transaction context.
    pub fn get_tx_context(&self) -> &ExecutionTxContext {
        &self.tx_context
    }

    /// Check if an account exists.
    pub fn account_exists(&mut self, address: &Address) -> bool {
        unsafe {
            assert!((*self.context.host).account_exists.is_some());
            (*self.context.host).account_exists.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
            )
        }
    }

    /// Read from a storage key.
    pub fn get_storage(&mut self, address: &Address, key: &Bytes32) -> Bytes32 {
        unsafe {
            assert!((*self.context.host).get_storage.is_some());
            (*self.context.host).get_storage.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
                key as *const Bytes32,
            )
        }
    }

    /// Set value of a storage key.
    pub fn set_storage(
        &mut self,
        address: &Address,
        key: &Bytes32,
        value: &Bytes32,
    ) -> ffi::evmc_storage_status {
        unsafe {
            assert!((*self.context.host).set_storage.is_some());
            (*self.context.host).set_storage.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
                key as *const Bytes32,
                value as *const Bytes32,
            )
        }
    }

    /// Get balance of an account.
    pub fn get_balance(&mut self, address: &Address) -> Uint256 {
        unsafe {
            assert!((*self.context.host).get_balance.is_some());
            (*self.context.host).get_balance.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
            )
        }
    }

    /// Get code size of an account.
    pub fn get_code_size(&mut self, address: &Address) -> usize {
        unsafe {
            assert!((*self.context.host).get_code_size.is_some());
            (*self.context.host).get_code_size.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
            )
        }
    }

    /// Get code hash of an account.
    pub fn get_code_hash(&mut self, address: &Address) -> Bytes32 {
        unsafe {
            assert!((*self.context.host).get_code_size.is_some());
            (*self.context.host).get_code_hash.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
            )
        }
    }

    /// Copy code of an account.
    pub fn copy_code(&mut self, address: &Address, code_offset: usize, buffer: &mut [u8]) -> usize {
        unsafe {
            assert!((*self.context.host).copy_code.is_some());
            (*self.context.host).copy_code.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
                code_offset,
                // FIXME: ensure that alignment of the array elements is OK
                buffer.as_mut_ptr(),
                buffer.len(),
            )
        }
    }

    /// Self-destruct the current account.
    pub fn selfdestruct(&mut self, address: &Address, beneficiary: &Address) {
        unsafe {
            assert!((*self.context.host).selfdestruct.is_some());
            (*self.context.host).selfdestruct.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
                beneficiary as *const Address,
            )
        }
    }

    /// Call to another account.
    pub fn call(&mut self, message: &ExecutionMessage) -> ExecutionResult {
        // There is no need to make any kind of copies here, because the caller
        // won't go out of scope and ensures these pointers remain valid.
        let input = message.input();
        let input_size = if input.is_some() {
            input.unwrap().len()
        } else {
            0
        };
        let input_data = if input.is_some() {
            input.unwrap().as_ptr()
        } else {
            std::ptr::null() as *const u8
        };
        // Cannot use a nice from trait here because that complicates memory management,
        // evmc_message doesn't have a release() method we could abstract it with.
        let message = ffi::evmc_message {
            kind: message.kind(),
            flags: message.flags(),
            depth: message.depth(),
            gas: message.gas(),
            destination: *message.destination(),
            sender: *message.sender(),
            input_data: input_data,
            input_size: input_size,
            value: *message.value(),
            create2_salt: *message.create2_salt(),
        };
        unsafe {
            assert!((*self.context.host).call.is_some());
            (*self.context.host).call.unwrap()(
                self.context as *mut ffi::evmc_context,
                &message as *const ffi::evmc_message,
            )
            .into()
        }
    }

    /// Get block hash of an account.
    pub fn get_block_hash(&mut self, num: i64) -> Bytes32 {
        unsafe {
            assert!((*self.context.host).get_block_hash.is_some());
            (*self.context.host).get_block_hash.unwrap()(
                self.context as *mut ffi::evmc_context,
                num,
            )
        }
    }

    /// Emit a log.
    pub fn emit_log(&mut self, address: &Address, data: &[u8], topics: &[Bytes32]) {
        unsafe {
            assert!((*self.context.host).emit_log.is_some());
            (*self.context.host).emit_log.unwrap()(
                self.context as *mut ffi::evmc_context,
                address as *const Address,
                // FIXME: ensure that alignment of the array elements is OK
                data.as_ptr(),
                data.len(),
                topics.as_ptr(),
                topics.len(),
            )
        }
    }
}

impl From<ffi::evmc_result> for ExecutionResult {
    fn from(result: ffi::evmc_result) -> Self {
        let ret = ExecutionResult {
            status_code: result.status_code,
            gas_left: result.gas_left,
            output: if result.output_data.is_null() {
                assert!(result.output_size == 0);
                None
            } else if result.output_size == 0 {
                None
            } else {
                Some(from_buf_raw::<u8>(result.output_data, result.output_size))
            },
            // Consider it is always valid.
            create_address: Some(result.create_address),
        };

        // Release allocated ffi struct.
        if result.release.is_some() {
            unsafe {
                result.release.unwrap()(&result as *const ffi::evmc_result);
            }
        }

        ret
    }
}

fn allocate_output_data(output: Option<&Vec<u8>>) -> (*const u8, usize) {
    if let Some(buf) = output {
        let buf_len = buf.len();

        // Manually allocate heap memory for the new home of the output buffer.
        let memlayout = std::alloc::Layout::from_size_align(buf_len, 1).expect("Bad layout");
        let new_buf = unsafe { std::alloc::alloc(memlayout) };
        unsafe {
            // Copy the data into the allocated buffer.
            std::ptr::copy(buf.as_ptr(), new_buf, buf_len);
        }

        (new_buf as *const u8, buf_len)
    } else {
        (std::ptr::null(), 0)
    }
}

unsafe fn deallocate_output_data(ptr: *const u8, size: usize) {
    if !ptr.is_null() {
        let buf_layout = std::alloc::Layout::from_size_align(size, 1).expect("Bad layout");
        std::alloc::dealloc(ptr as *mut u8, buf_layout);
    }
}

/// Returns a pointer to a heap-allocated evmc_result.
impl Into<*const ffi::evmc_result> for ExecutionResult {
    fn into(self) -> *const ffi::evmc_result {
        let mut result: ffi::evmc_result = self.into();
        result.release = Some(release_heap_result);
        Box::into_raw(Box::new(result))
    }
}

/// Callback to pass across FFI, de-allocating the optional output_data.
extern "C" fn release_heap_result(result: *const ffi::evmc_result) {
    unsafe {
        let tmp = Box::from_raw(result as *mut ffi::evmc_result);
        deallocate_output_data(tmp.output_data, tmp.output_size);
    }
}

/// Returns a pointer to a stack-allocated evmc_result.
impl Into<ffi::evmc_result> for ExecutionResult {
    fn into(self) -> ffi::evmc_result {
        let (buffer, len) = allocate_output_data(self.output.as_ref());
        ffi::evmc_result {
            status_code: self.status_code,
            gas_left: self.gas_left,
            output_data: buffer,
            output_size: len,
            release: Some(release_stack_result),
            create_address: if self.create_address.is_some() {
                self.create_address.unwrap()
            } else {
                Address { bytes: [0u8; 20] }
            },
            padding: [0u8; 4],
        }
    }
}

/// Callback to pass across FFI, de-allocating the optional output_data.
extern "C" fn release_stack_result(result: *const ffi::evmc_result) {
    unsafe {
        let tmp = *result;
        deallocate_output_data(tmp.output_data, tmp.output_size);
    }
}

impl From<&ffi::evmc_message> for ExecutionMessage {
    fn from(message: &ffi::evmc_message) -> Self {
        ExecutionMessage {
            kind: message.kind,
            flags: message.flags,
            depth: message.depth,
            gas: message.gas,
            destination: message.destination,
            sender: message.sender,
            input: if message.input_data.is_null() {
                assert!(message.input_size == 0);
                None
            } else if message.input_size == 0 {
                None
            } else {
                Some(from_buf_raw::<u8>(message.input_data, message.input_size))
            },
            value: message.value,
            create2_salt: message.create2_salt,
        }
    }
}

fn from_buf_raw<T>(ptr: *const T, size: usize) -> Vec<T> {
    // Pre-allocate a vector.
    let mut buf = Vec::with_capacity(size);
    unsafe {
        // Set the len of the vec manually.
        buf.set_len(size);
        // Copy from the C buffer to the vec's buffer.
        std::ptr::copy(ptr, buf.as_mut_ptr(), size);
    }
    buf
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn result_new() {
        let r = ExecutionResult::new(ffi::evmc_status_code::EVMC_FAILURE, 420, None);

        assert!(r.status_code() == ffi::evmc_status_code::EVMC_FAILURE);
        assert!(r.gas_left() == 420);
        assert!(r.output().is_none());
        assert!(r.create_address().is_none());
    }

    // Test-specific helper to dispose of execution results in unit tests
    extern "C" fn test_result_dispose(result: *const ffi::evmc_result) {
        unsafe {
            if !result.is_null() {
                let owned = *result;
                Vec::from_raw_parts(
                    owned.output_data as *mut u8,
                    owned.output_size,
                    owned.output_size,
                );
            }
        }
    }

    #[test]
    fn result_from_ffi() {
        let f = ffi::evmc_result {
            status_code: ffi::evmc_status_code::EVMC_SUCCESS,
            gas_left: 1337,
            output_data: Box::into_raw(Box::new([0xde, 0xad, 0xbe, 0xef])) as *const u8,
            output_size: 4,
            release: Some(test_result_dispose),
            create_address: Address { bytes: [0u8; 20] },
            padding: [0u8; 4],
        };

        let r: ExecutionResult = f.into();

        assert!(r.status_code() == ffi::evmc_status_code::EVMC_SUCCESS);
        assert!(r.gas_left() == 1337);
        assert!(r.output().is_some());
        assert!(r.output().unwrap().len() == 4);
        assert!(r.create_address().is_some());
    }

    #[test]
    fn result_into_heap_ffi() {
        let r = ExecutionResult::new(
            ffi::evmc_status_code::EVMC_FAILURE,
            420,
            Some(&[0xc0, 0xff, 0xee, 0x71, 0x75]),
        );

        let f: *const ffi::evmc_result = r.into();
        assert!(!f.is_null());
        unsafe {
            assert!((*f).status_code == ffi::evmc_status_code::EVMC_FAILURE);
            assert!((*f).gas_left == 420);
            assert!(!(*f).output_data.is_null());
            assert!((*f).output_size == 5);
            assert!(
                std::slice::from_raw_parts((*f).output_data, 5) as &[u8]
                    == &[0xc0, 0xff, 0xee, 0x71, 0x75]
            );
            assert!((*f).create_address.bytes == [0u8; 20]);
            if (*f).release.is_some() {
                (*f).release.unwrap()(f);
            }
        }
    }

    #[test]
    fn result_into_heap_ffi_empty_data() {
        let r = ExecutionResult::new(ffi::evmc_status_code::EVMC_FAILURE, 420, None);

        let f: *const ffi::evmc_result = r.into();
        assert!(!f.is_null());
        unsafe {
            assert!((*f).status_code == ffi::evmc_status_code::EVMC_FAILURE);
            assert!((*f).gas_left == 420);
            assert!((*f).output_data.is_null());
            assert!((*f).output_size == 0);
            assert!((*f).create_address.bytes == [0u8; 20]);
            if (*f).release.is_some() {
                (*f).release.unwrap()(f);
            }
        }
    }

    #[test]
    fn result_into_stack_ffi() {
        let r = ExecutionResult::new(
            ffi::evmc_status_code::EVMC_FAILURE,
            420,
            Some(&[0xc0, 0xff, 0xee, 0x71, 0x75]),
        );

        let f: ffi::evmc_result = r.into();
        unsafe {
            assert!(f.status_code == ffi::evmc_status_code::EVMC_FAILURE);
            assert!(f.gas_left == 420);
            assert!(!f.output_data.is_null());
            assert!(f.output_size == 5);
            assert!(
                std::slice::from_raw_parts(f.output_data, 5) as &[u8]
                    == &[0xc0, 0xff, 0xee, 0x71, 0x75]
            );
            assert!(f.create_address.bytes == [0u8; 20]);
            if f.release.is_some() {
                f.release.unwrap()(&f);
            }
        }
    }

    #[test]
    fn result_into_stack_ffi_empty_data() {
        let r = ExecutionResult::new(ffi::evmc_status_code::EVMC_FAILURE, 420, None);

        let f: ffi::evmc_result = r.into();
        unsafe {
            assert!(f.status_code == ffi::evmc_status_code::EVMC_FAILURE);
            assert!(f.gas_left == 420);
            assert!(f.output_data.is_null());
            assert!(f.output_size == 0);
            assert!(f.create_address.bytes == [0u8; 20]);
            if f.release.is_some() {
                f.release.unwrap()(&f);
            }
        }
    }

    #[test]
    fn message_new_with_input() {
        let input = vec![0xc0, 0xff, 0xee];
        let destination = Address { bytes: [32u8; 20] };
        let sender = Address { bytes: [128u8; 20] };
        let value = Uint256 { bytes: [0u8; 32] };
        let create2_salt = Bytes32 { bytes: [255u8; 32] };

        let ret = ExecutionMessage::new(
            ffi::evmc_call_kind::EVMC_CALL,
            44,
            66,
            4466,
            destination,
            sender,
            Some(&input),
            value,
            create2_salt,
        );

        assert_eq!(ret.kind(), ffi::evmc_call_kind::EVMC_CALL);
        assert_eq!(ret.flags(), 44);
        assert_eq!(ret.depth(), 66);
        assert_eq!(ret.gas(), 4466);
        assert_eq!(*ret.destination(), destination);
        assert_eq!(*ret.sender(), sender);
        assert!(ret.input().is_some());
        assert_eq!(*ret.input().unwrap(), input);
        assert_eq!(*ret.value(), value);
        assert_eq!(*ret.create2_salt(), create2_salt);
    }

    #[test]
    fn message_from_ffi() {
        let destination = Address { bytes: [32u8; 20] };
        let sender = Address { bytes: [128u8; 20] };
        let value = Uint256 { bytes: [0u8; 32] };
        let create2_salt = Bytes32 { bytes: [255u8; 32] };

        let msg = ffi::evmc_message {
            kind: ffi::evmc_call_kind::EVMC_CALL,
            flags: 44,
            depth: 66,
            gas: 4466,
            destination: destination,
            sender: sender,
            input_data: std::ptr::null(),
            input_size: 0,
            value: value,
            create2_salt: create2_salt,
        };

        let ret: ExecutionMessage = (&msg).into();

        assert_eq!(ret.kind(), msg.kind);
        assert_eq!(ret.flags(), msg.flags);
        assert_eq!(ret.depth(), msg.depth);
        assert_eq!(ret.gas(), msg.gas);
        assert_eq!(*ret.destination(), msg.destination);
        assert_eq!(*ret.sender(), msg.sender);
        assert!(ret.input().is_none());
        assert_eq!(*ret.value(), msg.value);
        assert_eq!(*ret.create2_salt(), msg.create2_salt);
    }

    #[test]
    fn message_from_ffi_with_input() {
        let input = vec![0xc0, 0xff, 0xee];
        let destination = Address { bytes: [32u8; 20] };
        let sender = Address { bytes: [128u8; 20] };
        let value = Uint256 { bytes: [0u8; 32] };
        let create2_salt = Bytes32 { bytes: [255u8; 32] };

        let msg = ffi::evmc_message {
            kind: ffi::evmc_call_kind::EVMC_CALL,
            flags: 44,
            depth: 66,
            gas: 4466,
            destination: destination,
            sender: sender,
            input_data: input.as_ptr(),
            input_size: input.len(),
            value: value,
            create2_salt: create2_salt,
        };

        let ret: ExecutionMessage = (&msg).into();

        assert_eq!(ret.kind(), msg.kind);
        assert_eq!(ret.flags(), msg.flags);
        assert_eq!(ret.depth(), msg.depth);
        assert_eq!(ret.gas(), msg.gas);
        assert_eq!(*ret.destination(), msg.destination);
        assert_eq!(*ret.sender(), msg.sender);
        assert!(ret.input().is_some());
        assert_eq!(*ret.input().unwrap(), input);
        assert_eq!(*ret.value(), msg.value);
        assert_eq!(*ret.create2_salt(), msg.create2_salt);
    }

    unsafe extern "C" fn get_dummy_tx_context(
        _context: *mut ffi::evmc_context,
    ) -> ffi::evmc_tx_context {
        ffi::evmc_tx_context {
            tx_gas_price: Uint256 { bytes: [0u8; 32] },
            tx_origin: Address { bytes: [0u8; 20] },
            block_coinbase: Address { bytes: [0u8; 20] },
            block_number: 42,
            block_timestamp: 235117,
            block_gas_limit: 105023,
            block_difficulty: Uint256 { bytes: [0xaa; 32] },
            chain_id: Uint256::default(),
        }
    }

    unsafe extern "C" fn get_dummy_code_size(
        _context: *mut ffi::evmc_context,
        _addr: *const Address,
    ) -> usize {
        105023 as usize
    }

    unsafe extern "C" fn execute_call(
        _context: *mut ffi::evmc_context,
        _msg: *const ffi::evmc_message,
    ) -> ffi::evmc_result {
        // Some dumb validation for testing.
        let msg = *_msg;
        let success = if msg.input_size != 0 && msg.input_data == std::ptr::null() {
            false
        } else if msg.input_size == 0 && msg.input_data != std::ptr::null() {
            false
        } else {
            true
        };

        ffi::evmc_result {
            status_code: if success {
                ffi::evmc_status_code::EVMC_SUCCESS
            } else {
                ffi::evmc_status_code::EVMC_INTERNAL_ERROR
            },
            gas_left: 2,
            // NOTE: we are passing the input pointer here, but for testing the lifetime is ok
            output_data: msg.input_data,
            output_size: msg.input_size,
            release: None,
            create_address: ffi::evmc_address::default(),
            padding: [0u8; 4],
        }
    }

    // Update these when needed for tests
    fn get_dummy_context() -> ffi::evmc_context {
        ffi::evmc_context {
            host: Box::into_raw(Box::new(ffi::evmc_host_interface {
                account_exists: None,
                get_storage: None,
                set_storage: None,
                get_balance: None,
                get_code_size: Some(get_dummy_code_size),
                get_code_hash: None,
                copy_code: None,
                selfdestruct: None,
                call: Some(execute_call),
                get_tx_context: Some(get_dummy_tx_context),
                get_block_hash: None,
                emit_log: None,
            })),
        }
    }

    // Helper to safely dispose of the dummy context, and not bring up false positives in the
    // sanitizers.
    fn dummy_context_dispose(context: ffi::evmc_context) {
        unsafe {
            Box::from_raw(context.host as *mut ffi::evmc_host_interface);
        }
    }

    #[test]
    fn execution_context() {
        let mut context_raw = get_dummy_context();
        // Make a copy here so we don't let get_dummy_context() go out of scope when called again
        // in get_dummy_tx_context() and cause LLVM
        // sanitizers to complain
        let mut context_raw_copy = context_raw.clone();

        let exe_context = ExecutionContext::new(&mut context_raw);
        let a = exe_context.get_tx_context();
        let b = unsafe { get_dummy_tx_context(&mut context_raw_copy as *mut ffi::evmc_context) };

        assert_eq!(a.block_gas_limit, b.block_gas_limit);
        assert_eq!(a.block_timestamp, b.block_timestamp);
        assert_eq!(a.block_number, b.block_number);

        dummy_context_dispose(context_raw);
    }

    #[test]
    fn get_code_size() {
        // This address is useless. Just a dummy parameter for the interface function.
        let test_addr = Address { bytes: [0u8; 20] };
        let mut context_raw = get_dummy_context();
        let mut exe_context = ExecutionContext::new(&mut context_raw);

        let a: usize = 105023;
        let b = exe_context.get_code_size(&test_addr);

        assert_eq!(a, b);

        dummy_context_dispose(context_raw);
    }

    #[test]
    fn test_call_empty_data() {
        // This address is useless. Just a dummy parameter for the interface function.
        let test_addr = ffi::evmc_address { bytes: [0u8; 20] };
        let mut context_raw = get_dummy_context();
        let mut exe_context = ExecutionContext::new(&mut context_raw);

        let message = ExecutionMessage::new(
            ffi::evmc_call_kind::EVMC_CALL,
            0,
            0,
            6566,
            test_addr,
            test_addr,
            None,
            ffi::evmc_uint256be::default(),
            ffi::evmc_bytes32::default(),
        );

        let b = exe_context.call(&message);

        assert_eq!(b.status_code(), ffi::evmc_status_code::EVMC_SUCCESS);
        assert_eq!(b.gas_left(), 2);
        assert!(b.output().is_none());
        assert!(b.create_address().is_some());
        assert_eq!(b.create_address().unwrap(), &ffi::evmc_address::default());

        dummy_context_dispose(context_raw);
    }

    #[test]
    fn test_call_with_data() {
        // This address is useless. Just a dummy parameter for the interface function.
        let test_addr = ffi::evmc_address { bytes: [0u8; 20] };
        let mut context_raw = get_dummy_context();
        let mut exe_context = ExecutionContext::new(&mut context_raw);

        let data = vec![0xc0, 0xff, 0xfe];

        let message = ExecutionMessage::new(
            ffi::evmc_call_kind::EVMC_CALL,
            0,
            0,
            6566,
            test_addr,
            test_addr,
            Some(&data),
            ffi::evmc_uint256be::default(),
            ffi::evmc_bytes32::default(),
        );

        let b = exe_context.call(&message);

        assert_eq!(b.status_code(), ffi::evmc_status_code::EVMC_SUCCESS);
        assert_eq!(b.gas_left(), 2);
        assert!(b.output().is_some());
        assert_eq!(b.output().unwrap(), &data);
        assert!(b.create_address().is_some());
        assert_eq!(b.create_address().unwrap(), &ffi::evmc_address::default());

        dummy_context_dispose(context_raw);
    }
}