mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 01:47:55 +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
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
# Sudo Module
|
|
|
|
- [`Config`](https://docs.rs/pallet-sudo/latest/pallet_sudo/pallet/trait.Config.html)
|
|
- [`Call`](https://docs.rs/pallet-sudo/latest/pallet_sudo/pallet/enum.Call.html)
|
|
|
|
## Overview
|
|
|
|
The Sudo module allows for a single account (called the "sudo key")
|
|
to execute dispatchable functions that require a `Root` call
|
|
or designate a new account to replace them as the sudo key.
|
|
Only one account can be the sudo key at a time.
|
|
|
|
## Interface
|
|
|
|
### Dispatchable Functions
|
|
|
|
Only the sudo key can call the dispatchable functions from the Sudo module.
|
|
|
|
- `sudo` - Make a `Root` call to a dispatchable function.
|
|
- `set_key` - Assign a new account to be the sudo key.
|
|
|
|
## Usage
|
|
|
|
### Executing Privileged Functions
|
|
|
|
The Sudo module itself is not intended to be used within other modules.
|
|
Instead, you can build "privileged functions" (i.e. functions that require `Root` origin) in other modules.
|
|
You can execute these privileged functions by calling `sudo` with the sudo key account.
|
|
Privileged functions cannot be directly executed via an extrinsic.
|
|
|
|
Learn more about privileged functions and `Root` origin in the [`Origin`] type documentation.
|
|
|
|
### Simple Code Snippet
|
|
|
|
This is an example of a module that exposes a privileged function:
|
|
|
|
```rust
|
|
#[frame_support::pallet]
|
|
pub mod pallet {
|
|
use super::*;
|
|
use frame_support::pallet_prelude::*;
|
|
use frame_system::pallet_prelude::*;
|
|
|
|
#[pallet::pallet]
|
|
pub struct Pallet<T>(_);
|
|
|
|
#[pallet::config]
|
|
pub trait Config: frame_system::Config {}
|
|
|
|
#[pallet::call]
|
|
impl<T: Config> Pallet<T> {
|
|
#[pallet::weight(0)]
|
|
pub fn privileged_function(origin: OriginFor<T>) -> DispatchResult {
|
|
ensure_root(origin)?;
|
|
|
|
// do something...
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Genesis Config
|
|
|
|
The Sudo module depends on the [`GenesisConfig`](https://docs.rs/pallet-sudo/latest/pallet_sudo/struct.GenesisConfig.html).
|
|
You need to set an initial superuser account as the sudo `key`.
|
|
|
|
## Related Modules
|
|
|
|
- [Democracy](https://docs.rs/pallet-democracy/latest/pallet_democracy/)
|
|
|
|
[`Call`]: ./enum.Call.html
|
|
[`Config`]: ./trait.Config.html
|
|
[`Origin`]: https://docs.substrate.io/main-docs/build/origins/
|
|
|
|
License: Apache-2.0
|