Expand description
The client for AssetHub, intended to be used in the relay chain.
The counter-part for this pallet is pallet-staking-async-rc-client
on AssetHub.
This documentation is divided into the following sections:
- Incoming messages: the messages that we receive from the relay chian.
- Outgoing messages: the messaged that we sent to the relay chain.
- Local interfaces: the interfaces that we expose to other pallets in the runtime.
§Incoming Messages
All incoming messages are handled via Call
. They are all gated to be dispatched only by
Config::AssetHubOrigin
. The only one is:
Call::validator_set
: A new validator set for a planning session index.
§Outgoing Messages
All outgoing messages are handled by a single trait SendToAssetHub
. They match the
incoming messages of the ah-client
pallet.
§Local Interfaces:
Living on the relay chain, this pallet must:
- Implement [
pallet_session::SessionManager
] (and historical variant thereof) to give information to the session pallet. - Implements
SessionInterface
to receive information from the session pallet - Implement [
sp_staking::offence::OnOffenceHandler
]. - Implement reward related APIs ([
frame_support::traits::RewardsReporter
]).
§Future Plans
- Governance functions to force set validators.
Re-exports§
pub use weights::WeightInfo;
pub use pallet::*;
Modules§
- benchmarking
- Benchmarking setup for pallet-staking-async-ah-client
- pallet
- The
pallet
module in each FRAME pallet hosts the most important items needed to construct this pallet. - weights
- Autogenerated weights for
pallet_staking_async_ah_client
Macros§
Structs§
- Buffered
Offence - Default
Exposure Of - See
pallet_staking::DefaultExposureOf
. This type is the same, except it is duplicated here so that an rc-runtime can use it afterpallet-staking
is fully removed as a dependency.
Enums§
- Operating
Mode - Represents the operating mode of the pallet.
Traits§
- Send
ToAsset Hub - The interface to communicate to asset hub.
- Session
Interface - Interface to talk to the local session pallet.
Type Aliases§
- Balance
Of - The balance type seen from this pallet’s PoV.
- Buffered
Offences Map - A map of buffered offences, keyed by session index and then by offender account id.
- Offence
Details Of - Type alias for offence details