Struct soroban_env_host::Host

pub struct Host(/* private fields */);

Implementations

impl Host

None of these functions are metered, which is why they’re behind the is_debug check

pub fn set_diagnostic_level( &self, diagnostic_level: DiagnosticLevel ) -> Result<(), HostError>

pub fn enable_debug(&self) -> Result<(), HostError>

pub fn is_debug(&self) -> Result<bool, HostError>

pub fn log_diagnostics(&self, msg: &str, args: &[Val]) -> Result<(), HostError>

pub fn fn_call_diagnostics( &self, called_contract_id: &Hash, func: &Symbol, args: &[Val] ) -> Result<(), HostError>

pub fn fn_return_diagnostics( &self, contract_id: &Hash, func: &Symbol, res: &Val ) -> Result<(), HostError>

impl Host

pub fn system_event( &self, topics: VecObject, data: Val ) -> Result<(), HostError>

impl Host

pub fn get_events(&self) -> Result<Events, HostError>

impl Host

pub fn storage_key_from_rawval( &self, k: Val, durability: ContractDataDurability ) -> Result<Rc<LedgerKey>, HostError>

Converts a Val to an ScVal and combines it with the currently-executing [ContractID] to produce a [Key], that can be used to access ledger [Storage].

impl Host

pub fn ed25519_pub_key_from_bytesobj_input( &self, k: BytesObject ) -> Result<VerifyingKey, HostError>

pub fn sha256_hash_from_bytesobj_input( &self, x: BytesObject ) -> Result<Vec<u8>, HostError>

impl Host

pub fn contract_instance_ledger_key( &self, contract_id: &Hash ) -> Result<Rc<LedgerKey>, HostError>

pub fn get_full_contract_id_preimage( &self, init_preimage: ContractIdPreimage ) -> Result<HashIdPreimage, HostError>

pub fn load_account( &self, account_id: AccountId ) -> Result<AccountEntry, HostError>

impl Host

pub fn error_lazy<'a>( &self, error: Error, msg: &str, debug_args: impl FnOnce() -> &'a [Val] + 'a ) -> HostError

Convenience function that only evaluates the auxiliary debug arguments to Host::error when Host::is_debug is true.

pub fn err( &self, type_: ScErrorType, code: ScErrorCode, msg: &str, args: &[Val] ) -> HostError

Convenience function to construct an Error and pass to Host::error.

pub fn error(&self, error: Error, msg: &str, args: &[Val]) -> HostError

At minimum constructs and returns a HostError build from the provided Error, and when running in [DiagnosticMode::Debug] additionally records a diagnostic event with the provided msg and args and then enriches the returned Error with [DebugInfo] in the form of a Backtrace and snapshot of the Events buffer.

pub fn map_err<T, E>(&self, res: Result<T, E>) -> Result<T, HostError>where Error: From<E>, E: Debug,

Given a result carrying some error type that can be converted to an Error and supports core::fmt::Debug, calls Host::error with the error when there’s an error, also passing the result of core::fmt::Debug::fmt when Host::is_debug is true. Returns a Result over HostError.

If you have an error type T you want to record as a detailed debug event and a less-detailed Error code embedded in a HostError, add an impl From<T> for Error over in soroban_env_common::error, or in the module defining T, and call this where the error is generated.

Note: we do not want to impl From<T> for HostError for such types, as doing so will avoid routing them through the host in order to record their extended diagnostic information into the event log. This means you will wind up writing host.map_err(...)? a bunch in code that you used to be able to get away with just writing ...?, there’s no way around this if we want to record the diagnostic information.

impl Host

pub fn with_test_contract_frame<F>( &self, id: Hash, func: Symbol, f: F ) -> Result<Val, HostError>where F: FnOnce() -> Result<Val, HostError>,

Pushes a test contract [Frame], runs a closure, and then pops the frame, rolling back if the closure returned an error. Returns the result that the closure returned (or any error caused during the frame push/pop). Used for testing.

pub fn invoke_function(&self, hf: HostFunction) -> Result<ScVal, HostError>

impl Host

pub fn metered_hash_xdr( &self, obj: &impl WriteXdr ) -> Result<[u8; 32], HostError>

