Skip to main content
Version: 21.0.x

Class: DefaultTrustedClaimIssuer

api/entities/DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer

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

Hierarchy

Properties

asset

asset: Asset

Asset for which this Identity is a Default Trusted Claim Issuer

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:39


assetPermissions

assetPermissions: AssetPermissions

Inherited from

Identity.assetPermissions

Defined in

api/entities/Identity/index.ts:114


authorizations

authorizations: IdentityAuthorizations

Inherited from

Identity.authorizations

Defined in

api/entities/Identity/index.ts:112


did

did: string

Identity ID as stored in the blockchain

Inherited from

Identity.did

Defined in

api/entities/Identity/index.ts:109


portfolios

portfolios: Portfolios

Inherited from

Identity.portfolios

Defined in

api/entities/Identity/index.ts:113


uuid

uuid: string

Inherited from

Identity.uuid

Defined in

api/entities/Entity.ts:46

Methods

addedAt

addedAt(): Promise<null | EventIdentifier>

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

Returns

Promise<null | EventIdentifier>


addedAtV2

addedAtV2(): Promise<null | EventIdentifier>

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 middlewareV2

Note

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

Returns

Promise<null | EventIdentifier>


areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(): Promise<boolean>

Check whether secondary Accounts are frozen

Note

can be subscribed to

Returns

Promise<boolean>

Inherited from

Identity.areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<boolean>

Returns

Promise<UnsubCallback>

Inherited from

Identity.areSecondaryAccountsFrozen


checkRoles

checkRoles(roles): Promise<CheckRolesResult>

Check whether this Identity possesses all specified roles

Parameters

NameType
rolesRole[]

Returns

Promise<CheckRolesResult>

Inherited from

Identity.checkRoles


exists

exists(): Promise<boolean>

Determine whether this Identity exists on chain

Note

asset Identities aren't considered to exist for this check

Returns

Promise<boolean>

Inherited from

Identity.exists


getAssetBalance

getAssetBalance(args): Promise<BigNumber>

Retrieve the balance of a particular Asset

Note

can be subscribed to

Parameters

NameType
argsObject
args.tickerstring

Returns

Promise<BigNumber>

Inherited from

Identity.getAssetBalance

getAssetBalance(args, callback): Promise<UnsubCallback>

Parameters

NameType
argsObject
args.tickerstring
callbackSubCallback<BigNumber>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getAssetBalance


getHeldAssets

getHeldAssets(opts?): Promise<ResultSet<Asset>>

Retrieve a list of all Assets which were held at one point by this Identity

Note

uses the middleware

Note

supports pagination

Parameters

NameType
optsObject
opts.order?Order
opts.size?BigNumber
opts.start?BigNumber

Returns

Promise<ResultSet<Asset>>

Inherited from

Identity.getHeldAssets


getHeldAssetsV2

getHeldAssetsV2(opts?): Promise<ResultSet<Asset>>

Retrieve a list of all Assets which were held at one point by this Identity

Note

uses the middlewareV2

Note

supports pagination

Parameters

NameType
optsObject
opts.order?AssetHoldersOrderBy
opts.size?BigNumber
opts.start?BigNumber

Returns

Promise<ResultSet<Asset>>

Inherited from

Identity.getHeldAssetsV2


getHistoricalInstructions

getHistoricalInstructions(): Promise<HistoricInstruction[]>

Retrieve all Instructions that have been associated with this Identity's DID

Note

uses the middleware V2

Returns

Promise<HistoricInstruction[]>

Inherited from

Identity.getHistoricalInstructions


getInstructions

getInstructions(): Promise<GroupedInstructions>

Retrieve all Instructions where this Identity is a custodian of one or more portfolios in the legs, grouped by status

Returns

Promise<GroupedInstructions>

Inherited from

Identity.getInstructions


getInvolvedInstructions

getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>

Retrieve all Instructions where this Identity is a participant (owner/custodian), grouped by the role of the Identity and Instruction status

Returns

Promise<GroupedInvolvedInstructions>

Inherited from

Identity.getInvolvedInstructions


getPendingDistributions

getPendingDistributions(): Promise<DistributionWithDetails[]>

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

Returns

Promise<DistributionWithDetails[]>

Inherited from

Identity.getPendingDistributions


getPrimaryAccount

getPrimaryAccount(): Promise<PermissionedAccount>

Retrieve the primary Account associated with the Identity

Note

can be subscribed to

Returns

Promise<PermissionedAccount>

Inherited from

Identity.getPrimaryAccount

getPrimaryAccount(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<PermissionedAccount>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getPrimaryAccount


getScopeId

getScopeId(args): Promise<null | string>

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

Note

more on Investor Uniqueness here and here

Parameters

NameType
argsObject
args.assetstring | Asset

Returns

Promise<null | string>

Inherited from

Identity.getScopeId


getSecondaryAccounts

getSecondaryAccounts(paginationOpts?): Promise<ResultSet<PermissionedAccount>>

Get the list of secondary Accounts related to the Identity

Note

supports pagination

Note

can be subscribed to

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet<PermissionedAccount>>

Inherited from

Identity.getSecondaryAccounts

getSecondaryAccounts(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getSecondaryAccounts

getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

Parameters

NameType
paginationOptsPaginationOptions
callbackSubCallback<PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getSecondaryAccounts


getTrustingAssets

getTrustingAssets(): Promise<Asset[]>

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

Note

uses the middleware

Returns

Promise<Asset[]>

Inherited from

Identity.getTrustingAssets


getTrustingAssetsV2

getTrustingAssetsV2(): Promise<Asset[]>

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

Note

uses the middlewareV2

Returns

Promise<Asset[]>

Inherited from

Identity.getTrustingAssetsV2


getVenues

getVenues(): Promise<Venue[]>

Retrieve all Venues created by this Identity

Note

can be subscribed to

Returns

Promise<Venue[]>

Inherited from

Identity.getVenues

getVenues(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<Venue[]>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getVenues


hasRole

hasRole(role): Promise<boolean>

Check whether this Identity possesses the specified Role

Parameters

NameType
roleRole

Returns

Promise<boolean>

Inherited from

Identity.hasRole


hasValidCdd

hasValidCdd(): Promise<boolean>

Check whether this Identity has a valid CDD claim

Returns

Promise<boolean>

Inherited from

Identity.hasValidCdd


isCddProvider

isCddProvider(): Promise<boolean>

Check whether this Identity is a CDD provider

Returns

Promise<boolean>

Inherited from

Identity.isCddProvider


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

Identity.isEqual


isGcMember

isGcMember(): Promise<boolean>

Check whether this Identity is Governance Committee member

Returns

Promise<boolean>

Inherited from

Identity.isGcMember


toHuman

toHuman(): string

Return the Identity's DID

Returns

string

Inherited from

Identity.toHuman


trustedFor

trustedFor(): Promise<null | ClaimType[]>

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

Returns

Promise<null | ClaimType[]>


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

Identity.generateUuid


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

Identity.unserialize