Struct pallet_indices :: pallet :: Pallet Copy item path

impl<T: Config> Pallet<T>

pub fn claim(origin: OriginFor<T>, index: T::AccountIndex) -> DispatchResult

Assign an previously unassigned index.

Payment: Deposit is reserved from the sender account.

The dispatch origin for this call must be Signed.

index: the index to be claimed. This must not be in use.

Emits IndexAssigned if successful.

§Complexity

O(1).

pub fn transfer( origin: OriginFor<T>, new: <<T as Config>::Lookup as StaticLookup>::Source, index: T::AccountIndex ) -> DispatchResult

Assign an index already owned by the sender to another account. The balance reservation is effectively transferred to the new account.

The dispatch origin for this call must be Signed.

index: the index to be re-assigned. This must be owned by the sender.
new: the new owner of the index. This function is a no-op if it is equal to sender.

Emits IndexAssigned if successful.

§Complexity

O(1).

pub fn free(origin: OriginFor<T>, index: T::AccountIndex) -> DispatchResult

Free up an index owned by the sender.

Payment: Any previous deposit placed for the index is unreserved in the sender account.

The dispatch origin for this call must be Signed and the sender must own the index.

index: the index to be freed. This must be owned by the sender.

Emits IndexFreed if successful.

§Complexity

O(1).

pub fn force_transfer( origin: OriginFor<T>, new: <<T as Config>::Lookup as StaticLookup>::Source, index: T::AccountIndex, freeze: bool ) -> DispatchResult

Force an index to an account. This doesn’t require a deposit. If the index is already held, then any deposit is reimbursed to its current owner.

The dispatch origin for this call must be Root.

index: the index to be (re-)assigned.
new: the new owner of the index. This function is a no-op if it is equal to sender.
freeze: if set to true, will freeze the index so it cannot be transferred.

Emits IndexAssigned if successful.

§Complexity

O(1).

pub fn freeze(origin: OriginFor<T>, index: T::AccountIndex) -> DispatchResult

Freeze an index so it will always point to the sender account. This consumes the deposit.

The dispatch origin for this call must be Signed and the signing account must have a non-frozen account index.

index: the index to be frozen in place.

Emits IndexFrozen if successful.

§Complexity

O(1).

impl<T: Config> Pallet<T>

pub fn lookup_index(index: T::AccountIndex) -> Option<T::AccountId>

Lookup an T::AccountIndex to get an Id, if there’s one there.

pub fn lookup_address( a: MultiAddress<T::AccountId, T::AccountIndex> ) -> Option<T::AccountId>

Lookup an address to get an Id, if there’s one there.

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

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro. Read more

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. Read more

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more

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). Read more

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application. Read more

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet. Read more

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. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

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

fn offchain_worker(n: BlockNumberFor<T>)

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

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.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See Hooks::on_idle.

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See Hooks::on_initialize.

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. Read more

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. Read more

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

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

1.0.0 · source§

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

type Source = MultiAddress<<T as Config>::AccountId, <T as Config>::AccountIndex>

Type to lookup from.

type Target = <T as Config>::AccountId

Type to lookup into.

fn lookup(a: Self::Source) -> Result<Self::Target, LookupError>

Attempt a lookup.

fn unlookup(a: Self::Target) -> Self::Source

Convert from Target back to Source.

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

fn storage_info() -> Vec<StorageInfo>

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>

Auto Trait Implementations§

impl<T> Freeze for Pallet<T>

impl<T> RefUnwindSafe for Pallet<T>
where T: RefUnwindSafe,

impl<T> Send for Pallet<T>
where T: Send,

impl<T> Sync for Pallet<T>
where T: Sync,

impl<T> Unpin for Pallet<T>
where T: Unpin,

impl<T> UnwindSafe for Pallet<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more