Struct pallet_identity::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

Identity pallet declaration.

pub fn add_registrar(
    origin: OriginFor<T>,
    account: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResultWithPostInfo

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.

• O(R) where R registrar-count (governance-bounded and code-bounded).
• One storage mutation (codec O(R)).
• One event.

pub fn set_identity(
    origin: OriginFor<T>,
    info: Box<IdentityInfo<T::MaxAdditionalFields>>
) -> DispatchResultWithPostInfo

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.

• O(X + X' + R)
  • where X additional-field-count (deposit-bounded and code-bounded)
  • where R judgements-count (registrar-count-bounded)
• One balance reserve operation.
• One storage mutation (codec-read O(X' + R), codec-write O(X + R)).
• One event.

pub fn set_subs(
    origin: OriginFor<T>,
    subs: Vec<(T::AccountId, Data)>
) -> DispatchResultWithPostInfo

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.

• O(P + S)
  • where P old-subs-count (hard- and deposit-bounded).
  • where S subs-count (hard- and deposit-bounded).
• At most one balance operations.
• DB:
  • P + S storage mutations (codec complexity O(1))
  • One storage read (codec complexity O(P)).
  • One storage write (codec complexity O(S)).
  • One storage-exists (IdentityOf::contains_key).

pub fn clear_identity(origin: OriginFor<T>) -> DispatchResultWithPostInfo

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.

• O(R + S + X)
  • where R registrar-count (governance-bounded).
  • where S subs-count (hard- and deposit-bounded).
  • where X additional-field-count (deposit-bounded and code-bounded).
• One balance-unreserve operation.
• 2 storage reads and S + 2 storage deletions.
• One event.

pub fn request_judgement(
    origin: OriginFor<T>,
    reg_index: RegistrarIndex,
    max_fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> DispatchResultWithPostInfo

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:

Self::registrars().get(reg_index).unwrap().fee

Emits JudgementRequested if successful.

• O(R + X).
• One balance-reserve operation.
• Storage: 1 read O(R), 1 mutate O(X + R).
• One event.

pub fn cancel_request(
    origin: OriginFor<T>,
    reg_index: RegistrarIndex
) -> DispatchResultWithPostInfo

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.

• O(R + X).
• One balance-reserve operation.
• One storage mutation O(R + X).
• One event

pub fn set_fee(
    origin: OriginFor<T>,
    index: RegistrarIndex,
    fee: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> DispatchResultWithPostInfo

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.

• O(R).
• One storage mutation O(R).
• Benchmark: 7.315 + R * 0.329 µs (min squares analysis)

pub fn set_account_id(
    origin: OriginFor<T>,
    index: RegistrarIndex,
    new: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResultWithPostInfo

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.

• O(R).
• One storage mutation O(R).
• Benchmark: 8.823 + R * 0.32 µs (min squares analysis)

pub fn set_fields(
    origin: OriginFor<T>,
    index: RegistrarIndex,
    fields: IdentityFields
) -> DispatchResultWithPostInfo

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.

• O(R).
• One storage mutation O(R).
• Benchmark: 7.464 + R * 0.325 µs (min squares analysis)

pub fn provide_judgement(
    origin: OriginFor<T>,
    reg_index: RegistrarIndex,
    target: <<T as Config>::Lookup as StaticLookup>::Source,
    judgement: Judgement<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>
) -> DispatchResultWithPostInfo

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.

Emits JudgementGiven if successful.

• O(R + X).
• One balance-transfer operation.
• Up to one account-lookup operation.
• Storage: 1 read O(R), 1 mutate O(R + X).
• One event.

pub fn kill_identity(
    origin: OriginFor<T>,
    target: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResultWithPostInfo

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.

• O(R + S + X).
• One balance-reserve operation.
• S + 2 storage mutations.
• One event.

pub fn add_sub(
    origin: OriginFor<T>,
    sub: <<T as Config>::Lookup as StaticLookup>::Source,
    data: Data
) -> DispatchResult

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.

pub fn rename_sub(
    origin: OriginFor<T>,
    sub: <<T as Config>::Lookup as StaticLookup>::Source,
    data: Data
) -> DispatchResult

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.

pub fn remove_sub(
    origin: OriginFor<T>,
    sub: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult

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.

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

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.

impl<T: Config> Pallet<T>

pub fn identity<KArg>(
    k: KArg
) -> Option<Registration<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::MaxRegistrars, T::MaxAdditionalFields>>where
    KArg: EncodeLike<T::AccountId>,

Information that is pertinent to identify the entity behind an account.

TWOX-NOTE: OK ― AccountId is a secure hash.

impl<T: Config> Pallet<T>

pub fn super_of<KArg>(k: KArg) -> Option<(T::AccountId, Data)>where
    KArg: EncodeLike<T::AccountId>,

The super-identity of an alternative “sub” identity together with its name, within that context. If the account is not some other account’s sub-identity, then just None.

impl<T: Config> Pallet<T>

pub fn subs_of<KArg>(
    k: KArg
) -> (<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, BoundedVec<T::AccountId, T::MaxSubAccounts>)where
    KArg: EncodeLike<T::AccountId>,

Alternative “sub” identities of this account.

The first item is the deposit, the second is a vector of the accounts.

TWOX-NOTE: OK ― AccountId is a secure hash.

impl<T: Config> Pallet<T>

pub fn registrars(
) -> BoundedVec<Option<RegistrarInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::AccountId>>, T::MaxRegistrars>

The set of registrars. Not expected to get very big as can only be added through a special origin (likely a council motion).

The index into this can be cast to RegistrarIndex to get a valid value.

impl<T: Config> Pallet<T>

pub fn subs(who: &T::AccountId) -> Vec<(T::AccountId, Data)>

Get the subs of an account.

pub fn has_identity(who: &T::AccountId, fields: u64) -> bool

Check if the account has corresponding identity information by the identity field.

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

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 Call = 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 try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime 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.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime 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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryState<<T as Config>::BlockNumber> for Pallet<T>

fn try_state(
    n: <T as Config>::BlockNumber,
    _s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

impl<T> Eq for Pallet<T>