Struct dock_runtime::did::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T> Pallet<T>where T: Config,

pub fn is_offchain_did(did: &Did) -> Result<bool, Error<T>>

pub fn offchain_did_details( did: &Did ) -> Result<OffChainDidDetails<T>, Error<T>>

Get DID detail of an off-chain DID. Throws error if DID does not exist or is on-chain.

impl<T> Pallet<T>where T: Config,

pub fn is_onchain_did(did: &Did) -> Result<bool, Error<T>>

pub fn onchain_did_details( did: &Did ) -> Result<WithNonce<T, OnChainDidDetails>, Error<T>>

Get DID detail of an on-chain DID. Throws error if DID does not exist or is off-chain.

impl<T> Pallet<T>where T: Config,

pub fn ensure_controller( controlled: &Did, controller: &Controller ) -> Result<(), Error<T>>

Throws an error if controller is not the controller of controlled

pub fn is_controller(controlled: &Did, controller: &Controller) -> bool

Returns true if given controlled DID is controlled by the controller DID.

pub fn is_self_controlled(did: &Did) -> bool

Returns true if DID controls itself, else false.

impl<T> Pallet<T>where T: Config,

pub fn aggregate_did_details( did: &Did, params: AggregatedDidDetailsRequestParams ) -> Option<AggregatedDidDetailsResponse<T>>

Request aggregated DID details containing specified information.

impl<T> Pallet<T>where T: Config,

pub fn new_offchain( origin: <T as Config>::Origin, did: Did, did_doc_ref: OffChainDidDocRef<T> ) -> Result<(), DispatchError>

Creates a new offchain DID (Decentralized Identifier) entry.

This function is used to create a new offchain DID entry by providing a reference to an offchain DID document.

Parameters

• origin: The origin of the call, which determines who is making the request.
• did: The decentralized identifier (DID) that uniquely identifies the entity.
• did_doc_ref: The new reference to the offchain DID document. It can be one of the following:
  • CID: A Content Identifier as per multiformats/cid.
  • URL: A URL pointing to the DID document.
  • Custom: A custom encoding of the reference.

pub fn set_offchain_did_doc_ref( origin: <T as Config>::Origin, did: Did, did_doc_ref: OffChainDidDocRef<T> ) -> Result<(), DispatchError>

Updates the offchain DID document reference for an existing DID.

This function is used to set or update the reference to the offchain DID document for a given DID. The offchain DID document reference can be one of the following types: CID, URL, or Custom.

Parameters

• origin: The origin of the call, which determines who is making the request and their permissions.
• did: The decentralized identifier (DID) that uniquely identifies the entity whose DID document reference is being updated.
• did_doc_ref: The new reference to the offchain DID document. It can be one of the following:
  • CID: A Content Identifier as per multiformats/cid.
  • URL: A URL pointing to the DID document.
  • Custom: A custom encoding of the reference.

pub fn remove_offchain_did( origin: <T as Config>::Origin, did: Did ) -> Result<(), DispatchError>

Removes an existing offchain DID entry.

This function is used to remove an offchain DID entry from the system. This operation deletes the DID and its associated offchain DID document reference.

Parameters

• origin: The origin of the call, which determines who is making the request and their permissions.
• did: The decentralized identifier (DID) that uniquely identifies the entity to be removed.

pub fn new_onchain( origin: <T as Config>::Origin, did: Did, keys: Vec<UncheckedDidKey, Global>, controllers: BTreeSet<Controller, Global> ) -> Result<(), DispatchError>

Create new DID. At least 1 control key or 1 controller must be provided. If any supplied key has an empty ver_rel, then it will use all verification relationships available for its key type.

