Struct oasis_runtime_sdk::modules::access::Module

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

The method access control module.

Trait Implementations

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

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

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

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

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

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_query<C: Context>( ctx: &C, method: &str, args: Value, ) -> DispatchResult<Value, Result<Value, RuntimeError>>

Dispatch a query.

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

Add storage prefixes to prefetch.

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

Dispatch a call.

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

Dispatch a message result.

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 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 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.

const VERSION: u32 = 1u32

Module version.

type Error = Error

Module error type.

type Event = ()

Module event type.

type Parameters = ()

Module parameters.

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 before_authorized_call_dispatch<C: Context>( _ctx: &C, call: &Call, ) -> Result<(), Error>

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

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 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.