Enum pallet_identity::pallet::Call

pub enum Call<T: Config> {
    add_registrar {
        account: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    set_identity {
        info: Box<T::IdentityInformation>,
    },
    set_subs {
        subs: Vec<(T::AccountId, Data)>,
    },
    clear_identity {},
    request_judgement {
        reg_index: RegistrarIndex,
        max_fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    },
    cancel_request {
        reg_index: RegistrarIndex,
    },
    set_fee {
        index: RegistrarIndex,
        fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    },
    set_account_id {
        index: RegistrarIndex,
        new: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    set_fields {
        index: RegistrarIndex,
        fields: <T::IdentityInformation as IdentityInformationProvider>::FieldsIdentifier,
    },
    provide_judgement {
        reg_index: RegistrarIndex,
        target: <<T as Config>::Lookup as StaticLookup>::Source,
        judgement: Judgement<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>,
        identity: T::Hash,
    },
    kill_identity {
        target: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    add_sub {
        sub: <<T as Config>::Lookup as StaticLookup>::Source,
        data: Data,
    },
    rename_sub {
        sub: <<T as Config>::Lookup as StaticLookup>::Source,
        data: Data,
    },
    remove_sub {
        sub: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    quit_sub {},
    add_username_authority {
        authority: <<T as Config>::Lookup as StaticLookup>::Source,
        suffix: Vec<u8>,
        allocation: u32,
    },
    remove_username_authority {
        suffix: Vec<u8>,
        authority: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    set_username_for {
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        username: Vec<u8>,
        signature: Option<T::OffchainSignature>,
        use_allocation: bool,
    },
    accept_username {
        username: BoundedVec<u8, <T as Config>::MaxUsernameLength>,
    },
    remove_expired_approval {
        username: BoundedVec<u8, <T as Config>::MaxUsernameLength>,
    },
    set_primary_username {
        username: BoundedVec<u8, <T as Config>::MaxUsernameLength>,
    },
    unbind_username {
        username: BoundedVec<u8, <T as Config>::MaxUsernameLength>,
    },
    remove_username {
        username: BoundedVec<u8, <T as Config>::MaxUsernameLength>,
    },
    kill_username {
        username: BoundedVec<u8, <T as Config>::MaxUsernameLength>,
    },
    // some variants omitted
}

Identity pallet declaration.

Variants

add_registrar

Add a registrar to the system.

The dispatch origin for this call must be T::RegistrarOrigin.

• account: the account of the registrar.

Emits RegistrarAdded if successful.

Fields

account: <<T as Config>::Lookup as StaticLookup>::Source

set_identity

Set an account’s identity information and reserve the appropriate deposit.

If the account already has identity information, the deposit is taken as part payment for the new deposit.

The dispatch origin for this call must be Signed.

• info: The identity information.

Emits IdentitySet if successful.

Fields

info: Box<T::IdentityInformation>

set_subs

Set the sub-accounts of the sender.

Payment: Any aggregate balance reserved by previous set_subs calls will be returned and an amount SubAccountDeposit will be reserved for each item in subs.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

• subs: The identity’s (new) sub-accounts.

Fields

subs: Vec<(T::AccountId, Data)>

clear_identity

Clear an account’s identity info and all sub-accounts and return all deposits.

Payment: All reserved balances on the account are returned.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

Emits IdentityCleared if successful.

request_judgement

Request a judgement from a registrar.

Payment: At most max_fee will be reserved for payment to the registrar if judgement given.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

• reg_index: The index of the registrar whose judgement is requested.
• max_fee: The maximum fee that may be paid. This should just be auto-populated as:

Registrars::<T>::get().get(reg_index).unwrap().fee

Emits JudgementRequested if successful.

Fields

reg_index: RegistrarIndex

max_fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

cancel_request

Cancel a previous request.

Payment: A previously reserved deposit is returned on success.

The dispatch origin for this call must be Signed and the sender must have a registered identity.

• reg_index: The index of the registrar whose judgement is no longer requested.

Emits JudgementUnrequested if successful.

Fields

reg_index: RegistrarIndex

set_fee

Set the fee required for a judgement to be requested from a registrar.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is index.

• index: the index of the registrar whose fee is to be set.
• fee: the new fee.

Fields

index: RegistrarIndex

fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

set_account_id

Change the account associated with a registrar.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is index.

• index: the index of the registrar whose fee is to be set.
• new: the new account ID.

Fields

index: RegistrarIndex

new: <<T as Config>::Lookup as StaticLookup>::Source

set_fields

Set the field information for a registrar.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is index.

• index: the index of the registrar whose fee is to be set.
• fields: the fields that the registrar concerns themselves with.

Fields

index: RegistrarIndex

fields: <T::IdentityInformation as IdentityInformationProvider>::FieldsIdentifier

provide_judgement

Provide a judgement for an account’s identity.

The dispatch origin for this call must be Signed and the sender must be the account of the registrar whose index is reg_index.

• reg_index: the index of the registrar whose judgement is being made.
• target: the account whose identity the judgement is upon. This must be an account with a registered identity.
• judgement: the judgement of the registrar of index reg_index about target.
• identity: The hash of the IdentityInformationProvider for that the judgement is provided.

Note: Judgements do not apply to a username.

Emits JudgementGiven if successful.

Fields

reg_index: RegistrarIndex

target: <<T as Config>::Lookup as StaticLookup>::Source

judgement: Judgement<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

identity: T::Hash

kill_identity

Remove an account’s identity and sub-account information and slash the deposits.

Payment: Reserved balances from set_subs and set_identity are slashed and handled by Slash. Verification request deposits are not returned; they should be cancelled manually using cancel_request.

The dispatch origin for this call must match T::ForceOrigin.

• target: the account whose identity the judgement is upon. This must be an account with a registered identity.

Emits IdentityKilled if successful.

Fields

target: <<T as Config>::Lookup as StaticLookup>::Source

add_sub

Add the given account to the sender’s subs.

Payment: Balance reserved by a previous set_subs call for one sub will be repatriated to the sender.

The dispatch origin for this call must be Signed and the sender must have a registered sub identity of sub.

Fields

sub: <<T as Config>::Lookup as StaticLookup>::Source

data: Data

rename_sub

Alter the associated name of the given sub-account.

The dispatch origin for this call must be Signed and the sender must have a registered sub identity of sub.

Fields

sub: <<T as Config>::Lookup as StaticLookup>::Source

data: Data

remove_sub

Remove the given account from the sender’s subs.

Payment: Balance reserved by a previous set_subs call for one sub will be repatriated to the sender.

The dispatch origin for this call must be Signed and the sender must have a registered sub identity of sub.

Fields

sub: <<T as Config>::Lookup as StaticLookup>::Source

quit_sub

Remove the sender as a sub-account.

Payment: Balance reserved by a previous set_subs call for one sub will be repatriated to the sender (not the original depositor).

The dispatch origin for this call must be Signed and the sender must have a registered super-identity.

NOTE: This should not normally be used, but is provided in the case that the non- controller of an account is maliciously registered as a sub-account.

add_username_authority

Add an AccountId with permission to grant usernames with a given suffix appended.

The authority can grant up to allocation usernames. To top up the allocation or change the account used to grant usernames, this call can be used with the updated parameters to overwrite the existing configuration.

Fields

authority: <<T as Config>::Lookup as StaticLookup>::Source

suffix: Vec<u8>

allocation: u32

remove_username_authority

Remove authority from the username authorities.

Fields

suffix: Vec<u8>

authority: <<T as Config>::Lookup as StaticLookup>::Source

set_username_for

Set the username for who. Must be called by a username authority.

If use_allocation is set, the authority must have a username allocation available to spend. Otherwise, the authority will need to put up a deposit for registering the username.

Users can either pre-sign their usernames or accept them later.

Usernames must:

• Only contain lowercase ASCII characters or digits.
• When combined with the suffix of the issuing authority be less than the MaxUsernameLength.

Fields

who: <<T as Config>::Lookup as StaticLookup>::Source

username: Vec<u8>

signature: Option<T::OffchainSignature>

use_allocation: bool

accept_username

Accept a given username that an authority granted. The call must include the full username, as in username.suffix.

Fields

username: BoundedVec<u8, <T as Config>::MaxUsernameLength>

remove_expired_approval

Remove an expired username approval. The username was approved by an authority but never accepted by the user and must now be beyond its expiration. The call must include the full username, as in username.suffix.

Fields

username: BoundedVec<u8, <T as Config>::MaxUsernameLength>

set_primary_username

Set a given username as the primary. The username should include the suffix.

Fields

username: BoundedVec<u8, <T as Config>::MaxUsernameLength>

unbind_username

Start the process of removing a username by placing it in the unbinding usernames map. Once the grace period has passed, the username can be deleted by calling remove_username.

Fields

username: BoundedVec<u8, <T as Config>::MaxUsernameLength>

remove_username

Permanently delete a username which has been unbinding for longer than the grace period. Caller is refunded the fee if the username expired and the removal was successful.

Fields

username: BoundedVec<u8, <T as Config>::MaxUsernameLength>

kill_username

Call with ForceOrigin privileges which deletes a username and slashes any deposit associated with it.

Fields

username: BoundedVec<u8, <T as Config>::MaxUsernameLength>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_add_registrar( account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant add_registrar.

pub fn new_call_variant_set_identity(info: Box<T::IdentityInformation>) -> Self

Create a call with the variant set_identity.

pub fn new_call_variant_set_subs(subs: Vec<(T::AccountId, Data)>) -> Self

Create a call with the variant set_subs.

pub fn new_call_variant_clear_identity() -> Self

Create a call with the variant clear_identity.

pub fn new_call_variant_request_judgement( reg_index: RegistrarIndex, max_fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant request_judgement.

pub fn new_call_variant_cancel_request(reg_index: RegistrarIndex) -> Self

Create a call with the variant cancel_request.

pub fn new_call_variant_set_fee( index: RegistrarIndex, fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, ) -> Self

Create a call with the variant set_fee.

pub fn new_call_variant_set_account_id( index: RegistrarIndex, new: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant set_account_id.

pub fn new_call_variant_set_fields( index: RegistrarIndex, fields: <T::IdentityInformation as IdentityInformationProvider>::FieldsIdentifier, ) -> Self

Create a call with the variant set_fields.

pub fn new_call_variant_provide_judgement( reg_index: RegistrarIndex, target: <<T as Config>::Lookup as StaticLookup>::Source, judgement: Judgement<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>, identity: T::Hash, ) -> Self

Create a call with the variant provide_judgement.

pub fn new_call_variant_kill_identity( target: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant kill_identity.

pub fn new_call_variant_add_sub( sub: <<T as Config>::Lookup as StaticLookup>::Source, data: Data, ) -> Self

Create a call with the variant add_sub.

pub fn new_call_variant_rename_sub( sub: <<T as Config>::Lookup as StaticLookup>::Source, data: Data, ) -> Self

Create a call with the variant rename_sub.

pub fn new_call_variant_remove_sub( sub: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant remove_sub.

pub fn new_call_variant_quit_sub() -> Self

Create a call with the variant quit_sub.

pub fn new_call_variant_add_username_authority( authority: <<T as Config>::Lookup as StaticLookup>::Source, suffix: Vec<u8>, allocation: u32, ) -> Self

Create a call with the variant add_username_authority.

pub fn new_call_variant_remove_username_authority( suffix: Vec<u8>, authority: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant remove_username_authority.

pub fn new_call_variant_set_username_for( who: <<T as Config>::Lookup as StaticLookup>::Source, username: Vec<u8>, signature: Option<T::OffchainSignature>, use_allocation: bool, ) -> Self

Create a call with the variant set_username_for.

pub fn new_call_variant_accept_username( username: BoundedVec<u8, <T as Config>::MaxUsernameLength>, ) -> Self

Create a call with the variant accept_username.

pub fn new_call_variant_remove_expired_approval( username: BoundedVec<u8, <T as Config>::MaxUsernameLength>, ) -> Self

Create a call with the variant remove_expired_approval.

pub fn new_call_variant_set_primary_username( username: BoundedVec<u8, <T as Config>::MaxUsernameLength>, ) -> Self

Create a call with the variant set_primary_username.

pub fn new_call_variant_unbind_username( username: BoundedVec<u8, <T as Config>::MaxUsernameLength>, ) -> Self

Create a call with the variant unbind_username.

pub fn new_call_variant_remove_username( username: BoundedVec<u8, <T as Config>::MaxUsernameLength>, ) -> Self

Create a call with the variant remove_username.

pub fn new_call_variant_kill_username( username: BoundedVec<u8, <T as Config>::MaxUsernameLength>, ) -> Self

Create a call with the variant kill_username.

Trait Implementations

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

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

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 decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 size_hint(&self) -> usize

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

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

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

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

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> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

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 in the same order as [GetCallIndex].

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 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, Box<T::IdentityInformation>: TypeInfo + 'static, Vec<(T::AccountId, Data)>: TypeInfo + 'static, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: HasCompact, <T::IdentityInformation as IdentityInformationProvider>::FieldsIdentifier: TypeInfo + 'static, Judgement<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>: TypeInfo + 'static, T::Hash: TypeInfo + 'static, Option<T::OffchainSignature>: TypeInfo + 'static, BoundedVec<u8, <T as Config>::MaxUsernameLength>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

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 RuntimeOrigin = <T as Config>::RuntimeOrigin

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

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

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

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

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