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:96
Create an Identity entity
Parameters:
| Name | Type |
|---|---|
| UniqueIdentifiers |
| Context |
Returns: Identity
Properties
assetPermissions
• assetPermissions: AssetPermissions
Defined in src/api/entities/Identity/index.ts:96
authorizations
• authorizations: IdentityAuthorizations
Defined in src/api/entities/Identity/index.ts:94
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:91
Identity ID as stored in the blockchain
portfolios
• portfolios: Portfolios
Defined in src/api/entities/Identity/index.ts:95
uuid
• uuid: string
Inherited from CheckpointSchedule.uuid
Defined in src/api/entities/Entity.ts:46
Methods
areSecondaryAccountsFrozen
▸ areSecondaryAccountsFrozen(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:649
Check whether secondary Accounts are frozen
note can be subscribed to
Returns: Promise‹boolean›
▸ areSecondaryAccountsFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:650
Parameters:
| Name | Type |
|---|---|
| SubCallback‹boolean› |
Returns: Promise‹UnsubCallback›
checkRoles
▸ checkRoles(roles: Role[]): Promise‹CheckRolesResult›
Defined in src/api/entities/Identity/index.ts:398
Check whether this Identity possesses all specified roles
Parameters:
| Name | Type |
|---|---|
| Role[] |
Returns: Promise‹CheckRolesResult›
exists
▸ exists(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:779
Determine whether this Identity exists on chain
Returns: Promise‹boolean›
getAssetBalance
▸ getAssetBalance(args: object): Promise‹BigNumber›
Defined in src/api/entities/Identity/index.ts:163
Retrieve the balance of a particular Asset
note can be subscribed to
Parameters:
▪ args: object
| Name | Type |
|---|---|
| string |
Returns: Promise‹BigNumber›
▸ getAssetBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:164
Parameters:
▪ args: object
| Name | Type |
|---|---|
| string |
▪ callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback›
getHeldAssets
▸ getHeldAssets(opts: object): Promise‹ResultSet‹Asset››
Defined in src/api/entities/Identity/index.ts:311
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 |
| BigNumber |
| BigNumber |
Returns: Promise‹ResultSet‹Asset››
getHeldAssetsV2
▸ getHeldAssetsV2(opts: object): Promise‹ResultSet‹Asset››
Defined in src/api/entities/Identity/index.ts:356
Retrieve a list of all Assets which were held at one point by this Identity
note uses the middlewareV2
note supports pagination
Parameters:
▪Default value opts: object= {}
| Name | Type |
|---|---|
| AssetHoldersOrderBy |
| BigNumber |
| BigNumber |
Returns: Promise‹ResultSet‹Asset››
getInstructions
▸ getInstructions(): Promise‹GroupedInstructions›
Defined in src/api/entities/Identity/index.ts:527
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns: Promise‹GroupedInstructions›
getPendingDistributions
▸ getPendingDistributions(): Promise‹DistributionWithDetails[]›
Defined in src/api/entities/Identity/index.ts:686
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[]›
Defined in src/api/entities/Identity/index.ts:596
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›
getPrimaryAccount
▸ getPrimaryAccount(): Promise‹PermissionedAccount›
Defined in src/api/entities/Identity/index.ts:264
Retrieve the primary Account associated with the Identity
note can be subscribed to
Returns: Promise‹PermissionedAccount›
▸ getPrimaryAccount(callback: SubCallback‹PermissionedAccount›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:265
Parameters:
| Name | Type |
|---|---|
|
Returns: Promise‹UnsubCallback›
getScopeId
▸ getScopeId(args: object): Promise‹string | null›
Defined in src/api/entities/Identity/index.ts:505
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 | string |
Returns: Promise‹string | null›
getSecondaryAccounts
▸ getSecondaryAccounts(): Promise‹PermissionedAccount[]›
Defined in src/api/entities/Identity/index.ts:740
Get the list of secondary Accounts related to the Identity
note can be subscribed to
Returns: Promise‹PermissionedAccount[]›
▸ getSecondaryAccounts(callback: SubCallback‹PermissionedAccount[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:741
Parameters:
| Name | Type |
|---|---|
|
Returns: Promise‹UnsubCallback›
getTrustingAssets
▸ getTrustingAssets(): Promise‹Asset[]›
Defined in src/api/entities/Identity/index.ts:433
Get the list of Assets for which this Identity is a trusted claim issuer
note uses the middleware
Returns: Promise‹Asset[]›
getTrustingAssetsV2
▸ getTrustingAssetsV2(): Promise‹Asset[]›
Defined in src/api/entities/Identity/index.ts:450
Get the list of Assets for which this Identity is a trusted claim issuer
note uses the middlewareV2
Returns: Promise‹Asset[]›
getVenues
▸ getVenues(): Promise‹Venue[]›
Defined in src/api/entities/Identity/index.ts:469
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:470
Parameters:
| Name | Type |
|---|---|
| SubCallback‹Venue[]› |
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role: Role): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:115
Check whether this Identity possesses the specified Role
Parameters:
| Name | Type |
|---|---|
|
Returns: Promise‹boolean›
hasRoles
▸ hasRoles(roles: Role[]): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:422
Check whether this Identity possesses all specified roles
deprecated in favor of checkRoles
Parameters:
| Name | Type |
|---|---|
| Role[] |
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:212
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
isCddProvider
▸ isCddProvider(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:245
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from CheckpointSchedule.isEqual
Defined in src/api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
Parameters:
| Name | Type |
|---|---|
| Entity‹unknown, unknown› |
Returns: boolean
isGcMember
▸ isGcMember(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:228
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
toHuman
▸ toHuman(): string
Defined in src/api/entities/Identity/index.ts:792
Return the Identity's DID
Returns: string
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:
| Name | Type | Description |
|---|---|---|
| Identifiers |
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:
| Name | Type | Description |
|---|---|---|
| string | UUID to unserialize |
Returns: Identifiers
Last updated