Struct Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

pub fn call_old_weight( origin: OriginFor<T>, dest: <<T as Config>::Lookup as StaticLookup>::Source, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: u64, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, data: Vec<u8>, ) -> DispatchResultWithPostInfo

👎Deprecated: 1D weight is used in this extrinsic, please migrate to call

Deprecated version if Self::call for use in an in-storage Call.

pub fn instantiate_with_code_old_weight( origin: OriginFor<T>, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: u64, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code: Vec<u8>, data: Vec<u8>, salt: Vec<u8>, ) -> DispatchResultWithPostInfo

👎Deprecated: 1D weight is used in this extrinsic, please migrate to instantiate_with_code

Deprecated version if Self::instantiate_with_code for use in an in-storage Call.

pub fn instantiate_old_weight( origin: OriginFor<T>, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: u64, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code_hash: <T as Config>::Hash, data: Vec<u8>, salt: Vec<u8>, ) -> DispatchResultWithPostInfo

👎Deprecated: 1D weight is used in this extrinsic, please migrate to instantiate

Deprecated version if Self::instantiate for use in an in-storage Call.

pub fn upload_code( origin: OriginFor<T>, code: Vec<u8>, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, determinism: Determinism, ) -> DispatchResult

Upload new code without instantiating a contract from it.

If the code does not already exist a deposit is reserved from the caller and unreserved only when Self::remove_code is called. The size of the reserve depends on the size of the supplied code.

If the code already exists in storage it will still return Ok and upgrades the in storage version to the current InstructionWeights::version.

• determinism: If this is set to any other value but Determinism::Enforced then the only way to use this code is to delegate call into it from an offchain execution. Set to Determinism::Enforced if in doubt.

Note

Anyone can instantiate a contract from any uploaded code and thus prevent its removal. To avoid this situation a constructor could employ access control so that it can only be instantiated by permissioned entities. The same is true when uploading through Self::instantiate_with_code.

Use Determinism::Relaxed exclusively for non-deterministic code. If the uploaded code is deterministic, specifying Determinism::Relaxed will be disregarded and result in higher gas costs.

pub fn remove_code( origin: OriginFor<T>, code_hash: <T as Config>::Hash, ) -> DispatchResultWithPostInfo

Remove the code stored under code_hash and refund the deposit to its owner.

A code can only be removed by its original uploader (its owner) and only if it is not used by any contract.

pub fn set_code( origin: OriginFor<T>, dest: <<T as Config>::Lookup as StaticLookup>::Source, code_hash: <T as Config>::Hash, ) -> DispatchResult

Privileged function that changes the code of an existing contract.

This takes care of updating refcounts and all other necessary operations. Returns an error if either the code_hash or dest do not exist.

Note

This does not change the address of the contract in question. This means that the contract address is no longer derived from its code hash after calling this dispatchable.

pub fn call( origin: OriginFor<T>, dest: <<T as Config>::Lookup as StaticLookup>::Source, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, data: Vec<u8>, ) -> DispatchResultWithPostInfo

Makes a call to an account, optionally transferring some balance.

Parameters

• dest: Address of the contract to call.

• value: The balance to transfer from the origin to dest.

• gas_limit: The gas limit enforced when executing the constructor.

• storage_deposit_limit: The maximum amount of balance that can be charged from the caller to pay for the storage consumed.

• data: The input data to pass to the contract.

• If the account is a smart-contract account, the associated code will be executed and any value will be transferred.

• If the account is a regular account, any value will be transferred.

• If no account exists and the call value is not less than existential_deposit, a regular account will be created and any value will be transferred.

pub fn instantiate_with_code( origin: OriginFor<T>, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code: Vec<u8>, data: Vec<u8>, salt: Vec<u8>, ) -> DispatchResultWithPostInfo

Instantiates a new contract from the supplied code optionally transferring some balance.

This dispatchable has the same effect as calling Self::upload_code + Self::instantiate. Bundling them together provides efficiency gains. Please also check the documentation of Self::upload_code.

Parameters

