Struct soroban_env_host::Host

pub struct Host(_);

Implementations

impl Host

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

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

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

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

pub fn storage_key_from_scval( &self, key: ScVal ) -> Result<Rc<LedgerKey>, HostError>

pub fn contract_data_key_from_rawval( &self, k: RawVal ) -> Result<Rc<LedgerKey>, HostError>

impl Host

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

pub fn id_preimage_from_ed25519( &self, key: Uint256, salt: Uint256 ) -> Result<HashIdPreimage, HostError>

pub fn id_preimage_from_contract( &self, contract_id: Hash, salt: Uint256 ) -> Result<HashIdPreimage, HostError>

pub fn id_preimage_from_asset( &self, asset: Asset ) -> Result<HashIdPreimage, HostError>

pub fn id_preimage_from_source_account( &self, salt: Uint256 ) -> Result<HashIdPreimage, HostError>

pub fn create_contract_args_hash_preimage( &self, source: ScContractExecutable, salt: Uint256 ) -> Result<HashIdPreimage, HostError>

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

impl Host

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

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

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

impl Host

pub fn err<T>(&self, src: T) -> HostErrorwhere DebugError: From<T>,

Records a debug-event from its input in as much detail as possible, then converts its input to a (often coarser-granularity) Status code, and then forms a HostError with it (which also captures a backtrace::Backtrace). This is the method you want to call any time there’s a finer-granularity error type that you want to log the details of and then downgrade fail with.

pub fn err_status<T>(&self, status: T) -> HostErrorwhere Status: From<T>,

Helper for the simplest status-only error path.

pub fn err_general(&self, msg: &'static str) -> HostError

Helper for the simplest string + general-error path.

pub fn err_status_msg<T>(&self, status: T, msg: &'static str) -> HostErrorwhere Status: From<T>,

Helper for the next-simplest status-and-extended-debug-message error path.

pub fn err_status_msg_with_args<T>( &self, status: T, msg: &'static str, args: &[RawVal] ) -> HostErrorwhere Status: From<T>,

Helper for the error message with status and an arbitrary number of args.

pub fn err_conversion_into_rawval<T>(&self, rv: RawVal) -> HostError

pub fn err_conversion_general(&self, msg: &'static str) -> HostError

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

Given a result carrying some error type that can be converted to a DebugError, calls self.err with it when there’s an error. 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 Status code embedded in a HostError, add an impl From<T> for DebugError over in the events module 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 debug buffer. 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_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)

pub fn remove_source_account(&self)

pub fn source_account(&self) -> Option<AccountId>

pub fn switch_to_recording_auth(&self)

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

pub fn set_ledger_info(&self, info: LedgerInfo)

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 with_budget<T, F>(&self, f: F) -> Twhere F: FnOnce(Budget) -> T,

Helper for mutating the Budget held in this Host, either to allocate it on contract creation or to deplete it on callbacks from the VM or host functions.

pub fn budget_cloned(&self) -> Budget

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

pub fn set_diagnostic_level(&self, diagnostic_level: DiagnosticLevel)

pub fn is_debug(&self) -> bool

pub fn record_debug_event<T>(&self, src: T) -> Result<(), HostError>where DebugEvent: From<T>,

Records a debug event. This in itself is not necessarily an error; it might just be some contextual event we want to put in a debug log for diagnostic purpopses. The return value from this is therefore () when the event is recorded successfully, even if the event itself represented some other error. This function only returns Err(…) when there was a failure to record the event, such as when budget is exceeded.

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

Accept a unique (refcount = 1) host reference and destroy the underlying [HostImpl], returning its constituent components to the caller as a tuple wrapped in Ok(...). If the provided host reference is not unique, returns Err(self).

pub fn with_test_contract_frame<F>( &self, id: Hash, func: Symbol, f: F ) -> Result<RawVal, HostError>where F: FnOnce() -> Result<RawVal, 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 call_account_contract_check_auth( &self, contract: BytesObject, args: VecObject ) -> Result<RawVal, 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 inject_val(&self, v: &ScVal) -> Result<RawVal, HostError>

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

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

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

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

pub fn get_recorded_top_authorizations( &self ) -> Result<Vec<(ScAddress, Hash, ScSymbol, ScVec)>, HostError>

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

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

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

Trait Implementations

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<AccessType> for Host

type Error = HostError

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

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<ContractCodeEntry> for Host

type Error = HostError

fn compare( &self, a: &ContractCodeEntry, b: &ContractCodeEntry ) -> 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<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 K: MeteredClone, V: MeteredClone, 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<ScContractExecutable> for Host

type Error = HostError

fn compare( &self, a: &ScContractExecutable, b: &ScContractExecutable ) -> 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() -> Host

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 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: &[RawVal] ) -> 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 [RawVal] ) -> Result<Void, HostError>

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

fn vec_new_from_slice(&self, vals: &[RawVal]) -> 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 [RawVal] ) -> 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_static_fmt_val( &self, fmt: &'static str, v: RawVal ) -> Result<(), HostError>

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

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

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

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

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

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

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

impl VmCallerEnv for Host

type VmUserState = Host

fn log_value( &self, _vmcaller: &mut VmCaller<'_, Host>, v: RawVal ) -> Result<Void, HostError>

This one variant of logging does not take a format string and is live in both Env=Guest and Env=Host configurations.

fn log_fmt_values( &self, _vmcaller: &mut VmCaller<'_, Host>, fmt: StringObject, args: VecObject ) -> Result<Void, HostError>

Record a debug event. Fmt must be a Bytes. Args must be a Vec. Void is returned.

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

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

fn obj_cmp( &self, _vmcaller: &mut VmCaller<'_, Host>, a: RawVal, b: RawVal ) -> 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: RawVal ) -> 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 On success, returns an SCStatus::Ok.

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

Get the Address object for the current contract.

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

Convert a u64 to an object containing a u64.

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

Convert an object containing a i64 to a u64.

fn obj_from_i64( &self, _vmcaller: &mut VmCaller<'_, Host>, i: i64 ) -> Result<I64Object, HostError>

Convert an i64 to an object containing an i64.

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

Convert an object containing an i64 to an i64.

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

Convert the low and high 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>, lo: u64, hi: u64 ) -> Result<I128Object, Self::Error>

Convert the lo and hi 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<u64, Self::Error>

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

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: RawVal, v: RawVal ) -> 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: RawVal ) -> Result<RawVal, 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: RawVal ) -> 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: RawVal ) -> Result<Bool, HostError>

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

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

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

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

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

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

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

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

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

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 set of input slices given by linear-memory addresses and lengths.

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 the RawVal values of a map, as described by set of input keys, into an array at a given linear-memory address.

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

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

