Type Alias Module

pub type Module<T> = Pallet<T>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T>(/* private fields */);

Implementations

impl<T: Config> Pallet<T>

pub fn checking_account() -> <T as Config>::AccountId

impl<T: Config> Pallet<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

pub fn eth_transact( origin: OriginFor<T>, payload: Vec<u8>, ) -> DispatchResultWithPostInfo

A raw EVM transaction, typically dispatched by an Ethereum JSON-RPC server.

Parameters

• payload: The encoded crate::evm::TransactionSigned.
• gas_limit: The gas limit enforced during contract execution.
• storage_deposit_limit: The maximum balance that can be charged to the caller for storage usage.

Note

This call cannot be dispatched directly; attempting to do so will result in a failed transaction. It serves as a wrapper for an Ethereum transaction. When submitted, the runtime converts it into a [sp_runtime::generic::CheckedExtrinsic] by recovering the signer and validating the transaction.

pub fn call( origin: OriginFor<T>, dest: H160, value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, 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( origin: OriginFor<T>, value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, code_hash: H256, data: Vec<u8>, salt: Option<[u8; 32]>, ) -> 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 instantiate_with_code( origin: OriginFor<T>, value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, code: Vec<u8>, data: Vec<u8>, salt: Option<[u8; 32]>, ) -> 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. If Some is supplied then CREATE2 semantics are used. If None then CRATE1 is used.

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 upload_code( origin: OriginFor<T>, code: Vec<u8>, storage_deposit_limit: BalanceOf<T>, ) -> 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.

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.

pub fn remove_code( origin: OriginFor<T>, code_hash: H256, ) -> 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: H160, code_hash: H256, ) -> 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 map_account(origin: OriginFor<T>) -> DispatchResult

Register the callers account id so that it can be used in contract interactions.

This will error if the origin is already mapped or is a eth native Address20. It will take a deposit that can be released by calling Self::unmap_account.

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

Unregister the callers account id in order to free the deposit.

There is no reason to ever call this function other than freeing up the deposit. This is only useful when the account should no longer be used.

pub fn dispatch_as_fallback_account( origin: OriginFor<T>, call: Box<<T as Config>::RuntimeCall>, ) -> DispatchResultWithPostInfo

Dispatch an call with the origin set to the callers fallback address.

Every AccountId32 can control its corresponding fallback account. The fallback account is the AccountId20 with the last 12 bytes set to 0xEE. This is essentially a recovery function in case an AccountId20 was used without creating a mapping first.

impl<T: Config> Pallet<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256> + Bounded, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

pub fn bare_call( origin: OriginFor<T>, dest: H160, value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: DepositLimit<BalanceOf<T>>, data: Vec<u8>, ) -> ContractResult<ExecReturnValue, BalanceOf<T>>

A generalized version of Self::call.

Identical to Self::call but tailored towards being called by other code within the runtime as opposed to from an extrinsic. It returns more information and allows the enablement of features that are not suitable for an extrinsic (debugging, event collection).

pub fn prepare_dry_run(account: &T::AccountId)

Prepare a dry run for the given account.

This function is public because it is called by the runtime API implementation (see impl_runtime_apis_plus_revive).

pub fn bare_instantiate( origin: OriginFor<T>, value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: DepositLimit<BalanceOf<T>>, code: Code, data: Vec<u8>, salt: Option<[u8; 32]>, ) -> ContractResult<InstantiateReturnValue, BalanceOf<T>>

A generalized version of Self::instantiate or Self::instantiate_with_code.

Identical to Self::instantiate or Self::instantiate_with_code but tailored towards being called by other code within the runtime as opposed to from an extrinsic. It returns more information to the caller useful to estimate the cost of the operation.

pub fn dry_run_eth_transact( tx: GenericTransaction, gas_limit: Weight, tx_fee: impl Fn(Call<T>, DispatchInfo) -> BalanceOf<T>, ) -> Result<EthTransactInfo<BalanceOf<T>>, EthTransactError>

where <T as Config>::RuntimeCall: Dispatchable<Info = DispatchInfo>, <T as Config>::RuntimeCall: From<Call<T>> + Encode, T::Nonce: Into<U256>, T::Hash: IsType<H256>,

Dry-run Ethereum calls.

Parameters

• tx: The Ethereum transaction to simulate.
• gas_limit: The gas limit enforced during contract execution.
• tx_fee: A function that returns the fee for the given call and dispatch info.

pub fn evm_balance(address: &H160) -> U256

Get the balance with EVM decimals of the given address.

pub fn evm_fee_to_gas(fee: BalanceOf<T>) -> U256

Convert a substrate fee into a gas value, using the fixed GAS_PRICE. The gas is calculated as fee / GAS_PRICE, rounded up to the nearest integer.

pub fn evm_gas_from_weight(weight: Weight) -> U256

Convert a weight to a gas value.

pub fn evm_block_gas_limit() -> U256

Get the block gas limit.

pub fn evm_gas_price() -> U256

Get the gas price.

pub fn evm_tracer(tracer_type: TracerType) -> Tracer

Build an EVM tracer from the given tracer type.

pub fn bare_upload_code( origin: OriginFor<T>, code: Vec<u8>, storage_deposit_limit: BalanceOf<T>, ) -> CodeUploadResult<BalanceOf<T>>

A generalized version of Self::upload_code.

It is identical to Self::upload_code and only differs in the information it returns.

pub fn get_storage(address: H160, key: [u8; 32]) -> GetStorageResult

Query storage of a specified contract under a specified key.

pub fn get_storage_var_key(address: H160, key: Vec<u8>) -> GetStorageResult

Query storage of a specified contract under a specified variable-sized key.

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, BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, <T as Config>::RuntimeEvent: From<Event<T>>, <T as Config>::RuntimeCall: From<Call<T>>, <T as Config>::Hash: IsType<H256>,

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 BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

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> Inspect<<T as Config>::AccountId> for Pallet<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256> + Bounded, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

type AssetId = H160

Means of identifying one asset class from another.

type Balance = u128

Scalar type for representing balance of an account.

fn total_issuance(asset_id: Self::AssetId) -> Self::Balance

The total amount of issuance in the system.

fn minimum_balance(_: Self::AssetId) -> Self::Balance

The minimum balance any single account may have.

fn total_balance( asset_id: Self::AssetId, account_id: &T::AccountId, ) -> Self::Balance

Get the total amount of funds whose ultimate beneficial ownership can be determined as who.

fn balance(asset_id: Self::AssetId, account_id: &T::AccountId) -> Self::Balance

Get the balance of who which does not include funds which are exclusively allocated to subsystems of the chain (“on hold” or “reserved”).

fn reducible_balance( asset_id: Self::AssetId, account_id: &T::AccountId, _: Preservation, _: Fortitude, ) -> Self::Balance

Get the maximum amount that who can withdraw/transfer successfully based on whether the account should be kept alive (preservation) or whether we are willing to force the transfer and potentially go below user-level restrictions on the minimum amount of the account.

fn can_deposit( _: Self::AssetId, _: &T::AccountId, _: Self::Balance, _: Provenance, ) -> DepositConsequence

Returns true if the asset balance of who may be increased by amount.

fn can_withdraw( _: Self::AssetId, _: &T::AccountId, _: Self::Balance, ) -> WithdrawConsequence<Self::Balance>

Returns Failed if the asset balance of who may not be decreased by amount, otherwise the consequence.

fn asset_exists(_: Self::AssetId) -> bool

Returns true if an asset exists.

fn active_issuance(asset: Self::AssetId) -> Self::Balance

The total amount of issuance in the system excluding those which are controlled by the system.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> Mutate<<T as Config>::AccountId> for Pallet<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256> + Bounded, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn burn_from( asset_id: Self::AssetId, who: &T::AccountId, amount: Self::Balance, _: Preservation, _: Precision, _: Fortitude, ) -> Result<Self::Balance, DispatchError>

Decrease the balance of who by at least amount, possibly slightly more in the case of minimum-balance requirements, burning the tokens. If that isn’t possible then an Err is returned and nothing is changed. If successful, the amount of tokens reduced is returned.

fn mint_into( asset_id: Self::AssetId, who: &T::AccountId, amount: Self::Balance, ) -> Result<Self::Balance, DispatchError>

Increase the balance of who by exactly amount, minting new tokens. If that isn’t possible then an Err is returned and nothing is changed.

fn shelve( asset: Self::AssetId, who: &AccountId, amount: Self::Balance, ) -> Result<Self::Balance, DispatchError>

Attempt to decrease the asset balance of who by amount.

fn restore( asset: Self::AssetId, who: &AccountId, amount: Self::Balance, ) -> Result<Self::Balance, DispatchError>

Attempt to increase the asset balance of who by amount.

fn transfer( asset: Self::AssetId, source: &AccountId, dest: &AccountId, amount: Self::Balance, preservation: Preservation, ) -> Result<Self::Balance, DispatchError>

Transfer funds from one account into another.

fn set_balance( asset: Self::AssetId, who: &AccountId, amount: Self::Balance, ) -> Self::Balance

Simple infallible function to force an account to have a particular balance, good for use in tests and benchmarks but not recommended for production code owing to the lack of error reporting.

fn done_mint_into( _asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance, )

fn done_burn_from( _asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance, )

fn done_shelve(_asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance)

fn done_restore(_asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance)

fn done_transfer( _asset: Self::AssetId, _source: &AccountId, _dest: &AccountId, _amount: Self::Balance, )

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> Unbalanced<<T as Config>::AccountId> for Pallet<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256> + Bounded, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn handle_raw_dust(_: Self::AssetId, _: Self::Balance)

Create some dust and handle it with Self::handle_dust. This is an unbalanced operation and it must only be used when an account is modified in a raw fashion, outside of the entire fungibles API. The amount is capped at Self::minimum_balance() - 1.

fn handle_dust(_: Dust<T::AccountId, Self>)

Do something with the dust which has been destroyed from the system. Dust can be converted into a Credit with the Balanced trait impl.

fn write_balance( _: Self::AssetId, _: &T::AccountId, _: Self::Balance, ) -> Result<Option<Self::Balance>, DispatchError>

Forcefully set the balance of who to amount.

fn set_total_issuance(_id: Self::AssetId, _amount: Self::Balance)

Set the total issuance to amount.

fn decrease_balance( _: Self::AssetId, _: &T::AccountId, _: Self::Balance, _: Precision, _: Preservation, _: Fortitude, ) -> Result<Self::Balance, DispatchError>

Reduce the balance of who by amount.

fn increase_balance( _: Self::AssetId, _: &T::AccountId, _: Self::Balance, _: Precision, ) -> Result<Self::Balance, DispatchError>

Increase the balance of who by amount.

fn deactivate(_asset: Self::AssetId, _: Self::Balance)

Reduce the active issuance by some amount.

fn reactivate(_asset: Self::AssetId, _: Self::Balance)

Increase the active issuance by some amount, up to the outstanding amount reduced.

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>