Struct pallet_identity::pallet::Pallet

impl<T: Config> Pallet<T>

pub fn create_identity( origin: OriginFor<T>, owner_key: T::AccountId ) -> DispatchResultWithPostInfo

Create an identity for an existing account

owner_key: the public key corresponding to the identity to be created

The origin must be allowed to create an identity.

pub fn confirm_identity( origin: OriginFor<T>, idty_name: IdtyName ) -> DispatchResultWithPostInfo

Confirm the creation of an identity and give it a name

idty_name: the name uniquely associated to this identity. Must match the validation rules defined by the runtime.

The identity must have been created using create_identity before it can be confirmed.

pub fn change_owner_key( origin: OriginFor<T>, new_key: T::AccountId, new_key_sig: T::Signature ) -> DispatchResultWithPostInfo

Change identity owner key.

new_key: the new owner key.
new_key_sig: the signature of the encoded form of IdtyIndexAccountIdPayload. Must be signed by new_key.

The origin should be the old identity owner key.

pub fn revoke_identity( origin: OriginFor<T>, idty_index: T::IdtyIndex, revocation_key: T::AccountId, revocation_sig: T::Signature ) -> DispatchResultWithPostInfo

Revoke an identity using a revocation signature

idty_index: the index of the identity to be revoked.
revocation_key: the key used to sign the revocation payload.
revocation_sig: the signature of the encoded form of RevocationPayload. Must be signed by revocation_key.

Any signed origin can execute this call.

pub fn prune_item_identities_names( origin: OriginFor<T>, names: Vec<IdtyName> ) -> DispatchResultWithPostInfo

Remove identity names from storage.

This function allows a privileged root origin to remove multiple identity names from storage in bulk.

origin - The origin of the call. It must be root.
names - A vector containing the identity names to be removed from storage.

pub fn fix_sufficients( origin: OriginFor<T>, owner_key: T::AccountId, inc: bool ) -> DispatchResultWithPostInfo

Change sufficient reference count for a given key.

This function allows a privileged root origin to increment or decrement the sufficient reference count associated with a specified owner key.

origin - The origin of the call. It must be root.
owner_key - The account whose sufficient reference count will be modified.
inc - A boolean indicating whether to increment (true) or decrement (false) the count.

pub fn link_account( origin: OriginFor<T>, account_id: T::AccountId, payload_sig: T::Signature ) -> DispatchResultWithPostInfo

Link an account to an identity.

This function links a specified account to an identity, requiring both the account and the identity to sign the operation.

origin - The origin of the call, which must have an associated identity index.
account_id - The account ID to link, which must sign the payload.
payload_sig - The signature with the linked identity.

impl<T: Config> Pallet<T>

pub fn identities_count() -> u32

Get the number of identities.

pub fn membership_added(idty_index: T::IdtyIndex)

Handle the addition of membership to an identity.

This function is called when an identity transitions to a member status. It updates the identity’s status, unschedules any pending identity change actions, and resets the identity’s next scheduled action to zero.

pub fn membership_removed(idty_index: T::IdtyIndex) -> Weight

Handle the removal of membership from an identity.

This function is called when membership is revoked from an identity. It checks if the identity is currently a member, and if so, updates its status to NotMember. If the identity is already revoked, this function does nothing.

pub fn do_remove_identity( idty_index: T::IdtyIndex, reason: RemovalReason ) -> Weight

Perform the removal of an identity.

This function acts as a garbage collector for identities. It should not be called while the identity is still a member; otherwise, there will still be a membership in storage, but no more identity.

pub fn do_revoke_identity( idty_index: T::IdtyIndex, reason: RevocationReason ) -> Weight

Revoke an identity.

This function revokes an identity, updating its status to Revoked and scheduling it for removal after the specified deletion period.

fn get_next_idty_index() -> T::IdtyIndex

incremental counter for identity index

pub fn prune_identities(block_number: BlockNumberFor<T>) -> Weight

Prune identities planned for removal at the given block number.

fn update_identity_status( idty_index: T::IdtyIndex, idty_value: IdtyValue<BlockNumberFor<T>, T::AccountId, T::IdtyData>, new_status: IdtyStatus, period: BlockNumberFor<T> )

