Trait Config

pub trait Config<I: 'static = ()>: Config {
    type RuntimeEvent: From<Event<Self, I>> + IsType<<Self as Config>::RuntimeEvent>;
    type RewardBalance: AtLeast32BitUnsigned + Copy + Member + Parameter + MaxEncodedLen;
    type Reward: Parameter + MaxEncodedLen + Send + Sync + Copy + Clone;
    type PaymentProcedure: PaymentProcedure<Self::AccountId, Self::Reward, Self::RewardBalance>;
    type StakeAndSlash: StakeAndSlash<Self::AccountId, BlockNumberFor<Self>, Self::Balance>;
    type Balance: Balance;
    type WeightInfo: WeightInfoExt;
}

Configuration trait of this pallet.

The main purpose of this trait is to act as an interface between this pallet and the runtime in which it is embedded in. A type, function, or constant in this trait is essentially left to be configured by the runtime that includes this pallet.

Consequently, a runtime that wants to include this pallet must implement this trait.

Required Associated Types

type RuntimeEvent: From<Event<Self, I>> + IsType<<Self as Config>::RuntimeEvent>

The overarching event type.

type RewardBalance: AtLeast32BitUnsigned + Copy + Member + Parameter + MaxEncodedLen

Type of relayer reward balance.

type Reward: Parameter + MaxEncodedLen + Send + Sync + Copy + Clone

Reward discriminator type. The pallet can collect different types of rewards for a single account, so Reward is used as the second key in the RelayerRewards double map.

For example, rewards for different bridges can be stored, where Reward is implemented as an enum representing each bridge.

type PaymentProcedure: PaymentProcedure<Self::AccountId, Self::Reward, Self::RewardBalance>

Pay rewards scheme.

type StakeAndSlash: StakeAndSlash<Self::AccountId, BlockNumberFor<Self>, Self::Balance>

Stake and slash scheme.

type Balance: Balance

Type for representing balance of an account used for T::StakeAndSlash.

type WeightInfo: WeightInfoExt

Pallet call weights.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Config for Runtime

impl Config for Runtime