Struct Pallet &nbsp; Copy item path

impl<T: Config> Pallet<T>

pub fn set_custom_validation_head_data( _: OriginFor<T>, custom_header: Vec<u8>, ) -> DispatchResult

A test dispatchable for setting a custom head data in validate_block.

pub fn read_and_write_child_tries(_: OriginFor<T>) -> DispatchResult

A dispatchable that first reads two values from two different child tries, asserts they are the expected values (if the values exist in the state) and then writes two different values to these child tries.

pub fn read_and_write_big_value(_: OriginFor<T>) -> DispatchResult

Reads a key and writes a big value under this key.

At genesis this key is empty and thus, will only be set in consequent blocks.

pub fn store_values_in_map(_: OriginFor<T>, max_key: u32) -> DispatchResult

Stores () in TestMap for keys from 0 up to max_key.

pub fn remove_value_from_map(_: OriginFor<T>, key: u32) -> DispatchResult

Removes the value associated with key from TestMap.

pub fn send_n_upward_messages(_: OriginFor<T>, n: u32) -> DispatchResult

Directly sets n small UMP messages in PendingUpwardMessages.

pub fn send_upward_message_of_size(_: OriginFor<T>, size: u32) -> DispatchResult

Sends a UMP message of specific size (in bytes).

pub fn queue_hrmp_messages( _: OriginFor<T>, n: u32, recipient: ParaId, ) -> DispatchResult

Queues n small HRMP messages to recipient.

pub fn queue_hrmp_messages_to_n_recipients( _: OriginFor<T>, n: u32, first_recipient: ParaId, ) -> DispatchResult

Queues one HRMP message each to n consecutive recipients starting from first_recipient.

pub fn schedule_weight_registration(_: OriginFor<T>) -> DispatchResult

Schedule a 1 second weight registration in the next on_initialize.

pub fn set_inherent_weight_consume( _: OriginFor<T>, weight: Weight, ) -> DispatchResult

Set the weight to be consumed by the next inherent call.

pub fn consume_weight_inherent(origin: OriginFor<T>) -> DispatchResult

Consume weight via inherent call (clears the storage after consuming).

pub fn use_more_weight_than_announced( _: OriginFor<T>, _must_be_first_block_in_core: bool, ) -> DispatchResult

This function registers a high weight usage manually, while it actually only announces to use a weight of 0 :)

Uses the TestTransactionExtension logic to ensure the transaction is only accepted when we can fit the 1s weight into the block.

pub fn set_use_full_core(_: OriginFor<T>) -> DispatchResult

Deposits the UseFullCore digest item to signal that this block should use the full core.

Trait Implementations§

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

fn clone(&self) -> Self

Returns a duplicate 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 From<<Pallet<Runtime> as Callable<Runtime>>::RuntimeCall> for RuntimeCall

fn from(call: CallableCallFor<TestPallet, Runtime>) -> Self

Converts to this type from the input type.

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_initialize(n: BlockNumberFor<T>) -> 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_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application. 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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block. 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

fn integrity_test()

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

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

fn integrity_test()

See Hooks::integrity_test.

impl IsSubType<<Pallet<Runtime> as Callable<Runtime>>::RuntimeCall> for RuntimeCall

fn is_sub_type(&self) -> Option<&CallableCallFor<TestPallet, Runtime>>

Returns Some(_) if self is an instance of sub type T.

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

fn on_validation_data(_data: &PersistedValidationData)

Called in each blocks once when the validation data is set by the inherent.

fn on_validation_code_applied()

Called when the validation code is being applied, aka from the next block on this is the new runtime.

fn on_relay_state_proof(relay_state_proof: &RelayChainStateProof) -> Weight

Called to process keys from the verified relay chain state proof.

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

const INHERENT_IDENTIFIER: InherentIdentifier = INHERENT_IDENTIFIER

The inherent identifier used by this inherent.

type Call = Call<T>

The call type of the pallet.

type Error = MakeFatalError<()>

The error returned by check_inherent.

fn create_inherent(_data: &InherentData) -> Option<Self::Call>

Create an inherent out of the given InherentData. Read more

fn is_inherent(call: &Self::Call) -> bool

Return whether the call is an inherent call. Read more

fn is_inherent_required( _: &InherentData, ) -> Result<Option<Self::Error>, Self::Error>

Determines whether this inherent is required in this block. Read more

fn check_inherent(_: &Self::Call, _: &InherentData) -> Result<(), Self::Error>

Check whether the given inherent is valid. Checking the inherent is optional and can be omitted by using the default implementation. Read more

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: Config> XcmpMessageSource for Pallet<T>

fn take_outbound_messages( maximum_channels: usize, excluded_recipients: &[ParaId], ) -> Vec<(ParaId, Vec<u8>)>

Take outbound XCMP messages from the queue. Read more

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