Struct ContractRuntime 

pub struct ContractRuntime<Application>
where
    Application: Contract,
{ /* private fields */ }

The common runtime to interface with the host executing the contract.

It automatically caches read-only values received from the host.

Implementations

impl<Application> ContractRuntime<Application>

where Application: Contract,

pub fn key_value_store(&self) -> KeyValueStore

Returns the key-value store to interface with storage.

pub fn root_view_storage_context(&self) -> ViewStorageContext

Returns a storage context suitable for a root view.

impl<Application> ContractRuntime<Application>

where Application: Contract,

pub fn application_parameters(&mut self) -> Application::Parameters

Returns the application parameters provided when the application was created.

pub fn application_id(&mut self) -> ApplicationId<Application::Abi>

Returns the ID of the current application.

pub fn application_creator_chain_id(&mut self) -> ChainId

Returns the chain ID of the current application creator.

pub fn chain_id(&mut self) -> ChainId

Returns the ID of the current chain.

pub fn block_height(&mut self) -> BlockHeight

Returns the height of the current block that is executing.

pub fn system_time(&mut self) -> Timestamp

Retrieves the current system time, i.e. the timestamp of the block in which this is called.

pub fn chain_balance(&mut self) -> Amount

Returns the current chain balance.

pub fn owner_balance(&mut self, owner: AccountOwner) -> Amount

Returns the balance of one of the accounts on this chain.

pub fn chain_ownership(&mut self) -> ChainOwnership

Retrieves the owner configuration for the current chain.

pub fn http_request(&mut self, request: Request) -> Response

Makes an HTTP request as an oracle and returns the HTTP response.

Should only be used with queries where it is very likely that all validators will receive the same response, otherwise most block proposals will fail.

Cannot be used in fast blocks: A block using this call should be proposed by a regular owner, not a super owner.

pub fn assert_before(&mut self, timestamp: Timestamp)

Panics if the current time at block validation is >= timestamp. Note that block validation happens at or after the block timestamp, but isn’t necessarily the same.

Cannot be used in fast blocks: A block using this call should be proposed by a regular owner, not a super owner.

pub fn read_data_blob(&mut self, hash: DataBlobHash) -> Vec<u8>

Reads a data blob with the given hash from storage.

pub fn assert_data_blob_exists(&mut self, hash: DataBlobHash)

Asserts that a data blob with the given hash exists in storage.

impl<Application> ContractRuntime<Application>

where Application: Contract,

pub fn authenticated_signer(&mut self) -> Option<AccountOwner>

Returns the authenticated signer for this execution, if there is one.

pub fn message_is_bouncing(&mut self) -> Option<bool>

Returns true if the incoming message was rejected from the original destination and is now bouncing back, or None if not executing an incoming message.

pub fn message_origin_chain_id(&mut self) -> Option<ChainId>

Returns the chain ID where the incoming message originated from, or None if not executing an incoming message.

pub fn authenticated_caller_id(&mut self) -> Option<ApplicationId>

Returns the authenticated caller ID, if the caller configured it and if the current context is executing a cross-application call.

pub fn check_account_permission( &mut self, owner: AccountOwner, ) -> Result<(), AccountPermissionError>

Verifies that the current execution context authorizes operations on a given account.

pub fn send_message( &mut self, destination: ChainId, message: Application::Message, )

Schedules a message to be sent to this application on another chain.

pub fn prepare_message( &mut self, message: Application::Message, ) -> MessageBuilder<Application::Message>

Returns a MessageBuilder to prepare a message to be sent.

pub fn transfer( &mut self, source: AccountOwner, destination: Account, amount: Amount, )

Transfers an amount of native tokens from source owner account (or the current chain’s balance) to destination.

pub fn claim(&mut self, source: Account, destination: Account, amount: Amount)

Claims an amount of native tokens from a source account to a destination account.

pub fn call_application<A: ContractAbi + Send>( &mut self, authenticated: bool, application: ApplicationId<A>, call: &A::Operation, ) -> A::Response

Calls another application.

pub fn emit(&mut self, name: StreamName, value: &Application::EventValue) -> u32

Adds a new item to an event stream. Returns the new event’s index in the stream.

pub fn read_event( &mut self, chain_id: ChainId, name: StreamName, index: u32, ) -> Application::EventValue

Reads an event from a stream. Returns the event’s value.

Fails the block if the event doesn’t exist.

pub fn subscribe_to_events( &mut self, chain_id: ChainId, application_id: ApplicationId, name: StreamName, )

Subscribes this application to an event stream.

pub fn unsubscribe_from_events( &mut self, chain_id: ChainId, application_id: ApplicationId, name: StreamName, )

Unsubscribes this application from an event stream.

pub fn query_service<A: ServiceAbi + Send>( &mut self, application_id: ApplicationId<A>, query: A::Query, ) -> A::QueryResponse

Queries an application service as an oracle and returns the response.

Should only be used with queries where it is very likely that all validators will compute the same result, otherwise most block proposals will fail.

Cannot be used in fast blocks: A block using this call should be proposed by a regular owner, not a super owner.

pub fn open_chain( &mut self, chain_ownership: ChainOwnership, application_permissions: ApplicationPermissions, balance: Amount, ) -> ChainId

Opens a new chain, configuring it with the provided chain_ownership, application_permissions and initial balance (debited from the current chain).

pub fn close_chain(&mut self) -> Result<(), CloseChainError>

Closes the current chain. Returns an error if the application doesn’t have permission to do so.

pub fn change_application_permissions( &mut self, application_permissions: ApplicationPermissions, ) -> Result<(), ChangeApplicationPermissionsError>

Changes the application permissions for the current chain.

pub fn create_application<Abi, Parameters, InstantiationArgument>( &mut self, module_id: ModuleId, parameters: &Parameters, argument: &InstantiationArgument, required_application_ids: Vec<ApplicationId>, ) -> ApplicationId<Abi>

where Abi: ContractAbi, Parameters: Serialize, InstantiationArgument: Serialize,

Creates a new on-chain application, based on the supplied module and parameters.

pub fn create_data_blob(&mut self, bytes: Vec<u8>) -> DataBlobHash

Creates a new data blob and returns its hash.

pub fn publish_module( &mut self, contract: Bytecode, service: Bytecode, vm_runtime: VmRuntime, ) -> ModuleId

Publishes a module with contract and service bytecode and returns the module ID.

pub fn validation_round(&mut self) -> Option<u32>

Returns the round in which this block was validated.

Trait Implementations

impl<Application> Debug for ContractRuntime<Application>

where Application: Contract + Debug, Application::Parameters: Debug, Application::Abi: Debug,

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

Formats the value using the given formatter.