Struct ContractEnv 

pub struct ContractEnv { /* private fields */ }

Represents the environment accessible in the contract context.

The ContractEnv struct provides methods for interacting with the contract environment, such as accessing storage, calling other contracts, and handling various contract-related operations.

The ContractEnv is available for the user to use in the module code.

Implementations

impl ContractEnv

pub const fn new(index: u32, backend: Rc<RefCell<dyn ContractContext>>) -> Self

Creates a new ContractEnv instance.

pub fn get_value<T: FromBytes>(&self, key: &[u8]) -> Option<T>

Retrieves the value associated with the given key from the contract storage.

Returns

The value associated with the key, if it exists.

pub fn set_value<T: ToBytes + CLTyped>(&self, key: &[u8], value: T)

Sets the value associated with the given key in the contract storage.

pub fn get_named_value<T: FromBytes + CLTyped, U: AsRef<str>>( &self, name: U, ) -> Option<T>

Retrieves the value associated with the given named key from the contract storage.

pub fn set_named_value<T: CLTyped + ToBytes, U: AsRef<str>>( &self, name: U, value: T, )

Sets the value associated with the given named key in the contract storage.

pub fn get_dictionary_value<T: FromBytes + CLTyped, U: AsRef<str>>( &self, dictionary_name: U, key: &[u8], ) -> Option<T>

Retrieves the value associated with the given named key from the named dictionary in the contract storage.

pub fn set_dictionary_value<T: CLTyped + ToBytes, U: AsRef<str>>( &self, dictionary_name: U, key: &[u8], value: T, )

Sets the value associated with the given named key in the named dictionary in the contract storage.

pub fn remove_dictionary<U: AsRef<str>>(&self, dictionary_name: U)

Removes the dictionary from the contract storage.

pub fn init_dictionary<U: AsRef<str>>(&self, dictionary_name: U)

Initializes the empty dictionary with the given name.

pub fn caller(&self) -> Address

Returns the address of the caller of the contract.

pub fn call_contract<T: FromBytes>(&self, address: Address, call: CallDef) -> T

Calls another contract with the specified address and call definition.

Returns

The result of the contract call. If any error occurs during the call, the contract will revert.

pub fn self_address(&self) -> Address

Returns the address of the current contract.

pub fn transfer_tokens(&self, to: &Address, amount: &U512)

Transfers tokens to the specified address.

pub fn get_block_time(&self) -> u64

Returns the current block time in milliseconds.

pub fn get_block_time_millis(&self) -> u64

Returns the current block time in milliseconds.

pub fn get_block_time_secs(&self) -> u64

Returns the current block time in seconds.

pub fn attached_value(&self) -> U512

Returns the value attached to the contract call.

pub fn self_balance(&self) -> U512

Returns the CSPR balance of the current contract.

pub fn revert<E: Into<OdraError>>(&self, error: E) -> !

Reverts the contract execution with the specified error.

pub fn emit_event<T: ToBytes + EventInstance>(&self, event: T)

Emits an event with the specified data.

pub fn emit_native_event<T: ToBytes + EventInstance>(&self, event: T)

Emits an event with the specified data using the native mechanism.

pub fn verify_signature( &self, message: &Bytes, signature: &Bytes, public_key: &PublicKey, ) -> bool

Verifies the signature of a message using the specified signature, public key, and message.

Arguments

• message - The message to verify.
• signature - The signature to verify.
• public_key - The public key to use for verification.

Returns

true if the signature is valid, false otherwise.

pub fn hash<T: AsRef<[u8]>>(&self, value: T) -> [u8; 32]

Hashes the specified value.

Returns

The hash value as a 32-byte array.

pub fn delegate(&self, validator: PublicKey, amount: U512)

Delegate tokens to a validator

Arguments

• validator - The validator to delegate to
• amount - The amount of tokens to delegate

pub fn undelegate(&self, validator: PublicKey, amount: U512)

Undelegate tokens from a validator

Arguments

• validator - The validator to undelegate from
• amount - The amount of tokens to undelegate

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

Returns the amount of tokens delegated to a validator

Arguments

• validator - The validator to get the delegated amount from

Returns

The amount of tokens delegated to the validator

pub fn get_validator_info(&self, validator: PublicKey) -> Option<ValidatorInfo>

Returns information about the validator

Arguments

• validator - The validator to query

Returns

Option

pub fn pseudorandom_bytes(&self, size: usize) -> Vec<u8>

Returns a vector of pseudorandom bytes of the specified size. There is no guarantee that the returned bytes are in any way cryptographically secure.

pub fn pseudorandom_number(&self, high: U512) -> U512

Returns a pseudorandom integer.

Trait Implementations

impl Clone for ContractEnv

fn clone(&self) -> ContractEnv

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Revertible for ContractEnv

fn revert<E: Into<OdraError>>(&self, e: E) -> !

Reverts the contract execution with the given error.