pub fn add_keys( origin: <T as Config>::Origin, keys: AddKeys<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Add more keys from DID doc. Does not check if the key was already added.

pub fn remove_keys( origin: <T as Config>::Origin, keys: RemoveKeys<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Remove keys from DID doc. This is an atomic operation meaning that it will either remove all keys or do nothing. Note that removing all keys might make DID unusable.

pub fn add_controllers( origin: <T as Config>::Origin, controllers: AddControllers<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Add new controllers to the signer DID. Does not require provided controllers to

• have any key
• exist on- or off-chain

pub fn remove_controllers( origin: <T as Config>::Origin, controllers: RemoveControllers<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Remove controllers from the signer DID. This is an atomic operation meaning that it will either remove all keys or do nothing. Note that removing all controllers might make DID unusable.

pub fn add_service_endpoint( origin: <T as Config>::Origin, service_endpoint: AddServiceEndpoint<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Add a single service endpoint to the signer DID.

pub fn remove_service_endpoint( origin: <T as Config>::Origin, service_endpoint: RemoveServiceEndpoint<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Remove a single service endpoint.

pub fn remove_onchain_did( origin: <T as Config>::Origin, removal: DidRemoval<T>, sig: DidOrDidMethodKeySignature<Controller> ) -> Result<(), DispatchError>

Remove the on-chain DID along with its keys, controllers, service endpoints and BBS+ keys. Other DID-controlled entities won’t be removed. However, the authorization logic ensures that once a DID is removed, it loses its ability to control any DID.

pub fn new_did_method_key( origin: <T as Config>::Origin, did_key: DidMethodKey ) -> Result<(), DispatchError>

Adds an on-chain state storing the nonce for the provided DID method key. After this state is set, this DID method key will be able to submit a DID transaction.

impl<T> Pallet<T>where T: Config,

pub fn did<KArg>(k: KArg) -> Option<StoredDidDetails<T>>where KArg: EncodeLike<Did>,

Stores details of off-chain and on-chain DIDs

impl<T> Pallet<T>where T: Config,

pub fn did_method_key<KArg>(k: KArg) -> Option<WithNonce<T, ()>>where KArg: EncodeLike<DidMethodKey>,

Stores nonce for did:key DIDs.

impl<T> Pallet<T>where T: Config,

pub fn did_key<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<DidKey>where KArg1: EncodeLike<Did>, KArg2: EncodeLike<IncId>,

Stores keys of a DID as (DID, IncId) -> DidKey. Does not check if the same key is being added multiple times to the same DID.

impl<T> Pallet<T>where T: Config,

pub fn bound_controller<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<()>where KArg1: EncodeLike<Did>, KArg2: EncodeLike<Controller>,

Stores controlled - controller pairs of a DID as (DID, DID) -> zero-sized record. If a record exists, then the controller is bound.

impl<T> Pallet<T>where T: Config,

pub fn did_service_endpoint<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<ServiceEndpoint<T>>where KArg1: EncodeLike<Did>, KArg2: EncodeLike<ServiceEndpointId<T>>,

Stores service endpoints of a DID as (DID, endpoint id) -> ServiceEndpoint.

impl<T> Pallet<T>where T: Config,

pub fn storage_version() -> StorageVersion

Trait Implementations

impl<T> Callable<T> for Pallet<T>where T: Config,

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

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<(), Error>

Formats the value using the given formatter.

impl From<<Pallet<Runtime> as Callable<Runtime>>::Call> for Call

fn from(call: CallableCallFor<DIDModule, Runtime>) -> Self

Converts to this type from the input type.

impl<T> GetStorageVersion for Pallet<T>where T: Config,

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> Hooks<<T as Config>::BlockNumber> for Pallet<T>where T: Config,

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 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> IntegrityTest for Pallet<T>where T: Config,

fn integrity_test()

Run integrity test.

impl IsSubType<<Pallet<Runtime> as Callable<Runtime>>::Call> for Call

fn is_sub_type(&self) -> Option<&CallableCallFor<DIDModule, Runtime>>

Returns Some(_) if self is an instance of sub type T.

impl<T> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>where T: Config,

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>where T: Config,

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T> OnGenesis for Pallet<T>where T: Config,

fn on_genesis()

Something that should happen at genesis.

impl<T> OnIdle<<T as Config>::BlockNumber> for Pallet<T>where T: Config,

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> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>where T: Config,

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T> PalletInfoAccess for Pallet<T>where T: Config,

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> PalletsInfoAccess for Pallet<T>where T: Config,

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData, Global>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Pallet<T>) -> 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> StorageInfoTrait for Pallet<T>where T: Config,

fn storage_info() -> Vec<StorageInfo, Global>

impl<T> Eq for Pallet<T>