Shaun Wang
2e5522444a
* Use 'Pallet' struct in construct_runtime. * Fix genesis and metadata macro. * Fix 'Pallet' type alias. * Replace 'Module' with 'Pallet' for all construct_runtime use cases. * Replace more deprecated 'Module' struct. * Bring back AllModules and AllPalletsWithSystem type, but deprecate them. * Replace deprecated 'Module' struct from merge master. * Minor fix. * Fix UI tests. * Revert UI override in derive_no_bound. * Fix more deprecated 'Module' use from master branch. * Fix more deprecated 'Module' use from master branch.
Sudo Module
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 aRootcall 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:
use frame_support::{decl_module, dispatch};
use frame_system::ensure_root;
pub trait Config: frame_system::Config {}
decl_module! {
pub struct Module<T: Config> for enum Call where origin: T::Origin {
#[weight = 0]
pub fn privileged_function(origin) -> dispatch::DispatchResult {
ensure_root(origin)?;
// do something...
Ok(())
}
}
}
Genesis Config
The Sudo module depends on the GenesisConfig.
You need to set an initial superuser account as the sudo key.
Related Modules
License: Apache-2.0