Struct ink_engine::ext::Engine

pub struct Engine {
    pub database: Database,
    pub exec_context: ExecContext,
    // some fields omitted
}

The off-chain engine.

Fields

database: Database

The environment database.

exec_context: ExecContext

The current execution context.

Implementations

impl Engine

pub fn new() -> Self

impl Engine

pub fn transfer(&mut self, account_id: &[u8], value: &[u8]) -> Result<(), Error>

Transfers value from the contract to the destination account.

pub fn deposit_event(&mut self, topics: &[u8], data: &[u8])

Deposits an event identified by the supplied topics and data.

pub fn set_storage(&mut self, key: &[u8; 32], encoded_value: &[u8])

Writes the encoded value into the storage at the given key.

pub fn get_storage(
    &mut self,
    key: &[u8; 32],
    output: &mut &mut [u8]
) -> Result<(), Error>

Returns the decoded contract storage at the key if any.

pub fn clear_storage(&mut self, key: &[u8; 32])

Removes the storage entries at the given key.

pub fn terminate(&mut self, beneficiary: &[u8]) -> !

Remove the calling account and transfer remaining balance.

This function never returns. Either the termination was successful and the execution of the destroyed contract is halted. Or it failed during the termination which is considered fatal.

pub fn caller(&self, output: &mut &mut [u8])

Returns the address of the caller.

pub fn balance(&self, output: &mut &mut [u8])

Returns the balance of the executed contract.

pub fn value_transferred(&self, output: &mut &mut [u8])

Returns the transferred value for the called contract.

pub fn address(&self, output: &mut &mut [u8])

Returns the address of the executed contract.

pub fn restore_to(
    &mut self,
    _account_id: &[u8],
    _code_hash: &[u8],
    _rent_allowance: &[u8],
    filtered_keys: &[&[u8]]
)

Restores a tombstone to the original smart contract.

Params

• account_id: Encoded bytes of the AccountId of the to-be-restored contract.
• code_hash: Encoded code hash of the to-be-restored contract.
• rent_allowance: The encoded rent allowance of the restored contract upon successful restoration.
• filtered_keys: Storage keys that will be ignored for the tombstone hash match calculation that decide whether the original contract storage and the storage of the restorer contract is equal.

pub fn debug_message(&mut self, message: &str)

Records the given debug message and appends to stdout.

pub fn hash_blake2_256(input: &[u8], output: &mut [u8; 32])

Conduct the BLAKE-2 256-bit hash and place the result into output.

pub fn hash_blake2_128(input: &[u8], output: &mut [u8; 16])

Conduct the BLAKE-2 128-bit hash and place the result into output.

pub fn hash_sha2_256(input: &[u8], output: &mut [u8; 32])

Conduct the SHA-2 256-bit hash and place the result into output.

pub fn hash_keccak_256(input: &[u8], output: &mut [u8; 32])

Conduct the KECCAK 256-bit hash and place the result into output.

pub fn block_number(&self, _output: &mut &mut [u8])

pub fn block_timestamp(&self, _output: &mut &mut [u8])

pub fn gas_left(&self, _output: &mut &mut [u8])

pub fn rent_allowance(&self, _output: &mut &mut [u8])

pub fn minimum_balance(&self, _output: &mut &mut [u8])

pub fn tombstone_deposit(&self, _output: &mut &mut [u8])

pub fn instantiate(
    &mut self,
    _code_hash: &[u8],
    _gas_limit: u64,
    _endowment: &[u8],
    _input: &[u8],
    _out_address: &mut &mut [u8],
    _out_return_value: &mut &mut [u8],
    _salt: &[u8]
) -> Result<(), Error>

pub fn call(
    &mut self,
    _callee: &[u8],
    _gas_limit: u64,
    _value: &[u8],
    _input: &[u8],
    _output: &mut &mut [u8]
) -> Result<(), Error>

pub fn weight_to_fee(&self, _gas: u64, _output: &mut &mut [u8])

pub fn set_rent_allowance(&mut self, _value: &[u8])

pub fn random(&self, _subject: &[u8], _output: &mut &mut [u8])

pub fn call_chain_extension(
    &mut self,
    _func_id: u32,
    _input: &[u8],
    _output: &mut &mut [u8]
) -> u32

pub fn ecdsa_recover(
    &mut self,
    signature: &[u8; 65],
    message_hash: &[u8; 32],
    output: &mut [u8; 33]
) -> Result<(), Error>

Recovers the compressed ECDSA public key for given signature and message_hash, and stores the result in output.

impl Engine

pub fn initialize_or_reset(&mut self)

Resets the environment.

pub fn get_contract_storage_rw(&self, account_id: Vec<u8>) -> (usize, usize)

Returns the total number of reads and writes of the contract’s storage.

pub fn set_caller(&mut self, caller: Vec<u8>)

Sets a caller for the next call.

pub fn set_callee(&mut self, callee: Vec<u8>)

Sets the callee for the next call.

pub fn count_used_storage_cells(
    &self,
    account_id: &[u8]
) -> Result<usize, Error>

Returns the amount of storage cells used by the account account_id.

Returns None if the account_id is non-existent.

pub fn get_callee(&self) -> Vec<u8>

Returns the callee, i.e. the currently executing contract.

pub fn get_emitted_debug_messages(&self) -> RecordedDebugMessages

Returns the contents of the past performed environmental debug_message in order.

pub fn get_emitted_events(&self) -> impl Iterator<Item = EmittedEvent>

Returns the recorded emitted events in order.

pub fn get_balance(&self, account_id: Vec<u8>) -> Result<u128, Error>

Returns the current balance of account_id.

pub fn set_balance(&mut self, account_id: Vec<u8>, new_balance: u128)

Sets the balance of account_id to new_balance.

pub fn set_value_transferred(&mut self, value: u128)

Sets the value transferred from the caller to the callee as part of the call.

Trait Implementations

impl Default for Engine

fn default() -> Self

Returns the “default value” for a type.