Struct casper_execution_engine::core::runtime_context::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>, R::Error: Into<Error>,

pub fn new( tracking_copy: Rc<RefCell<TrackingCopy<R>>>, entry_point_type: EntryPointType, named_keys: &'a mut NamedKeys, access_rights: ContextAccessRights, runtime_args: RuntimeArgs, authorization_keys: BTreeSet<AccountHash>, account: &'a Account, base_key: Key, blocktime: BlockTime, deploy_hash: DeployHash, gas_limit: Gas, gas_counter: Gas, address_generator: Rc<RefCell<AddressGenerator>>, protocol_version: ProtocolVersion, correlation_id: CorrelationId, phase: Phase, engine_config: EngineConfig, transfers: Vec<TransferAddr>, remaining_spending_limit: U512 ) -> 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, base_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 remove_key(&mut self, name: &str) -> Result<(), Error>

Remove Key from the named_keys map of the current context. It removes both from the ephemeral map (RuntimeContext::named_keys) but also persistable map (one that is found in the TrackingCopy/GlobalState).

pub fn get_caller(&self) -> AccountHash

Returns the caller of the contract.

pub fn get_blocktime(&self) -> BlockTime

Returns the block time.

pub fn get_deploy_hash(&self) -> DeployHash

Returns the deploy 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 account(&self) -> &'a Account

Returns account 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 base_key(&self) -> Key

Returns the base key.

This could be either a Key::Account or a Key::Hash depending on the entry point type.

pub fn protocol_version(&self) -> ProtocolVersion

Returns the protocol version.

pub fn correlation_id(&self) -> CorrelationId

Returns the correlation id.

pub fn phase(&self) -> Phase

Returns the current phase.

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

Generates new deterministic hash for uses as an address.

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

Returns 32 pseudo random bytes.

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

Creates new URef instance.

pub fn new_transfer_addr(&mut self) -> Result<TransferAddr, Error>

Creates a new transfer address using a transfer address generator.

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

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

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

Read a stored value under a Key.

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

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, Error>where T: TryFrom<StoredValue>, 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>, Error>

Returns all keys based on the tag prefix.

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

Read an account from the global state.

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

Write an account to the global state.

pub fn write_transfer(&mut self, key: Key, value: Transfer)

Write a transfer instance to the global state.

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

Write an era info instance to 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 effect(&self) -> ExecutionEffect

Returns current effects of a tracking copy.

pub fn execution_journal(&self) -> ExecutionJournal

Returns an ExecutionJournal.

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

Returns list of transfers.

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

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

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

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

pub fn system_contract_registry(&self) -> Result<SystemContractRegistry, Error>

Returns system contract registry by querying the global state.