Struct soroban_env_guest::Guest

pub struct Guest;

The Guest is the implementation of the Env interface seen and used by contracts built into WASM for execution within a WASM VM. It is a 0-sized “stub” type implementation of the Env interface that forwards each Env method to an external function, imported from its runtime environment. This implementation is automatically generated and has no interesting content.

Trait Implementations

impl Clone for Guest

fn clone(&self) -> Guest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Guest

fn default() -> Guest

Returns the “default value” for a type.

impl Env for Guest

fn log_value(&self, v: RawVal) -> RawVal

fn get_invoking_contract(&self) -> Object

Get the contractID Bytes of the contract which invoked the running contract. Traps if the running contract was not invoked by a contract.

fn obj_cmp(&self, a: RawVal, b: RawVal) -> i64

fn contract_event(&self, topics: Object, data: RawVal) -> RawVal

Records a contract event. topics is expected to be a SCVec with length <= 4 that cannot contain Vec, Map, or Bytes with length > 32 On success, returns an SCStatus::Ok.

fn get_current_contract(&self) -> Object

Get the contractID Bytes of the contract which invoked the running contract. Traps if the running contract was not invoked by a contract.

fn get_ledger_version(&self) -> RawVal

Return the protocol version of the current ledger as a u32.

fn get_ledger_sequence(&self) -> RawVal

Return the sequence number of the current ledger as a u32.

fn get_ledger_timestamp(&self) -> Object

Return the timestamp number of the current ledger as a u64.

fn get_ledger_network_passphrase(&self) -> Object

Return the network passphrase of the current ledger as Bytes.

fn get_current_call_stack(&self) -> Object

Returns the full call stack from the first contract call to the current one as a vector of vectors, where the inside vector contains the contract id as Hash, and a function as a Symbol.

fn fail_with_status(&self, status: Status) -> RawVal

Causes the currently executing contract to fail immediately with a provided status code, which must be of error-type ScStatusType::ContractError. Does not actually return.

fn log_fmt_values(&self, fmt: Object, args: Object) -> RawVal

fn get_invoker_type(&self) -> u64

Get whether the contract invocation is from an account or another contract. Returns 0 for account, 1 for contract.

fn get_invoking_account(&self) -> Object

Get the AccountID object type of the account which invoked the running contract. Traps if the running contract was not invoked by an account.

fn get_ledger_network_id(&self) -> Object

Return the network id (sha256 hash of network passphrase) of the current ledger as Bytes. The value is always 32 bytes in length.

fn obj_from_u64(&self, v: u64) -> Object

fn obj_to_u64(&self, obj: Object) -> u64

fn obj_from_i64(&self, v: i64) -> Object

Convert an i64 to an object containing an i64.

fn obj_to_i64(&self, obj: Object) -> i64

Convert an object containing an i64 to an i64.

fn map_new(&self) -> Object

Create an empty new map.

fn map_put(&self, m: Object, k: RawVal, v: RawVal) -> Object

Insert a key/value mapping into an existing map, and return the map object handle. If the map already has a mapping for the given key, the previous value is overwritten.

fn map_get(&self, m: Object, k: RawVal) -> RawVal

Get the value for a key from a map. Traps if key is not found.

fn map_del(&self, m: Object, k: RawVal) -> Object

Remove a key/value mapping from a map if it exists, traps if doesn’t.

fn map_len(&self, m: Object) -> RawVal

Get the size of a map.

fn map_has(&self, m: Object, k: RawVal) -> RawVal

Test for the presence of a key in a map. Returns (SCStatic) TRUE/FALSE.

fn map_prev_key(&self, m: Object, k: RawVal) -> RawVal

Given a key, find the first key less than itself in the map’s sorted order. If such a key does not exist, return an SCStatus containing the error code (TBD).

fn map_next_key(&self, m: Object, k: RawVal) -> RawVal

Given a key, find the first key greater than itself in the map’s sorted order. If such a key does not exist, return an SCStatus containing the error code (TBD).

