Type Alias public_credentials::pallet::Module

pub type Module<T> = Pallet<T>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T>(/* private fields */);

Implementations

impl<T: Config> Pallet<T>

pub fn add( origin: OriginFor<T>, credential: Box<InputCredentialOf<T>> ) -> DispatchResultWithPostInfo

Register a new public credential on chain.

This function fails if a credential with the same identifier already exists for the specified subject.

Emits CredentialStored.

pub fn revoke( origin: OriginFor<T>, credential_id: CredentialIdOf<T>, authorization: Option<T::AccessControl> ) -> DispatchResultWithPostInfo

Revokes a public credential.

If a credential was already revoked, this function does not fail but simply results in a noop.

The dispatch origin must be authorized to revoke the credential.

Emits CredentialRevoked.

pub fn unrevoke( origin: OriginFor<T>, credential_id: CredentialIdOf<T>, authorization: Option<T::AccessControl> ) -> DispatchResultWithPostInfo

Unrevokes a public credential.

If a credential was not revoked, this function does not fail but simply results in a noop.

The dispatch origin must be authorized to unrevoke the credential.

Emits CredentialUnrevoked.

pub fn remove( origin: OriginFor<T>, credential_id: CredentialIdOf<T>, authorization: Option<T::AccessControl> ) -> DispatchResultWithPostInfo

Removes the information pertaining a public credential from the chain.

The removal of the credential does not delete it entirely from the blockchain history, but only its link from the blockchain state to the blockchain history is removed.

Clients parsing public credentials should interpret the lack of such a link as the fact that the credential has been removed by its attester some time in the past.

This function fails if a credential already exists for the specified subject.

The dispatch origin must be authorized to remove the credential.

Emits CredentialRemoved.

pub fn reclaim_deposit( origin: OriginFor<T>, credential_id: CredentialIdOf<T> ) -> DispatchResult

Removes the information pertaining a public credential from the chain and returns the deposit to its payer.

The removal of the credential does not delete it entirely from the blockchain history, but only its link from the blockchain state to the blockchain history is removed.

Clients parsing public credentials should interpret the lack of such a link as the fact that the credential has been removed by its attester some time in the past.

This function fails if a credential already exists for the specified subject.

The dispatch origin must be the owner of the deposit, hence not the credential’s attester.

Emits CredentialRemoved.

pub fn change_deposit_owner( origin: OriginFor<T>, credential_id: CredentialIdOf<T> ) -> DispatchResult

Changes the deposit owner.

The balance that is reserved by the current deposit owner will be freed and balance of the new deposit owner will get reserved.

The subject of the call must be the owner of the credential. The sender of the call will be the new deposit owner.

pub fn update_deposit( origin: OriginFor<T>, credential_id: CredentialIdOf<T> ) -> DispatchResult

Updates the deposit amount to the current deposit rate.

The sender must be the deposit owner.

impl<T: Config> Pallet<T>

pub fn get_credential_info<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<CredentialEntryOf<T>>where KArg1: EncodeLike<SubjectIdOf<T>>, KArg2: EncodeLike<CredentialIdOf<T>>,

An auto-generated getter for Credentials.

impl<T: Config> Pallet<T>

pub fn get_credential_subject<KArg>(k: KArg) -> Option<SubjectIdOf<T>>where KArg: EncodeLike<CredentialIdOf<T>>,

An auto-generated getter for CredentialSubjects.

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 + Debug + Config + Config<CtypeCreatorId = T::AttesterId>, <T as Config>::EnsureOrigin: GenerateBenchmarkOrigin<T::RuntimeOrigin, T::AccountId, T::AttesterId>, <T as Config>::SubjectId: GetWorstCase<Output = <T as Config>::SubjectId> + Into<Vec<u8>> + Debug, <T as Config>::CredentialId: Default, BlockNumberFor<T>: From<u64>, <T as Config>::Currency: Mutate<T::AccountId> + ReservableCurrency<T::AccountId>,

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

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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]).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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 wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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.

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect ) -> Result<(), TryRuntimeError>

Execute the state checks.

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>