fn vec_put( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, i: U32Val, x: RawVal ) -> 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<RawVal, 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: RawVal ) -> 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: RawVal ) -> 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<RawVal, 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<RawVal, 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: RawVal ) -> 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: RawVal ) -> Result<RawVal, 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 ScStatic::Void.

fn vec_last_index_of( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: RawVal ) -> Result<RawVal, 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 ScStatic::Void.

fn vec_binary_search( &self, _vmcaller: &mut VmCaller<'_, Host>, v: VecObject, x: RawVal ) -> 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 RawVals given by a linear-memory address and length.

fn vec_unpack_to_linear_memory( &self, vmcaller: &mut VmCaller<'_, Host>, vec: VecObject, vals_pos: U32Val, len: U32Val ) -> Result<Void, HostError>

Copy the RawVals of a vec into an array at a given linear-memory address.

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

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

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

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

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

Deploys a contract from the current contract. wasm_hash must be a hash of the contract code that has already been installed on this network. salt is used to create a unique contract id.

fn call( &self, _vmcaller: &mut VmCaller<'_, Host>, contract: BytesObject, func: Symbol, args: VecObject ) -> Result<RawVal, HostError>

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

fn try_call( &self, vmcaller: &mut VmCaller<'_, Host>, contract: BytesObject, func: Symbol, args: VecObject ) -> Result<RawVal, HostError>

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.

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

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

fn deserialize_from_bytes( &self, _vmcaller: &mut VmCaller<'_, Host>, b: BytesObject ) -> Result<RawVal, 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, i: 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, i: 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 verify_sig_ed25519( &self, _vmcaller: &mut VmCaller<'_, Host>, x: BytesObject, k: BytesObject, s: BytesObject ) -> Result<Void, HostError>

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_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_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_status( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState>, status: Status ) -> Result<Void, Self::Error>

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

fn dummy0( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState> ) -> Result<RawVal, 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<RawVal, 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<RawVal, 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 get_current_contract_id( &self, vmcaller: &mut VmCaller<'_, Self::VmUserState> ) -> Result<BytesObject, Self::Error>

Gets the 32-byte identifer of the current contract. Traps if the running contract was not invoked by a contract.

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<RawVal, 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 RawVal corresponding to the unit type (()).

fn address_to_contract_id( &self, _vmcaller: &mut VmCaller<'_, Self::VmUserState>, address: AddressObject ) -> Result<RawVal, Self::Error>

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