Trait soroban_env_guest::Env

source · [−]
pub trait Env: EnvBase {

Show 116 methods    fn log_value(&self, v: RawVal) -> RawVal;
    fn get_invoking_contract(&self) -> Object;
    fn obj_cmp(&self, a: RawVal, b: RawVal) -> i64;
    fn contract_event(&self, topics: Object, data: RawVal) -> RawVal;
    fn get_current_contract(&self) -> Object;
    fn get_ledger_version(&self) -> RawVal;
    fn get_ledger_sequence(&self) -> RawVal;
    fn get_ledger_timestamp(&self) -> Object;
    fn get_ledger_network_passphrase(&self) -> Object;
    fn get_current_call_stack(&self) -> Object;
    fn fail_with_status(&self, status: Status) -> RawVal;
    fn log_fmt_values(&self, fmt: Object, args: Object) -> RawVal;
    fn get_invoker_type(&self) -> u64;
    fn get_invoking_account(&self) -> Object;
    fn get_ledger_network_id(&self) -> Object;
    fn obj_from_u64(&self, v: u64) -> Object;
    fn obj_to_u64(&self, obj: Object) -> u64;
    fn obj_from_i64(&self, v: i64) -> Object;
    fn obj_to_i64(&self, obj: Object) -> i64;
    fn map_new(&self) -> Object;
    fn map_put(&self, m: Object, k: RawVal, v: RawVal) -> Object;
    fn map_get(&self, m: Object, k: RawVal) -> RawVal;
    fn map_del(&self, m: Object, k: RawVal) -> Object;
    fn map_len(&self, m: Object) -> RawVal;
    fn map_has(&self, m: Object, k: RawVal) -> RawVal;
    fn map_prev_key(&self, m: Object, k: RawVal) -> RawVal;
    fn map_next_key(&self, m: Object, k: RawVal) -> RawVal;
    fn map_min_key(&self, m: Object) -> RawVal;
    fn map_max_key(&self, m: Object) -> RawVal;
    fn map_keys(&self, m: Object) -> Object;
    fn map_values(&self, m: Object) -> Object;
    fn vec_new(&self, c: RawVal) -> Object;
    fn vec_put(&self, v: Object, i: RawVal, x: RawVal) -> Object;
    fn vec_get(&self, v: Object, i: RawVal) -> RawVal;
    fn vec_del(&self, v: Object, i: RawVal) -> Object;
    fn vec_len(&self, v: Object) -> RawVal;
    fn vec_push_front(&self, v: Object, x: RawVal) -> Object;
    fn vec_pop_front(&self, v: Object) -> Object;
    fn vec_push_back(&self, v: Object, x: RawVal) -> Object;
    fn vec_pop_back(&self, v: Object) -> Object;
    fn vec_front(&self, v: Object) -> RawVal;
    fn vec_back(&self, v: Object) -> RawVal;
    fn vec_insert(&self, v: Object, i: RawVal, x: RawVal) -> Object;
    fn vec_append(&self, v1: Object, v2: Object) -> Object;
    fn vec_slice(&self, v: Object, start: RawVal, end: RawVal) -> Object;
    fn vec_first_index_of(&self, v: Object, x: RawVal) -> RawVal;
    fn vec_last_index_of(&self, v: Object, x: RawVal) -> RawVal;
    fn vec_binary_search(&self, v: Object, x: RawVal) -> u64;
    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;
    fn create_token_from_source_account(&self, salt: Object) -> Object;
    fn call(&self, contract: Object, func: Symbol, args: Object) -> RawVal;
    fn try_call(&self, contract: Object, func: Symbol, args: Object) -> RawVal;
    fn bigint_from_u64(&self, x: u64) -> Object;
    fn bigint_to_u64(&self, x: Object) -> u64;
    fn bigint_from_i64(&self, x: i64) -> Object;
    fn bigint_to_i64(&self, x: Object) -> i64;
    fn bigint_add(&self, x: Object, y: Object) -> Object;
    fn bigint_sub(&self, x: Object, y: Object) -> Object;
    fn bigint_mul(&self, x: Object, y: Object) -> Object;
    fn bigint_div(&self, x: Object, y: Object) -> Object;
    fn bigint_rem(&self, x: Object, y: Object) -> Object;
    fn bigint_and(&self, x: Object, y: Object) -> Object;
    fn bigint_or(&self, x: Object, y: Object) -> Object;
    fn bigint_xor(&self, x: Object, y: Object) -> Object;
    fn bigint_shl(&self, x: Object, y: Object) -> Object;
    fn bigint_shr(&self, x: Object, y: Object) -> Object;
    fn bigint_is_zero(&self, x: Object) -> RawVal;
    fn bigint_neg(&self, x: Object) -> Object;
    fn bigint_not(&self, x: Object) -> Object;
    fn bigint_gcd(&self, x: Object, y: Object) -> Object;
    fn bigint_lcm(&self, x: Object, y: Object) -> Object;
    fn bigint_pow(&self, x: Object, y: Object) -> Object;
    fn bigint_pow_mod(&self, p: Object, q: Object, m: Object) -> Object;
    fn bigint_sqrt(&self, x: Object) -> Object;
    fn bigint_bits(&self, x: Object) -> u64;
    fn bigint_to_bytes_be(&self, x: Object) -> Object;
    fn bigint_to_radix_be(&self, x: Object, radix: RawVal) -> Object;
    fn bigint_from_bytes_be(&self, sign: RawVal, bytes: Object) -> Object;
    fn bigint_from_radix_be(
        &self,
        sign: RawVal,
        buf: Object,
        radix: RawVal
    ) -> Object;
    fn serialize_to_bytes(&self, v: RawVal) -> Object;
    fn deserialize_from_bytes(&self, b: Object) -> RawVal;
    fn bytes_copy_to_linear_memory(
        &self,
        b: Object,
        b_pos: RawVal,
        lm_pos: RawVal,
        len: RawVal
    ) -> RawVal;
    fn bytes_copy_from_linear_memory(
        &self,
        b: Object,
        b_pos: RawVal,
        lm_pos: RawVal,
        len: RawVal
    ) -> Object;
    fn bytes_new_from_linear_memory(&self, lm_pos: RawVal, len: RawVal) -> Object;
    fn bytes_new(&self) -> Object;
    fn bytes_put(&self, b: Object, i: RawVal, u: RawVal) -> Object;
    fn bytes_get(&self, b: Object, i: RawVal) -> RawVal;
    fn bytes_del(&self, b: Object, i: RawVal) -> Object;
    fn bytes_len(&self, b: Object) -> RawVal;
    fn bytes_push(&self, b: Object, u: RawVal) -> Object;
    fn bytes_pop(&self, b: Object) -> Object;
    fn bytes_front(&self, b: Object) -> RawVal;
    fn bytes_back(&self, b: Object) -> RawVal;
    fn bytes_insert(&self, b: Object, i: RawVal, u: RawVal) -> Object;
    fn bytes_append(&self, b1: Object, b2: Object) -> Object;
    fn bytes_slice(&self, b: Object, start: RawVal, end: RawVal) -> Object;
    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;
    fn account_get_medium_threshold(&self, a: Object) -> RawVal;
    fn account_get_high_threshold(&self, a: Object) -> RawVal;
    fn account_get_signer_weight(&self, a: Object, s: Object) -> RawVal;
    fn account_exists(&self, a: Object) -> RawVal;

}
Expand description

