Struct HostEnv 

pub struct HostEnv { /* private fields */ }

Represents the host environment for executing smart contracts.

It provides methods for interacting with the underlying host context and managing the execution of contracts.

Implementations

impl HostEnv

pub fn new(backend: Rc<RefCell<dyn HostContext>>) -> HostEnv

Creates a new HostEnv instance with the specified backend.

pub fn set_captures_events(&self, captures: bool)

Sets the captures_events flag, which determines whether events should be captured.

pub fn get_account(&self, index: usize) -> Address

Returns the account address at the specified index.

pub fn get_validator(&self, index: usize) -> PublicKey

Returns the validator public key.

pub fn set_caller(&self, address: Address)

Sets the caller address for the current contract execution.

pub fn advance_block_time(&self, time_diff: u64)

Advances the block time by the specified time difference in milliseconds.

pub fn advance_with_auctions(&self, time_diff: u64)

Advances the block time by the specified time difference in milliseconds and processes auctions.

pub fn auction_delay(&self) -> u64

Returns the era length in milliseconds.

pub fn unbonding_delay(&self) -> u64

Returns the delay between unstaking and the transfer of funds back to the delegator in milliseconds.

pub fn delegated_amount(&self, delegator: Address, validator: PublicKey) -> U512

Returns the amount of CSPR delegated to the specified validator by the specified delegator.

pub fn remove_validator(&self, index: usize)

Evicts the validator at the specified index from the validator set.

pub fn block_time(&self) -> u64

Returns the current block time in milliseconds.

pub fn block_time_millis(&self) -> u64

Returns the current block time in milliseconds.

pub fn block_time_secs(&self) -> u64

Returns the current block time in seconds.

pub fn new_contract( &self, name: &str, init_args: RuntimeArgs, entry_points_caller: EntryPointsCaller, ) -> OdraResult<Address>

Registers a new contract with the specified name, initialization arguments, and entry points caller.

pub fn upgrade_contract( &self, name: &str, contract_to_upgrade: Address, upgrade_args: RuntimeArgs, entry_points_caller: EntryPointsCaller, ) -> OdraResult<Address>

Upgrades an existing contract with a new one with given upgrade arguments and new entry points caller.

pub fn register_contract( &self, address: Address, contract_name: String, entry_points_caller: EntryPointsCaller, )

Registers an existing contract with the specified address, name and entry points caller. Similar to new_contract, but skips the deployment phase.

pub fn call_contract<T: FromBytes + CLTyped>( &self, address: Address, call_def: CallDef, ) -> OdraResult<T>

Calls a contract at the specified address with the given call definition.

pub fn raw_call_contract( &self, address: Address, call_def: CallDef, use_proxy: bool, ) -> OdraResult<Bytes>

Calls a contract at the specified address with the given call definition. Returns raw, not serialized bytes.

pub fn contract_env(&self) -> ContractEnv

Returns the gas cost of the last contract call.

pub fn gas_report(&self) -> GasReport

Prints the gas report for the current contract execution.

pub fn balance_of<T: Addressable>(&self, addr: &T) -> U512

Returns the CSPR balance of the specified address.

pub fn get_event<T: FromBytes + EventInstance, R: Addressable>( &self, addr: &R, index: i32, ) -> Result<T, EventError>

Retrieves an event with the specified index from the specified contract.

Returns

Returns the event as an instance of the specified type, or an error if the event couldn’t be retrieved or parsed.

pub fn get_native_event<T: FromBytes + EventInstance, R: Addressable>( &self, addr: &R, index: i32, ) -> Result<T, EventError>

Retrieves a native event with the specified index from the specified contract.

Returns

Returns the event as an instance of the specified type, or an error if the event couldn’t be retrieved or parsed.

pub fn get_event_bytes<T: Addressable>( &self, addr: &T, index: u32, ) -> Result<Bytes, EventError>

Retrieves a raw event (serialized) with the specified index from the specified contract.

pub fn get_native_event_bytes<T: Addressable>( &self, addr: &T, index: u32, ) -> Result<Bytes, EventError>

Retrieves a raw native event (serialized) with the specified index from the specified contract.

pub fn event_names<T: Addressable>(&self, addr: &T) -> Vec<String>

Returns the names of all events emitted by the specified contract.

pub fn events<T: Addressable>(&self, addr: &T) -> Vec<Bytes>

Returns all events emitted by the specified contract.

pub fn events_count<T: Addressable>(&self, addr: &T) -> u32

Returns the number of events emitted by the specified contract.

pub fn native_events_count<T: Addressable>(&self, addr: &T) -> u32

Returns the number of native events emitted by the specified contract.

pub fn emitted_event<T: ToBytes + EventInstance, R: Addressable>( &self, addr: &R, event: T, ) -> bool

Returns true if the specified event was emitted by the specified contract.

pub fn emitted_native_event<T: ToBytes + EventInstance, R: Addressable>( &self, addr: &R, event: T, ) -> bool

Returns true if the specified event was emitted by the specified contract.

pub fn emitted<T: AsRef<str>, R: Addressable>( &self, addr: &R, event_name: T, ) -> bool

Returns true if an event with the specified name was emitted by the specified contract.

pub fn emitted_native<T: AsRef<str>, R: Addressable>( &self, addr: &R, event_name: T, ) -> bool

Returns true if a native event with the specified name was emitted by the specified contract.

pub fn last_call_result(&self, contract_address: Address) -> ContractCallResult

Returns the last call result for the specified contract.

pub fn sign_message(&self, message: &Bytes, address: &Address) -> Bytes

Signs the specified message with the private key of the specified address.

pub fn public_key(&self, address: &Address) -> PublicKey

Returns the public key associated with the specified address.

pub fn caller(&self) -> Address

Returns the caller address for the current contract execution.

pub fn set_gas(&self, gas: u64)

Sets the gas limit for the current contract execution.

pub fn transfer(&self, to: Address, amount: U512) -> OdraResult<()>

Transfers the specified amount of CSPR from the current caller to the specified address.

Trait Implementations

impl Clone for HostEnv

fn clone(&self) -> HostEnv

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.