Struct Pallet

pub struct Pallet<T, I = ()>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn get_value( key: T::OracleKey, ) -> Option<TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>>

Retrieve the aggregated oracle value for a specific key, including its timestamp.

pub fn all_values() -> Vec<(T::OracleKey, TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>)>

Retrieve every aggregated oracle value tracked by the pallet.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn feed_values( origin: OriginFor<T>, values: BoundedVec<(T::OracleKey, T::OracleValue), T::MaxFeedValues>, ) -> DispatchResultWithPostInfo

Feeds external data values into the oracle system.

Dispatch Origin

The dispatch origin of this call must be a signed account that is either:

• A member of the oracle operators set (managed by [SortedMembers])
• The root origin

Details

This function allows authorized oracle operators to submit timestamped key-value pairs into the oracle system. Each submitted value is immediately timestamped with the current block time and stored in the RawValues storage. The system then attempts to aggregate all raw values for each key using the configured CombineData trait implementation, updating the final Values storage with the aggregated result.

Only one submission per oracle operator per block is allowed to prevent spam and ensure fair participation. The function also triggers the OnNewData hook for each submitted value, allowing other pallets to react to new oracle data.

Errors

• Error::NoPermission: The sender is not authorized to feed data
• Error::AlreadyFeeded: The sender has already fed data in the current block
• Error::ExceedsMaxHasDispatchedSize: Too many operators have fed data in this block

Events

• Event::NewFeedData: Emitted when data is successfully fed into the oracle

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn raw_values<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> Option<TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>>

where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<T::OracleKey>,

An auto-generated getter for RawValues.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn values<KArg>( k: KArg, ) -> Option<TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>>

where KArg: EncodeLike<<T as Config<I>>::OracleKey>,

An auto-generated getter for Values.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn read_raw_values( key: &T::OracleKey, ) -> Vec<TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>>

Reads the raw values for a given key from all oracle members.

pub fn get( key: &T::OracleKey, ) -> Option<TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>>

Returns the aggregated and timestamped value for a given key.

Trait Implementations

impl<T: Config<I>, I: 'static> BeforeAllRuntimeMigrations for Pallet<T, I>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T, I> Benchmarking for Pallet<T, I>

where T: Config + Config<I>, I: 'static,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

impl<T: Config<I>, I: 'static> ChangeMembers<<T as Config>::AccountId> for Pallet<T, I>

fn change_members_sorted( _incoming: &[T::AccountId], outgoing: &[T::AccountId], _new: &[T::AccountId], )

A number of members _incoming just joined the set and replaced some _outgoing ones. The new set is thus given by sorted_new and must be sorted.

fn set_prime(_prime: Option<T::AccountId>)

Set the prime member.

fn change_members( incoming: &[AccountId], outgoing: &[AccountId], new: Vec<AccountId>, )

A number of members incoming just joined the set and replaced some outgoing ones. The new set is given by new, and need not be sorted.

fn set_members_sorted(new_members: &[AccountId], old_members: &[AccountId])

Set the new members; they must already be sorted. This will compute the diff and use it to call change_members_sorted.

fn compute_members_diff_sorted( new_members: &[AccountId], old_members: &[AccountId], ) -> (Vec<AccountId>, Vec<AccountId>)

Compute diff between new and old members; they must already be sorted.

fn get_prime() -> Option<AccountId>

Get the current prime.

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config<I>, I: 'static> DataFeeder<<T as Config<I>>::OracleKey, <T as Config<I>>::OracleValue, <T as Config>::AccountId> for Pallet<T, I>

fn feed_value( who: Option<T::AccountId>, key: T::OracleKey, value: T::OracleValue, ) -> DispatchResult

Feeds a new value for a given key.

impl<T: Config<I>, I: 'static> DataProvider<<T as Config<I>>::OracleKey, <T as Config<I>>::OracleValue> for Pallet<T, I>

fn get(key: &T::OracleKey) -> Option<T::OracleValue>

Returns the data for a given key.

impl<T: Config<I>, I: 'static> DataProviderExtended<<T as Config<I>>::OracleKey, TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>> for Pallet<T, I>

fn get_all_values() -> impl Iterator<Item = (T::OracleKey, Option<TimestampedValue<<T as Config<I>>::OracleValue, <<T as Config<I>>::Time as Time>::Moment>>)>

Returns a list of all keys and their optional timestamped values.

impl<T, I> Debug for Pallet<T, I>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> DispatchViewFunction for Pallet<T, I>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(_n: BlockNumberFor<T>) -> Weight

on_initialize to return the weight used in on_finalize.

fn on_finalize(_n: BlockNumberFor<T>)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config<I>, I: 'static> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T, I> PartialEq for Pallet<T, I>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> TryDecodeEntireStorage for Pallet<T, I>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

impl<T: Config<I>, I: 'static> ViewFunctionIdPrefix for Pallet<T, I>

fn prefix() -> [u8; 16]

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T, I> Eq for Pallet<T, I>