Struct RuntimeContext

pub struct RuntimeContext<'a, R> { /* private fields */ }

Holds information specific to the deployed contract.

Implementations

impl<'a, R> RuntimeContext<'a, R>

where R: StateReader<Key, StoredValue, Error = Error>,

pub fn new( named_keys: &'a mut NamedKeys, runtime_footprint: Rc<RefCell<RuntimeFootprint>>, context_key: Key, authorization_keys: BTreeSet<AccountHash>, access_rights: ContextAccessRights, account_hash: AccountHash, address_generator: Rc<RefCell<AddressGenerator>>, tracking_copy: Rc<RefCell<TrackingCopy<R>>>, engine_config: EngineConfig, block_info: BlockInfo, transaction_hash: TransactionHash, phase: Phase, args: RuntimeArgs, gas_limit: Gas, gas_counter: Gas, transfers: Vec<Transfer>, remaining_spending_limit: U512, entry_point_type: EntryPointType, allow_install_upgrade: AllowInstallUpgrade, ) -> Self

Creates new runtime context where we don’t already have one.

Where we already have a runtime context, consider using new_from_self().

pub fn new_from_self( &self, context_key: Key, entry_point_type: EntryPointType, named_keys: &'a mut NamedKeys, access_rights: ContextAccessRights, runtime_args: RuntimeArgs, ) -> Self

Creates new runtime context cloning values from self.

pub fn authorization_keys(&self) -> &BTreeSet<AccountHash>

Returns all authorization keys for this deploy.

pub fn named_keys_get(&self, name: &str) -> Option<&Key>

Returns a named key by a name if it exists.

pub fn named_keys(&self) -> &NamedKeys

Returns named keys.

pub fn named_keys_mut(&mut self) -> &mut NamedKeys

Returns a mutable reference to named keys.

pub fn named_keys_contains_key(&self, name: &str) -> bool

Checks if named keys contains a key referenced by name.

pub fn maybe_payment_purse(&self) -> Option<URef>

Returns the payment purse, if set.

pub fn set_payment_purse(&mut self, uref: URef)

Sets the payment purse to the imputed uref.

pub fn engine_config(&self) -> &EngineConfig

Returns an instance of the engine config.

pub fn remove_key(&mut self, name: &str) -> Result<(), ExecError>

Remove Key from the named_keys map of the current context. It removes both from the ephemeral map (RuntimeContext::named_keys) but also the to-be-persisted map (in the TrackingCopy/GlobalState).

pub fn get_block_info(&self) -> BlockInfo

Returns block info.

pub fn get_transaction_hash(&self) -> TransactionHash

Returns the transaction hash.

pub fn access_rights_extend(&mut self, urefs: &[URef])

Extends access rights with a new map.

pub fn access_rights(&self) -> &ContextAccessRights

Returns a mapping of access rights for each URefs address.

pub fn runtime_footprint(&self) -> Rc<RefCell<RuntimeFootprint>>

Returns footprint of the caller.

pub fn args(&self) -> &RuntimeArgs

Returns arguments.

pub fn address_generator(&self) -> Rc<RefCell<AddressGenerator>>

Returns new shared instance of an address generator.

pub fn gas_limit(&self) -> Gas

Returns the gas limit.

pub fn gas_counter(&self) -> Gas

Returns the current gas counter.

pub fn set_gas_counter(&mut self, new_gas_counter: Gas)

Sets the gas counter to a new value.

pub fn get_context_key(&self) -> Key

Returns the context key for this instance.

pub fn get_initiator(&self) -> AccountHash

Returns the initiator of the call chain.

pub fn protocol_version(&self) -> ProtocolVersion

Returns the protocol version.

pub fn phase(&self) -> Phase

Returns the current phase.

pub fn install_upgrade_allowed(&self) -> bool

Returns true if the execution is permitted to call casper_add_contract_version().

pub fn new_hash_address(&mut self) -> Result<[u8; 32], ExecError>

Generates new deterministic hash for uses as an address.

pub fn random_bytes(&mut self) -> Result<[u8; 32], ExecError>

Returns 32 pseudo random bytes.

pub fn new_uref(&mut self, value: StoredValue) -> Result<URef, ExecError>

Creates new URef instance.

pub fn put_key(&mut self, name: String, key: Key) -> Result<(), ExecError>

Puts key to the map of named keys of current context.

pub fn read_gs(&mut self, key: &Key) -> Result<Option<StoredValue>, ExecError>

Read a stored value under a Key.

pub fn read_gs_unsafe( &mut self, key: &Key, ) -> Result<Option<StoredValue>, ExecError>

Reads a value from a global state directly.

Usage

DO NOT EXPOSE THIS VIA THE FFI - This function bypasses security checks and should be used with caution.

pub fn read_gs_typed<T>(&mut self, key: &Key) -> Result<T, ExecError>

where T: TryFrom<StoredValue, Error = StoredValueTypeMismatch>, T::Error: Debug,

This method is a wrapper over read_gs in the sense that it extracts the type held by a StoredValue stored in the global state in a type safe manner.

This is useful if you want to get the exact type from global state.

pub fn get_keys(&mut self, key_tag: &KeyTag) -> Result<BTreeSet<Key>, ExecError>

Returns all keys based on the tag prefix.

pub fn get_keys_with_prefix( &mut self, prefix: &[u8], ) -> Result<Vec<Key>, ExecError>

Returns all key’s that start with prefix, if any.

pub fn write_era_info(&mut self, key: Key, value: EraInfo)

Write an era info instance to the global state.

pub fn write_account( &mut self, key: Key, account: Account, ) -> Result<(), ExecError>

Write an account to the global state.

pub fn read_account( &mut self, key: &Key, ) -> Result<Option<StoredValue>, ExecError>

Read an account from the global state.

pub fn grant_access(&mut self, uref: URef) -> GrantedAccess

Grants access to a URef; unless access was pre-existing.

pub fn remove_access( &mut self, uref_addr: URefAddr, access_rights: AccessRights, )

Removes an access right from the current runtime context.

pub fn effects(&self) -> Effects

Returns a copy of the current effects of a tracking copy.

pub fn messages(&self) -> Messages

Returns a copy of the current messages of a tracking copy.

pub fn cache(&self) -> TrackingCopyCache

Returns a copy of the current named keys of a tracking copy.

pub fn emit_message_cost(&self) -> U512

Returns the cost charged for the last emitted message.

pub fn set_emit_message_cost(&mut self, cost: U512)

Sets the cost charged for the last emitted message.

pub fn transfers(&self) -> &Vec<Transfer>

Returns list of transfers.

pub fn transfers_mut(&mut self) -> &mut Vec<Transfer>

Returns mutable list of transfers.

pub fn is_readable(&self, key: &Key) -> bool

Tests whether reading from the key is valid.

pub fn is_addable(&self, key: &Key) -> bool

Tests whether addition to key is valid.

pub fn is_writeable(&self, key: &Key) -> bool

Tests whether writing to key is valid.

pub fn get_main_purse(&mut self) -> Result<URef, ExecError>

Gets main purse id

pub fn entry_point_type(&self) -> EntryPointType

Gets entry point type.

pub fn dictionary_put( &mut self, seed_uref: URef, dictionary_item_key: &str, cl_value: CLValue, ) -> Result<(), ExecError>

Puts a dictionary item key from a dictionary referenced by a uref.

pub fn system_entity_registry(&self) -> Result<SystemHashRegistry, ExecError>

Returns system entity registry by querying the global state.