pub struct IdentityClient<S> { /* private fields */ }
Expand description
A client for interacting with the IOTA network.
Implementations§
Source§impl<S> IdentityClient<S>where
S: Signer<IotaKeySignature> + Sync,
impl<S> IdentityClient<S>where
S: Signer<IotaKeySignature> + Sync,
Sourcepub async fn new(
client: IdentityClientReadOnly,
signer: S,
) -> Result<IdentityClient<S>, Error>
pub async fn new( client: IdentityClientReadOnly, signer: S, ) -> Result<IdentityClient<S>, Error>
Create a new IdentityClient
.
Source§impl<S> IdentityClient<S>
impl<S> IdentityClient<S>
Sourcepub fn sender_public_key(&self) -> &[u8] ⓘ
pub fn sender_public_key(&self) -> &[u8] ⓘ
Returns the bytes of the sender’s public key.
Sourcepub fn sender_address(&self) -> IotaAddress
pub fn sender_address(&self) -> IotaAddress
Returns this IdentityClient
’s sender address.
Sourcepub fn signer(&self) -> &S
pub fn signer(&self) -> &S
Returns a reference to this IdentityClient
’s [Signer
].
Sourcepub fn create_identity(&self, iota_document: IotaDocument) -> IdentityBuilder
pub fn create_identity(&self, iota_document: IotaDocument) -> IdentityBuilder
Returns a new IdentityBuilder
in order to build a new crate::rebased::migration::OnChainIdentity
.
Sourcepub fn create_authenticated_asset<T>(
&self,
content: T,
) -> AuthenticatedAssetBuilder<T>
pub fn create_authenticated_asset<T>( &self, content: T, ) -> AuthenticatedAssetBuilder<T>
Returns a new IdentityBuilder
in order to build a new crate::rebased::migration::OnChainIdentity
.
Sourcepub async fn find_owned_ref<P>(
&self,
tag: StructTag,
predicate: P,
) -> Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>
pub async fn find_owned_ref<P>( &self, tag: StructTag, predicate: P, ) -> Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>
Query the objects owned by the address wrapped by this client to find the object of type tag
and that satisfies predicate
.
Source§impl<S> IdentityClient<S>where
S: Signer<IotaKeySignature> + Sync,
impl<S> IdentityClient<S>where
S: Signer<IotaKeySignature> + Sync,
Sourcepub fn publish_did_document(&self, document: IotaDocument) -> PublishDidTx
pub fn publish_did_document(&self, document: IotaDocument) -> PublishDidTx
Returns [Transaction
] PublishDidTx
that - when executed - will publish a new DID Document on chain.
Sourcepub async fn publish_did_document_update(
&self,
document: IotaDocument,
gas_budget: u64,
) -> Result<IotaDocument, Error>
pub async fn publish_did_document_update( &self, document: IotaDocument, gas_budget: u64, ) -> Result<IotaDocument, Error>
Updates a DID Document.
Methods from Deref<Target = IdentityClientReadOnly>§
Sourcepub fn package_id(&self) -> ObjectID
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.
Sourcepub fn network(&self) -> &NetworkName
pub fn network(&self) -> &NetworkName
Returns the name of the network the client is currently connected to.
Sourcepub fn migration_registry_id(&self) -> ObjectID
pub fn migration_registry_id(&self) -> ObjectID
Returns the migration registry’s ID.
Sourcepub async fn get_object_by_id<T>(&self, id: ObjectID) -> Result<T, Error>where
T: DeserializeOwned,
pub async fn get_object_by_id<T>(&self, id: ObjectID) -> Result<T, Error>where
T: DeserializeOwned,
Resolves a Move Object of ID id
and parses it to a value of type T
.
Sourcepub async fn get_object_ref_by_id(
&self,
obj: ObjectID,
) -> Result<Option<OwnedObjectRef>, Error>
pub async fn get_object_ref_by_id( &self, obj: ObjectID, ) -> Result<Option<OwnedObjectRef>, Error>
Returns an object’s [OwnedObjectRef
], if any.
Sourcepub async fn find_owned_ref_for_address<P>(
&self,
address: IotaAddress,
tag: StructTag,
predicate: P,
) -> Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>
pub async fn find_owned_ref_for_address<P>( &self, address: IotaAddress, tag: StructTag, predicate: P, ) -> Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>
Queries the object owned by this sender address and returns the first one
that matches tag
and for which predicate
returns true
.
Sourcepub async fn resolve_did(&self, did: &IotaDID) -> Result<IotaDocument, Error>
pub async fn resolve_did(&self, did: &IotaDID) -> Result<IotaDocument, Error>
Queries an IotaDocument
DID Document through its did
.
Trait Implementations§
Source§impl<S> Clone for IdentityClient<S>where
S: Clone,
impl<S> Clone for IdentityClient<S>where
S: Clone,
Source§fn clone(&self) -> IdentityClient<S>
fn clone(&self) -> IdentityClient<S>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<S> Deref for IdentityClient<S>
impl<S> Deref for IdentityClient<S>
Source§type Target = IdentityClientReadOnly
type Target = IdentityClientReadOnly
Auto Trait Implementations§
impl<S> Freeze for IdentityClient<S>where
S: Freeze,
impl<S> !RefUnwindSafe for IdentityClient<S>
impl<S> Send for IdentityClient<S>where
S: Send,
impl<S> Sync for IdentityClient<S>where
S: Sync,
impl<S> Unpin for IdentityClient<S>where
S: Unpin,
impl<S> !UnwindSafe for IdentityClient<S>
Blanket Implementations§
§impl<U> As for U
impl<U> As for U
§fn as_<T>(self) -> Twhere
T: CastFrom<U>,
fn as_<T>(self) -> Twhere
T: CastFrom<U>,
self
to type T
. The semantics of numeric casting with the as
operator are followed, so <T as As>::as_::<U>
can be used in the same way as T as U
for numeric conversions. Read more§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> ConvertTo<T> for Twhere
T: Send,
impl<T> ConvertTo<T> for Twhere
T: Send,
fn convert(self) -> Result<T, Error>
fn convert_unchecked(self) -> T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a Request
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.