Struct pallet_indices::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

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.

• O(1).
• One storage mutation (codec O(1)).
• One reserve operation.
• One event.

---

• DB Weight: 1 Read/Write (Accounts)

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.

• O(1).
• One storage mutation (codec O(1)).
• One transfer operation.
• One event.

---

• DB Weight:
  • Reads: Indices Accounts, System Account (recipient)
  • Writes: Indices Accounts, System Account (recipient)

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.

• O(1).
• One storage mutation (codec O(1)).
• One reserve operation.
• One event.

---

• DB Weight: 1 Read/Write (Accounts)

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.

• O(1).
• One storage mutation (codec O(1)).
• Up to one reserve operation.
• One event.

---

• DB Weight:
  • Reads: Indices Accounts, System Account (original owner)
  • Writes: Indices Accounts, System Account (original owner)

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.

• O(1).
• One storage mutation (codec O(1)).
• Up to one slash operation.
• One event.

---

• DB Weight: 1 Read/Write (Accounts)

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