pub fn metered_from_xdr<T: ReadXdr>(&self, bytes: &[u8]) -> Result<T, HostError>

impl Host

pub fn with_storage_and_budget(storage: Storage, budget: Budget) -> Self

Constructs a new Host that will use the provided Storage for contract-data access functions such as [Env::get_contract_data].

pub fn set_source_account( &self, source_account: AccountId ) -> Result<(), HostError>

pub fn remove_source_account(&self) -> Result<(), HostError>

pub fn source_account_address(&self) -> Result<Option<AddressObject>, HostError>

pub fn switch_to_recording_auth( &self, disable_non_root_auth: bool ) -> Result<(), HostError>

pub fn set_authorization_entries( &self, auth_entries: Vec<SorobanAuthorizationEntry> ) -> Result<(), HostError>

pub fn set_base_prng_seed(&self, seed: Seed) -> Result<(), HostError>

pub fn set_ledger_info(&self, info: LedgerInfo) -> Result<(), HostError>

pub fn with_ledger_info<F, T>(&self, f: F) -> Result<T, HostError>where F: FnOnce(&LedgerInfo) -> Result<T, HostError>,

pub fn with_mut_ledger_info<F>(&self, f: F) -> Result<(), HostError>where F: FnMut(&mut LedgerInfo),

pub fn get_ledger_protocol_version(&self) -> Result<u32, HostError>

pub fn budget_cloned(&self) -> Budget

pub fn charge_budget( &self, ty: ContractCostType, input: Option<u64> ) -> Result<(), HostError>

pub fn with_mut_storage<F, U>(&self, f: F) -> Result<U, HostError>where F: FnOnce(&mut Storage) -> Result<U, HostError>,

pub fn try_finish(self) -> Result<(Storage, Events), HostError>

Accept a unique (refcount = 1) host reference and destroy the underlying [HostImpl], returning its finalized components containing processing side effects to the caller as a tuple wrapped in Ok(...).

pub fn call_account_contract_check_auth( &self, contract: BytesObject, args: VecObject ) -> Result<Val, HostError>

Invokes the reserved __check_auth function on a provided contract.

This is useful for testing the custom account contracts. Otherwise, the host prohibits calling __check_auth outside of internal implementation of require_auth[_for_args] calls.

pub fn snapshot_auth_manager(&self) -> Result<AuthorizationManager, HostError>

Returns the current state of the authorization manager.

Use this in conjunction with set_auth_manager to do authorized operations without breaking the current authorization state (useful for preserving the auth state while doing the generic test setup).

pub fn set_auth_manager( &self, auth_manager: AuthorizationManager ) -> Result<(), HostError>

Replaces authorization manager with the provided new instance.

Use this in conjunction with snapshot_auth_manager to do authorized operations without breaking the current authorization state (useful for preserving the auth state while doing the generic test setup).

pub fn inject_val(&self, v: &ScVal) -> Result<Val, HostError>

pub fn register_test_contract( &self, contract_address: AddressObject, contract_fns: Rc<dyn ContractFunctionSet> ) -> Result<(), HostError>

pub fn add_ledger_entry( &self, key: &Rc<LedgerKey>, val: &Rc<LedgerEntry>, expiration_ledger: Option<u32> ) -> Result<(), HostError>

pub fn setup_storage_entry( &self, key: Rc<LedgerKey>, val: Option<(Rc<LedgerEntry>, Option<u32>)>, access_type: AccessType ) -> Result<(), HostError>

pub fn setup_storage_footprint( &self, footprint: Footprint ) -> Result<(), HostError>

pub fn get_authenticated_authorizations( &self ) -> Result<Vec<(ScAddress, SorobanAuthorizedInvocation)>, HostError>

pub fn get_recorded_auth_payloads( &self ) -> Result<Vec<RecordedAuthPayload>, HostError>

Trait Implementations

impl AsBudget for &Host

fn as_budget(&self) -> &Budget

impl AsBudget for Host

fn as_budget(&self) -> &Budget

impl Clone for Host

fn clone(&self) -> Host

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compare<AccountEntry> for Host

