Identity
Represents an Identity in the Polymesh blockchain

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Identity(identifiers: UniqueIdentifiers, context: Context): Identity
Overrides void
Create an Identity entity
Parameters:
Name
Type
identifiers
UniqueIdentifiers
context
Context
Returns: Identity

Properties

assetPermissions

assetPermissions: AssetPermissions

authorizations

authorizations: IdentityAuthorizations

Protected context

context: Context
Inherited from CheckpointSchedule.context

did

did: string
Identity ID as stored in the blockchain

portfolios

portfolios: Portfolios

uuid

uuid: string
Inherited from CheckpointSchedule.uuid

Methods

areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(): Promise‹boolean›
Check whether secondary Accounts are frozen
note can be subscribed to
Returns: Promise‹boolean›
areSecondaryAccountsFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback

checkRoles

checkRoles(roles: Role[]): Promise‹CheckRolesResult
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹CheckRolesResult

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Identity exists on chain
Returns: Promise‹boolean›

getAssetBalance

getAssetBalance(args: object): Promise‹BigNumber›
Retrieve the balance of a particular Asset
note can be subscribed to
Parameters:
args: object
Name
Type
ticker
string
Returns: Promise‹BigNumber›
getAssetBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback
Parameters:
args: object
Name
Type
ticker
string
callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback

getHeldAssets

getHeldAssets(opts: object): Promise‹ResultSetAsset››
Retrieve a list of all Assets which were held at one point by this Identity
note uses the middleware
note supports pagination
Parameters:
Default value opts: object= { order: Order.Asc }
Name
Type
order?
Order
size?
BigNumber
start?
BigNumber
Returns: Promise‹ResultSetAsset››

getInstructions

getInstructions(): Promise‹GroupedInstructions
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns: Promise‹GroupedInstructions

getPendingDistributions

getPendingDistributions(): Promise‹DistributionWithDetails[]›
Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid
note uses the middleware
note this query can be potentially SLOW depending on which Assets this Identity has held
Returns: Promise‹DistributionWithDetails[]›

getPendingInstructions

getPendingInstructions(): Promise‹Instruction[]›
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›

getPrimaryAccount

getPrimaryAccount(): Promise‹PermissionedAccount
Retrieve the primary Account associated with the Identity
note can be subscribed to
Returns: Promise‹PermissionedAccount
getPrimaryAccount(callback: SubCallbackPermissionedAccount›): Promise‹UnsubCallback
Parameters:
Name
Type
Returns: Promise‹UnsubCallback

getScopeId

getScopeId(args: object): Promise‹string | null›
Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null if there is none
note more on Investor Uniqueness here and here
Parameters:
args: object
Name
Type
asset
Asset | string
Returns: Promise‹string | null›

getSecondaryAccounts

getSecondaryAccounts(): Promise‹PermissionedAccount[]›
Get the list of secondary Accounts related to the Identity
note can be subscribed to
Returns: Promise‹PermissionedAccount[]›
getSecondaryAccounts(callback: SubCallbackPermissionedAccount[]›): Promise‹UnsubCallback
Parameters:
Name
Type
Returns: Promise‹UnsubCallback

getTrustingAssets

getTrustingAssets(): Promise‹Asset[]›
Get the list of Assets for which this Identity is a trusted claim issuer
note uses the middleware
Returns: Promise‹Asset[]›

getVenues

getVenues(): Promise‹Venue[]›
Retrieve all Venues created by this Identity
note can be subscribed to
Returns: Promise‹Venue[]›
getVenues(callback: SubCallbackVenue[]›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallbackVenue[]›
Returns: Promise‹UnsubCallback

hasRole

hasRole(role: Role): Promise‹boolean›
Check whether this Identity possesses the specified Role
Parameters:
Name
Type
role
Role
Returns: Promise‹boolean›

hasRoles

hasRoles(roles: Role[]): Promise‹boolean›
Check whether this Identity possesses all specified roles
deprecated in favor of checkRoles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹boolean›

hasValidCdd

hasValidCdd(): Promise‹boolean›
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›

isCddProvider

isCddProvider(): Promise‹boolean›
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from CheckpointSchedule.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

isGcMember

isGcMember(): Promise‹boolean›
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›

toJson

toJson(): string
Overrides Entity.toJson
Return the Identity's DID
Returns: string

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers