Identity
Represents an Identity in the Polymesh blockchain
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Identity(identifiers
: UniqueIdentifiers, context
: Context): Identity
Overrides void
Defined in src/api/entities/Identity/index.ts:86
Create an Identity entity
Parameters:
Returns: Identity
Properties
authorizations
• authorizations: IdentityAuthorizations
Defined in src/api/entities/Identity/index.ts:85
Protected
context
Protected
context• context: Context
Inherited from CheckpointSchedule.context
Defined in src/api/entities/Entity.ts:48
did
• did: string
Defined in src/api/entities/Identity/index.ts:82
identity ID as stored in the blockchain
portfolios
• portfolios: Portfolios
Defined in src/api/entities/Identity/index.ts:86
uuid
• uuid: string
Inherited from CheckpointSchedule.uuid
Defined in src/api/entities/Entity.ts:46
Methods
areSecondaryKeysFrozen
▸ areSecondaryKeysFrozen(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:483
Check whether secondary keys are frozen
note
can be subscribed to
Returns: Promise‹boolean›
▸ areSecondaryKeysFrozen(callback
: SubCallback‹boolean›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:484
Parameters:
Returns: Promise‹UnsubCallback›
getHeldTokens
▸ getHeldTokens(opts
: object): Promise‹ResultSet‹SecurityToken››
Defined in src/api/entities/Identity/index.ts:309
Retrieve a list of all tokens which were held at one point by this Identity
note
uses the middleware
note
supports pagination
Parameters:
▪Default value
opts: object= { order: Order.Asc }
Returns: Promise‹ResultSet‹SecurityToken››
getPendingDistributions
▸ getPendingDistributions(): Promise‹DistributionWithDetails[]›
Defined in src/api/entities/Identity/index.ts:519
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 Tokens this Identity has held
Returns: Promise‹DistributionWithDetails[]›
getPendingInstructions
▸ getPendingInstructions(): Promise‹Instruction[]›
Defined in src/api/entities/Identity/index.ts:432
Retrieve all pending Instructions involving this Identity
Returns: Promise‹Instruction[]›
getPrimaryKey
▸ getPrimaryKey(): Promise‹string›
Defined in src/api/entities/Identity/index.ts:274
Retrieve the primary key associated with the Identity
note
can be subscribed to
Returns: Promise‹string›
▸ getPrimaryKey(callback
: SubCallback‹string›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:275
Parameters:
Returns: Promise‹UnsubCallback›
getScopeId
▸ getScopeId(args
: object): Promise‹string›
Defined in src/api/entities/Identity/index.ts:415
Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token
note
more on Investor Uniqueness: https://developers.polymesh.live/confidential_identity
Parameters:
▪ args: object
Returns: Promise‹string›
getTokenBalance
▸ getTokenBalance(args
: object): Promise‹BigNumber›
Defined in src/api/entities/Identity/index.ts:174
Retrieve the balance of a particular Security Token
note
can be subscribed to
Parameters:
▪ args: object
Returns: Promise‹BigNumber›
▸ getTokenBalance(args
: object, callback
: SubCallback‹BigNumber›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:175
Parameters:
▪ args: object
▪ callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback›
getTrustingTokens
▸ getTrustingTokens(args
: object): Promise‹SecurityToken[]›
Defined in src/api/entities/Identity/index.ts:360
Get the list of tokens for which this Identity is a trusted claim issuer
note
uses the middleware
Parameters:
▪Default value
args: object= { order: Order.Asc }
Returns: Promise‹SecurityToken[]›
getVenues
▸ getVenues(): Promise‹Venue[]›
Defined in src/api/entities/Identity/index.ts:381
Retrieve all Venues created by this Identity
note
can be subscribed to
Returns: Promise‹Venue[]›
▸ getVenues(callback
: SubCallback‹Venue[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:382
Parameters:
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role
: Role): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:104
Check whether this Identity possesses the specified Role
Parameters:
Returns: Promise‹boolean›
hasRoles
▸ hasRoles(roles
: Role[]): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:349
Check whether this Identity possesses all specified roles
Parameters:
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:222
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
isCddProvider
▸ isCddProvider(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:255
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity
: Entity‹unknown›): boolean
Inherited from CheckpointSchedule.isEqual
Defined in src/api/entities/Entity.ts:61
Whether this Entity is the same as another one
Parameters:
Returns: boolean
isGcMember
▸ isGcMember(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:238
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
Static
generateUuid
Static
generateUuid▸ generateUuid‹Identifiers›(identifiers
: Identifiers): string
Inherited from CheckpointSchedule.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers
Parameters:
Returns: string
Static
unserialize
Static
unserialize▸ unserialize‹Identifiers›(serialized
: string): Identifiers
Inherited from CheckpointSchedule.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers
Parameters:
Returns: Identifiers
Last updated