Type Alias pallet_web3_names::pallet::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 claim(origin: OriginFor<T>, name: Web3NameInput<T>) -> DispatchResult

Assign the specified name to the owner as specified in the origin.

The name must not have already been claimed by someone else and the owner must not already own another name.

Emits Web3NameClaimed if the operation is carried out successfully.

Weight: O(1)

• Reads: Names, Owner, Banned storage entries + available currency check + origin check
• Writes: Names, Owner storage entries + currency deposit reserve

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

Release the provided name from its owner.

The origin must be the owner of the specified name.

Emits Web3NameReleased if the operation is carried out successfully.

Weight: O(1)

• Reads: Names storage entry + origin check
• Writes: Names, Owner storage entries + currency deposit release

pub fn reclaim_deposit( origin: OriginFor<T>, name: Web3NameInput<T> ) -> DispatchResult

Release the provided name from its owner.

The origin must be the account that paid for the name’s deposit.

Emits Web3NameReleased if the operation is carried out successfully.

Weight: O(1)

• Reads: Owner storage entry + origin check
• Writes: Names, Owner storage entries + currency deposit release

pub fn ban(origin: OriginFor<T>, name: Web3NameInput<T>) -> DispatchResult

Ban a name.

A banned name cannot be claimed by anyone. The name’s deposit is returned to the original payer.

The origin must be the ban origin.

Emits Web3NameBanned if the operation is carried out successfully.

Weight: O(1)

• Reads: Banned, Owner, Names storage entries + origin check
• Writes: Names, Owner, Banned storage entries + currency deposit release

pub fn unban(origin: OriginFor<T>, name: Web3NameInput<T>) -> DispatchResult

Unban a name.

Make a name claimable again.

The origin must be the ban origin.

Emits Web3NameUnbanned if the operation is carried out successfully.

Weight: O(1)

• Reads: Banned storage entry + origin check
• Writes: Banned storage entry deposit release

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

Changes the deposit owner.

The balance that is reserved by the current deposit owner will be freed and balance of the new deposit owner will get reserved.

The subject of the call must be the owner of the web3name. The sender of the call will be the new deposit owner.

pub fn update_deposit( origin: OriginFor<T>, name_input: Web3NameInput<T> ) -> DispatchResult

Updates the deposit amount to the current deposit rate.

The sender must be the deposit owner.

impl<T: Config> Pallet<T>

pub fn register_name( name: Web3NameOf<T>, owner: Web3NameOwnerOf<T>, deposit_payer: AccountIdOf<T> ) -> DispatchResult

Assign a name to the provided owner reserving the deposit from the provided account. This function must be called after check_claiming_preconditions as it does not verify all the preconditions again.

impl<T: Config> Pallet<T>

pub fn owner<KArg>(k: KArg) -> Option<Web3OwnershipOf<T>>where KArg: EncodeLike<Web3NameOf<T>>,

An auto-generated getter for Owner.

impl<T: Config> Pallet<T>

pub fn names<KArg>(k: KArg) -> Option<Web3NameOf<T>>where KArg: EncodeLike<Web3NameOwnerOf<T>>,

An auto-generated getter for Names.

impl<T: Config> Pallet<T>

pub fn is_banned<KArg>(k: KArg) -> Option<()>where KArg: EncodeLike<Web3NameOf<T>>,

An auto-generated getter for Banned.

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, T::AccountId: From<Public>, T::Web3NameOwner: From<T::AccountId>, T::OwnerOrigin: GenerateBenchmarkOrigin<T::RuntimeOrigin, T::AccountId, T::Web3NameOwner>, T::BanOrigin: EnsureOrigin<T::RuntimeOrigin>, <T as Config>::Currency: Mutate<T::AccountId>,

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>

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>

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

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_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

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

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> 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 wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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