Struct Pallet Copy item path

impl<T: Config> Pallet<T>

pub fn manage( origin: OriginFor<T>, op: ManagerOperation<T>, ) -> DispatchResultWithPostInfo

Manage this pallet.

The origin of this call must be Config::ManagerOrigin.

See ManagerOperation for various operations that are possible.

pub fn admin( origin: OriginFor<T>, op: AdminOperation<T>, ) -> DispatchResultWithPostInfo

impl<T: Config> Pallet<T>

pub fn round() -> u32

An auto-generated getter for Round.

impl<T: Config> Pallet<T>

pub fn current_phase() -> Phase<T>

An auto-generated getter for CurrentPhase.

impl<T: Config> Pallet<T>

pub fn msp_range_for(length: usize) -> Vec<PageIndex> ⓘ

Return the length most significant pages.

For example, if Pages = 4, and length = 2, our full snapshot range would be [0, 1, 2, 3], with 3 being msp. But, in this case, then this returns [2, 3] two most significant pages, in the old order.

pub fn average_election_duration() -> u32

A reasonable next election block number.

impl<T: Config> Pallet<T>

pub fn check_all_weights( limit_weight: Weight, maybe_max_ratio: Option<Percent>, maybe_max_warn_ratio: Option<Percent>, )
where T: Config + Config + Config,

Helper function to check the weights of all significant operations of this this pallet against a runtime.

Will check the weights for:

snapshot
signed submission and cleanip
unsigned solution submission
signed validation
export.

Arguments:

limit_weight should be the maximum block weight (often obtained from frame_system).
maybe_max_ratio is the maximum ratio of limit_weight that we may consume, else we panic.
maybe_max_warn_rati has the same effect, but it emits a warning instead of panic.

A reasonable value for maybe_max_weight would be 75%, and 50% for maybe_max_warn_ratio.

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 + Config + 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”. Read more

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.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter. Read more

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

type AccountId = <T as Config>::AccountId

The account ID identifier;

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

The block number type.

type Error = ElectionError<T>

The error type returned by the provider;

type DataProvider = <T as Config>::DataProvider

The data provider of the election.

type Pages = <T as Config>::Pages

The number of pages that this election provider supports.

type MaxWinnersPerPage = <<T as Config>::Verifier as Verifier>::MaxWinnersPerPage

The maximum number of winners per page in results returned by this election provider. Read more

type MaxBackersPerWinner = <<T as Config>::Verifier as Verifier>::MaxBackersPerWinner

The maximum number of backers that a single page may have in results returned by this election provider. Read more

type MaxBackersPerWinnerFinal = <<T as Config>::Verifier as Verifier>::MaxBackersPerWinnerFinal

Same as [Self::MaxBackersPerWinner], but across all pages. Read more

fn elect(remaining: PageIndex) -> Result<BoundedSupportsOf<Self>, Self::Error>

Elect a new set of winners. Read more

fn start() -> Result<(), Self::Error>

Signal that the election should start

fn duration() -> Self::BlockNumber

Return the duration of your election. Read more

fn status() -> Result<Option<Weight>, ()>

Indicate whether this election provider is currently ongoing an asynchronous election. Read more

fn asap()

Signal the election provider that we are about to call elect asap, and it should prepare itself.

fn msp() -> u32

The index of the most significant page that this election provider supports.

fn lsp() -> u32

The index of the least significant page that this election provider supports.

fn desired_targets_checked() -> Result<u32, &'static str>

checked call to Self::DataProvider::desired_targets() ensuring the value never exceeds [Self::MaxWinnersPerPage].

fn duration_with_export() -> Self::BlockNumber
where Self::BlockNumber: From<u32> + Add<Output = Self::BlockNumber>,

Return the duration of your election, including the export.

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro. Read more

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. Read more

fn on_poll(_now: BlockNumberFor<T>, weight_meter: &mut WeightMeter)

A hook to run logic after inherent application. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

fn try_state(now: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block. Read more

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_finalize(_n: BlockNumber)

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

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]). Read more

fn on_runtime_upgrade() -> Weight

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

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

Execute some pre-checks prior to a runtime upgrade. Read more

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

Execute some post-checks after a runtime upgrade. Read more

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. Read more

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

fn integrity_test()

See [Hooks::integrity_test].

fn offchain_worker(n: BlockNumberFor<T>)

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

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.

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

See [Hooks::on_idle].

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

See [Hooks::on_initialize].

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. Read more

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. Read more

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. Read more

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 ==.

1.0.0 · Source§

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.

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

Execute the state checks.

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>

Auto Trait Implementations§

impl<T> Freeze for Pallet<T>

impl<T> RefUnwindSafe for Pallet<T>
where T: RefUnwindSafe,

impl<T> Send for Pallet<T>
where T: Send,

impl<T> Sync for Pallet<T>
where T: Sync,

impl<T> Unpin for Pallet<T>
where T: Unpin,

impl<T> UnwindSafe for Pallet<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T, U> DefensiveTruncateInto for T
where U: DefensiveTruncateFrom<T>,

fn defensive_truncate_into(self) -> U

Defensively truncate a value and convert it into its bounded form.

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more