Polymesh SDK API Reference
v14.1.0
v14.1.0
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • asset
  • assetPermissions
  • authorizations
  • Protected context
  • did
  • portfolios
  • uuid
  • Methods
  • addedAt
  • areSecondaryAccountsFrozen
  • checkRoles
  • exists
  • getAssetBalance
  • getHeldAssets
  • getInstructions
  • getPendingDistributions
  • getPendingInstructions
  • getPrimaryAccount
  • getScopeId
  • getSecondaryAccounts
  • getTrustingAssets
  • getVenues
  • hasRole
  • hasRoles
  • hasValidCdd
  • isCddProvider
  • isEqual
  • isGcMember
  • toJson
  • trustedFor
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

DefaultTrustedClaimIssuer

PreviousDefaultPortfolioNextDistributions

Last updated 2 years ago

Was this helpful?

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

Hierarchy

↳

↳ DefaultTrustedClaimIssuer

Index

Properties

Methods

Properties

asset

Asset for which this Identity is a Default Trusted Claim Issuer


assetPermissions


authorizations


Protected context

• context: Context


did

• did: string

Identity ID as stored in the blockchain


portfolios


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


areSecondaryAccountsFrozen

▸ areSecondaryAccountsFrozen(): Promise‹boolean›

Check whether secondary Accounts are frozen

note can be subscribed to

Returns: Promise‹boolean›

Parameters:

Name
Type

callback


checkRoles

Check whether this Identity possesses all specified roles

Parameters:

Name
Type

roles


exists

▸ exists(): Promise‹boolean›

Determine whether this Identity exists on chain

Returns: Promise‹boolean›


getAssetBalance

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

Retrieve the balance of a particular Asset

note can be subscribed to

Parameters:

â–ª args: object

Name
Type

ticker

string

Returns: Promise‹BigNumber›

Parameters:

â–ª args: object

Name
Type

ticker

string


getHeldAssets

Retrieve a list of all Assets 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?

BigNumber

start?

BigNumber


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 Assets this Identity has held


getPendingInstructions

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions


getPrimaryAccount

Retrieve the primary Account associated with the Identity

note can be subscribed to

Parameters:

Name
Type

callback


getScopeId

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

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null if there is none

Parameters:

â–ª args: object

Name
Type

asset

Returns: Promise‹string | null›


getSecondaryAccounts

Get the list of secondary Accounts related to the Identity

note can be subscribed to

Parameters:

Name
Type

callback


getTrustingAssets

Get the list of Assets for which this Identity is a trusted claim issuer

note uses the middleware


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

deprecated in favor of checkRoles

Parameters:

Name
Type

roles

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

Determine 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


trustedFor

Retrieve claim types for which this Claim Issuer is trusted. A null value means that the issuer is trusted for all claim types


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

• asset:

Defined in

• assetPermissions:

Inherited from .

Defined in

• authorizations:

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

• portfolios:

Inherited from .

Defined in

Inherited from .

Defined in

