Struct gtest::System

pub struct System(/* private fields */);

The testing environment which simulates the chain state and its transactions but somehow the real on-chain execution environment could be different.

use gtest::System;

// Create a new testing environment.
let system = System::new();

// Init logger with "gwasm" target set to `debug` level.
system.init_logger();

Implementations

impl System

pub fn new() -> Self

Create a new testing environment.

pub fn init_logger(&self)

Init logger with “gwasm” target set to debug level.

pub fn init_verbose_logger(&self)

Init logger with “gwasm” and “gtest” targets set to debug level.

pub fn init_logger_with_default_filter<'a>( &self, default_filter: impl Into<Cow<'a, str>> )

Init logger with default_filter as default filter.

pub fn send_dispatch(&self, dispatch: Dispatch) -> RunResult

Send raw message dispatch.

pub fn spend_blocks(&self, amount: u32) -> Vec<RunResult>

Spend blocks and return all results.

pub fn block_height(&self) -> u32

Return the current block height of the testing environment.

pub fn block_timestamp(&self) -> u64

Return the current block timestamp of the testing environment.

pub fn get_program<ID: Into<ProgramIdWrapper>>(&self, id: ID) -> Program<'_>

Returns a Program by id.

The method doesn’t check whether program exists or not. So if provided id doesn’t belong to program, message sent to such “program” will cause panics.

pub fn is_active_program<ID: Into<ProgramIdWrapper>>(&self, id: ID) -> bool

Detect if a program is active with given id.

An active program means that the program could be called, instead, if returns false it means that the program has exited or terminated that it can’t be called anymore.

pub fn submit_code<P: AsRef<Path>>(&self, code_path: P) -> CodeId

Saves code to the storage and returns it’s code hash

This method is mainly used for providing a proper program from program creation logic. In order to successfully create a new program with gstd::prog::create_program_bytes_with_gas function, developer should provide to the function “child’s” code hash. Code for that code hash must be in storage at the time of the function call. So this method stores the code in storage.

pub fn submit_code_local<P: AsRef<Path>>(&self, code_path: P) -> CodeId

Saves code to the storage and returns it’s code hash

Same as [‘submit_code’], but path is provided as relative to the current directory.

pub fn submitted_code(&self, code_id: CodeId) -> Option<Vec<u8>>

Returns previously submitted code by its code hash.

pub fn get_mailbox<ID: Into<ProgramIdWrapper>>(&self, id: ID) -> Mailbox<'_>

Extract mailbox of user with given id.

The mailbox contains messages from the program that are waiting for user action.

pub fn mint_to<ID: Into<ProgramIdWrapper>>(&self, id: ID, value: u128)

Mint balance to user with given id and value.

pub fn balance_of<ID: Into<ProgramIdWrapper>>(&self, id: ID) -> u128

Returns balance of user with given id.

pub fn claim_value_from_mailbox<ID: Into<ProgramIdWrapper>>(&self, id: ID)

Claim the user’s value from the mailbox with given id.

Trait Implementations

impl Default for System

fn default() -> Self

Returns the “default value” for a type.