CurrentIdentity

Represents the Identity associated to the current Account

Hierarchy

↳ Identity

↳ CurrentIdentity

Index

Constructors

• constructor

Properties

• authorizations

• context

• createVenue

• did

• freezeSecondaryKeys

• inviteAccount

• modifyPermissions

• portfolios

• removeSecondaryKeys

• revokePermissions

• unfreezeSecondaryKeys

• uuid

Methods

• areSecondaryKeysFrozen
• getHeldTokens
• getPendingInstructions
• getPrimaryKey
• getScopeId
• getSecondaryKeys
• getTokenBalance
• getTrustingTokens
• getVenues
• hasRole
• hasRoles
• hasValidCdd
• isCddProvider
• isEqual
• isGcMember
• generateUuid
• unserialize

Constructors

constructor

+ new CurrentIdentity(identifiers: UniqueIdentifiers, context: Context): CurrentIdentity

Overrides Identity.constructor

Defined in src/api/entities/CurrentIdentity.ts:23

Create a CurrentIdentity entity

Parameters:

Name	Type
identifiers	UniqueIdentifiers
context	Context

Returns: CurrentIdentity

Properties

authorizations

• authorizations: IdentityAuthorizations

Inherited from Identity.authorizations

Defined in src/api/entities/Identity/index.ts:82

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

createVenue

• createVenue: ProcedureMethod‹CreateVenueParams, Venue›

Defined in src/api/entities/CurrentIdentity.ts:133

Create a Venue

did

• did: string

Inherited from Identity.did

Defined in src/api/entities/Identity/index.ts:79

identity ID as stored in the blockchain

freezeSecondaryKeys

• freezeSecondaryKeys: ProcedureMethod‹void, void›

Defined in src/api/entities/CurrentIdentity.ts:138

Freeze all the secondary keys in this Identity. This means revoking their permission to perform any operation on the blockchain and freezing their funds until the keys are unfrozen via unfreezeSecondaryKeys

inviteAccount

• inviteAccount: ProcedureMethod‹InviteAccountParams, void›

Defined in src/api/entities/CurrentIdentity.ts:128

Send an invitation to an Account to join this Identity

note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

param list of allowed permissions (optional, defaults to no permissions)

param array of Security Tokens (or tickers) for which to allow permission. Set null to allow all (optional, no permissions if not passed)

param array of tags associated with the transaction that will be executed for which to allow permission. Set null to allow all (optional, no permissions if not passed)

param array of portfolios for which to allow permission. Set null to allow all (optional, no permissions if not passed)

modifyPermissions

• modifyPermissions: ProcedureMethod‹ModifySignerPermissionsParams, void›

Defined in src/api/entities/CurrentIdentity.ts:114

Modify all permissions of a list of secondary keys associated with the Identity

param list of permissions

param array of Security Tokens on which to grant permissions. A null value represents full permissions

param array of transaction tags that the Secondary Key has permission to execute. A null value represents full permissions

param array of Portfolios for which to grant permissions. A null value represents full permissions

portfolios

• portfolios: Portfolios

Inherited from Identity.portfolios

Defined in src/api/entities/Identity/index.ts:83

removeSecondaryKeys

• removeSecondaryKeys: ProcedureMethod‹RemoveSecondaryKeysParams, void›

Defined in src/api/entities/CurrentIdentity.ts:99

Remove a list of secondary keys associated with the Identity

revokePermissions

• revokePermissions: ProcedureMethod‹object, void›

Defined in src/api/entities/CurrentIdentity.ts:104

Revoke all permissions of a list of secondary keys associated with the Identity

unfreezeSecondaryKeys

• unfreezeSecondaryKeys: ProcedureMethod‹void, void›

Defined in src/api/entities/CurrentIdentity.ts:143

Unfreeze all the secondary keys in this Identity. This will restore their permissions as they were before being frozen

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

areSecondaryKeysFrozen

▸ areSecondaryKeysFrozen(): Promise‹boolean›

Inherited from Identity.areSecondaryKeysFrozen

Defined in src/api/entities/Identity/index.ts:480

Check whether secondary keys are frozen

note can be subscribed to

Returns: Promise‹boolean›

▸ areSecondaryKeysFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback›

Inherited from Identity.areSecondaryKeysFrozen

Defined in src/api/entities/Identity/index.ts:481

Parameters:

Name	Type
callback	SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

getHeldTokens

▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››

Inherited from Identity.getHeldTokens

Defined in src/api/entities/Identity/index.ts:306

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 }

Name	Type
order?	Order
size?	undefined | number
start?	undefined | number

Returns: Promise‹ResultSet‹SecurityToken››

getPendingInstructions

▸ getPendingInstructions(): Promise‹Instruction[]›

Inherited from Identity.getPendingInstructions

Defined in src/api/entities/Identity/index.ts:429

Retrieve all pending Instructions involving this Identity

Returns: Promise‹Instruction[]›

getPrimaryKey

▸ getPrimaryKey(): Promise‹string›

Inherited from Identity.getPrimaryKey

Defined in src/api/entities/Identity/index.ts:271

Retrieve the primary key associated with the Identity

note can be subscribed to

Returns: Promise‹string›

▸ getPrimaryKey(callback: SubCallback‹string›): Promise‹UnsubCallback›

Inherited from Identity.getPrimaryKey

Defined in src/api/entities/Identity/index.ts:272

Parameters:

Name	Type
callback	SubCallback‹string›

Returns: Promise‹UnsubCallback›

getScopeId

▸ getScopeId(args: object): Promise‹string›

Inherited from Identity.getScopeId

Defined in src/api/entities/Identity/index.ts:412

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

Name	Type
token	SecurityToken | string

Returns: Promise‹string›

getSecondaryKeys

▸ getSecondaryKeys(): Promise‹SecondaryKey[]›

Defined in src/api/entities/CurrentIdentity.ts:80

Get the list of secondary keys related to the Identity

note can be subscribed to

Returns: Promise‹SecondaryKey[]›

▸ getSecondaryKeys(callback: SubCallback‹SecondaryKey[]›): Promise‹UnsubCallback›

Defined in src/api/entities/CurrentIdentity.ts:81

Parameters:

Name	Type
callback	SubCallback‹SecondaryKey[]›

Returns: Promise‹UnsubCallback›

getTokenBalance

▸ getTokenBalance(args: object): Promise‹BigNumber›

Inherited from Identity.getTokenBalance

Defined in src/api/entities/Identity/index.ts:171

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

▪ args: object

Name	Type
ticker	string

Returns: Promise‹BigNumber›

▸ getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback›

Inherited from Identity.getTokenBalance

Defined in src/api/entities/Identity/index.ts:172

Parameters:

▪ args: object

Name	Type
ticker	string

▪ callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback›

getTrustingTokens

▸ getTrustingTokens(args: object): Promise‹SecurityToken[]›

Inherited from Identity.getTrustingTokens

Defined in src/api/entities/Identity/index.ts:357

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 }

Name	Type
order	Order

Returns: Promise‹SecurityToken[]›

getVenues

▸ getVenues(): Promise‹Venue[]›

Inherited from Identity.getVenues

Defined in src/api/entities/Identity/index.ts:378

Retrieve all Venues created by this Identity

note can be subscribed to

Returns: Promise‹Venue[]›

▸ getVenues(callback: SubCallback‹Venue[]›): Promise‹UnsubCallback›

Inherited from Identity.getVenues

Defined in src/api/entities/Identity/index.ts:379

Parameters:

Name	Type
callback	SubCallback‹Venue[]›

Returns: Promise‹UnsubCallback›

hasRole

▸ hasRole(role: Role): Promise‹boolean›

Inherited from Identity.hasRole

Defined in src/api/entities/Identity/index.ts:101

Check whether this Identity possesses the specified Role

Parameters:

Name	Type
role	Role

Returns: Promise‹boolean›

hasRoles

▸ hasRoles(roles: Role[]): Promise‹boolean›

Inherited from Identity.hasRoles

Defined in src/api/entities/Identity/index.ts:346

Check whether this Identity possesses all specified roles

Parameters:

Name	Type
roles	Role[]

Returns: Promise‹boolean›

hasValidCdd

▸ hasValidCdd(): Promise‹boolean›

Inherited from Identity.hasValidCdd

Defined in src/api/entities/Identity/index.ts:219

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›

isCddProvider

▸ isCddProvider(): Promise‹boolean›

Inherited from Identity.isCddProvider

Defined in src/api/entities/Identity/index.ts:252

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›

isEqual

▸ isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹object›

Returns: boolean

isGcMember

▸ isGcMember(): Promise‹boolean›

Inherited from Identity.isGcMember

Defined in src/api/entities/Identity/index.ts:235

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›

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: object

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

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: object

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers