Struct identity_account::account::Account

pub struct Account<C = Arc<Client>> where
    C: SharedPtr<Client>,  { /* private fields */ }

An account manages one identity.

It handles private keys, writing to storage and publishing to the Tangle.

Implementations

impl<C> Account<C> where
    C: SharedPtr<Client>, 

pub fn builder() -> AccountBuilder<C>

Creates a new AccountBuilder.

pub fn storage(&self) -> &Arc<dyn Storage>

Returns a reference counter to the Storage implementation.

pub fn autopublish(&self) -> bool

Returns whether auto-publish is enabled.

pub fn autosave(&self) -> AutoSave

Returns the auto-save configuration value.

pub fn actions(&self) -> usize

Returns the total number of actions executed by this instance.

pub fn did(&self) -> &IotaDID

Returns the did of the managed identity.

pub fn chain_state(&self) -> &ChainState

Return the chain state of the identity.

pub fn document(&self) -> &IotaDocument

Returns the DID document of the identity, which this account manages, with all updates applied.

Note: the returned document only has a valid signature after publishing an integration chain update. In general, for use cases where the signature is required, it is advisable to resolve the document from the Tangle.

pub fn set_chain_state_unchecked(&mut self, chain_state: ChainState)

Sets the ChainState for the identity this account manages, without doing any validation.

WARNING

This method is dangerous and can easily corrupt the internal state, potentially making the identity unusable. Only call this if you fully understand the implications!

pub async fn resolve_identity(&self) -> Result<ResolvedIotaDocument>

Resolves the DID Document associated with this Account from the Tangle.

pub fn update_identity(&mut self) -> IdentityUpdater<'_, C>

Returns the IdentityUpdater for this identity.

On this type, various operations can be executed that modify an identity, such as creating services or methods.

pub async fn update_document_unchecked(
    &mut self,
    document: IotaDocument
) -> Result<()>

Overwrites the IotaDocument this account manages, without doing any validation.

WARNING

This method is dangerous and can easily corrupt the internal state, potentially making the identity unusable. Only call this if you fully understand the implications!

pub async fn delete_identity(self) -> Result<()>

Removes the identity from the local storage entirely.

Note: This will remove all associated document updates and key material - recovery is NOT POSSIBLE!

pub async fn sign<U>(
    &self,
    fragment: &str,
    data: &mut U,
    options: ProofOptions
) -> Result<()> where
    U: Serialize + SetSignature, 

Signs data with the key specified by fragment.

pub async fn publish(&mut self) -> Result<()>

Push all unpublished changes to the tangle in a single message.

pub async fn publish_with_options(
    &mut self,
    options: PublishOptions
) -> Result<()>

Push all unpublished changes to the Tangle in a single message, optionally choosing the signing key used or forcing an integration chain update.

See PublishOptions.

pub async fn fetch_document(&mut self) -> Result<()>

Fetches the latest document from the tangle and overwrites the local document.

If a DID is managed from distributed accounts, this should be called before making changes to the identity, to avoid publishing updates that would be ignored.

pub async fn revoke_credentials(
    &mut self,
    fragment: &str,
    credential_indices: &[u32]
) -> Result<()>

If the document has a RevocationBitmap service identified by fragment, revoke all credentials with a revocationBitmapIndex in credential_indices.

pub async fn unrevoke_credentials(
    &mut self,
    fragment: &str,
    credential_indices: &[u32]
) -> Result<()>

If the document has a RevocationBitmap service identified by fragment, unrevoke all credentials with a revocationBitmapIndex in credential_indices.

pub async fn encrypt_data(
    &self,
    plaintext: &[u8],
    associated_data: &[u8],
    encryption_algorithm: &EncryptionAlgorithm,
    cek_algorithm: &CekAlgorithm,
    public_key: PublicKey
) -> Result<EncryptedData>

Encrypts the given plaintext with the specified encryption_algorithm and cek_algorithm.

Returns an EncryptedData instance.

pub async fn decrypt_data(
    &self,
    data: EncryptedData,
    encryption_algorithm: &EncryptionAlgorithm,
    cek_algorithm: &CekAlgorithm,
    fragment: &str
) -> Result<Vec<u8>>

Decrypts the given data with the key identified by fragment using the given encryption_algorithm and cek_algorithm.

Returns the decrypted text.

Trait Implementations

impl<C: Debug> Debug for Account<C> where
    C: SharedPtr<Client>, 

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

Formats the value using the given formatter.