Struct OnChainIdentity

pub struct OnChainIdentity { /* private fields */ }

An on-chain entity that wraps an optional DID Document.

Implementations

impl OnChainIdentity

pub fn id(&self) -> ObjectID

Returns the [ObjectID] of this OnChainIdentity.

pub fn did_document(&self) -> &IotaDocument

Returns the IotaDocument contained in this OnChainIdentity.

pub fn has_deleted_did(&self) -> bool

Returns whether the IotaDocument contained in this OnChainIdentity has been deleted. Once a DID Document is deleted, it cannot be reactivated.

When calling OnChainIdentity::did_document on an Identity whose DID Document had been deleted, an empty and deactivated IotaDocument will be returned.

pub fn is_shared(&self) -> bool

Returns true if this OnChainIdentity is shared between multiple controllers.

pub fn proposals(&self) -> &HashSet<ObjectID>

Returns this OnChainIdentity’s list of active proposals.

pub fn controllers(&self) -> &HashMap<ObjectID, u64>

Returns this OnChainIdentity’s controllers as the map: controller_id -> controller_voting_power.

pub fn threshold(&self) -> u64

Returns the threshold required by this OnChainIdentity for executing a proposal.

pub fn controller_voting_power(&self, controller_id: ObjectID) -> Option<u64>

Returns the voting power of controller with ID controller_id, if any.

pub async fn get_controller_token_for_address( &self, address: IotaAddress, client: &(impl CoreClientReadOnly + OptionalSync), ) -> Result<Option<ControllerToken>, Error>

Returns a ControllerToken owned by address that grants access to this Identity.

Notes

None is returned if address doesn’t own a valid ControllerToken.

pub async fn get_controller_token<S>( &self, client: &(impl CoreClient<S> + OptionalSync), ) -> Result<Option<ControllerToken>, Error>

where S: Signer<IotaKeySignature> + OptionalSync,

Returns a ControllerToken, owned by client’s sender address, that grants access to this Identity.

Notes

None is returned if client’s sender address doesn’t own a valid ControllerToken.

pub fn update_did_document<'i, 'c>( &'i mut self, updated_doc: IotaDocument, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, UpdateDidDocument>

Updates this OnChainIdentity’s DID Document.

pub fn update_config<'i, 'c>( &'i mut self, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, ConfigChange>

Updates this OnChainIdentity’s configuration.

pub fn deactivate_did<'i, 'c>( &'i mut self, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, UpdateDidDocument>

Deactivates the DID Document represented by this OnChainIdentity.

pub fn delete_did<'i, 'c>( &'i mut self, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, UpdateDidDocument>

Deletes the DID Document contained in this OnChainIdentity.

pub fn upgrade_version<'i, 'c>( &'i mut self, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, Upgrade>

Upgrades this OnChainIdentity’s version to match the package’s.

pub fn send_assets<'i, 'c>( &'i mut self, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, SendAction>

Sends assets owned by this OnChainIdentity to other addresses.

pub fn borrow_assets<'i, 'c>( &'i mut self, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, BorrowAction>

Borrows assets owned by this OnChainIdentity to use them in a custom transaction.

pub fn controller_execution<'i, 'c>( &'i mut self, controller_cap: ObjectID, controller_token: &'c ControllerToken, ) -> ProposalBuilder<'i, 'c, ControllerExecution>

👎Deprecated: use OnChainIdentity::access_sub_identity instead.

Borrows a ControllerCap with ID controller_cap owned by this identity in a transaction. This proposal is used to perform operation on a sub-identity controlled by this one.

pub fn access_sub_identity<'i, 'sub>( &'i mut self, sub_identity: &'sub mut OnChainIdentity, controller_token: &ControllerToken, ) -> AccessSubIdentityBuilder<'i, 'sub>

Perform an action on an Identity that is controlled by this Identity.

pub async fn get_history( &self, client: &IdentityClientReadOnly, last_version: Option<&IotaObjectData>, page_size: Option<usize>, ) -> Result<Vec<IotaObjectData>, Error>

Returns historical data for this OnChainIdentity.

pub fn revoke_delegation_token( &self, controller_capability: &ControllerCap, delegation_token: &DelegationToken, ) -> Result<TransactionBuilder<DelegationTokenRevocation>, Error>

Returns a [Transaction] to revoke a DelegationToken.

pub fn unrevoke_delegation_token( &self, controller_capability: &ControllerCap, delegation_token: &DelegationToken, ) -> Result<TransactionBuilder<DelegationTokenRevocation>, Error>

Returns a [Transaction] to unrevoke a DelegationToken.

pub fn delete_delegation_token( &self, delegation_token: DelegationToken, ) -> Result<TransactionBuilder<DeleteDelegationToken>, Error>

Returns a [Transaction] to delete a DelegationToken.

Trait Implementations

impl Clone for OnChainIdentity

fn clone(&self) -> OnChainIdentity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnChainIdentity

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

Formats the value using the given formatter.

impl From<OnChainIdentity> for IotaDocument

fn from(identity: OnChainIdentity) -> IotaDocument

Converts to this type from the input type.

impl MoveType for OnChainIdentity

fn move_type(package: ObjectID) -> TypeTag

Returns the Move type for this type.

fn get_typed_value(&self, _package: ObjectID) -> TypedValue<'_, Self>

where Self: MoveType + Sized,

impl Serialize for OnChainIdentity

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.