fn map_min_key(&self, m: Object) -> RawVal

Find the minimum key from a map. If the map is empty, return an SCStatus containing the error code (TBD).

fn map_max_key(&self, m: Object) -> RawVal

Find the maximum key from a map. If the map is empty, return an SCStatus containing the error code (TBD).

fn map_keys(&self, m: Object) -> Object

Return a new vector containing all the keys in a map. The new vector is ordered in the original map’s key-sorted order.

fn map_values(&self, m: Object) -> Object

Return a new vector containing all the values in a map. The new vector is ordered in the original map’s key-sorted order.

fn vec_new(&self, c: RawVal) -> Object

Creates a new vector with an optional capacity hint c. If c is ScStatic::Void, no hint is assumed and the new vector is empty. Otherwise, c is parsed as an u32 that represents the initial capacity of the new vector.

fn vec_put(&self, v: Object, i: RawVal, x: RawVal) -> Object

Update the value at index i in the vector. Return the new vector. Trap if the index is out of bounds.

fn vec_get(&self, v: Object, i: RawVal) -> RawVal

Returns the element at index i of the vector. Traps if the index is out of bound.

fn vec_del(&self, v: Object, i: RawVal) -> Object

Delete an element in a vector at index i, shifting all elements after it to the left. Return the new vector. Traps if the index is out of bound.

fn vec_len(&self, v: Object) -> RawVal

Returns length of the vector.

fn vec_push_front(&self, v: Object, x: RawVal) -> Object

Push a value to the front of a vector.

fn vec_pop_front(&self, v: Object) -> Object

Removes the first element from the vector and returns the new vector. Traps if original vector is empty.

fn vec_push_back(&self, v: Object, x: RawVal) -> Object

Appends an element to the back of the vector.

fn vec_pop_back(&self, v: Object) -> Object

Removes the last element from the vector and returns the new vector. Traps if original vector is empty.

fn vec_front(&self, v: Object) -> RawVal

Return the first element in the vector. Traps if the vector is empty

fn vec_back(&self, v: Object) -> RawVal

Return the last element in the vector. Traps if the vector is empty

fn vec_insert(&self, v: Object, i: RawVal, x: RawVal) -> Object

Inserts an element at index i within the vector, shifting all elements after it to the right. Traps if the index is out of bound

fn vec_append(&self, v1: Object, v2: Object) -> Object

Clone the vector v1, then moves all the elements of vector v2 into it. Return the new vector. Traps if number of elements in the vector overflows a u32.

fn vec_slice(&self, v: Object, start: RawVal, end: RawVal) -> Object

Copy the elements from start index until end index, exclusive, in the vector and create a new vector from it. Return the new vector. Traps if the index is out of bound.

fn vec_first_index_of(&self, v: Object, x: RawVal) -> RawVal

Get the index of the first occurrence of a given element in the vector. Returns the u32 index of the value if it’s there. Otherwise, it returns ScStatic::Void.

fn vec_last_index_of(&self, v: Object, x: RawVal) -> RawVal

Get the index of the last occurrence of a given element in the vector. Returns the u32 index of the value if it’s there. Otherwise, it returns ScStatic::Void.

fn vec_binary_search(&self, v: Object, x: RawVal) -> u64

Binary search a sorted vector for a given element. If it exists, the high-32 bits of the return value is 0x0001 and the low-32 bits contain the u32 index of the element. If it does not exist, the high-32 bits of the return value is 0x0000 and the low-32 bits contain the u32 index at which the element would need to be inserted into the vector to maintain sorted order.

fn put_contract_data(&self, k: RawVal, v: RawVal) -> RawVal

fn has_contract_data(&self, k: RawVal) -> RawVal

fn get_contract_data(&self, k: RawVal) -> RawVal

fn del_contract_data(&self, k: RawVal) -> RawVal

