Struct soroban_env_host::UnimplementedEnv

pub struct UnimplementedEnv;

A dummy implementation of the Env trait that fails with unimplemented!() in all functions. Useful for certain testing scenarios.

Trait Implementations

impl Clone for UnimplementedEnv

fn clone(&self) -> UnimplementedEnv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for UnimplementedEnv

fn default() -> UnimplementedEnv

Returns the “default value” for a type.

impl Env for UnimplementedEnv

fn log_from_linear_memory( &self, _: U32Val, _: U32Val, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Emit a diagnostic event containing a message and sequence of Vals.

fn get_invoking_contract( &self ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Get the address object of the contract which invoked the running contract. Traps if the running contract was not invoked by a contract.

fn obj_cmp( &self, _: Val, _: Val ) -> Result<i64, <UnimplementedEnv as EnvBase>::Error>

Compare two objects, or at least one object to a non-object, structurally. Returns -1 if a<b, 1 if a>b, or 0 if a==b.

fn contract_event( &self, _: VecObject, _: Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Records a contract event. topics is expected to be a SCVec with length <= 4 that cannot contain Vec, Map, or Bytes with length > 32.

fn get_ledger_version( &self ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

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

fn get_ledger_sequence( &self ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

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

fn get_ledger_timestamp( &self ) -> Result<U64Val, <UnimplementedEnv as EnvBase>::Error>

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

fn get_current_call_stack( &self ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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_error( &self, _: Error ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

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

fn get_ledger_network_id( &self ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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

fn get_current_contract_address( &self ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Get the Address object for the current contract.

fn get_max_expiration_ledger( &self ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Returns the max ledger sequence that an entry can live to (inclusive).

fn obj_from_u64( &self, _: u64 ) -> Result<U64Object, <UnimplementedEnv as EnvBase>::Error>

Convert a u64 to an object containing a u64.

fn obj_to_u64( &self, _: U64Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Convert an object containing a u64 to a u64.

fn obj_from_i64( &self, _: i64 ) -> Result<I64Object, <UnimplementedEnv as EnvBase>::Error>

Convert an i64 to an object containing an i64.

fn obj_to_i64( &self, _: I64Object ) -> Result<i64, <UnimplementedEnv as EnvBase>::Error>

Convert an object containing an i64 to an i64.

fn obj_from_u128_pieces( &self, _: u64, _: u64 ) -> Result<U128Object, <UnimplementedEnv as EnvBase>::Error>

Convert the high and low 64-bit words of a u128 to an object containing a u128.

fn obj_to_u128_lo64( &self, _: U128Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract the low 64 bits from an object containing a u128.

fn obj_to_u128_hi64( &self, _: U128Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract the high 64 bits from an object containing a u128.

fn obj_from_i128_pieces( &self, _: i64, _: u64 ) -> Result<I128Object, <UnimplementedEnv as EnvBase>::Error>

Convert the high and low 64-bit words of an i128 to an object containing an i128.

fn obj_to_i128_lo64( &self, _: I128Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract the low 64 bits from an object containing an i128.

fn obj_to_i128_hi64( &self, _: I128Object ) -> Result<i64, <UnimplementedEnv as EnvBase>::Error>

Extract the high 64 bits from an object containing an i128.

fn obj_from_u256_pieces( &self, _: u64, _: u64, _: u64, _: u64 ) -> Result<U256Object, <UnimplementedEnv as EnvBase>::Error>

Convert the four 64-bit words of a u256 (big-endian) to an object containing a u256.

fn u256_val_from_be_bytes( &self, _: BytesObject ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Create a U256 Val from its representation as a byte array in big endian.

fn u256_val_to_be_bytes( &self, _: U256Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Return the memory representation of this U256 Val as a byte array in big endian byte order.

fn obj_to_u256_hi_hi( &self, _: U256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract the highest 64-bits (bits 192-255) from an object containing a u256.

fn obj_to_u256_hi_lo( &self, _: U256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract bits 128-191 from an object containing a u256.

fn obj_to_u256_lo_hi( &self, _: U256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract bits 64-127 from an object containing a u256.

fn obj_to_u256_lo_lo( &self, _: U256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract the lowest 64-bits (bits 0-63) from an object containing a u256.

fn obj_from_i256_pieces( &self, _: i64, _: u64, _: u64, _: u64 ) -> Result<I256Object, <UnimplementedEnv as EnvBase>::Error>

Convert the four 64-bit words of an i256 (big-endian) to an object containing an i256.

fn i256_val_from_be_bytes( &self, _: BytesObject ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Create a I256 Val from its representation as a byte array in big endian.

fn i256_val_to_be_bytes( &self, _: I256Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Return the memory representation of this I256 Val as a byte array in big endian byte order.

fn obj_to_i256_hi_hi( &self, _: I256Object ) -> Result<i64, <UnimplementedEnv as EnvBase>::Error>

Extract the highest 64-bits (bits 192-255) from an object containing an i256.

fn obj_to_i256_hi_lo( &self, _: I256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract bits 128-191 from an object containing an i256.

fn obj_to_i256_lo_hi( &self, _: I256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract bits 64-127 from an object containing an i256.

fn obj_to_i256_lo_lo( &self, _: I256Object ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Extract the lowest 64-bits (bits 0-63) from an object containing an i256.

fn u256_add( &self, _: U256Val, _: U256Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer addition. Computes lhs + rhs, returning ScError if overflow occurred.

fn u256_sub( &self, _: U256Val, _: U256Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer subtraction. Computes lhs - rhs, returning ScError if overflow occurred.

fn u256_mul( &self, _: U256Val, _: U256Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer multiplication. Computes lhs * rhs, returning ScError if overflow occurred.

fn u256_div( &self, _: U256Val, _: U256Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer division. Computes lhs / rhs, returning ScError if rhs == 0 or overflow occurred.

fn u256_pow( &self, _: U256Val, _: U32Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked exponentiation. Computes lhs.exp(rhs), returning ScError if overflow occurred.

fn u256_shl( &self, _: U256Val, _: U32Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked shift left. Computes lhs << rhs, returning ScError if rhs is larger than or equal to the number of bits in lhs.

fn u256_shr( &self, _: U256Val, _: U32Val ) -> Result<U256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked shift right. Computes lhs >> rhs, returning ScError if rhs is larger than or equal to the number of bits in lhs.

fn i256_add( &self, _: I256Val, _: I256Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer addition. Computes lhs + rhs, returning ScError if overflow occurred.

fn i256_sub( &self, _: I256Val, _: I256Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer subtraction. Computes lhs - rhs, returning ScError if overflow occurred.

fn i256_mul( &self, _: I256Val, _: I256Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer multiplication. Computes lhs * rhs, returning ScError if overflow occurred.

fn i256_div( &self, _: I256Val, _: I256Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked integer division. Computes lhs / rhs, returning ScError if rhs == 0 or overflow occurred.

fn i256_pow( &self, _: I256Val, _: U32Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked exponentiation. Computes lhs.exp(rhs), returning ScError if overflow occurred.

fn i256_shl( &self, _: I256Val, _: U32Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked shift left. Computes lhs << rhs, returning ScError if rhs is larger than or equal to the number of bits in lhs.

fn i256_shr( &self, _: I256Val, _: U32Val ) -> Result<I256Val, <UnimplementedEnv as EnvBase>::Error>

Performs checked shift right. Computes lhs >> rhs, returning ScError if rhs is larger than or equal to the number of bits in lhs.

fn timepoint_obj_from_u64( &self, _: u64 ) -> Result<TimepointObject, <UnimplementedEnv as EnvBase>::Error>

Convert a u64 to a Timepoint object.

fn timepoint_obj_to_u64( &self, _: TimepointObject ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Convert a Timepoint object to a u64.

fn duration_obj_from_u64( &self, _: u64 ) -> Result<DurationObject, <UnimplementedEnv as EnvBase>::Error>

Convert a u64 to a Duration object.

fn duration_obj_to_u64( &self, _: DurationObject ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Convert a Duration object a u64.

fn map_new(&self) -> Result<MapObject, <UnimplementedEnv as EnvBase>::Error>

Create an empty new map.

fn map_put( &self, _: MapObject, _: Val, _: Val ) -> Result<MapObject, <UnimplementedEnv as EnvBase>::Error>

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, _: MapObject, _: Val ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn map_del( &self, _: MapObject, _: Val ) -> Result<MapObject, <UnimplementedEnv as EnvBase>::Error>

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

fn map_len( &self, _: MapObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Get the size of a map.

fn map_has( &self, _: MapObject, _: Val ) -> Result<Bool, <UnimplementedEnv as EnvBase>::Error>

Test for the presence of a key in a map. Returns Bool.

fn map_key_by_pos( &self, _: MapObject, _: U32Val ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

Get the key from a map at position i. If i is an invalid position, return ScError.

fn map_val_by_pos( &self, _: MapObject, _: U32Val ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

Get the value from a map at position i. If i is an invalid position, return ScError.

fn map_keys( &self, _: MapObject ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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, _: MapObject ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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 map_new_from_linear_memory( &self, _: U32Val, _: U32Val, _: U32Val ) -> Result<MapObject, <UnimplementedEnv as EnvBase>::Error>

Return a new map initialized from a pair of equal-length arrays, one for keys and one for values, given by a pair of linear-memory addresses and a length in Vals.

fn map_unpack_to_linear_memory( &self, _: MapObject, _: U32Val, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Copy Vals from map to the array vals_pos, selecting only the keys identified by the array keys_pos. Both arrays have len elements and are identified by linear-memory addresses.

fn vec_new(&self) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

Creates an empty new vector.

fn vec_put( &self, _: VecObject, _: U32Val, _: Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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, _: VecObject, _: U32Val ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_del( &self, _: VecObject, _: U32Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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, _: VecObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Returns length of the vector.

fn vec_push_front( &self, _: VecObject, _: Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

Push a value to the front of a vector.

fn vec_pop_front( &self, _: VecObject ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_push_back( &self, _: VecObject, _: Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

Appends an element to the back of the vector.

fn vec_pop_back( &self, _: VecObject ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_front( &self, _: VecObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_back( &self, _: VecObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_insert( &self, _: VecObject, _: U32Val, _: Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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, _: VecObject, _: VecObject ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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, _: VecObject, _: U32Val, _: U32Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

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, _: VecObject, _: Val ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_last_index_of( &self, _: VecObject, _: Val ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn vec_binary_search( &self, _: VecObject, _: Val ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

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 vec_new_from_linear_memory( &self, _: U32Val, _: U32Val ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

Return a new vec initialized from an input slice of Vals given by a linear-memory address and length in Vals.

fn vec_unpack_to_linear_memory( &self, _: VecObject, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Copy the Vals of a vec into an array at a given linear-memory address and length in Vals.

fn put_contract_data( &self, _: Val, _: Val, _: StorageType ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

fn has_contract_data( &self, _: Val, _: StorageType ) -> Result<Bool, <UnimplementedEnv as EnvBase>::Error>

fn get_contract_data( &self, _: Val, _: StorageType ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

fn del_contract_data( &self, _: Val, _: StorageType ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

fn create_contract( &self, _: AddressObject, _: BytesObject, _: BytesObject ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Creates the contract instance on behalf of deployer. deployer must authorize this call via Soroban auth framework, i.e. this calls deployer.require_auth with respective arguments. wasm_hash must be a hash of the contract code that has already been uploaded on this network. salt is used to create a unique contract id. Returns the address of the created contract.

fn create_asset_contract( &self, _: BytesObject ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Creates the instance of Stellar Asset contract corresponding to the provided asset. serialized_asset is stellar::Asset XDR serialized to bytes format. Returns the address of the created contract.

fn upload_wasm( &self, _: BytesObject ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Uploads provided wasm bytecode to the network and returns its identifier (SHA-256 hash). No-op in case if the same Wasm object already exists.

fn update_current_contract_wasm( &self, _: BytesObject ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Replaces the executable of the current contract with the provided Wasm code identified by a hash. Wasm entry corresponding to the hash has to already be present in the ledger. The update happens only after the current contract invocation has successfully finished, so this can be safely called in the middle of a function.

fn bump_contract_data( &self, _: Val, _: StorageType, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

If the entry expiration is below low_expiration_watermark ledgers from the current ledger (inclusive), then bump the expiration to be high_expiration_watermark from the current ledger (inclusive)

fn bump_current_contract_instance_and_code( &self, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

If expiration for the current contract instance and code (if applicable) is below low_expiration_watermark ledgers from the current ledger (inclusive), then bump the expiration to be high_expiration_watermark from the current ledger (inclusive)

fn bump_contract_instance_and_code( &self, _: AddressObject, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

If expiration of the provided contract instance and code (if applicable) is below low_expiration_watermark ledgers from the current ledger (inclusive), then bump the expiration to be high_expiration_watermark from the current ledger (inclusive)

fn get_contract_id( &self, _: AddressObject, _: BytesObject ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Get the id of a contract without creating it. deployer is address of the contract deployer. salt is used to create a unique contract id. Returns the address of the would-be contract.

fn get_asset_contract_id( &self, _: BytesObject ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Get the id of the Stellar Asset contract corresponding to the provided asset without creating the instance. serialized_asset is stellar::Asset XDR serialized to bytes format. Returns the address of the would-be asset contract.

fn call( &self, _: AddressObject, _: Symbol, _: VecObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn try_call( &self, _: AddressObject, _: Symbol, _: VecObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

Calls a function in another contract with arguments contained in vector args, returning either the result of the called function or an ScError if the called function failed.

fn serialize_to_bytes( &self, _: Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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

fn deserialize_from_bytes( &self, _: BytesObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

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

fn bytes_copy_to_linear_memory( &self, _: BytesObject, _: U32Val, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

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, _: BytesObject, _: U32Val, _: U32Val, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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, _: U32Val, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Create an empty new Bytes object.

fn bytes_put( &self, _: BytesObject, _: U32Val, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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, _: BytesObject, _: U32Val ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

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

fn bytes_del( &self, _: BytesObject, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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, _: BytesObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Returns length of the Bytes object.

fn bytes_push( &self, _: BytesObject, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Appends an element to the back of the Bytes object.

fn bytes_pop( &self, _: BytesObject ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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

fn bytes_front( &self, _: BytesObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

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

fn bytes_back( &self, _: BytesObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

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

fn bytes_insert( &self, _: BytesObject, _: U32Val, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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, _: BytesObject, _: BytesObject ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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, _: BytesObject, _: U32Val, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

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 string_copy_to_linear_memory( &self, _: StringObject, _: U32Val, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

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

fn symbol_copy_to_linear_memory( &self, _: SymbolObject, _: U32Val, _: U32Val, _: U32Val ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

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

fn string_new_from_linear_memory( &self, _: U32Val, _: U32Val ) -> Result<StringObject, <UnimplementedEnv as EnvBase>::Error>

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

fn symbol_new_from_linear_memory( &self, _: U32Val, _: U32Val ) -> Result<SymbolObject, <UnimplementedEnv as EnvBase>::Error>

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

fn string_len( &self, _: StringObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Returns length of the String object.

fn symbol_len( &self, _: SymbolObject ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Returns length of the Symbol object.

fn symbol_index_in_linear_memory( &self, _: Symbol, _: U32Val, _: U32Val ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Return the index of a Symbol in an array of linear-memory byte-slices, or trap if not found.

fn compute_hash_sha256( &self, _: BytesObject ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

fn verify_sig_ed25519( &self, _: BytesObject, _: BytesObject, _: BytesObject ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

fn compute_hash_keccak256( &self, _: BytesObject ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Returns the keccak256 hash of given input bytes.

fn recover_key_ecdsa_secp256k1( &self, _: BytesObject, _: BytesObject, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Recovers the SEC-1-encoded ECDSA secp256k1 public key that produced a given 64-byte signature over a given 32-byte message digest, for a given recovery_id byte.

fn require_auth_for_args( &self, _: AddressObject, _: VecObject ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Checks if the address has authorized the invocation of the current contract function with the provided arguments. Traps if the invocation hasn’t been authorized.

fn require_auth( &self, _: AddressObject ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Checks if the address has authorized the invocation of the current contract function with all the arguments of the invocation. Traps if the invocation hasn’t been authorized.

fn account_public_key_to_address( &self, _: BytesObject ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Converts a provided 32-byte Stellar account public key to the corresponding address. This is only useful in the context of cross-chain interoperability. Prefer directly using the Address objects whenever possible.

fn contract_id_to_address( &self, _: BytesObject ) -> Result<AddressObject, <UnimplementedEnv as EnvBase>::Error>

Converts a provided 32-byte contract identifier to a corresponding Address object.

fn address_to_account_public_key( &self, _: AddressObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

Returns the 32-byte public key of the Stellar account corresponding to the provided Address object. If the Address doesn’t belong to an account, returns Val corresponding to the unit type (()).

fn address_to_contract_id( &self, _: AddressObject ) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

Returns the 32-byte contract identifier corresponding to the provided Address object. If the Address doesn’t belong to an account, returns Val corresponding to the unit type (()).

fn authorize_as_curr_contract( &self, _: VecObject ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Authorizes sub-contract calls for the next contract call on behalf of the current contract. Every entry in the argument vector corresponds to InvokerContractAuthEntry contract type that authorizes a tree of require_auth calls on behalf of the current contract. The entries must not contain any authorizations for the direct contract call, i.e. if current contract needs to call contract function F1 that calls function F2 both of which require auth, only F2 should be present in auth_entries.

fn dummy0(&self) -> Result<Val, <UnimplementedEnv as EnvBase>::Error>

A dummy function taking 0 arguments and performs no-op. This function is for test purpose only, for measuring the roundtrip cost of invoking a host function, i.e. host->Vm->host.

fn prng_reseed( &self, _: BytesObject ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Reseed the frame-local PRNG with a given BytesObject, which should be 32 bytes long.

fn prng_bytes_new( &self, _: U32Val ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Construct a new BytesObject of the given length filled with bytes drawn from the frame-local PRNG.

fn prng_u64_in_inclusive_range( &self, _: u64, _: u64 ) -> Result<u64, <UnimplementedEnv as EnvBase>::Error>

Return a u64 uniformly sampled from the inclusive range [lo,hi] by the frame-local PRNG.

fn prng_vec_shuffle( &self, _: VecObject ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

Return a (Fisher-Yates) shuffled clone of a given vector, using the frame-local PRNG.

impl EnvBase for UnimplementedEnv

type Error = Infallible

The type of error returned from the environment when the environment itself fails “unrecoverably”, or at least in a way that the user is not expected to be able to recover from, such as an internal logic error, exceeding the execution budget, or being passed malformed input in a way that the user-facing API does not anticipate or allow for. This type is returned from all environment-interface methods, and will only ever take on two possible concrete types: either Infallible (in the Guest) or HostError (in the Host).

fn escalate_error_to_panic(&self, _e: <UnimplementedEnv as EnvBase>::Error) -> !

Reject an error from the environment, turning it into a panic but on terms that the environment controls (eg. transforming or logging it). This should only ever be called by client-side / SDK local-testing code, never in the Host.

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Used for recovering the concrete type of the Host.

fn check_same_env(&self, _other: &UnimplementedEnv)

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

fn deep_clone(&self) -> UnimplementedEnv

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

fn bytes_copy_from_slice( &self, _b: BytesObject, _b_pos: U32Val, _slice: &[u8] ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Clone an existing Bytes object in the host, replacing the portion of its memory with bytes supplied by slice, returning the new object. The replaced portion of the original object’s memory begins at b_pos and extends for the same length as the new slice.

fn bytes_copy_to_slice( &self, _b: BytesObject, _b_pos: U32Val, _slice: &mut [u8] ) -> Result<(), <UnimplementedEnv as EnvBase>::Error>

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

fn string_copy_to_slice( &self, _b: StringObject, _b_pos: U32Val, _slice: &mut [u8] ) -> Result<(), <UnimplementedEnv as EnvBase>::Error>

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

fn symbol_copy_to_slice( &self, _b: SymbolObject, _b_pos: U32Val, _slice: &mut [u8] ) -> Result<(), <UnimplementedEnv as EnvBase>::Error>

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

fn bytes_new_from_slice( &self, _slice: &[u8] ) -> Result<BytesObject, <UnimplementedEnv as EnvBase>::Error>

Form a new Bytes host object from a slice of client memory.

fn string_new_from_slice( &self, _s: &str ) -> Result<StringObject, <UnimplementedEnv as EnvBase>::Error>

Form a new String host object from a slice of client memory.

fn symbol_new_from_slice( &self, _s: &str ) -> Result<SymbolObject, <UnimplementedEnv as EnvBase>::Error>

Form a new Symbol host object from a slice of client memory.

fn map_new_from_slices( &self, _keys: &[&str], _vals: &[Val] ) -> Result<MapObject, <UnimplementedEnv as EnvBase>::Error>

Form a new Map host object from a slice of symbol-names and a slice of values. Keys must be in sorted order.

fn map_unpack_to_slice( &self, _map: MapObject, _keys: &[&str], _vals: &mut [Val] ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Unpack a Map host object with a specified set of keys to a slice of Vals. Keys must be in sorted order and must match the key set of the unpacked object exactly.

fn vec_new_from_slice( &self, _vals: &[Val] ) -> Result<VecObject, <UnimplementedEnv as EnvBase>::Error>

Form a new Vec host object from a slice of values.

fn vec_unpack_to_slice( &self, _vec: VecObject, _vals: &mut [Val] ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Form a new Vec host object from a slice of values. The values slice must be the same length as the host object.

fn symbol_index_in_strs( &self, _key: Symbol, _strs: &[&str] ) -> Result<U32Val, <UnimplementedEnv as EnvBase>::Error>

Return the index of a Symbol in an array of &strs, or error if not found.

fn log_from_slice( &self, _msg: &str, _vals: &[Val] ) -> Result<Void, <UnimplementedEnv as EnvBase>::Error>

Log a string and set of values as a diagnostic event, if diagnostic events are enabled. When running on host, logs directly; when running on guest, redirects through log_from_linear_memory.

fn augment_err_result<T>( &self, x: Result<T, Self::Error> ) -> Result<T, Self::Error>

If x is Err(...), ensure as much debug information as possible is attached to that error; in any case return “essentially the same” x – either Ok(...) or Err(...) – just with extra error context.