Class IdentitiesController

Collection of methods to query identities and its related data

Index

Methods

getIdentityBalance getIdentityByIdentifier getIdentityByPublicKeyHash getIdentityContractNonce getIdentityNonce getIdentityPublicKeys

Methods

getIdentityBalance

getIdentityBalance(identifier: IdentifierLike): Promise<bigint>
Get current balance of your Identity by identifier
Parameters
- identifier: IdentifierLike
  {IdentifierLike} Identifier of an identity
Returns Promise<bigint>
- Defined in src/identities/index.ts:31

getIdentityByIdentifier

getIdentityByIdentifier(identifier: IdentifierLike): Promise<IdentityWASM>
Retrieves Identity by identifier from the network
Parameters
- identifier: IdentifierLike
  {IdentifierLike} identifier
Returns Promise<IdentityWASM>
- Defined in src/identities/index.ts:56

getIdentityByPublicKeyHash

getIdentityByPublicKeyHash(hex: string): Promise<IdentityWASM>
Retrieves an Identity from the network by give public key hash
Parameters
- hex: string
  {string=} public key hash value in hex, should be a length of 40
Returns Promise<IdentityWASM>
- Defined in src/identities/index.ts:42

getIdentityContractNonce

getIdentityContractNonce(
identifier: IdentifierLike,
dataContract: IdentifierLike,
): Promise<bigint>
Get Identity Contract Nonce (usually used by Document transitions)
Parameters
- identifier: IdentifierLike
- dataContract: IdentifierLike
Returns Promise<bigint>
- Defined in src/identities/index.ts:75

getIdentityNonce

getIdentityNonce(identifier: IdentifierLike): Promise<bigint>
Get Identity Nonce (usually used by Identity transitions)
Parameters
- identifier: IdentifierLike
Returns Promise<bigint>
- Defined in src/identities/index.ts:64

getIdentityPublicKeys

getIdentityPublicKeys(
identifier: IdentifierLike,
): Promise<IdentityPublicKeyWASM[]>
Retrieve given Identity's public keys
Parameters
- identifier: IdentifierLike
Returns Promise<IdentityPublicKeyWASM[]>
- Defined in src/identities/index.ts:85