type Error = HostError

fn compare( &self, a: &AccountEntry, b: &AccountEntry ) -> Result<Ordering, Self::Error>

impl Compare<AccountId> for Host

type Error = HostError

fn compare(&self, a: &AccountId, b: &AccountId) -> Result<Ordering, Self::Error>

impl Compare<ClaimableBalanceEntry> for Host

type Error = HostError

fn compare( &self, a: &ClaimableBalanceEntry, b: &ClaimableBalanceEntry ) -> Result<Ordering, Self::Error>

impl Compare<ConfigSettingEntry> for Host

type Error = HostError

fn compare( &self, a: &ConfigSettingEntry, b: &ConfigSettingEntry ) -> Result<Ordering, Self::Error>

impl Compare<ContractDataDurability> for Host

type Error = HostError

fn compare( &self, a: &ContractDataDurability, b: &ContractDataDurability ) -> Result<Ordering, Self::Error>

impl Compare<ContractExecutable> for Host

type Error = HostError

fn compare( &self, a: &ContractExecutable, b: &ContractExecutable ) -> Result<Ordering, Self::Error>

impl Compare<CreateContractArgs> for Host

type Error = HostError

fn compare( &self, a: &CreateContractArgs, b: &CreateContractArgs ) -> Result<Ordering, Self::Error>

impl Compare<DataEntry> for Host

type Error = HostError

fn compare(&self, a: &DataEntry, b: &DataEntry) -> Result<Ordering, Self::Error>

impl Compare<Duration> for Host

type Error = HostError

fn compare(&self, a: &Duration, b: &Duration) -> Result<Ordering, Self::Error>

impl Compare<ExtensionPoint> for Host

type Error = HostError

fn compare( &self, a: &ExtensionPoint, b: &ExtensionPoint ) -> Result<Ordering, Self::Error>

impl Compare<Hash> for Host

type Error = HostError

fn compare(&self, a: &Hash, b: &Hash) -> Result<Ordering, Self::Error>

impl Compare<I256> for Host

type Error = HostError

fn compare(&self, a: &I256, b: &I256) -> Result<Ordering, Self::Error>

impl Compare<LedgerEntryExt> for Host

type Error = HostError

fn compare( &self, a: &LedgerEntryExt, b: &LedgerEntryExt ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyAccount> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyAccount, b: &LedgerKeyAccount ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyClaimableBalance> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyClaimableBalance, b: &LedgerKeyClaimableBalance ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyConfigSetting> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyConfigSetting, b: &LedgerKeyConfigSetting ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyContractCode> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyContractCode, b: &LedgerKeyContractCode ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyData> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyData, b: &LedgerKeyData ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyLiquidityPool> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyLiquidityPool, b: &LedgerKeyLiquidityPool ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyOffer> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyOffer, b: &LedgerKeyOffer ) -> Result<Ordering, Self::Error>

impl Compare<LedgerKeyTrustLine> for Host

type Error = HostError

fn compare( &self, a: &LedgerKeyTrustLine, b: &LedgerKeyTrustLine ) -> Result<Ordering, Self::Error>

impl Compare<LiquidityPoolEntry> for Host

type Error = HostError

fn compare( &self, a: &LiquidityPoolEntry, b: &LiquidityPoolEntry ) -> Result<Ordering, Self::Error>

impl<K, V> Compare<MeteredOrdMap<K, V, Host>> for Hostwhere Host: Compare<K, Error = HostError> + Compare<V, Error = HostError>,

type Error = HostError

fn compare( &self, a: &MeteredOrdMap<K, V, Host>, b: &MeteredOrdMap<K, V, Host> ) -> Result<Ordering, Self::Error>

impl<Elt: MeteredClone> Compare<MeteredVector<Elt>> for Hostwhere Host: Compare<Elt, Error = HostError>,

type Error = HostError

fn compare( &self, a: &MeteredVector<Elt>, b: &MeteredVector<Elt> ) -> Result<Ordering, Self::Error>

impl Compare<OfferEntry> for Host

type Error = HostError

fn compare( &self, a: &OfferEntry, b: &OfferEntry ) -> Result<Ordering, Self::Error>

