Class IdentitiesController

Collection of methods to query identities and its related data

Index

Methods

createStateTransition getIdentityBalance getIdentityByIdentifier getIdentityByNonUniquePublicKeyHash getIdentityByPublicKeyHash getIdentityContractNonce getIdentityNonce getIdentityPublicKeys

Methods

createStateTransition

createStateTransition(
type: "update" | "create" | "topUp" | "creditTransfer" | "withdrawal",
params: IdentityTransitionParams,
): StateTransitionWASM
Helper function for creating {StateTransitionWASM} for Identity transitions

To create an IdentityCreateTransition, you should pass a params.assetLockProof object containing all necessary AssetLockProof data to make the transaction. Both InstantSend and ChainLock AssetLock proofs supported

Please refer to Identity.spec.js or README for example commands
Parameters
- type: "update" | "create" | "topUp" | "creditTransfer" | "withdrawal"
  {string} type of transition, must be a one of ('create' | 'update' | 'topUp' | 'creditTransfer' | 'withdrawal')
- params: IdentityTransitionParams
  {IdentityTransitionParams} params
Returns StateTransitionWASM
- Defined in identities/index.ts:131

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 identities/index.ts:45

getIdentityByIdentifier

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

getIdentityByNonUniquePublicKeyHash

getIdentityByNonUniquePublicKeyHash(hex: string): Promise<IdentityWASM>
Retrieves an Identity from the network by non-unique public key hash (like Voter Identity, SHA160)
Parameters
- hex: string
  {string} public key hash value in hex, should be a length of 40
Returns Promise<IdentityWASM>
- Defined in identities/index.ts:71

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 identities/index.ts:56

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 identities/index.ts:104

getIdentityNonce

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

getIdentityPublicKeys

getIdentityPublicKeys(
identifier: IdentifierLike,
keyIds?: number[],
): Promise<IdentityPublicKeyWASM[]>
Retrieve given Identity's public keys
Parameters
- identifier: IdentifierLike
  {IdentifierLike}
- OptionalkeyIds: number[]
  {=number[]} optional, specific keyIds to request
Returns Promise<IdentityPublicKeyWASM[]>
- Defined in identities/index.ts:115