Struct oasis_runtime_sdk::modules::core::Module

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

Implementations

impl<Cfg: Config> Module<Cfg>

pub fn init(genesis: Genesis)

impl<Cfg: Config> Module<Cfg>

pub fn query_estimate_gas<C: Context>( ctx: &C, args: EstimateGasQuery, ) -> Result<u64, Error>

Run a transaction in simulation and return how much gas it uses. This looks up the method in the context’s method registry. Transactions that fail still use gas, and this query will estimate that and return successfully, so do not use this query to see if a transaction will succeed.

Trait Implementations

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

type Config = Cfg

Module configuration.

fn use_batch_gas(gas: u64) -> Result<(), Error>

Attempt to use gas. If the gas specified would cause either total used to exceed its limit, fails with Error::OutOfGas or Error::BatchOutOfGas, and neither gas usage is increased.

fn use_tx_gas(gas: u64) -> Result<(), Error>

Attempt to use gas. If the gas specified would cause either total used to exceed its limit, fails with Error::OutOfGas or Error::BatchOutOfGas, and neither gas usage is increased.

fn remaining_batch_gas() -> u64

Returns the remaining batch-wide gas.

fn used_batch_gas() -> u64

Returns the total batch-wide gas used.

fn remaining_tx_gas() -> u64

Return the remaining tx-wide gas.

fn used_tx_gas() -> u64

Return the used tx-wide gas.

fn max_batch_gas() -> u64

Configured maximum amount of gas that can be used in a batch.

fn min_gas_price(denom: &Denomination) -> Option<u128>

Configured minimum gas price.

fn set_priority(priority: u64)

Sets the transaction priority to the provided amount.

fn take_priority() -> u64

Takes and returns the stored transaction priority.

fn set_sender_meta(meta: SenderMeta)

Set transaction sender metadata.

fn take_sender_meta() -> SenderMeta

Takes and returns the stored transaction sender metadata.

fn estimate_gas_search_max_iters<C: Context>(ctx: &C) -> u64

Returns the configured max iterations in the binary search for the estimate gas.

fn has_epoch_changed() -> bool

Check whether the epoch has changed since last processed block.

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_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 is_allowed_private_km_query(method: &str) -> bool

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

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_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 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 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 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_dispatch_tx<C: Context>( _ctx: &C, _tx_auth_info: &AuthInfo, _result: &CallResult, )

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