Type Alias Preimage

pub type Preimage = Pallet<Runtime>;

Aliased Type

struct Preimage(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn deposit_event(event: Event<T>)

impl<T> Pallet<T>

where T: Config,

pub fn note_preimage( origin: <T as Config>::RuntimeOrigin, bytes: Vec<u8>, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Register a preimage on-chain.

If the preimage was previously requested, no fees or deposits are taken for providing the preimage. Otherwise, a deposit is taken proportional to the size of the preimage.

pub fn unnote_preimage( origin: <T as Config>::RuntimeOrigin, hash: <T as Config>::Hash, ) -> Result<(), DispatchError>

Clear an unrequested preimage from the runtime storage.

If len is provided, then it will be a much cheaper operation.

• hash: The hash of the preimage to be removed from the store.
• len: The length of the preimage of hash.

pub fn request_preimage( origin: <T as Config>::RuntimeOrigin, hash: <T as Config>::Hash, ) -> Result<(), DispatchError>

Request a preimage be uploaded to the chain without paying any fees or deposits.

If the preimage requests has already been provided on-chain, we unreserve any deposit a user may have paid, and take the control of the preimage out of their hands.

pub fn unrequest_preimage( origin: <T as Config>::RuntimeOrigin, hash: <T as Config>::Hash, ) -> Result<(), DispatchError>

Clear a previously made request for a preimage.

NOTE: THIS MUST NOT BE CALLED ON hash MORE TIMES THAN request_preimage.

pub fn ensure_updated( origin: <T as Config>::RuntimeOrigin, hashes: Vec<<T as Config>::Hash>, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Ensure that the bulk of pre-images is upgraded.

The caller pays no fee if at least 90% of pre-images were successfully updated.

Trait Implementations

impl<T> BeforeAllRuntimeMigrations for Pallet<T>

where T: Config,

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

where T: Config,

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> DispatchViewFunction for Pallet<T>

where T: Config,

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

where O: Output,

impl<T> GetStorageVersion for Pallet<T>

where T: Config,

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

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

where T: Config,

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_finalize(_n: BlockNumber)

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

where T: Config,

fn integrity_test()

See Hooks::integrity_test.

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

where T: Config,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

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

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

where T: Config,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

See Hooks::on_finalize.

impl<T> OnGenesis for Pallet<T>

where T: Config,

fn on_genesis()

Something that should happen at genesis.

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

where T: Config,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight, ) -> Weight

See Hooks::on_idle.

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

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

See Hooks::on_initialize.

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

where T: Config,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter, )

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

impl<T> OnRuntimeUpgrade for Pallet<T>

where T: Config,

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

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

See Hooks::pre_upgrade.

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

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

where T: Config,

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

where T: Config,

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: &Pallet<T>) -> 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> PreimageProvider<<T as Config>::Hash> for Pallet<T>

where T: Config,

fn have_preimage(hash: &<T as Config>::Hash) -> bool

Returns whether a preimage exists for a given hash.

fn preimage_requested(hash: &<T as Config>::Hash) -> bool

Returns whether a preimage request exists for a given hash.

fn get_preimage(hash: &<T as Config>::Hash) -> Option<Vec<u8>>

Returns the preimage for a given hash.

fn request_preimage(hash: &<T as Config>::Hash)

Request that someone report a preimage. Providers use this to optimise the economics for preimage reporting.

fn unrequest_preimage(hash: &<T as Config>::Hash)

Cancel a previous preimage request.

impl<T> PreimageRecipient<<T as Config>::Hash> for Pallet<T>

where T: Config,

type MaxSize = ConstU32<pallet_preimage::::{impl#2}::MaxSize::{constant#0}>

Maximum size of a preimage.

fn note_preimage( bytes: BoundedVec<u8, <Pallet<T> as PreimageRecipient<<T as Config>::Hash>>::MaxSize>, )

Store the bytes of a preimage on chain infallible due to the bounded type.

fn unnote_preimage(hash: &<T as Config>::Hash)

Clear a previously noted preimage. This is infallible and should be treated more like a hint - if it was not previously noted or if it is now requested, then this will not do anything.

impl<T> QueryPreimage for Pallet<T>

where T: Config,

type H = <T as Config>::Hashing

The hasher used in the runtime.

fn len(hash: &<T as Config>::Hash) -> Option<u32>

Returns whether a preimage exists for a given hash and if so its length.

fn fetch( hash: &<T as Config>::Hash, len: Option<u32>, ) -> Result<Cow<'static, [u8]>, DispatchError>

Returns the preimage for a given hash. If given, len must be the size of the preimage.

fn is_requested(hash: &<T as Config>::Hash) -> bool

Returns whether a preimage request exists for a given hash.

fn request(hash: &<T as Config>::Hash)

Request that someone report a preimage. Providers use this to optimise the economics for preimage reporting.

fn unrequest(hash: &<T as Config>::Hash)

Cancel a previous preimage request.

fn hold<T>(bounded: &Bounded<T, Self::H>)

Request that the data required for decoding the given bounded value is made available.

fn drop<T>(bounded: &Bounded<T, Self::H>)

No longer request that the data required for decoding the given bounded value is made available.

fn have<T>(bounded: &Bounded<T, Self::H>) -> bool

Check to see if all data required for the given bounded value is available for its decoding.

fn pick<T>(hash: <Self::H as Hasher>::Out, len: u32) -> Bounded<T, Self::H>

Create a Bounded instance based on the hash and len of the encoded value.

fn peek<T>( bounded: &Bounded<T, Self::H>, ) -> Result<(T, Option<u32>), DispatchError>

where T: Decode,

Convert the given bounded instance back into its original instance, also returning the exact size of its encoded form if it needed to be looked-up from a stored preimage).

fn realize<T>( bounded: &Bounded<T, Self::H>, ) -> Result<(T, Option<u32>), DispatchError>

where T: Decode,

Convert the given bounded value back into its original instance. If successful, drop any data backing it. This will not break the realisability of independently created instances of Bounded which happen to have identical data.

impl<T> StorageInfoTrait for Pallet<T>

where T: Config,

fn storage_info() -> Vec<StorageInfo>

impl<T> StorePreimage for Pallet<T>

where T: Config,

const MAX_LENGTH: usize = 4_194_304usize

The maximum length of preimage we can store.

fn note(bytes: Cow<'_, [u8]>) -> Result<<T as Config>::Hash, DispatchError>

Request and attempt to store the bytes of a preimage on chain.

fn unnote(hash: &<T as Config>::Hash)

Attempt to clear a previously noted preimage. Exactly the same as unrequest but is provided for symmetry.

fn bound<T>(t: T) -> Result<Bounded<T, Self::H>, DispatchError>

where T: Encode,

Convert an otherwise unbounded or large value into a type ready for placing in storage.

impl<T> TryDecodeEntireStorage for Pallet<T>

where T: Config,

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

where T: Config,

fn try_state( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, _s: Select, ) -> Result<(), DispatchError>

Execute the state checks.

impl<T> ViewFunctionIdPrefix for Pallet<T>

where T: Config,

fn prefix() -> [u8; 16]

impl<T> WhitelistedStorageKeys for Pallet<T>

where T: Config,

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>