Type Alias Module

pub type Module<T> = Pallet<T>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T>(/* private fields */);

Implementations

impl<T: Config> Pallet<T>

pub fn epoch_index() -> u64

An auto-generated getter for EpochIndex.

impl<T: Config> Pallet<T>

pub fn authorities() -> AuthoritiesVec<T>

An auto-generated getter for Authorities.

impl<T: Config> Pallet<T>

pub fn next_authorities() -> AuthoritiesVec<T>

An auto-generated getter for NextAuthorities.

impl<T: Config> Pallet<T>

pub fn genesis_slot() -> Slot

An auto-generated getter for GenesisSlot.

impl<T: Config> Pallet<T>

pub fn current_slot() -> Slot

An auto-generated getter for CurrentSlot.

impl<T: Config> Pallet<T>

pub fn randomness() -> Randomness

An auto-generated getter for CurrentRandomness.

impl<T: Config> Pallet<T>

pub fn next_randomness() -> Randomness

An auto-generated getter for NextRandomness.

impl<T: Config> Pallet<T>

pub fn randomness_accumulator() -> Randomness

An auto-generated getter for RandomnessAccumulator.

impl<T: Config> Pallet<T>

pub fn config() -> EpochConfiguration

An auto-generated getter for EpochConfig.

impl<T: Config> Pallet<T>

pub fn next_config() -> Option<EpochConfiguration>

An auto-generated getter for NextEpochConfig.

impl<T: Config> Pallet<T>

pub fn ring_context() -> Option<RingContext>

An auto-generated getter for RingContext.

impl<T: Config> Pallet<T>

pub fn submit_tickets( origin: OriginFor<T>, tickets: BoundedVec<TicketEnvelope, EpochLengthFor<T>>, ) -> DispatchResultWithPostInfo

Submit next epoch tickets candidates.

The number of tickets allowed to be submitted in one call is equal to the epoch length.

pub fn plan_config_change( origin: OriginFor<T>, config: EpochConfiguration, ) -> DispatchResult

Plan an epoch configuration change.

The epoch configuration change is recorded and will be announced at the beginning of the next epoch together with next epoch authorities information. In other words, the configuration will be enacted one epoch later.

Multiple calls to this method will replace any existing planned config change that has not been enacted yet.

impl<T: Config> Pallet<T>

pub fn current_epoch() -> Epoch

Current epoch information.

pub fn next_epoch() -> Epoch

Next epoch information.

pub fn slot_ticket_id(slot: Slot) -> Option<TicketId>

Fetch expected ticket-id for the given slot according to an “outside-in” sorting strategy.

Given an ordered sequence of tickets [t0, t1, t2, …, tk] to be assigned to n slots, with n >= k, then the tickets are assigned to the slots according to the following strategy:

slot-index : [ 0, 1, 2, ………… , n ] tickets : [ t1, t3, t5, … , t4, t2, t0 ].

With slot-index computed as epoch_start() - slot.

If slot value falls within the current epoch then we fetch tickets from the current epoch tickets list.

If slot value falls within the next epoch then we fetch tickets from the next epoch tickets ids list. Note that in this case we may have not finished receiving all the tickets for that epoch yet. The next epoch tickets should be considered “stable” only after the current epoch first half slots were elapsed (see submit_tickets_unsigned_extrinsic).

Returns None if, according to the sorting strategy, there is no ticket associated to the specified slot-index (happens if a ticket falls in the middle of an epoch and n > k), or if the slot falls beyond the next epoch.

Before importing the first block this returns None.

pub fn slot_ticket(slot: Slot) -> Option<(TicketId, TicketBody)>

Returns ticket id and data associated with the given slot.

Refer to the slot_ticket_id documentation for the slot-ticket association criteria.

pub fn submit_tickets_unsigned_extrinsic(tickets: Vec<TicketEnvelope>) -> bool

Submit next epoch validator tickets via an unsigned extrinsic constructed with a call to submit_unsigned_transaction.

The submitted tickets are added to the next epoch outstanding tickets as long as the extrinsic is called within the first half of the epoch. Tickets received during the second half are dropped.

pub fn epoch_length() -> u32

Epoch length

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + Config,

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> BoundToRuntimeAppPublic for Pallet<T>

type Public = Public

The [RuntimeAppPublic] this type is bound to.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> DispatchViewFunction for Pallet<T>

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

impl<T: Config> GetStorageVersion for Pallet<T>

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> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_: 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> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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> OnRuntimeUpgrade for Pallet<T>

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> PalletInfoAccess for Pallet<T>

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> PalletsInfoAccess for Pallet<T>

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> PartialEq for Pallet<T>

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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryDecodeEntireStorage for Pallet<T>

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> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

Execute the state checks.

impl<T: Config> ValidateUnsigned for Pallet<T>

type Call = Call<T>

The call to validate

fn validate_unsigned( source: TransactionSource, call: &Self::Call, ) -> TransactionValidity

Return the validity of the call

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

impl<T: Config> ViewFunctionIdPrefix for Pallet<T>

fn prefix() -> [u8; 16]

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

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> Eq for Pallet<T>