Enum pallet_indices::pallet::Call

pub enum Call<T: Config> {
    claim {
        index: T::AccountIndex,
    },
    transfer {
        new: T::AccountId,
        index: T::AccountIndex,
    },
    free {
        index: T::AccountIndex,
    },
    force_transfer {
        new: T::AccountId,
        index: T::AccountIndex,
        freeze: bool,
    },
    freeze {
        index: T::AccountIndex,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

claim

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)

Fields of claim

index: T::AccountIndex

transfer

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)

Fields of transfer

new: T::AccountIdindex: T::AccountIndex

free

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)

Fields of free

index: T::AccountIndex

force_transfer

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)

Fields of force_transfer

new: T::AccountIdindex: T::AccountIndexfreeze: bool

freeze

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)

Fields of freeze

index: T::AccountIndex

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_claim(index: T::AccountIndex) -> Self

Create a call with the variant claim.

pub fn new_call_variant_transfer(
    new: T::AccountId,
    index: T::AccountIndex
) -> Self

Create a call with the variant transfer.

pub fn new_call_variant_free(index: T::AccountIndex) -> Self

Create a call with the variant free.

pub fn new_call_variant_force_transfer(
    new: T::AccountId,
    index: T::AccountIndex,
    freeze: bool
) -> Self

Create a call with the variant force_transfer.

pub fn new_call_variant_freeze(index: T::AccountIndex) -> Self

Create a call with the variant freeze.

Trait Implementations

impl<T: Config> Clone for Call<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: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq<Call<T>> for Call<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 !=.

impl<T: Config> TypeInfo for Call<T> where
    PhantomData<(T,)>: TypeInfo + 'static,
    T::AccountIndex: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountIndex: TypeInfo + 'static,
    T::AccountIndex: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T::AccountIndex: TypeInfo + 'static,
    T::AccountIndex: TypeInfo + 'static,
    T: Config + 'static, 

type Identity = Self

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type Origin = OriginFor<T>

The origin type of the runtime, (i.e. frame_system::Config::Origin).

fn dispatch_bypass_filter(
    self,
    origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>