impl Compare<PublicKey> for Host

type Error = HostError

fn compare(&self, a: &PublicKey, b: &PublicKey) -> Result<Ordering, Self::Error>

impl Compare<ScAddress> for Host

type Error = HostError

fn compare(&self, a: &ScAddress, b: &ScAddress) -> Result<Ordering, Self::Error>

impl Compare<ScNonceKey> for Host

type Error = HostError

fn compare( &self, a: &ScNonceKey, b: &ScNonceKey ) -> Result<Ordering, Self::Error>

impl Compare<TimePoint> for Host

type Error = HostError

fn compare(&self, a: &TimePoint, b: &TimePoint) -> Result<Ordering, Self::Error>

impl Compare<TrustLineAsset> for Host

type Error = HostError

fn compare( &self, a: &TrustLineAsset, b: &TrustLineAsset ) -> Result<Ordering, Self::Error>

impl Compare<TrustLineEntry> for Host

type Error = HostError

fn compare( &self, a: &TrustLineEntry, b: &TrustLineEntry ) -> Result<Ordering, Self::Error>

impl Compare<U256> for Host

type Error = HostError

fn compare(&self, a: &U256, b: &U256) -> Result<Ordering, Self::Error>

impl Compare<Uint256> for Host

type Error = HostError

fn compare(&self, a: &Uint256, b: &Uint256) -> Result<Ordering, Self::Error>

impl Compare<bool> for Host

type Error = HostError

fn compare(&self, a: &bool, b: &bool) -> Result<Ordering, Self::Error>

impl Compare<i128> for Host

type Error = HostError

fn compare(&self, a: &i128, b: &i128) -> Result<Ordering, Self::Error>

impl Compare<i32> for Host

type Error = HostError

fn compare(&self, a: &i32, b: &i32) -> Result<Ordering, Self::Error>

impl Compare<i64> for Host

type Error = HostError

fn compare(&self, a: &i64, b: &i64) -> Result<Ordering, Self::Error>

impl Compare<u128> for Host

type Error = HostError

fn compare(&self, a: &u128, b: &u128) -> Result<Ordering, Self::Error>

impl Compare<u32> for Host

type Error = HostError

fn compare(&self, a: &u32, b: &u32) -> Result<Ordering, Self::Error>

impl Compare<u64> for Host

type Error = HostError

fn compare(&self, a: &u64, b: &u64) -> Result<Ordering, Self::Error>

impl Convert<&Object, ScValObject> for Host

type Error = HostError

fn convert(&self, ob: &Object) -> Result<ScValObject, Self::Error>

impl<'a> Convert<&ScValObjRef<'a>, Object> for Host

type Error = HostError

fn convert(&self, ob: &ScValObjRef<'a>) -> Result<Object, Self::Error>

impl Convert<Object, ScValObject> for Host

type Error = HostError

fn convert(&self, ob: Object) -> Result<ScValObject, Self::Error>

impl<'a> Convert<ScValObjRef<'a>, Object> for Host

type Error = HostError

fn convert(&self, ob: ScValObjRef<'a>) -> Result<Object, Self::Error>

impl Debug for Host

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Host

fn default() -> Self

Returns the “default value” for a type.

impl EnvBase for Host

type Error = HostError

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: Self::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 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.

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: BytesObject, b_pos: U32Val, slice: &[u8] ) -> Result<BytesObject, HostError>

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<(), HostError>

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<(), HostError>

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, s: SymbolObject, b_pos: U32Val, slice: &mut [u8] ) -> Result<(), HostError>

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

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

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

fn string_new_from_slice(&self, s: &str) -> Result<StringObject, HostError>

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

fn symbol_new_from_slice(&self, s: &str) -> Result<SymbolObject, HostError>

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

fn map_new_from_slices( &self, keys: &[&str], vals: &[Val] ) -> Result<MapObject, HostError>

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, HostError>

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, Self::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, Self::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, sym: Symbol, slices: &[&str] ) -> Result<U32Val, Self::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, HostError>

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.

impl ResourceLimiter for Host

