Module frame::runtime::prelude

source ·
Expand description

The main prelude of FRAME for building runtimes.

A runtime typically starts with:

use frame::{prelude::*, runtime::prelude::*};

Macros

  • construct_runtime
    Macro to amalgamate the runtime into struct Runtime. Construct a runtime, with the given name and the given pallets.
  • create_runtime_str
    Types to define your runtime version. Create a const RuntimeString.
  • impl_runtime_apis
    Macro to implement runtime APIs.
  • ord_parameter_types
    Macros to easily impl traits such as Get for types. Macro for easily creating a new implementation of both the Get and Contains traits. Use exactly as with parameter_types, only the type must be Ord.
  • parameter_types
    Macros to easily impl traits such as Get for types. Create new implementations of the Get trait.

Structs

  • ConstBool
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstI8
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstI16
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstI32
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstI64
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstI128
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstU8
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstU16
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstU32
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstU64
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • ConstU128
    Const types that can easily be used in conjuncture with Get. Const getter for a basic type.
  • Executive
    All of the types related to the FRAME runtime executive. Main entry point for certain runtime actions as e.g. execute_block.
  • NativeVersion
    The version of the native runtime.
  • RuntimeVersion
    Types to define your runtime version. Runtime version. This should not be thought of as classic Semver (major/minor/tiny). This triplet have different semantics and mis-interpretation could cause problems. In particular: bug fixes should result in an increment of spec_version and possibly authoring_version, absolutely not impl_version since they change the semantics of the runtime.

Type Definitions

  • CallOf
    All of the types related to the FRAME runtime executive.
  • CheckedOf
    All of the types related to the FRAME runtime executive.
  • OriginOf
    All of the types related to the FRAME runtime executive.

Attribute Macros

  • derive_impl
    Macro to easily derive the Config trait of various pallet for Runtime. This attribute can be used to derive a full implementation of a trait based on a local partial impl and an external impl containing defaults that can be overriden in the local impl.
  • runtime_version
    Types to define your runtime version.