Struct IdentityClientReadOnly

pub struct IdentityClientReadOnly { /* private fields */ }

An [IotaClient] enriched with identity-related functionalities.

Implementations

impl IdentityClientReadOnly

pub fn package_id(&self) -> ObjectID

Returns iota_identity’s package ID. The ID of the packages depends on the network the client is connected to.

pub const fn network(&self) -> &NetworkName

Returns the name of the network the client is currently connected to.

pub fn chain_id(&self) -> &str

Returns the chain identifier for the network this client is connected to. This method differs from IdentityClientReadOnly::network as it doesn’t return the human-readable network ID when available.

pub async fn new( iota_client: IotaClient, ) -> Result<IdentityClientReadOnly, Error>

Attempts to create a new IdentityClientReadOnly from a given [IotaClient].

Failures

This function fails if the provided iota_client is connected to an unrecognized network.

Notes

When trying to connect to a local or unofficial network, prefer using IdentityClientReadOnly::new_with_pkg_id.

pub async fn new_with_pkg_id( iota_client: IotaClient, package_id: ObjectID, ) -> Result<IdentityClientReadOnly, Error>

Attempts to create a new IdentityClientReadOnly from the given IOTA client and the ID of the IotaIdentity package published on the network the client is connected to.

pub fn set_migration_registry_id(&mut self, id: ObjectID)

Sets the migration registry ID for the current network.

Notes

This is only needed when automatic retrieval of MigrationRegistry’s ID fails.

pub async fn resolve_did(&self, did: &IotaDID) -> Result<IotaDocument, Error>

Queries an IotaDocument DID Document through its did.

pub async fn get_identity(&self, object_id: ObjectID) -> Result<Identity, Error>

Resolves an Identity from its ID object_id.

pub async fn dids_controlled_by( &self, address: IotaAddress, ) -> Result<Vec<IotaDID>, QueryControlledDidsError>

Returns the list of all unique DIDs the given address has access to as a controller.

Notes

For a streaming version of this API see dids_controlled_by_streamed.

Errors

This method might return a QueryControlledDidsError when the underlying RPC call fails. QueryControlledDidsError’s source can be downcasted to SDK’s Error in order to check whether calling this method again might return a successful result.

Example

let address = "0x666638f5118b8f894c4e60052f9bc47d6fcfb04fdb990c9afbb988848b79c475".parse()?;
let controlled_dids = identity_client.dids_controlled_by(address).await?;
assert_eq!(
  controlled_dids,
  vec![IotaDID::parse(
    "did:iota:testnet:0x052cfb920024f7a640dc17f7f44c6042ea0038d26972c2cff5c7ba31c82fbb08"
  )?]
);

Trait Implementations

impl Clone for IdentityClientReadOnly

fn clone(&self) -> IdentityClientReadOnly

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CoreClientReadOnly for IdentityClientReadOnly

fn package_id(&self) -> ObjectID

Returns the package ID associated with the Client.

fn network_name(&self) -> &NetworkName

Returns the name of the network the client is connected to.

fn client_adapter(&self) -> &IotaClientRustSdk

Returns the underlying [IotaClientAdapter] used by this client.

fn package_history(&self) -> Vec<ObjectID>

Returns the IDs of all packages version, from initial to current.

fn get_object_by_id<'life0, 'async_trait, T>( &'life0 self, object_id: ObjectID, ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, T: 'async_trait + DeserializeOwned, Self: Sync + 'async_trait,

Retrieves a Move Object by its ID.

fn get_object_ref_by_id<'life0, 'async_trait>( &'life0 self, object_id: ObjectID, ) -> Pin<Box<dyn Future<Output = Result<Option<OwnedObjectRef>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Retrieves an object’s [OwnedObjectRef], if any.

fn find_object_for_address<'life0, 'async_trait, T, P>( &'life0 self, address: IotaAddress, predicate: P, ) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, T: MoveType + DeserializeOwned + 'async_trait, P: Fn(&T) -> bool + Send + 'async_trait, Self: Sync + 'async_trait,

Retrieves an object owned by the specified address that matches the given predicate.

fn get_iota_coins_with_at_least_balance<'life0, 'async_trait>( &'life0 self, owner: IotaAddress, balance: u64, ) -> Pin<Box<dyn Future<Output = Result<Vec<(ObjectID, SequenceNumber, ObjectDigest)>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Retrieves coins owned by the specified address with a balance of at least balance.

fn find_owned_ref_for_address<'life0, 'async_trait, P>( &'life0 self, address: IotaAddress, tag: StructTag, predicate: P, ) -> Pin<Box<dyn Future<Output = Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, P: Fn(&IotaObjectData) -> bool + Send + 'async_trait, Self: Sync + 'async_trait,

Queries the object owned by this sender address and returns the first one that matches tag and for which predicate returns true.

impl Deref for IdentityClientReadOnly

type Target = IotaClientRustSdk

The resulting type after dereferencing.

fn deref(&self) -> &<IdentityClientReadOnly as Deref>::Target

Dereferences the value.

impl DidResolutionHandler for IdentityClientReadOnly

fn resolve_did<'life0, 'life1, 'async_trait>( &'life0 self, did: &'life1 IotaDID, ) -> Pin<Box<dyn Future<Output = Result<IotaDocument, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, IdentityClientReadOnly: 'async_trait,

Resolve a IotaDocument. Returns an empty, deactivated document if the state metadata of the identity is empty.