fn memory_growing( &mut self, current: usize, desired: usize, maximum: Option<usize> ) -> Result<bool, MemoryError>

Notifies the resource limiter that an instance’s linear memory has been requested to grow.

fn table_growing( &mut self, current: u32, desired: u32, maximum: Option<u32> ) -> Result<bool, TableError>

Notifies the resource limiter that an instance’s table has been requested to grow.

fn instances(&self) -> usize

The maximum number of instances that can be created for a Store.

fn tables(&self) -> usize

The maximum number of tables that can be created for a Store.

fn memories(&self) -> usize

The maximum number of linear memories that can be created for a Store

fn memory_grow_failed(&mut self, _error: &MemoryError)

Notifies the resource limiter that growing a linear memory, permitted by the memory_growing method, has failed.

fn table_grow_failed(&mut self, _error: &TableError)

Notifies the resource limiter that growing a linear memory, permitted by the table_growing method, has failed.

impl VmCallerEnv for Host

type VmUserState = Host

fn log_from_linear_memory( &self, vmcaller: &mut VmCaller<'_, Host>, msg_pos: U32Val, msg_len: U32Val, vals_pos: U32Val, vals_len: U32Val ) -> Result<Void, HostError>

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

fn get_invoking_contract( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<AddressObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, a: Val, b: Val ) -> Result<i64, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, topics: VecObject, data: Val ) -> Result<Void, HostError>

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, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<U32Val, Self::Error>

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