• value: The balance to transfer from the origin to the newly created contract.
• gas_limit: The gas limit enforced when executing the constructor.
• storage_deposit_limit: The maximum amount of balance that can be charged/reserved from the caller to pay for the storage consumed.
• code: The contract code to deploy in raw bytes.
• data: The input data to pass to the contract constructor.
• salt: Used for the address derivation. See Pallet::contract_address.

Instantiation is executed as follows:

• The supplied code is deployed, and a code_hash is created for that code.
• If the code_hash already exists on the chain the underlying code will be shared.
• The destination address is computed based on the sender, code_hash and the salt.
• The smart-contract account is created at the computed address.
• The value is transferred to the new account.
• The deploy function is executed in the context of the newly-created account.

pub fn instantiate( origin: OriginFor<T>, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code_hash: <T as Config>::Hash, data: Vec<u8>, salt: Vec<u8>, ) -> DispatchResultWithPostInfo

Instantiates a contract from a previously deployed wasm binary.

This function is identical to Self::instantiate_with_code but without the code deployment step. Instead, the code_hash of an on-chain deployed wasm binary must be supplied.

pub fn migrate( origin: OriginFor<T>, weight_limit: Weight, ) -> DispatchResultWithPostInfo

When a migration is in progress, this dispatchable can be used to run migration steps. Calls that contribute to advancing the migration have their fees waived, as it’s helpful for the chain. Note that while the migration is in progress, the pallet will also leverage the on_idle hooks to run migration steps.

impl<T: Config> Pallet<T>

pub fn bare_call( origin: T::AccountId, dest: T::AccountId, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>, data: Vec<u8>, debug: DebugInfo, collect_events: CollectEvents, determinism: Determinism, ) -> ContractExecResult<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, EventRecord<<T as Config>::RuntimeEvent, <T as Config>::Hash>>

Perform a call to a specified contract.

This function is similar to Self::call, but doesn’t perform any address lookups and better suitable for calling directly from Rust.

Note

If debug is set to DebugInfo::UnsafeDebug it returns additional human readable debugging information.

If collect_events is set to CollectEvents::UnsafeCollect it collects all the Events emitted in the block so far and the ones emitted during the execution of this contract.

pub fn bare_instantiate( origin: T::AccountId, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>, code: Code<<T as Config>::Hash>, data: Vec<u8>, salt: Vec<u8>, debug: DebugInfo, collect_events: CollectEvents, ) -> ContractInstantiateResult<T::AccountId, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, EventRecord<<T as Config>::RuntimeEvent, <T as Config>::Hash>>

Instantiate a new contract.

This function is similar to Self::instantiate, but doesn’t perform any address lookups and better suitable for calling directly from Rust.

It returns the execution result, account id and the amount of used weight.

Note

If debug is set to DebugInfo::UnsafeDebug it returns additional human readable debugging information.

If collect_events is set to CollectEvents::UnsafeCollect it collects all the Events emitted in the block so far.

pub fn bare_upload_code( origin: T::AccountId, code: Vec<u8>, storage_deposit_limit: Option<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>, determinism: Determinism, ) -> CodeUploadResult<<T as Config>::Hash, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>

Upload new code without instantiating a contract from it.

This function is similar to Self::upload_code, but doesn’t perform any address lookups and better suitable for calling directly from Rust.

pub fn get_storage(address: T::AccountId, key: Vec<u8>) -> GetStorageResult

Query storage of a specified contract under a specified key.

pub fn contract_address( deploying_address: &T::AccountId, code_hash: &<T as Config>::Hash, input_data: &[u8], salt: &[u8], ) -> T::AccountId

Determine the address of a contract.

This is the address generation function used by contract instantiation. See DefaultAddressGenerator for the default implementation.

pub fn code_hash( account: &<T as Config>::AccountId, ) -> Option<<T as Config>::Hash>

Returns the code hash of the contract specified by account ID.

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, <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance: From<<Pallet<T> as Currency<T::AccountId>>::Balance>, <Pallet<T> as Currency<T::AccountId>>::Balance: From<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>,

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

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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

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_idle(_block: BlockNumberFor<T>, limit: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

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