Trait Config

Source

pub trait Config<I: 'static = ()>: Config + Config<RuntimeEvent: From<Event<Self, I>>> {
    type OnNewData: OnNewData<Self::AccountId, Self::OracleKey, Self::OracleValue>;
    type CombineData: CombineData<Self::OracleKey, TimestampedValue<<Self as Config<I>>::OracleValue, <<Self as Config<I>>::Time as Time>::Moment>>;
    type Time: Time;
    type OracleKey: Parameter + Member + MaxEncodedLen;
    type OracleValue: Parameter + Member + Ord + MaxEncodedLen;
    type PalletId: Get<PalletId>;
    type Members: SortedMembers<Self::AccountId>;
    type WeightInfo: WeightInfo;
    type MaxHasDispatchedSize: Get<u32>;
    type MaxFeedValues: Get<u32>;
    type BenchmarkHelper: BenchmarkHelper<Self::OracleKey, Self::OracleValue, Self::MaxFeedValues>;
}

Expand description

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§

Source

type OnNewData: OnNewData<Self::AccountId, Self::OracleKey, Self::OracleValue>

A hook to be called when new data is received.

This hook is triggered whenever an oracle operator successfully submits new data. It allows other pallets to react to oracle updates, enabling real-time responses to external data changes.

Source

type CombineData: CombineData<Self::OracleKey, TimestampedValue<<Self as Config<I>>::OracleValue, <<Self as Config<I>>::Time as Time>::Moment>>

The implementation to combine raw values into a single aggregated value.

This type defines how multiple oracle operator submissions are combined into a single trusted value. Common implementations include taking the median (to resist outliers) or weighted averages based on operator reputation.

Source

type Time: Time

The time provider for timestamping oracle data.

This type provides the current timestamp used to mark when oracle data was submitted. Timestamps are crucial for determining data freshness and preventing stale data usage.

Source

type OracleKey: Parameter + Member + MaxEncodedLen

The key type for identifying oracle data feeds.

This type is used to uniquely identify different types of oracle data (e.g., currency pairs, asset prices, weather data).

Source

type OracleValue: Parameter + Member + Ord + MaxEncodedLen

The value type for oracle data.

This type represents the actual data submitted by oracle operators (e.g., prices, temperatures, scores).

Source

type PalletId: Get<PalletId>

The pallet ID.

Will be used to derive the pallet’s account, which is used as the oracle account when values are fed by root.

Source

type Members: SortedMembers<Self::AccountId>

The source of oracle members.

This type provides the set of accounts authorized to submit oracle data. Typically implemented by membership pallets to allow governance-controlled management of oracle operators.

Source