fn create_contract_from_ed25519(
    &self,
    v: Object,
    salt: Object,
    key: Object,
    sig: Object
) -> Object

fn create_contract_from_contract(&self, v: Object, salt: Object) -> Object

fn create_token_from_ed25519(
    &self,
    salt: Object,
    key: Object,
    sig: Object
) -> Object

fn create_token_from_contract(&self, salt: Object) -> Object

fn create_token_from_asset(&self, asset: Object) -> Object

fn create_contract_from_source_account(&self, v: Object, salt: Object) -> Object

Create a contract using the source account and salt as input to the contract ID that gets created. Pass as arguments a Bytes for the wasm code and a Bytes for the salt. Returned will be a Bytes of length 32 bytes.

fn create_token_from_source_account(&self, salt: Object) -> Object

Create a token contract using the source account and salt as input to the contract ID that gets created. Pass as arguments a Bytes for the salt. Returned will be a Bytes of length 32 bytes.

fn call(&self, contract: Object, func: Symbol, args: Object) -> RawVal

Calls a function in another contract with arguments contained in vector args. If the call is successful, forwards the result of the called function. Traps otherwise.

fn try_call(&self, contract: Object, func: Symbol, args: Object) -> RawVal

Calls a function in another contract with arguments contained in vector args. Returns:

fn bigint_from_u64(&self, x: u64) -> Object

Constructs a BigInt from an u64.

fn bigint_to_u64(&self, x: Object) -> u64

Converts a BigInt to an u64. Traps if the value cannot fit into u64.

fn bigint_from_i64(&self, x: i64) -> Object

Constructs a BigInt from an i64.

fn bigint_to_i64(&self, x: Object) -> i64

Converts a BigInt to an i64. Traps if the value cannot fit into i64.

fn bigint_add(&self, x: Object, y: Object) -> Object

Performs the + operation.

fn bigint_sub(&self, x: Object, y: Object) -> Object

Performs the - operation.

fn bigint_mul(&self, x: Object, y: Object) -> Object

Performs the * operation.

fn bigint_div(&self, x: Object, y: Object) -> Object

Performs the / operation. Traps if y is zero.

fn bigint_rem(&self, x: Object, y: Object) -> Object

Performs the % operation. Traps if y is zero.

fn bigint_and(&self, x: Object, y: Object) -> Object

Performs the & operation.

fn bigint_or(&self, x: Object, y: Object) -> Object

Performs the | operation.

fn bigint_xor(&self, x: Object, y: Object) -> Object

Performs the ^ operation.

fn bigint_shl(&self, x: Object, y: Object) -> Object

Performs the << operation. Traps if y is negative or larger than the size of u64.

fn bigint_shr(&self, x: Object, y: Object) -> Object

Performs the >> operation. Traps if y is negative or larger than the size of u64.

fn bigint_is_zero(&self, x: Object) -> RawVal

Returns true if x is equal to the additive identity.

fn bigint_neg(&self, x: Object) -> Object

Performs the unary - operation.

fn bigint_not(&self, x: Object) -> Object

Performs the unary ! operation.

fn bigint_gcd(&self, x: Object, y: Object) -> Object

Calculates the Greatest Common Divisor (GCD) of x and y.

fn bigint_lcm(&self, x: Object, y: Object) -> Object

Calculates the Lowest Common Multiple (LCM) of x and y.

fn bigint_pow(&self, x: Object, y: Object) -> Object

Calculates x to the power y. Traps if y is negative or larger than the size of u64.

fn bigint_pow_mod(&self, p: Object, q: Object, m: Object) -> Object

Calculates (p ^ q) mod m. Note that this rounds like mod_floor, not like the % operator, which makes a difference when given a negative p or m. The result will be in the interval [0, m) for m > 0, or in the interval (m, 0] for m < 0. Traps if the q is negative or the m is zero.

fn bigint_sqrt(&self, x: Object) -> Object

Calculates the truncated principal square root of x. Traps if x is negative.

