Trait Context

pub trait Context {
    type Runtime: Runtime;

    // Required methods
    fn clone(&self) -> Self;
    fn get_logger(&self, module: &'static str) -> Logger;
    fn host_info(&self) -> &HostInfo;
    fn key_manager(&self) -> Option<&dyn KeyManager>;
    fn runtime_header(&self) -> &Header;
    fn runtime_round_results(&self) -> &RoundResults;
    fn consensus_state(&self) -> &ConsensusState;
    fn history(&self) -> &dyn HistoryHost;
    fn epoch(&self) -> EpochTime;
    fn max_messages(&self) -> u32;

    // Provided methods
    fn should_execute_contracts(&self) -> bool { ... }
    fn is_allowed_query<R: Runtime>(&self, method: &str) -> bool { ... }
    fn local_config<T>(&self, key: &str) -> Option<T>
       where T: Decode { ... }
    fn runtime_id(&self) -> &Namespace { ... }
    fn is_confidential(&self) -> bool { ... }
    fn now(&self) -> u64 { ... }
}

Runtime SDK context.

Required Associated Types

type Runtime: Runtime

Runtime that the context is being invoked in.

Required Methods

fn clone(&self) -> Self

Clone this context.

fn get_logger(&self, module: &'static str) -> Logger

Returns a logger.

fn host_info(&self) -> &HostInfo

Information about the host environment.

fn key_manager(&self) -> Option<&dyn KeyManager>

The key manager, if the runtime is confidential.

fn runtime_header(&self) -> &Header

Last runtime block header.

fn runtime_round_results(&self) -> &RoundResults

Results of executing the last successful runtime round.

fn consensus_state(&self) -> &ConsensusState

Consensus state.

fn history(&self) -> &dyn HistoryHost

Historical state.

fn epoch(&self) -> EpochTime

Current epoch.

fn max_messages(&self) -> u32

Maximum number of consensus messages that the runtime can emit in this block.

Provided Methods

fn should_execute_contracts(&self) -> bool

Whether smart contracts should be executed in this context.

fn is_allowed_query<R: Runtime>(&self, method: &str) -> bool

Whether method is an allowed query per policy in the local config.

fn local_config<T>(&self, key: &str) -> Option<T>

where T: Decode,

Returns node operator-provided local configuration.

This method will always return None in Mode::ExecuteTx contexts.

fn runtime_id(&self) -> &Namespace

Runtime ID.

fn is_confidential(&self) -> bool

Whether the context has a key manager available (e.g. the runtime is confidential).

fn now(&self) -> u64

UNIX timestamp of the current block.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<R: Runtime> Context for RuntimeBatchContext<'_, R>

type Runtime = R