pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-26 15:47:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add srml readme, clarify comment in staking (#3151)

Browse Source 
* add srml readme, nit on staking/lib.rs

* increase impl version, not spec version

* change back impl
This commit is contained in:
Amar Singh
2019-07-21 15:22:11 +02:00
committed by Kian Peymani
parent a7a4caed1a
commit 4bbfaa9c8f
2 changed files with 25 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/srml/README.adoc
+24 -2
View File
@@ -1,4 +1,26 @@
= Runtime
= SRML
Set of libs for the substrate runtime.
The Substrate Runtime Module Library (SRML) is a collection of runtime modules.
== What are runtime modules?
A Substrate runtime can be composed of several smaller components for separation of concerns. These components are called runtime _modules_. Each runtime module packages together a set of functions (dispatchable extrinsic calls, public or private, mutable or immutable), storage items, and events.
There are four primary components that support runtime modules:
=== system module
https://github.com/paritytech/substrate/tree/master/srml/system[`system`] provides low-level APIs and utilities for other modules. https://github.com/paritytech/substrate/tree/master/srml/system[`system`] also defines all core types and extrinsic events for the Substrate runtime. *All modules depend on the system module.*
=== executive module
https://github.com/paritytech/substrate/tree/master/srml/executive[`executive`] dispatches incoming extrinsic calls to the respective modules in the runtime.
=== support macros
https://github.com/paritytech/substrate/tree/master/srml/support[`support` macros] are a collection of Rust macros to facilitate the implementation of common module components. https://github.com/paritytech/substrate/tree/master/srml/support[`support` macros] expand at runtime to generate types (e.g. `Module`, `Call`, `Store`, `Event`) which are thereafter used by the runtime to communicate with the modules. Common support macros include https://crates.parity.io/srml_support/macro.decl_module.html[`decl_module`], https://crates.parity.io/srml_support_procedural/macro.decl_storage.html[`decl_storage`], https://crates.parity.io/srml_support/macro.decl_event.html[`decl_event`], and https://crates.parity.io/srml_support/macro.ensure.html[`ensure`].
=== runtime
The runtime expands the support macros to get type and trait implementations for each module before calling https://github.com/paritytech/substrate/tree/master/srml/executive[`executive`] to dispatch calls to the individual modules. To see an example of how this might look, see https://github.com/paritytech/substrate/blob/master/node/runtime/src/lib.rs[`../node/runtime`].
substrate/srml/staking/src/lib.rs
+1 -1
View File
@@ -447,7 +447,7 @@ pub const DEFAULT_BONDING_DURATION: u32 = 1;
/// Means for interacting with a specialized version of the `session` trait.
///
/// This is needed because `Staking` sets the `ValidatorId` of the `session::Trait`
/// This is needed because `Staking` sets the `ValidatorIdOf` of the `session::Trait`
pub trait SessionInterface<AccountId>: system::Trait {
/// Disable a given validator by stash ID.
fn disable_validator(validator: &AccountId) -> Result<(), ()>;