fn get_ledger_sequence( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<U32Val, Self::Error>

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

fn get_ledger_timestamp( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<U64Val, Self::Error>

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

fn get_current_call_stack( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<VecObject, HostError>

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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, error: Error ) -> Result<Void, Self::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, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<BytesObject, Self::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, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<AddressObject, HostError>

Get the Address object for the current contract.

fn get_max_expiration_ledger( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<U32Val, Self::Error>

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

fn obj_from_u64( &self, _vmcaller: &mut VmCaller<'_, Host>, u: u64 ) -> Result<<u64 as HostObjectType>::Wrapper, HostError>

Convert a u64 to an object containing a u64.

fn obj_to_u64( &self, _vmcaller: &mut VmCaller<'_, Host>, obj: <u64 as HostObjectType>::Wrapper ) -> Result<u64, HostError>

Convert an object containing a u64 to a u64.

fn obj_from_i64( &self, _vmcaller: &mut VmCaller<'_, Host>, u: i64 ) -> Result<<i64 as HostObjectType>::Wrapper, HostError>

Convert an i64 to an object containing an i64.

fn obj_to_i64( &self, _vmcaller: &mut VmCaller<'_, Host>, obj: <i64 as HostObjectType>::Wrapper ) -> Result<i64, HostError>

Convert an object containing an i64 to an i64.

fn timepoint_obj_from_u64( &self, _vmcaller: &mut VmCaller<'_, Host>, u: u64 ) -> Result<<TimePoint as HostObjectType>::Wrapper, HostError>

Convert a u64 to a Timepoint object.

fn timepoint_obj_to_u64( &self, _vmcaller: &mut VmCaller<'_, Host>, obj: <TimePoint as HostObjectType>::Wrapper ) -> Result<u64, HostError>

Convert a Timepoint object to a u64.

fn duration_obj_from_u64( &self, _vmcaller: &mut VmCaller<'_, Host>, u: u64 ) -> Result<<Duration as HostObjectType>::Wrapper, HostError>

Convert a u64 to a Duration object.

fn duration_obj_to_u64( &self, _vmcaller: &mut VmCaller<'_, Host>, obj: <Duration as HostObjectType>::Wrapper ) -> Result<u64, HostError>

Convert a Duration object a u64.

fn obj_from_u128_pieces( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, hi: u64, lo: u64 ) -> Result<U128Object, Self::Error>

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

fn obj_to_u128_lo64( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: U128Object ) -> Result<u64, Self::Error>

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

fn obj_to_u128_hi64( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: U128Object ) -> Result<u64, Self::Error>

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

fn obj_from_i128_pieces( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, hi: i64, lo: u64 ) -> Result<I128Object, Self::Error>

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

fn obj_to_i128_lo64( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: I128Object ) -> Result<u64, Self::Error>

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

fn obj_to_i128_hi64( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: I128Object ) -> Result<i64, Self::Error>

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

fn obj_from_u256_pieces( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, hi_hi: u64, hi_lo: u64, lo_hi: u64, lo_lo: u64 ) -> Result<U256Object, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, bytes: BytesObject ) -> Result<U256Val, HostError>

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

fn u256_val_to_be_bytes( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, val: U256Val ) -> Result<BytesObject, HostError>

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

fn obj_to_u256_hi_hi( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: U256Object ) -> Result<u64, HostError>

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

fn obj_to_u256_hi_lo( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: U256Object ) -> Result<u64, HostError>

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

fn obj_to_u256_lo_hi( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: U256Object ) -> Result<u64, HostError>

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

fn obj_to_u256_lo_lo( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: U256Object ) -> Result<u64, HostError>

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

fn obj_from_i256_pieces( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, hi_hi: i64, hi_lo: u64, lo_hi: u64, lo_lo: u64 ) -> Result<I256Object, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, bytes: BytesObject ) -> Result<I256Val, HostError>

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

fn i256_val_to_be_bytes( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, val: I256Val ) -> Result<BytesObject, HostError>

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

fn obj_to_i256_hi_hi( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: I256Object ) -> Result<i64, HostError>

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

fn obj_to_i256_hi_lo( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: I256Object ) -> Result<u64, HostError>

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

fn obj_to_i256_lo_hi( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: I256Object ) -> Result<u64, HostError>

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

fn obj_to_i256_lo_lo( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, obj: I256Object ) -> Result<u64, HostError>

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

fn u256_add( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U256Val ) -> Result<U256Val, Self::Error>

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

fn u256_sub( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U256Val ) -> Result<U256Val, Self::Error>

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

fn u256_mul( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U256Val ) -> Result<U256Val, Self::Error>

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

fn u256_div( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U256Val ) -> Result<U256Val, Self::Error>

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

fn u256_pow( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U32Val ) -> Result<U256Val, Self::Error>

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

fn u256_shl( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U32Val ) -> Result<U256Val, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: U256Val, rhs_val: U32Val ) -> Result<U256Val, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: I256Val ) -> Result<I256Val, Self::Error>

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

fn i256_sub( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: I256Val ) -> Result<I256Val, Self::Error>

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

fn i256_mul( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: I256Val ) -> Result<I256Val, Self::Error>

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

fn i256_div( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: I256Val ) -> Result<I256Val, Self::Error>

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

fn i256_pow( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: U32Val ) -> Result<I256Val, Self::Error>

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

fn i256_shl( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: U32Val ) -> Result<I256Val, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lhs_val: I256Val, rhs_val: U32Val ) -> Result<I256Val, Self::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 map_new( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<MapObject, HostError>

Create an empty new map.

fn map_put( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject, k: Val, v: Val ) -> Result<MapObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject, k: Val ) -> Result<Val, HostError>

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

fn map_del( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject, k: Val ) -> Result<MapObject, HostError>

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

fn map_len( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject ) -> Result<U32Val, HostError>

Get the size of a map.

fn map_has( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject, k: Val ) -> Result<Bool, HostError>

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

fn map_key_by_pos( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject, i: U32Val ) -> Result<Val, HostError>

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

fn map_val_by_pos( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject, i: U32Val ) -> Result<Val, HostError>

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

fn map_keys( &self, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject ) -> Result<VecObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, m: MapObject ) -> Result<VecObject, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, keys_pos: U32Val, vals_pos: U32Val, len: U32Val ) -> Result<MapObject, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, map: MapObject, keys_pos: U32Val, vals_pos: U32Val, len: U32Val ) -> Result<Void, HostError>

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, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<VecObject, HostError>

Creates an empty new vector.

fn vec_put( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, i: U32Val, x: Val ) -> Result<VecObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, i: U32Val ) -> Result<Val, HostError>

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

fn vec_del( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, i: U32Val ) -> Result<VecObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject ) -> Result<U32Val, HostError>

Returns length of the vector.

fn vec_push_front( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: Val ) -> Result<VecObject, HostError>

Push a value to the front of a vector.

fn vec_pop_front( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject ) -> Result<VecObject, HostError>

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

fn vec_push_back( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: Val ) -> Result<VecObject, HostError>

Appends an element to the back of the vector.

fn vec_pop_back( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject ) -> Result<VecObject, HostError>

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

fn vec_front( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject ) -> Result<Val, HostError>

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

fn vec_back( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject ) -> Result<Val, HostError>

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

fn vec_insert( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, i: U32Val, x: Val ) -> Result<VecObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, v1: VecObject, v2: VecObject ) -> Result<VecObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, start: U32Val, end: U32Val ) -> Result<VecObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: Val ) -> Result<Val, Self::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, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: Val ) -> Result<Val, Self::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, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: Val ) -> Result<u64, Self::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, vmcaller: &mut VmCaller<'_, Host>, vals_pos: U32Val, len: U32Val ) -> Result<VecObject, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, vec: VecObject, vals_pos: U32Val, len: U32Val ) -> Result<Void, HostError>

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

