Struct did::did_details::DidDetails

pub struct DidDetails<T: Config> {
    pub authentication_key: KeyIdOf<T>,
    pub key_agreement_keys: BoundedBTreeSet<KeyIdOf<T>, <T as Config>::MaxTotalKeyAgreementKeys>,
    pub delegation_key: Option<KeyIdOf<T>>,
    pub attestation_key: Option<KeyIdOf<T>>,
    pub public_keys: BoundedBTreeMap<KeyIdOf<T>, DidPublicKeyDetails<BlockNumberFor<T>, AccountIdOf<T>>, <T as Config>::MaxPublicKeysPerDid>,
    pub last_tx_counter: u64,
    pub deposit: Deposit<AccountIdOf<T>, BalanceOf<T>>,
}

The details associated to a DID identity.

Fields

authentication_key: KeyIdOf<T>

The ID of the authentication key, used to authenticate DID-related operations.

key_agreement_keys: BoundedBTreeSet<KeyIdOf<T>, <T as Config>::MaxTotalKeyAgreementKeys>

The set of the key agreement key IDs, which can be used to encrypt data addressed to the DID subject.

delegation_key: Option<KeyIdOf<T>>

[OPTIONAL] The ID of the delegation key, used to verify the signatures of the delegations created by the DID subject.

attestation_key: Option<KeyIdOf<T>>

[OPTIONAL] The ID of the attestation key, used to verify the signatures of the attestations created by the DID subject.

public_keys: BoundedBTreeMap<KeyIdOf<T>, DidPublicKeyDetails<BlockNumberFor<T>, AccountIdOf<T>>, <T as Config>::MaxPublicKeysPerDid>

The map of public keys, with the key label as the key map and the tuple (key, addition_block_number) as the map value. The map includes all the keys under the control of the DID subject, including the ones currently used for authentication, key agreement, attestation, and delegation. Other than those, the map also contains the old attestation keys that have been rotated, i.e., they cannot be used to create new attestations but can still be used to verify previously issued attestations.

last_tx_counter: u64

The counter used to avoid replay attacks, which is checked and updated upon each DID operation involving with the subject as the creator.

deposit: Deposit<AccountIdOf<T>, BalanceOf<T>>

The deposit that was taken to incentivise fair use of the on chain storage.

Implementations

impl<T: Config> DidDetails<T>

pub fn new( authentication_key: DidVerificationKey<AccountIdOf<T>>, block_number: BlockNumberFor<T>, deposit_owner: AccountIdOf<T> ) -> Result<Self, StorageError>

Creates a new instance of DID details with the minimum information, i.e., an authentication key and the block creation time.

The tx counter is automatically set to 0.

pub fn calculate_deposit(&self, endpoint_count: u32) -> BalanceOf<T>

Calculate the deposit that should be secured for the DID based on the number of keys and service endpoints.

Since service endpoints are not stored inside the DidDetails, the number of endpoints need to be provided.

pub fn new_with_creation_details( details: DidCreationDetails<DidIdentifierOf<T>, AccountIdOf<T>, <T as Config>::MaxNewKeyAgreementKeys, DidEndpoint<T>>, new_auth_key: DidVerificationKey<AccountIdOf<T>> ) -> Result<Self, DidError>

Creates a new DID entry from some DidCreationDetails and a given authentication key.

pub fn update_authentication_key( &mut self, new_authentication_key: DidVerificationKey<AccountIdOf<T>>, block_number: BlockNumberFor<T> ) -> Result<(), StorageError>

Update the DID authentication key.

The old key is deleted from the set of public keys if it is not used in any other part of the DID. The new key is added to the set of public keys.

pub fn add_key_agreement_keys( &mut self, new_key_agreement_keys: BoundedBTreeSet<DidEncryptionKey, T::MaxNewKeyAgreementKeys>, block_number: BlockNumberFor<T> ) -> Result<(), StorageError>

Add new key agreement keys to the DID.

The new keys are added to the set of public keys.

pub fn add_key_agreement_key( &mut self, new_key_agreement_key: DidEncryptionKey, block_number: BlockNumberFor<T> ) -> Result<(), StorageError>

Add a single new key agreement key to the DID.

The new key is added to the set of public keys.

pub fn remove_key_agreement_key( &mut self, key_id: KeyIdOf<T> ) -> Result<(), StorageError>

Remove a key agreement key from both the set of key agreement keys and the one of public keys.

pub fn update_attestation_key( &mut self, new_attestation_key: DidVerificationKey<AccountIdOf<T>>, block_number: BlockNumberFor<T> ) -> Result<(), StorageError>

Update the DID attestation key, replacing the old one with the new one.

The old key is deleted from the set of public keys if it is not used in any other part of the DID. The new key is added to the set of public keys.

pub fn remove_attestation_key(&mut self) -> Result<(), StorageError>

Remove the DID attestation key.

The old key is deleted from the set of public keys if it is not used in any other part of the DID. The new key is added to the set of public keys.

pub fn update_delegation_key( &mut self, new_delegation_key: DidVerificationKey<AccountIdOf<T>>, block_number: BlockNumberFor<T> ) -> Result<(), StorageError>

Update the DID delegation key, replacing the old one with the new one.

The old key is deleted from the set of public keys if it is not used in any other part of the DID. The new key is added to the set of public keys.

pub fn remove_delegation_key(&mut self) -> Result<(), StorageError>

Remove the DID delegation key.

The old key is deleted from the set of public keys if it is not used in any other part of the DID. The new key is added to the set of public keys.

pub fn remove_key_if_unused(&mut self, key_id: KeyIdOf<T>)

Remove a key from the map of public keys if none of the other keys, i.e., authentication, key agreement, attestation, or delegation, is referencing it.

pub fn get_verification_key_for_key_type( &self, key_type: DidVerificationKeyRelationship ) -> Option<&DidVerificationKey<AccountIdOf<T>>>

Returns a reference to a specific verification key given the type of the key needed.

pub fn increase_tx_counter(&mut self) -> u64

Increase the tx counter of the DID.

Trait Implementations

impl<T: Clone + Config> Clone for DidDetails<T>

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

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Config> Debug for DidDetails<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for DidDetails<T>where KeyIdOf<T>: Decode, BoundedBTreeSet<KeyIdOf<T>, <T as Config>::MaxTotalKeyAgreementKeys>: Decode, Option<KeyIdOf<T>>: Decode, BoundedBTreeMap<KeyIdOf<T>, DidPublicKeyDetails<BlockNumberFor<T>, AccountIdOf<T>>, <T as Config>::MaxPublicKeysPerDid>: Decode, Deposit<AccountIdOf<T>, BalanceOf<T>>: Decode,

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 DidDetails<T>where KeyIdOf<T>: Encode, BoundedBTreeSet<KeyIdOf<T>, <T as Config>::MaxTotalKeyAgreementKeys>: Encode, Option<KeyIdOf<T>>: Encode, BoundedBTreeMap<KeyIdOf<T>, DidPublicKeyDetails<BlockNumberFor<T>, AccountIdOf<T>>, <T as Config>::MaxPublicKeysPerDid>: Encode, Deposit<AccountIdOf<T>, BalanceOf<T>>: Encode,

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere 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> MaxEncodedLen for DidDetails<T>

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: PartialEq + Config> PartialEq<DidDetails<T>> for DidDetails<T>

fn eq(&self, other: &DidDetails<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> TypeInfo for DidDetails<T>where KeyIdOf<T>: TypeInfo + 'static, BoundedBTreeSet<KeyIdOf<T>, <T as Config>::MaxTotalKeyAgreementKeys>: TypeInfo + 'static, Option<KeyIdOf<T>>: TypeInfo + 'static, BoundedBTreeMap<KeyIdOf<T>, DidPublicKeyDetails<BlockNumberFor<T>, AccountIdOf<T>>, <T as Config>::MaxPublicKeysPerDid>: TypeInfo + 'static, Deposit<AccountIdOf<T>, BalanceOf<T>>: TypeInfo + 'static, T: Config + 'static,

type Identity = DidDetails<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> EncodeLike<DidDetails<T>> for DidDetails<T>where KeyIdOf<T>: Encode, BoundedBTreeSet<KeyIdOf<T>, <T as Config>::MaxTotalKeyAgreementKeys>: Encode, Option<KeyIdOf<T>>: Encode, BoundedBTreeMap<KeyIdOf<T>, DidPublicKeyDetails<BlockNumberFor<T>, AccountIdOf<T>>, <T as Config>::MaxPublicKeysPerDid>: Encode, Deposit<AccountIdOf<T>, BalanceOf<T>>: Encode,

impl<T: Config> StructuralPartialEq for DidDetails<T>