fn bigint_bits(&self, x: Object) -> u64

Determines the fewest bits necessary to express x, not including the sign.

fn bigint_to_bytes_be(&self, x: Object) -> Object

Outputs the BigInt’s magnitude in big-endian byte order into a byte array. The sign is dropped.

fn bigint_to_radix_be(&self, x: Object, radix: RawVal) -> Object

Outputs the BigInt’s magnitude in the requested base in big-endian digit order into a byte array. The sign is dropped. Radix must be in the range 2…256.

fn bigint_from_bytes_be(&self, sign: RawVal, bytes: Object) -> Object

Creates a BigInt from a byte array and i32 sign. Bytes are in big-endian order. Sign is interpreted: -1 as negative, 0 as zero, 1 as positive If sign is 0, then the input bytes are ignored and will return a BigInt of 0.

fn bigint_from_radix_be(&self, sign: RawVal, buf: Object, radix: RawVal) -> Object

Creates a BigInt from a byte array buf, an i32 sign and an u32 radix. Each u8 of the byte array is interpreted as one digit of the number and must therefore be less than the radix. The bytes are in big-endian byte order. Radix must be in the range 2..=256. Sign follows same rule as in bigint_from_bytes_be.

fn serialize_to_bytes(&self, v: RawVal) -> Object

Serializes an (SC)Val into XDR opaque Bytes object.

fn deserialize_from_bytes(&self, b: Object) -> RawVal

Deserialize a Bytes object to get back the (SC)Val.

fn bytes_copy_to_linear_memory(
    &self,
    b: Object,
    b_pos: RawVal,
    lm_pos: RawVal,
    len: RawVal
) -> RawVal

Copies a slice of bytes from a Bytes object specified at offset b_pos with length len into the linear memory at position lm_pos. Traps if either the Bytes object or the linear memory doesn’t have enough bytes.

fn bytes_copy_from_linear_memory(
    &self,
    b: Object,
    b_pos: RawVal,
    lm_pos: RawVal,
    len: RawVal
) -> Object

Copies a segment of the linear memory specified at position lm_pos with length len, into a Bytes object at offset b_pos. The Bytes object may grow in size to accommodate the new bytes. Traps if the linear memory doesn’t have enough bytes.

fn bytes_new_from_linear_memory(&self, lm_pos: RawVal, len: RawVal) -> Object

Constructs a new Bytes object initialized with bytes copied from a linear memory slice specified at position lm_pos with length len.

fn bytes_new(&self) -> Object

Create an empty new Bytes object.

fn bytes_put(&self, b: Object, i: RawVal, u: RawVal) -> Object

Update the value at index i in the Bytes object. Return the new Bytes. Trap if the index is out of bounds.

fn bytes_get(&self, b: Object, i: RawVal) -> RawVal

Returns the element at index i of the Bytes object. Traps if the index is out of bound.

fn bytes_del(&self, b: Object, i: RawVal) -> Object

Delete an element in a Bytes object at index i, shifting all elements after it to the left. Return the new Bytes. Traps if the index is out of bound.

fn bytes_len(&self, b: Object) -> RawVal

Returns length of the Bytes object.

fn bytes_push(&self, b: Object, u: RawVal) -> Object

Appends an element to the back of the Bytes object.

fn bytes_pop(&self, b: Object) -> Object

Removes the last element from the Bytes object and returns the new Bytes. Traps if original Bytes is empty.

fn bytes_front(&self, b: Object) -> RawVal

Return the first element in the Bytes object. Traps if the Bytes is empty

fn bytes_back(&self, b: Object) -> RawVal

Return the last element in the Bytes object. Traps if the Bytes is empty

fn bytes_insert(&self, b: Object, i: RawVal, u: RawVal) -> Object

Inserts an element at index i within the Bytes object, shifting all elements after it to the right. Traps if the index is out of bound

fn bytes_append(&self, b1: Object, b2: Object) -> Object