fn put_contract_data( &self, _vmcaller: &mut VmCaller<'_, Host>, k: Val, v: Val, t: StorageType ) -> Result<Void, HostError>

fn has_contract_data( &self, _vmcaller: &mut VmCaller<'_, Host>, k: Val, t: StorageType ) -> Result<Bool, HostError>

fn get_contract_data( &self, _vmcaller: &mut VmCaller<'_, Host>, k: Val, t: StorageType ) -> Result<Val, HostError>

fn del_contract_data( &self, _vmcaller: &mut VmCaller<'_, Host>, k: Val, t: StorageType ) -> Result<Void, HostError>

fn bump_contract_data( &self, _vmcaller: &mut VmCaller<'_, Host>, k: Val, t: StorageType, low_expiration_watermark: U32Val, high_expiration_watermark: U32Val ) -> Result<Void, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, low_expiration_watermark: U32Val, high_expiration_watermark: U32Val ) -> Result<Void, HostError>

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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, contract: AddressObject, low_expiration_watermark: U32Val, high_expiration_watermark: U32Val ) -> Result<Void, Self::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 create_contract( &self, _vmcaller: &mut VmCaller<'_, Host>, deployer: AddressObject, wasm_hash: BytesObject, salt: BytesObject ) -> Result<AddressObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, serialized_asset: BytesObject ) -> Result<AddressObject, HostError>

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 get_contract_id( &self, _vmcaller: &mut VmCaller<'_, Host>, deployer: AddressObject, salt: BytesObject ) -> Result<AddressObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, serialized_asset: BytesObject ) -> Result<AddressObject, HostError>

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 upload_wasm( &self, _vmcaller: &mut VmCaller<'_, Host>, wasm: BytesObject ) -> Result<BytesObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, hash: BytesObject ) -> Result<Void, HostError>

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 call( &self, _vmcaller: &mut VmCaller<'_, Host>, contract_address: AddressObject, func: Symbol, args: VecObject ) -> Result<Val, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, contract_address: AddressObject, func: Symbol, args: VecObject ) -> Result<Val, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, v: Val ) -> Result<BytesObject, HostError>

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

fn deserialize_from_bytes( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject ) -> Result<Val, HostError>

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

fn string_copy_to_linear_memory( &self, vmcaller: &mut VmCaller<'_, Host>, s: StringObject, s_pos: U32Val, lm_pos: U32Val, len: U32Val ) -> Result<Void, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, s: SymbolObject, s_pos: U32Val, lm_pos: U32Val, len: U32Val ) -> Result<Void, HostError>

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 bytes_copy_to_linear_memory( &self, vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, b_pos: U32Val, lm_pos: U32Val, len: U32Val ) -> Result<Void, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, b_pos: U32Val, lm_pos: U32Val, len: U32Val ) -> Result<BytesObject, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, lm_pos: U32Val, len: U32Val ) -> Result<BytesObject, HostError>

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

fn string_new_from_linear_memory( &self, vmcaller: &mut VmCaller<'_, Host>, lm_pos: U32Val, len: U32Val ) -> Result<StringObject, HostError>

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, vmcaller: &mut VmCaller<'_, Host>, lm_pos: U32Val, len: U32Val ) -> Result<SymbolObject, HostError>

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

fn symbol_index_in_linear_memory( &self, vmcaller: &mut VmCaller<'_, Host>, sym: Symbol, lm_pos: U32Val, len: U32Val ) -> Result<U32Val, HostError>

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

fn bytes_new( &self, _vmcaller: &mut VmCaller<'_, Host> ) -> Result<BytesObject, HostError>

Create an empty new Bytes object.

fn bytes_put( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, iv: U32Val, u: U32Val ) -> Result<BytesObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, iv: U32Val ) -> Result<U32Val, HostError>

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

fn bytes_del( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, i: U32Val ) -> Result<BytesObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject ) -> Result<U32Val, HostError>

Returns length of the Bytes object.

fn string_len( &self, _vmcaller: &mut VmCaller<'_, Host>, b: StringObject ) -> Result<U32Val, HostError>

Returns length of the String object.

fn symbol_len( &self, _vmcaller: &mut VmCaller<'_, Host>, b: SymbolObject ) -> Result<U32Val, HostError>

Returns length of the Symbol object.

fn bytes_push( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, u: U32Val ) -> Result<BytesObject, HostError>

Appends an element to the back of the Bytes object.

fn bytes_pop( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject ) -> Result<BytesObject, HostError>

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

fn bytes_front( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject ) -> Result<U32Val, HostError>

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

fn bytes_back( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject ) -> Result<U32Val, HostError>

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

fn bytes_insert( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, i: U32Val, u: U32Val ) -> Result<BytesObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, b1: BytesObject, b2: BytesObject ) -> Result<BytesObject, HostError>

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, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject, start: U32Val, end: U32Val ) -> Result<BytesObject, HostError>

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 compute_hash_sha256( &self, _vmcaller: &mut VmCaller<'_, Host>, x: BytesObject ) -> Result<BytesObject, HostError>

fn compute_hash_keccak256( &self, _vmcaller: &mut VmCaller<'_, Host>, x: BytesObject ) -> Result<BytesObject, HostError>

Returns the keccak256 hash of given input bytes.

fn verify_sig_ed25519( &self, _vmcaller: &mut VmCaller<'_, Host>, k: BytesObject, x: BytesObject, s: BytesObject ) -> Result<Void, HostError>

fn recover_key_ecdsa_secp256k1( &self, _vmcaller: &mut VmCaller<'_, Host>, msg_digest: BytesObject, signature: BytesObject, recovery_id: U32Val ) -> Result<BytesObject, HostError>

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 dummy0( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState> ) -> Result<Val, Self::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 require_auth_for_args( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, address: AddressObject, args: VecObject ) -> Result<Void, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, address: AddressObject ) -> Result<Void, Self::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 authorize_as_curr_contract( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, auth_entries: VecObject ) -> Result<Void, HostError>

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 account_public_key_to_address( &self, _vmcaller: &mut VmCaller<'_, Self::VmUserState>, pk_bytes: BytesObject ) -> Result<AddressObject, Self::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, _vmcaller: &mut VmCaller<'_, Self::VmUserState>, contract_id_bytes: BytesObject ) -> Result<AddressObject, Self::Error>

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

fn address_to_account_public_key( &self, _vmcaller: &mut VmCaller<'_, Self::VmUserState>, address: AddressObject ) -> Result<Val, Self::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, _vmcaller: &mut VmCaller<'_, Self::VmUserState>, address: AddressObject ) -> Result<Val, Self::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 prng_reseed( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, seed: BytesObject ) -> Result<Void, Self::Error>

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

fn prng_bytes_new( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, length: U32Val ) -> Result<BytesObject, Self::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, vmcaller: &mut VmCaller<'_, Self::VmUserState>, lo: u64, hi: u64 ) -> Result<u64, Self::Error>

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

fn prng_vec_shuffle( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, vec: VecObject ) -> Result<VecObject, Self::Error>

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