Struct oasis_runtime_sdk::modules::rofl::Module

pub struct Module<Cfg: Config> { /* private fields */ }

Trait Implementations

impl<Cfg: Config> API for Module<Cfg>

fn get_origin_rak() -> Option<PublicKey>

Get the Runtime Attestation Key of the ROFL app instance in case the origin transaction is signed by a ROFL instance. Otherwise None is returned.

fn get_origin_registration(app: AppId) -> Option<Registration>

Get the registration descriptor of the ROFL app instance in case the origin transaction is signed by a ROFL instance of the specified app. Otherwise None is returned.

fn is_authorized_origin(app: AppId) -> bool

Verify whether the origin transaction is signed by an authorized ROFL instance for the given application.

fn get_registration(app: AppId, rak: PublicKey) -> Result<Registration, Error>

Get a specific registered instance for an application.

fn get_app(id: AppId) -> Result<AppConfig, Error>

Get an application’s configuration.

fn get_instances(id: AppId) -> Result<Vec<Registration>, Error>

Get all registered instances for an application.

impl<Cfg: Config> BlockHandler for Module<Cfg>

fn end_block<C: Context>(ctx: &C)

Perform any common actions at the end of the block (after all transactions have been executed).

fn begin_block<C: Context>(_ctx: &C)

Perform any common actions at the start of the block (before any transactions have been executed).

impl<Cfg: Config> FeeProxyHandler for Module<Cfg>

fn resolve_payer<C: Context>( ctx: &C, tx: &Transaction, ) -> Result<Option<Address>, Error>

Resolve the proxy payer for the given transaction. If no payer could be resolved, None should be returned.

impl<Cfg: Config> InvariantHandler for Module<Cfg>

fn check_invariants<C: Context>(_ctx: &C) -> Result<(), Error>

Check invariants.

impl<Cfg: Config> MethodHandler for Module<Cfg>

fn dispatch_call<C: Context>( ctx: &C, method: &str, body: Value, ) -> DispatchResult<Value, CallResult>

Dispatch a call.

fn dispatch_query<C: Context>( ctx: &C, method: &str, args: Value, ) -> DispatchResult<Value, Result<Value, RuntimeError>>

Dispatch a query.

fn supported_methods() -> Vec<MethodHandlerInfo>

Lists the names of all RPC methods exposed by this module. The result is informational only. An empty return vector means that the implementor does not care to list the methods, or the implementor is a tuple of modules.

fn is_expensive_query(method: &str) -> bool

Checks whether the given query method is tagged as expensive.

fn prefetch( _prefixes: &mut BTreeSet<Prefix>, _method: &str, body: Value, _auth_info: &AuthInfo, ) -> DispatchResult<Value, Result<(), RuntimeError>>

Add storage prefixes to prefetch.

fn dispatch_message_result<C: Context>( _ctx: &C, _handler_name: &str, result: MessageResult, ) -> DispatchResult<MessageResult, ()>

Dispatch a message result.

fn is_allowed_private_km_query(_method: &str) -> bool

Checks whether the given query is allowed to access private key manager state.

fn is_allowed_interactive_call(_method: &str) -> bool

Checks whether the given call is allowed to be called interactively via read-only transactions.

impl<Cfg: Config> MigrationHandler for Module<Cfg>

type Genesis = Genesis

Genesis state type.

fn init_or_migrate<C: Context>( _ctx: &C, meta: &mut Metadata, genesis: Self::Genesis, ) -> bool

Initialize state from genesis or perform a migration.

impl<Cfg: Config> Module for Module<Cfg>

const NAME: &'static str = MODULE_NAME

Module name.

type Error = Error

Module error type.

type Event = Event

Module event type.

type Parameters = Parameters

Module parameters.

const VERSION: u32 = 1u32

Module version.

fn params() -> Self::Parameters

Return the module’s parameters.

fn set_params(params: Self::Parameters)

Set the module’s parameters.

impl<Cfg: Config> TransactionHandler for Module<Cfg>

fn approve_raw_tx<C: Context>(_ctx: &C, _tx: &[u8]) -> Result<(), Error>

Judge if a raw transaction is good enough to undergo decoding. This takes place before even decoding the transaction.

fn approve_unverified_tx<C: Context>( _ctx: &C, _utx: &UnverifiedTransaction, ) -> Result<(), Error>

Judge if an unverified transaction is good enough to undergo verification. This takes place before even verifying signatures.

fn decode_tx<C: Context>( _ctx: &C, _scheme: &str, _body: &[u8], ) -> Result<Option<Transaction>, Error>

Decode a transaction that was sent with module-controlled decoding and verify any signatures.

fn authenticate_tx<C: Context>( _ctx: &C, _tx: &Transaction, ) -> Result<AuthDecision, Error>

Authenticate a transaction.

fn before_handle_call<C: Context>(_ctx: &C, _call: &Call) -> Result<(), Error>

Perform any action after authentication, within the transaction context.

fn before_authorized_call_dispatch<C: Context>( _ctx: &C, _call: &Call, ) -> Result<(), Error>

Perform any action after authentication and decoding, within the transaction context.

fn after_handle_call<C: Context>( _ctx: &C, result: CallResult, ) -> Result<CallResult, Error>

Perform any action after call, within the transaction context.

fn after_dispatch_tx<C: Context>( _ctx: &C, _tx_auth_info: &AuthInfo, _result: &CallResult, )

Perform any action after dispatching the transaction, in batch context.