Class: Identity
api/entities/Identity.Identity
Represents an Identity in the Polymesh blockchain
Hierarchy
-
Entity
<UniqueIdentifiers
,string
>↳
Identity
Properties
assetPermissions
• assetPermissions: AssetPermissions
Defined in
api/entities/Identity/index.ts:110
authorizations
• authorizations: IdentityAuthorizations
Defined in
api/entities/Identity/index.ts:108
did
• did: string
Identity ID as stored in the blockchain
Defined in
api/entities/Identity/index.ts:105
portfolios
• portfolios: Portfolios
Defined in
api/entities/Identity/index.ts:109
uuid
• uuid: string
Inherited from
Defined in
Methods
areSecondaryAccountsFrozen
▸ areSecondaryAccountsFrozen(): Promise
<boolean
>
Check whether secondary Accounts are frozen
Returns
Promise
<boolean
>
Note
can be subscribed to
Defined in
api/entities/Identity/index.ts:642
▸ areSecondaryAccountsFrozen(callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
callback | SubCallback <boolean > |
Returns
Promise
<UnsubCallback
>
Defined in
api/entities/Identity/index.ts:643
checkRoles
▸ checkRoles(roles
): Promise
<CheckRolesResult
>
Check whether this Identity possesses all specified roles
Parameters
Name | Type |
---|---|
roles | Role [] |
Returns
Promise
<CheckRolesResult
>
Defined in
api/entities/Identity/index.ts:385
exists
▸ exists(): Promise
<boolean
>
Determine whether this Identity exists on chain
Returns
Promise
<boolean
>
Note
asset Identities aren't considered to exist for this check
Overrides
Defined in
api/entities/Identity/index.ts:808
getAssetBalance
▸ getAssetBalance(args
): Promise
<BigNumber
>
Retrieve the balance of a particular Asset
Parameters
Name | Type |
---|---|
args | Object |
args.ticker | string |
Returns
Promise
<BigNumber
>
Note
can be subscribed to
Defined in
api/entities/Identity/index.ts:179
▸ getAssetBalance(args
, callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
args | Object |
args.ticker | string |
callback | SubCallback <BigNumber > |
Returns
Promise
<UnsubCallback
>
Defined in
api/entities/Identity/index.ts:180
getHeldAssets
▸ getHeldAssets(opts?
): Promise
<ResultSet
<Asset
>>
Retrieve a list of all Assets which were held at one point by this Identity
Parameters
Name | Type |
---|---|
opts | Object |
opts.order? | AssetHoldersOrderBy |
opts.size? | BigNumber |
opts.start? | BigNumber |
Returns
Note
uses the middlewareV2
Note
supports pagination
Defined in
api/entities/Identity/index.ts:343
getHistoricalInstructions
▸ getHistoricalInstructions(): Promise
<HistoricInstruction
[]>
Retrieve all Instructions that have been associated with this Identity's DID
Returns
Promise
<HistoricInstruction
[]>
Note
uses the middleware V2
Defined in
api/entities/Identity/index.ts:840
getInstructions
▸ getInstructions(): Promise
<GroupedInstructions
>
Retrieve all Instructions where this Identity is a custodian of one or more portfolios in the legs, grouped by status
Returns
Promise
<GroupedInstructions
>
Defined in
api/entities/Identity/index.ts:465
getInvolvedInstructions
▸ getInvolvedInstructions(): Promise
<GroupedInvolvedInstructions
>
Retrieve all Instructions where this Identity is a participant (owner/custodian), grouped by the role of the Identity and Instruction status
Returns
Promise
<GroupedInvolvedInstructions
>
Defined in
api/entities/Identity/index.ts:583
getPendingDistributions
▸ getPendingDistributions(): Promise
<DistributionWithDetails
[]>
Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid
Returns
Promise
<DistributionWithDetails
[]>
Note
uses the middleware
Note
this query can be potentially SLOW depending on which Assets this Identity has held
Defined in
api/entities/Identity/index.ts:679
getPrimaryAccount
▸ getPrimaryAccount(): Promise
<PermissionedAccount
>
Retrieve the primary Account associated with the Identity
Returns
Promise
<PermissionedAccount
>
Note
can be subscribed to
Defined in
api/entities/Identity/index.ts:290
▸ getPrimaryAccount(callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
callback | SubCallback <PermissionedAccount > |
Returns
Promise
<UnsubCallback
>
Defined in
api/entities/Identity/index.ts:291
getSecondaryAccounts
▸ getSecondaryAccounts(paginationOpts?
): Promise
<ResultSet
<PermissionedAccount
>>
Get the list of secondary Accounts related to the Identity
Parameters
Name | Type |
---|---|
paginationOpts? | PaginationOptions |
Returns
Promise
<ResultSet
<PermissionedAccount
>>
Note
supports pagination
Note
can be subscribed to
Defined in
api/entities/Identity/index.ts:734
▸ getSecondaryAccounts(callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
callback | SubCallback <PermissionedAccount []> |
Returns
Promise
<UnsubCallback
>
Defined in
api/entities/Identity/index.ts:738
▸ getSecondaryAccounts(paginationOpts
, callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
paginationOpts | PaginationOptions |
callback | SubCallback <PermissionedAccount []> |
Returns
Promise
<UnsubCallback
>
Defined in
api/entities/Identity/index.ts:742
getTrustingAssets
▸ getTrustingAssets(): Promise
<Asset
[]>
Get the list of Assets for which this Identity is a trusted claim issuer
Returns
Promise
<Asset
[]>
Note
uses the middlewareV2
Defined in
api/entities/Identity/index.ts:409
getVenues
▸ getVenues(): Promise
<Venue
[]>
Retrieve all Venues created by this Identity
Returns
Promise
<Venue
[]>
Note
can be subscribed to
Defined in
api/entities/Identity/index.ts:428
hasRole
▸ hasRole(role
): Promise
<boolean
>
Check whether this Identity possesses the specified Role
Parameters
Name | Type |
---|---|
role | Role |
Returns
Promise
<boolean
>
Defined in
api/entities/Identity/index.ts:131
hasValidCdd
▸ hasValidCdd(): Promise
<boolean
>
Check whether this Identity has a valid CDD claim
Returns
Promise
<boolean
>
Defined in
api/entities/Identity/index.ts:238
isCddProvider
▸ isCddProvider(): Promise
<boolean
>
Check whether this Identity is a CDD provider
Returns
Promise
<boolean
>
Defined in
api/entities/Identity/index.ts:271
isEqual
▸ isEqual(entity
): boolean
Determine whether this Entity is the same as another one
Parameters
Name | Type |
---|---|
entity | Entity <unknown , unknown > |
Returns
boolean
Inherited from
Defined in
isGcMember
▸ isGcMember(): Promise
<boolean
>
Check whether this Identity is Governance Committee member
Returns
Promise
<boolean
>
Defined in
api/entities/Identity/index.ts:254
toHuman
▸ toHuman(): string
Return the Identity's DID
Returns
string
Overrides
Defined in
api/entities/Identity/index.ts:831
generateUuid
▸ Static
generateUuid<Identifiers
>(identifiers
): string
Generate the Entity's UUID from its identifying properties
Type parameters
Name |
---|
Identifiers |
Parameters
Name | Type |
---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static
unserialize<Identifiers
>(serialized
): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Name |
---|
Identifiers |
Parameters
Name | Type | Description |
---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers