mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 12:17:58 +00:00
Chevdor
a30092ab42
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
# Executive Module
|
|
|
|
The Executive module acts as the orchestration layer for the runtime. It dispatches incoming extrinsic calls to the
|
|
respective modules in the runtime.
|
|
|
|
## Overview
|
|
|
|
The executive module is not a typical pallet providing functionality around a specific feature. It is a cross-cutting
|
|
framework component for the FRAME. It works in conjunction with the [FRAME System
|
|
module](https://docs.rs/frame-system/latest/frame_system/) to perform these cross-cutting functions.
|
|
|
|
The Executive module provides functions to:
|
|
|
|
- Check transaction validity.
|
|
- Initialize a block.
|
|
- Apply extrinsics.
|
|
- Execute a block.
|
|
- Finalize a block.
|
|
- Start an off-chain worker.
|
|
|
|
### Implementations
|
|
|
|
The Executive module provides the following implementations:
|
|
|
|
- `Executive`: Type that can be used to make the FRAME available from the runtime.
|
|
|
|
## Usage
|
|
|
|
The default Substrate node template declares the
|
|
[`Executive`](https://docs.rs/frame-executive/latest/frame_executive/struct.Executive.html) type in its library.
|
|
|
|
### Example
|
|
|
|
`Executive` type declaration from the node template.
|
|
|
|
```rust
|
|
#
|
|
/// Executive: handles dispatch to the various modules.
|
|
pub type Executive = executive::Executive<
|
|
Runtime,
|
|
Block,
|
|
Context,
|
|
Runtime,
|
|
AllPallets,
|
|
>;
|
|
```
|
|
|
|
### Custom `OnRuntimeUpgrade` logic
|
|
|
|
You can add custom logic that should be called in your runtime on a runtime upgrade. This is done by setting an optional
|
|
generic parameter. The custom logic will be called before the on runtime upgrade logic of all modules is called.
|
|
|
|
```rust
|
|
#
|
|
struct CustomOnRuntimeUpgrade;
|
|
impl frame_support::traits::OnRuntimeUpgrade for CustomOnRuntimeUpgrade {
|
|
fn on_runtime_upgrade() -> frame_support::weights::Weight {
|
|
// Do whatever you want.
|
|
frame_support::weights::Weight::zero()
|
|
}
|
|
}
|
|
|
|
pub type Executive = executive::Executive<
|
|
Runtime,
|
|
Block,
|
|
Context,
|
|
Runtime,
|
|
AllPallets,
|
|
CustomOnRuntimeUpgrade,
|
|
>;
|
|
```
|
|
|
|
License: Apache-2.0
|