Struct oasis_runtime_sdk::modules::consensus::Module

pub struct Module;

Implementations

impl Module

pub fn init(genesis: Genesis)

Trait Implementations

impl API for Module

fn transfer<C: Context>( ctx: &C, to: Address, amount: &BaseUnits, hook: MessageEventHookInvocation ) -> Result<(), Error>

Transfer an amount from the runtime account.

fn withdraw<C: Context>( ctx: &C, from: Address, amount: &BaseUnits, hook: MessageEventHookInvocation ) -> Result<(), Error>

Withdraw an amount into the runtime account.

fn escrow<C: Context>( ctx: &C, to: Address, amount: &BaseUnits, hook: MessageEventHookInvocation ) -> Result<(), Error>

Escrow an amount of the runtime account funds.

fn reclaim_escrow<C: Context>( ctx: &C, from: Address, shares: u128, hook: MessageEventHookInvocation ) -> Result<(), Error>

Reclaim an amount of runtime staked shares.

fn consensus_denomination() -> Result<Denomination, Error>

Returns consensus token denomination.

fn ensure_compatible_tx_signer() -> Result<(), Error>

Ensures transaction signer is consensus compatible.

fn account<C: Context>( ctx: &C, addr: Address ) -> Result<ConsensusAccount, Error>

Query consensus account info.

fn delegation<C: Context>( ctx: &C, delegator_addr: Address, escrow_addr: Address ) -> Result<ConsensusDelegation, Error>

Query consensus delegation info.

fn amount_from_consensus<C: Context>( _ctx: &C, amount: u128 ) -> Result<u128, Error>

Convert runtime amount to consensus amount, scaling as needed.

fn amount_to_consensus<C: Context>( _ctx: &C, amount: u128 ) -> Result<u128, Error>

Convert consensus amount to runtime amount, scaling as needed.

fn height_for_epoch<C: Context>(ctx: &C, epoch: EpochTime) -> Result<u64, Error>

Determine consensus height corresponding to the given epoch transition. This query may be expensive in case the epoch is far back.

fn round_roots<C: Context>( ctx: &C, runtime_id: Namespace, round: u64 ) -> Result<Option<RoundRoots>, Error>

Round roots return the round roots for the given runtime ID and round.

impl BlockHandler for Module

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 InvariantHandler for Module

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

Check invariants.

impl MethodHandler for Module

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 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_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 MigrationHandler for Module

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 Module for Module

const NAME: &'static str = MODULE_NAME

Module name.

const VERSION: u32 = 1u32

Module version.

type Error = Error

Module error type.

type Event = Event

Module event type.

type Parameters = Parameters

Module parameters.

fn params() -> Self::Parameters

Return the module’s parameters.

fn set_params(params: Self::Parameters)

Set the module’s parameters.

impl TransactionHandler for Module

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<(), 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.