Polymesh SDK API Reference
v9.0.0
v9.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • 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
    • TokenPermissions
    • 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
    • IdentityRole
    • 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
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • authorizations
  • Protected context
  • did
  • portfolios
  • ticker
  • tokenPermissions
  • Optional trustedFor
  • uuid
  • Methods
  • addedAt
  • areSecondaryKeysFrozen
  • createVenue
  • freezeSecondaryKeys
  • getHeldTokens
  • getInstructions
  • getPendingDistributions
  • getPendingInstructions
  • getPrimaryKey
  • getScopeId
  • getSecondaryKeys
  • getTokenBalance
  • getTrustingTokens
  • getVenues
  • hasRole
  • hasRoles
  • hasValidCdd
  • inviteAccount
  • isCddProvider
  • isEqual
  • isGcMember
  • modifyPermissions
  • removeSecondaryKeys
  • revokePermissions
  • toJson
  • unfreezeSecondaryKeys
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

DefaultTrustedClaimIssuer

PreviousDefaultPortfolioNextDistributions

Last updated 3 years ago

Was this helpful?

Represents a default trusted claim issuer for a specific token in the Polymesh blockchain

Hierarchy

↳

↳ DefaultTrustedClaimIssuer

Index

Properties

Methods

Properties

authorizations

Protected context

did

• did: string

identity ID as stored in the blockchain

portfolios

ticker

• ticker: string

ticker of the Security Token

tokenPermissions

Optional trustedFor

claim types for which this Claim Issuer is trusted. An undefined value means that the issuer is trusted for all claim types

uuid

• uuid: string

Methods

addedAt

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the trusted claim issuer was added

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

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›

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

• authorizations:

Inherited from .

Defined in

• context:

Inherited from .

Defined in

Inherited from .

Defined in

• portfolios:

Inherited from .

Defined in

Defined in

• tokenPermissions:

Inherited from .

Defined in

• trustedFor? : []

Defined in

Inherited from .

Defined in

▸ addedAt(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

Inherited from .

Defined in

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

Inherited from .

Defined in

‹boolean›

Returns: Promise‹›

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

Inherited from .

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››

Inherited from .

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

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

Inherited from .

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››

Inherited from .

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››

Inherited from .

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››

Inherited from .

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››

Inherited from .

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

IdentityAuthorizations
src/api/entities/Identity/index.ts:108
Context
src/api/entities/Entity.ts:48
src/api/entities/Identity/index.ts:105
Portfolios
src/api/entities/Identity/index.ts:109
src/api/entities/DefaultTrustedClaimIssuer.ts:40
TokenPermissions
src/api/entities/Identity/index.ts:110
ClaimType
src/api/entities/DefaultTrustedClaimIssuer.ts:35
src/api/entities/Entity.ts:46
EventIdentifier
src/api/entities/DefaultTrustedClaimIssuer.ts:60
EventIdentifier
src/api/entities/Identity/index.ts:682
src/api/entities/Identity/index.ts:683
CreateVenueParams
ProcedureOpts
TransactionQueue
Venue
src/api/entities/Identity/index.ts:224
ProcedureMethod
TransactionQueue
Venue
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:234
ProcedureMethod
TransactionQueue
ResultSet
SecurityToken
src/api/entities/Identity/index.ts:434
ResultSet
SecurityToken
GroupedInstructions
src/api/entities/Identity/index.ts:558
GroupedInstructions
DistributionWithDetails
src/api/entities/Identity/index.ts:718
DistributionWithDetails
Instruction
src/api/entities/Identity/index.ts:631
Instruction
src/api/entities/Identity/index.ts:399
src/api/entities/Identity/index.ts:400
src/api/entities/Identity/index.ts:540
https://developers.polymesh.live/confidential_identity
SecondaryKey
src/api/entities/Identity/index.ts:770
SecondaryKey
src/api/entities/Identity/index.ts:771
src/api/entities/Identity/index.ts:299
src/api/entities/Identity/index.ts:300
SecurityToken
src/api/entities/Identity/index.ts:485
SecurityToken
Venue
src/api/entities/Identity/index.ts:506
Venue
src/api/entities/Identity/index.ts:507
src/api/entities/Identity/index.ts:251
src/api/entities/Identity/index.ts:474
src/api/entities/Identity/index.ts:347
InviteAccountParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:214
ProcedureMethod
TransactionQueue
src/api/entities/Identity/index.ts:380
Entity
src/api/entities/Entity.ts:61
src/api/entities/Identity/index.ts:363
ModifySignerPermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:200
ProcedureMethod
TransactionQueue
RemoveSecondaryKeysParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:180
ProcedureMethod
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:190
ProcedureMethod
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:805
ProcedureOpts
TransactionQueue
src/api/entities/Identity/index.ts:244
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Identity
authorizations
context
did
portfolios
ticker
tokenPermissions
trustedFor
uuid
addedAt
areSecondaryKeysFrozen
createVenue
freezeSecondaryKeys
getHeldTokens
getInstructions
getPendingDistributions
getPendingInstructions
getPrimaryKey
getScopeId
getSecondaryKeys
getTokenBalance
getTrustingTokens
getVenues
hasRole
hasRoles
hasValidCdd
inviteAccount
isCddProvider
isEqual
isGcMember
modifyPermissions
removeSecondaryKeys
revokePermissions
toJson
unfreezeSecondaryKeys
generateUuid
unserialize
unfreezeSecondaryKeys
CreateVenueParams
ProcedureOpts
ProcedureOpts
SecurityToken
InviteAccountParams
ProcedureOpts
Entity
ModifySignerPermissionsParams
ProcedureOpts
RemoveSecondaryKeysParams
ProcedureOpts
ProcedureOpts
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SecondaryKey
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
Venue
SubCallback
UnsubCallback
UnsubCallback
Role
Role
SubCallback
SubCallback
SecondaryKey
SubCallback
Venue
SubCallback
Role
Role
Signer
Identity
Entity
Identity
Identity
Identity
Entity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Identity
Entity
Identity
Identity
Identity
Identity
Identity
Entity
Identity
Entity
Entity
context
uuid
isEqual
toJson
generateUuid
unserialize
authorizations
did
portfolios
tokenPermissions
areSecondaryKeysFrozen
areSecondaryKeysFrozen
createVenue
freezeSecondaryKeys
getHeldTokens
getInstructions
getPendingDistributions
getPendingInstructions
getPrimaryKey
getPrimaryKey
getScopeId
getSecondaryKeys
getSecondaryKeys
getTokenBalance
getTokenBalance
getTrustingTokens
getVenues
getVenues
hasRole
hasRoles
hasValidCdd
inviteAccount
isCddProvider
isGcMember
modifyPermissions
removeSecondaryKeys
revokePermissions
toJson
unfreezeSecondaryKeys