Clone the Bytes object b1, then moves all the elements of Bytes object b2 into it. Return the new Bytes. Traps if its length overflows a u32.

fn bytes_slice(&self, b: Object, start: RawVal, end: RawVal) -> Object

Copies the elements from start index until end index, exclusive, in the Bytes object and creates a new Bytes from it. Returns the new Bytes. Traps if the index is out of bound.

fn hash_from_bytes(&self, x: Object) -> Object

fn hash_to_bytes(&self, x: Object) -> Object

fn public_key_from_bytes(&self, x: Object) -> Object

fn public_key_to_bytes(&self, x: Object) -> Object

fn compute_hash_sha256(&self, x: Object) -> Object

fn verify_sig_ed25519(&self, x: Object, k: Object, s: Object) -> RawVal

fn account_get_low_threshold(&self, a: Object) -> RawVal

Get the low threshold for the account with ID a (a is AccountId). Traps if no such account exists.

fn account_get_medium_threshold(&self, a: Object) -> RawVal

Get the medium threshold for the account with ID a (a is AccountId). Traps if no such account exists.

fn account_get_high_threshold(&self, a: Object) -> RawVal

Get the high threshold for the account with ID a (a is AccountId). Traps if no such account exists.

fn account_get_signer_weight(&self, a: Object, s: Object) -> RawVal

Get the signer weight for the signer with ed25519 public key s (s is Bytes) on the account with ID a (a is AccountId). Returns the master weight if the signer is the master, and returns 0 if no such signer exists. Traps if no such account exists.

fn account_exists(&self, a: Object) -> RawVal

Given an ID a (a is AccountId) of an account, check if it exists. Returns (SCStatic) TRUE/FALSE.

impl EnvBase for Guest

fn as_mut_any(&mut self) -> &mut dyn Any

Used for recovering the concrete type of the Host.

fn check_same_env(&self, other: &Self)

Used to check two environments are the same, trapping if not.

fn deep_clone(&self) -> Self

Used to clone an environment deeply, not just a handle to it.

fn bytes_copy_from_slice(
    &self,
    b: Object,
    b_pos: RawVal,
    mem: &[u8]
) -> Result<Object, Status>

Copy a slice of bytes from the caller’s memory into an existing Bytes object the host, returning a new Bytes.

fn bytes_copy_to_slice(
    &self,
    b: Object,
    b_pos: RawVal,
    mem: &mut [u8]
) -> Result<(), Status>

Copy a slice of bytes from a Bytes object in the host into the caller’s memory.

fn bytes_new_from_slice(&self, mem: &[u8]) -> Result<Object, Status>

Form a new Bytes object in the host from a slice of memory in the caller.

fn log_static_fmt_val(&self, fmt: &'static str, v: RawVal) -> Result<(), Status>

Log a formatted debugging message to the debug log (if present), passing a simplified format string (supporting only positional {} markers) and a single RawVal argument that will be inserted at the marker in the format string.

fn log_static_fmt_static_str(
    &self,
    fmt: &'static str,
    s: &'static str
) -> Result<(), Status>

Log a formatted debugging message to the debug log (if present), passing a simplified format string (supporting only positional {} markers) and a single string-slice argument that will be inserted at the marker in the format string.

fn log_static_fmt_val_static_str(
    &self,
    fmt: &'static str,
    v: RawVal,
    s: &'static str
) -> Result<(), Status>

Log a formatted debugging message to the debug log (if present), passing a simplified format string (supporting only positional {} markers) and both a RawVal and a string-slice argument, that will each be inserted at markers in the format string.

fn log_static_fmt_general(
    &self,
    fmt: &'static str,
    vals: &[RawVal],
    strs: &[&'static str]
) -> Result<(), Status>

Log a formatted debugging message to the debug log (if present), passing a simplified format string (supporting only positional {} markers) and both a slice of RawVals and a slice of string-slice argument, that will be sequentially inserted at markers in the format string.

impl Copy for Guest