Change the identity status and reschedule the next action accordingly.

fn unschedule_identity_change( idty_id: T::IdtyIndex, block_number: BlockNumberFor<T> )

Unschedules the change related to an identity.

fn schedule_identity_change( idty_id: T::IdtyIndex, period: BlockNumberFor<T> ) -> BlockNumberFor<T>

Schedule an identity change after a specified period.

fn check_create_identity( issuer_key: &T::AccountId, receiver_key: &T::AccountId, block_number: BlockNumberFor<T> ) -> Result<T::IdtyIndex, DispatchError>

Check if creating an identity is allowed.

pub fn identity<KArg>( k: KArg ) -> Option<IdtyValue<BlockNumberFor<T>, T::AccountId, T::IdtyData>>
where KArg: EncodeLike<T::IdtyIndex>,

An auto-generated getter for Identities.

impl<T: Config> Pallet<T>

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

An auto-generated getter for IdentityIndexOf.

impl<T: Config> Pallet<T>

pub fn identity_by_did<KArg>(k: KArg) -> Option<T::IdtyIndex>
where KArg: EncodeLike<IdtyName>,

An auto-generated getter for IdentitiesNames.

impl<T: Config> Pallet<T>

pub fn next_scheduled<KArg>(k: KArg) -> Vec<T::IdtyIndex>
where KArg: EncodeLike<BlockNumberFor<T>>,

An auto-generated getter for IdentityChangeSchedule.

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> Benchmarking for Pallet<T>
where T: Config + Config, T::Signature: From<Signature>, T::AccountId: From<AccountId32>, T::IdtyIndex: From<u32>,

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

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 RuntimeCall = Call<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: Config> Convert<<T as Config>::IdtyIndex, Option<<T as Config>::AccountId>> for Pallet<T>

fn convert(idty_index: T::IdtyIndex) -> Option<T::AccountId>

Make conversion.

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

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: BlockNumberFor<T>) -> 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> Idty<<T as Config>::IdtyIndex, <T as Config>::AccountId> for Pallet<T>

fn idty_index(owner_key: T::AccountId) -> Option<T::IdtyIndex>

fn owner_key(idty_index: T::IdtyIndex) -> Option<T::AccountId>

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

fn integrity_test()

See [Hooks::integrity_test].

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

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_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 name_hash() -> [u8; 16]

Two128 hash of name.

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

fn storage_info() -> Vec<StorageInfo>

impl<T> StoredMap<<T as Config>::AccountId, <T as Config>::IdtyData> for Pallet<T>
where T: Config,

fn get(key: &T::AccountId) -> T::IdtyData

Get identity data for an account.

fn try_mutate_exists<R, E: From<DispatchError>>( key: &T::AccountId, f: impl FnOnce(&mut Option<T::IdtyData>) -> Result<R, E> ) -> Result<R, E>

Mutate an account in function of its data.

fn mutate<R>(k: &K, f: impl FnOnce(&mut T) -> R) -> Result<R, DispatchError>

Mutate the item.

fn mutate_exists<R>( k: &K, f: impl FnOnce(&mut Option<T>) -> R ) -> Result<R, DispatchError>

Mutate the item, removing or resetting to default value if it has been mutated to None. Read more

fn insert(k: &K, t: T) -> Result<(), DispatchError>

Set the item to something new.

fn remove(k: &K) -> Result<(), DispatchError>

Remove the item or otherwise replace it with its default value; we don’t care which.

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

Compare self to key and return true if they are equal.

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

impl<T, U> IntoKey for T
where U: FromKey<T>,

fn into_key(self) -> U

impl<T> IsType<T> for T

fn from_ref(t: &T) -> &T

Cast reference.

fn into_ref(&self) -> &T

Cast reference.

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

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

Cast mutable reference.

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

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

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryIntoKey for T
where U: TryFromKey<T>,

type Error = >::Error

fn try_into_key(self) -> Result<U, >::Error>

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> JsonSchemaMaybe for T

impl<T> MaybeDebug for T
where T: Debug,

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

impl<T> Member for T
where T: Send + Sync + Debug + Eq + PartialEq + Clone + 'static,