▸ addedAt(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

Inherited from .

Defined in

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

Inherited from .

Defined in

‹boolean›

Returns: Promise‹›

▸ checkRoles(roles: []): Promise‹›

Inherited from .

Defined in

[]

Returns: Promise‹›

Inherited from .

Overrides .

Defined in

Inherited from .

Defined in

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

Inherited from .

Defined in

▪ callback: ‹BigNumber›

Returns: Promise‹›

▸ getHeldAssets(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‹[]›

▸ getPrimaryAccount(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

▸ getPrimaryAccount(callback: ‹›): Promise‹›

Inherited from .

Defined in

‹›

Returns: Promise‹›

Inherited from .

Defined in

note more on Investor Uniqueness and

| string

▸ getSecondaryAccounts(): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

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

Inherited from .

Defined in

‹[]›

Returns: Promise‹›

▸ getTrustingAssets(): 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

Inherited from .

Defined in

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

Inherited from .

Defined in

‹unknown, unknown›

Inherited from .

Defined in

Inherited from .

Overrides .

Defined in

▸ trustedFor(): Promise‹[] | null›

Defined in

Returns: Promise‹[] | null›

Inherited from .

Defined in

Inherited from .

Defined in

Identity
asset
assetPermissions
authorizations
context
did
portfolios
uuid
addedAt
areSecondaryAccountsFrozen
checkRoles
exists
getAssetBalance
getHeldAssets
getInstructions
getPendingDistributions
getPendingInstructions
getPrimaryAccount
getScopeId
getSecondaryAccounts
getTrustingAssets
getVenues
hasRole
hasRoles
hasValidCdd
isCddProvider
isEqual
isGcMember
toJson
trustedFor
generateUuid
unserialize
Asset
src/api/entities/DefaultTrustedClaimIssuer.ts:36
AssetPermissions
Identity
assetPermissions
src/api/entities/Identity/index.ts:94
IdentityAuthorizations
Identity
authorizations
src/api/entities/Identity/index.ts:92
CheckpointSchedule
context
src/api/entities/Entity.ts:48
Identity
did
src/api/entities/Identity/index.ts:89
Portfolios
Identity
portfolios
src/api/entities/Identity/index.ts:93
CheckpointSchedule
uuid
src/api/entities/Entity.ts:46
EventIdentifier
src/api/entities/DefaultTrustedClaimIssuer.ts:55
EventIdentifier
Identity
areSecondaryAccountsFrozen
src/api/entities/Identity/index.ts:583
SubCallback
UnsubCallback
Identity
areSecondaryAccountsFrozen
src/api/entities/Identity/index.ts:584
UnsubCallback
Role
CheckRolesResult
Identity
checkRoles
src/api/entities/Identity/index.ts:351
CheckRolesResult
Identity
exists
Entity
exists
src/api/entities/Identity/index.ts:713
Identity
getAssetBalance
src/api/entities/Identity/index.ts:161
SubCallback
UnsubCallback
Identity
getAssetBalance
src/api/entities/Identity/index.ts:162
SubCallback
UnsubCallback
ResultSet
Asset
Identity
getHeldAssets
src/api/entities/Identity/index.ts:309
ResultSet
Asset
GroupedInstructions
Identity
getInstructions
src/api/entities/Identity/index.ts:461
GroupedInstructions
DistributionWithDetails
Identity
getPendingDistributions
src/api/entities/Identity/index.ts:620
DistributionWithDetails
Instruction
Identity
getPendingInstructions
src/api/entities/Identity/index.ts:530
Instruction
PermissionedAccount
Identity
getPrimaryAccount
src/api/entities/Identity/index.ts:262
PermissionedAccount
SubCallback
PermissionedAccount
UnsubCallback
Identity
getPrimaryAccount
src/api/entities/Identity/index.ts:263
UnsubCallback
Identity
getScopeId
src/api/entities/Identity/index.ts:439
here
here
PermissionedAccount
Identity
getSecondaryAccounts
src/api/entities/Identity/index.ts:674
PermissionedAccount
SubCallback
PermissionedAccount
UnsubCallback
Identity
getSecondaryAccounts
src/api/entities/Identity/index.ts:675
UnsubCallback
Asset
Identity
getTrustingAssets
src/api/entities/Identity/index.ts:386
Asset
Venue
Identity
getVenues
src/api/entities/Identity/index.ts:403
Venue
SubCallback
Venue
UnsubCallback
Identity
getVenues
src/api/entities/Identity/index.ts:404
UnsubCallback
Role
Identity
hasRole
src/api/entities/Identity/index.ts:113
Role
Identity
hasRoles
src/api/entities/Identity/index.ts:375
Identity
hasValidCdd
src/api/entities/Identity/index.ts:210
Identity
isCddProvider
src/api/entities/Identity/index.ts:243
Entity
CheckpointSchedule
isEqual
src/api/entities/Entity.ts:61
Identity
isGcMember
src/api/entities/Identity/index.ts:226
Identity
toJson
Entity
toJson
src/api/entities/Identity/index.ts:726
ClaimType
src/api/entities/DefaultTrustedClaimIssuer.ts:77
ClaimType
CheckpointSchedule
generateUuid
src/api/entities/Entity.ts:14
CheckpointSchedule
unserialize
src/api/entities/Entity.ts:23
SubCallback
Role
SubCallback
PermissionedAccount
Asset
SubCallback
PermissionedAccount
SubCallback
Venue
Role
Role
Entity