Polymesh SDK API Reference
v8.0.0
v8.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • Agent
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • GroupedInstructions
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenIdentifier
    • TransactionPermissions
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Constructors
  • Properties
  • Methods
  • Constructors
  • constructor
  • Properties
  • authorizations
  • Protected context
  • did
  • portfolios
  • uuid
  • Methods
  • areSecondaryKeysFrozen
  • createVenue
  • freezeSecondaryKeys
  • getHeldTokens
  • getInstructions
  • getPendingDistributions
  • getPendingInstructions
  • getPrimaryKey
  • getScopeId
  • getSecondaryKeys
  • getTokenBalance
  • getTrustingTokens
  • getVenues
  • hasRole
  • hasRoles
  • hasTokenPermissions
  • hasValidCdd
  • inviteAccount
  • isCddProvider
  • isEqual
  • isGcMember
  • modifyPermissions
  • removeSecondaryKeys
  • revokePermissions
  • toJson
  • unfreezeSecondaryKeys
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CurrentIdentity

PreviousCurrentAccountNextCustomPermissionGroup

Last updated 3 years ago

Was this helpful?

Represents the Identity associated to the current

Hierarchy

↳

↳ CurrentIdentity

Index

Constructors

Properties

Methods

Constructors

constructor

Create a CurrentIdentity entity

Parameters:

Name

Type

identifiers

context

Properties

authorizations

Protected context

did

• did: string

identity ID as stored in the blockchain

portfolios

uuid

• uuid: string

Methods

areSecondaryKeysFrozen

▸ areSecondaryKeysFrozen(): Promise‹boolean›

Check whether secondary keys are frozen

note can be subscribed to

Returns: Promise‹boolean›

Parameters:

Name

Type

callback

createVenue

Create a Venue

Parameters:

Name

Type

args

opts?

freezeSecondaryKeys

Parameters:

Name

Type

args

void

opts?

getHeldTokens

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

getInstructions

Retrieve all Instructions where this Identity is a participant, grouped by status

getPendingDistributions

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

getPendingInstructions

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

getPrimaryKey

▸ getPrimaryKey(): Promise‹string›

Retrieve the primary key associated with the Identity

note can be subscribed to

Returns: Promise‹string›

Parameters:

Name

Type

callback

getScopeId

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

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token

Parameters:

â–ª args: object

Name

Type

token

Returns: Promise‹string›

getSecondaryKeys

Get the list of secondary keys related to the Identity

note can be subscribed to

Parameters:

Name

Type

callback

getTokenBalance

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

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

â–ª args: object

Name

Type

ticker

string

Returns: Promise‹BigNumber›

Parameters:

â–ª args: object

Name

Type

ticker

string

getTrustingTokens

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

getVenues

Retrieve all Venues created by this Identity

note can be subscribed to

Parameters:

Name

Type

callback

hasRole

Check whether this Identity possesses the specified Role

Parameters:

Name

Type

role

Returns: Promise‹boolean›

hasRoles

Check whether this Identity possesses all specified roles

Parameters:

Name

Type

roles

Returns: Promise‹boolean›

hasTokenPermissions

▸ hasTokenPermissions(args: object): Promise‹boolean›

Check whether this Identity has specific transaction Permissions over a Security Token

Parameters:

â–ª args: object

Name

Type

token

transactions

TxTag[] | null

Returns: Promise‹boolean›

hasValidCdd

▸ hasValidCdd(): Promise‹boolean›

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›

inviteAccount

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

Parameters:

Name

Type

args

opts?

isCddProvider

▸ isCddProvider(): Promise‹boolean›

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

isGcMember

▸ isGcMember(): Promise‹boolean›

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›

modifyPermissions

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

Parameters:

Name

Type

args

opts?

removeSecondaryKeys

Remove a list of secondary keys associated with the Identity

Parameters:

Name

Type

args

opts?

revokePermissions

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

Parameters:

â–ª args: object

Name

Type

secondaryKeys

toJson

â–¸ toJson(): string

Return the Identity's DID

Returns: string

unfreezeSecondaryKeys

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

Parameters:

Name

Type

args

void

opts?

Static generateUuid

▸ generateUuid‹Identifiers›(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

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

+ new CurrentIdentity(identifiers: , context: ):

Overrides .

Defined in

Returns:

• authorizations:

Inherited from .

Defined in

• context:

Inherited from .

Defined in

Inherited from .

Defined in

• portfolios:

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

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

Inherited from .

Defined in

‹boolean›

Returns: Promise‹›

▸ createVenue(args: , opts?: ): Promise‹‹››

Defined in

note this method is of type , which means you can call createVenue.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ freezeSecondaryKeys(args: void, opts?: ): Promise‹‹void››

Defined in

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

note this method is of type , which means you can call freezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

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

Inherited from .

Defined in

Returns: Promise‹‹››

▸ getInstructions(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

▸ getPendingDistributions(): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getPendingInstructions(): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

Inherited from .

Defined in

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

Inherited from .

Defined in

‹string›

Returns: Promise‹›

Inherited from .

Defined in

note more on Investor Uniqueness:

| string

▸ getSecondaryKeys(): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getSecondaryKeys(callback: ‹[]›): Promise‹›

Inherited from .

Defined in

‹[]›

Returns: Promise‹›

Inherited from .

Defined in

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

Inherited from .

Defined in

▪ callback: ‹BigNumber›

Returns: Promise‹›

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

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getVenues(): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getVenues(callback: ‹[]›): Promise‹›

Inherited from .

Defined in

‹[]›

Returns: Promise‹›

▸ hasRole(role: ): Promise‹boolean›

Inherited from .

Defined in

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

Inherited from .

Defined in

[]

Inherited from .

Defined in

| string

Inherited from .

Defined in

▸ inviteAccount(args: , opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call inviteAccount.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

Inherited from .

Defined in

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Inherited from .

Defined in

▸ modifyPermissions(args: , opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call modifyPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ removeSecondaryKeys(args: , opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call removeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ revokePermissions(args: object, opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call revokePermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

[]

â–ªOptional opts:

Returns: Promise‹‹void››

Inherited from .

Overrides .

Defined in

▸ unfreezeSecondaryKeys(args: void, opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call unfreezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

UniqueIdentifiers
Context
CurrentIdentity
src/api/entities/CurrentIdentity.ts:24
CurrentIdentity
IdentityAuthorizations
src/api/entities/Identity/index.ts:96
Context
src/api/entities/Entity.ts:48
src/api/entities/Identity/index.ts:93
Portfolios
src/api/entities/Identity/index.ts:97
src/api/entities/Entity.ts:46
src/api/entities/Identity/index.ts:667
src/api/entities/Identity/index.ts:668
CreateVenueParams
ProcedureOpts
TransactionQueue
Venue
src/api/entities/CurrentIdentity.ts:130
ProcedureMethod
TransactionQueue
Venue
ProcedureOpts
TransactionQueue
src/api/entities/CurrentIdentity.ts:140
ProcedureMethod
TransactionQueue
ResultSet
SecurityToken
src/api/entities/Identity/index.ts:419
ResultSet
SecurityToken
GroupedInstructions
src/api/entities/Identity/index.ts:543
GroupedInstructions
DistributionWithDetails
src/api/entities/Identity/index.ts:703
DistributionWithDetails
Instruction
src/api/entities/Identity/index.ts:616
Instruction
src/api/entities/Identity/index.ts:384
src/api/entities/Identity/index.ts:385
src/api/entities/Identity/index.ts:525
https://developers.polymesh.live/confidential_identity
SecondaryKey
src/api/entities/Identity/index.ts:755
SecondaryKey
src/api/entities/Identity/index.ts:756
src/api/entities/Identity/index.ts:284
src/api/entities/Identity/index.ts:285
SecurityToken
src/api/entities/Identity/index.ts:470
SecurityToken
Venue
src/api/entities/Identity/index.ts:491
Venue
src/api/entities/Identity/index.ts:492
src/api/entities/Identity/index.ts:238
src/api/entities/Identity/index.ts:459
src/api/entities/Identity/index.ts:115
src/api/entities/Identity/index.ts:332
InviteAccountParams
ProcedureOpts
TransactionQueue
src/api/entities/CurrentIdentity.ts:120
ProcedureMethod
TransactionQueue
src/api/entities/Identity/index.ts:365
Entity
src/api/entities/Entity.ts:61
src/api/entities/Identity/index.ts:348
ModifySignerPermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/CurrentIdentity.ts:106
ProcedureMethod
TransactionQueue
RemoveSecondaryKeysParams
ProcedureOpts
TransactionQueue
src/api/entities/CurrentIdentity.ts:86
ProcedureMethod
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/CurrentIdentity.ts:96
ProcedureMethod
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:790
ProcedureOpts
TransactionQueue
src/api/entities/CurrentIdentity.ts:150
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Account
Identity
constructor
authorizations
context
did
portfolios
uuid
areSecondaryKeysFrozen
createVenue
freezeSecondaryKeys
getHeldTokens
getInstructions
getPendingDistributions
getPendingInstructions
getPrimaryKey
getScopeId
getSecondaryKeys
getTokenBalance
getTrustingTokens
getVenues
hasRole
hasRoles
hasTokenPermissions
hasValidCdd
inviteAccount
isCddProvider
isEqual
isGcMember
modifyPermissions
removeSecondaryKeys
revokePermissions
toJson
unfreezeSecondaryKeys
generateUuid
unserialize
unfreezeSecondaryKeys
UniqueIdentifiers
Context
CreateVenueParams
ProcedureOpts
ProcedureOpts
SecurityToken
SecurityToken
InviteAccountParams
ProcedureOpts
Entity
ModifySignerPermissionsParams
ProcedureOpts
RemoveSecondaryKeysParams
ProcedureOpts
ProcedureOpts
Identity
Identity
Entity
Identity
Identity
Entity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
SecondaryKey
Identity
Identity
Identity
Identity
Identity
Venue
Identity
Identity
Identity
Identity
Identity
Identity
Entity
Identity
Identity
Entity
Entity
Entity
SecondaryKey
Venue
context
uuid
isEqual
toJson
generateUuid
unserialize
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
Role
Role
SubCallback
SubCallback
SubCallback
SubCallback
Role
Role
Signer
constructor
authorizations
did
portfolios
areSecondaryKeysFrozen
areSecondaryKeysFrozen
getHeldTokens
getInstructions
getPendingDistributions
getPendingInstructions
getPrimaryKey
getPrimaryKey
getScopeId
getSecondaryKeys
getSecondaryKeys
getTokenBalance
getTokenBalance
getTrustingTokens
getVenues
getVenues
hasRole
hasRoles
hasTokenPermissions
hasValidCdd
isCddProvider
isGcMember
toJson