Polymesh SDK API Reference
v7.0.0
v7.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • Agent
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • 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
    • KnownPermissionGroup
    • KnownTokenType
    • 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
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • GroupedInstructions
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • 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
    • 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
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenPiaRole
    • TransactionPermissions
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • authorizations
  • Protected context
  • did
  • portfolios
  • ticker
  • Optional trustedFor
  • uuid
  • Methods
  • addedAt
  • areSecondaryKeysFrozen
  • getHeldTokens
  • getInstructions
  • getPendingDistributions
  • getPendingInstructions
  • getPrimaryKey
  • getScopeId
  • getSecondaryKeys
  • getTokenBalance
  • getTrustingTokens
  • getVenues
  • hasRole
  • hasRoles
  • hasTokenPermissions
  • hasValidCdd
  • isCddProvider
  • isEqual
  • isGcMember
  • toJson
  • 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

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

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›

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›

toJson

â–¸ toJson(): string

Return the Identity's DID

Returns: string

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

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

▸ 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

Inherited from .

Defined in

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

Inherited from .

Defined in

‹unknown, unknown›

Inherited from .

Defined in

Inherited from .

Overrides .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

IdentityAuthorizations
src/api/entities/Identity/index.ts:98
Context
src/api/entities/Entity.ts:48
src/api/entities/Identity/index.ts:95
Portfolios
src/api/entities/Identity/index.ts:99
src/api/entities/DefaultTrustedClaimIssuer.ts:40
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:693
src/api/entities/Identity/index.ts:694
ResultSet
SecurityToken
src/api/entities/Identity/index.ts:445
ResultSet
SecurityToken
GroupedInstructions
src/api/entities/Identity/index.ts:569
GroupedInstructions
DistributionWithDetails
src/api/entities/Identity/index.ts:729
DistributionWithDetails
Instruction
src/api/entities/Identity/index.ts:642
Instruction
src/api/entities/Identity/index.ts:410
src/api/entities/Identity/index.ts:411
src/api/entities/Identity/index.ts:551
https://developers.polymesh.live/confidential_identity
SecondaryKey
src/api/entities/Identity/index.ts:781
SecondaryKey
src/api/entities/Identity/index.ts:782
src/api/entities/Identity/index.ts:310
src/api/entities/Identity/index.ts:311
SecurityToken
src/api/entities/Identity/index.ts:496
SecurityToken
Venue
src/api/entities/Identity/index.ts:517
Venue
src/api/entities/Identity/index.ts:518
src/api/entities/Identity/index.ts:240
src/api/entities/Identity/index.ts:485
src/api/entities/Identity/index.ts:117
src/api/entities/Identity/index.ts:358
src/api/entities/Identity/index.ts:391
Entity
src/api/entities/Entity.ts:61
src/api/entities/Identity/index.ts:374
src/api/entities/Identity/index.ts:816
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Identity
authorizations
context
did
portfolios
ticker
trustedFor
uuid
addedAt
areSecondaryKeysFrozen
getHeldTokens
getInstructions
getPendingDistributions
getPendingInstructions
getPrimaryKey
getScopeId
getSecondaryKeys
getTokenBalance
getTrustingTokens
getVenues
hasRole
hasRoles
hasTokenPermissions
hasValidCdd
isCddProvider
isEqual
isGcMember
toJson
generateUuid
unserialize
SecurityToken
SecurityToken
Entity
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
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
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
Role
Role
SubCallback
SubCallback
SubCallback
SubCallback
Role
Role