Struct pallet_preimage::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn note_preimage(
    origin: OriginFor<T>,
    bytes: Vec<u8>
) -> DispatchResultWithPostInfo

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: OriginFor<T>, hash: T::Hash) -> DispatchResult

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: OriginFor<T>, hash: T::Hash) -> DispatchResult

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: OriginFor<T>, hash: T::Hash) -> DispatchResult

Clear a previously made request for a preimage.

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

Trait Implementations

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

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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

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

Returns whether a preimage exists for a given hash.

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

Returns whether a preimage request exists for a given hash.

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

Returns the preimage for a given hash.

fn request_preimage(hash: &T::Hash)

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

fn unrequest_preimage(hash: &T::Hash)

Cancel a previous preimage request.

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

type MaxSize = ConstU32<MAX_SIZE>

Maximum size of a preimage.

fn note_preimage(bytes: BoundedVec<u8, Self::MaxSize>)

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

fn unnote_preimage(hash: &T::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: Config<Hash = PreimageHash>> QueryPreimage for Pallet<T>

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

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

fn fetch(hash: &T::Hash, len: Option<u32>) -> FetchResult

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

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

Returns whether a preimage request exists for a given hash.

fn request(hash: &T::Hash)

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

fn unrequest(hash: &T::Hash)

Cancel a previous preimage request.

fn hold<T>(bounded: &Bounded<T>)

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

fn drop<T>(bounded: &Bounded<T>)

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

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

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

fn pick<T>(hash: H256, len: u32) -> Bounded<T>

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

fn peek<T>(bounded: &Bounded<T>) -> 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>) -> 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: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<Hash = PreimageHash>> StorePreimage for Pallet<T>

const MAX_LENGTH: usize = 4_194_304usize

The maximum length of preimage we can store.

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

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

fn unnote(hash: &T::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>, DispatchError>where
    T: Encode,

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

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>