This trait represents the interface between Host and Guest, used by client contract code and implemented (via CheckedEnv) by the host. It consists of functions that take or return only 64-bit values such as RawVal or u64.

Required Methods

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

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.

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

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

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

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

Return the network passphrase of the current ledger as Bytes.

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.

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.

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

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

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

Convert an i64 to an object containing an i64.

Convert an object containing an i64 to an i64.

Create an empty new map.

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.

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

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

Get the size of a map.

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

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).

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).

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

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

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

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

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.

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

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

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.

Returns length of the vector.

Push a value to the front of a vector.

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

Appends an element to the back of the vector.

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

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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

  • if successful, result of the called function.
  • otherwise, an SCStatus containing the error status code.

Constructs a BigInt from an u64.

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

Constructs a BigInt from an i64.

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

Performs the + operation.

Performs the - operation.

Performs the * operation.

Performs the / operation. Traps if y is zero.

Performs the % operation. Traps if y is zero.

Performs the & operation.

Performs the | operation.

Performs the ^ operation.

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

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

Returns true if x is equal to the additive identity.

Performs the unary - operation.

Performs the unary ! operation.

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

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

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

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.

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

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

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

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.

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.

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.

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

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

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.

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.

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

Create an empty new Bytes object.

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

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

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.

Returns length of the Bytes object.

Appends an element to the back of the Bytes object.

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

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

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

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

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.

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.

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

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

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

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.

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

Implementors