DefaultTrustedClaimIssuer

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

Hierarchy

↳ Identity

↳ DefaultTrustedClaimIssuer

Index

Properties

• asset

• assetPermissions

• authorizations

• context

• did

• portfolios

• uuid

Methods

• addedAt
• addedAtV2
• areSecondaryAccountsFrozen
• checkRoles
• exists
• getAssetBalance
• getHeldAssets
• getHeldAssetsV2
• getInstructions
• getPendingDistributions
• getPendingInstructions
• getPrimaryAccount
• getScopeId
• getSecondaryAccounts
• getTrustingAssets
• getTrustingAssetsV2
• getVenues
• hasRole
• hasRoles
• hasValidCdd
• isCddProvider
• isEqual
• isGcMember
• toHuman
• trustedFor
• generateUuid
• unserialize

Properties

asset

• asset: Asset

Defined in src/api/entities/DefaultTrustedClaimIssuer.ts:39

Asset for which this Identity is a Default Trusted Claim Issuer

---

assetPermissions

• assetPermissions: AssetPermissions

Inherited from Identity.assetPermissions

Defined in src/api/entities/Identity/index.ts:96

---

authorizations

• authorizations: IdentityAuthorizations

Inherited from Identity.authorizations

Defined in src/api/entities/Identity/index.ts:94

---

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

did

• did: string

Inherited from Identity.did

Defined in src/api/entities/Identity/index.ts:91

Identity ID as stored in the blockchain

---

portfolios

• portfolios: Portfolios

Inherited from Identity.portfolios

Defined in src/api/entities/Identity/index.ts:95

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

addedAt

▸ addedAt(): Promise‹EventIdentifier | null›

Defined in src/api/entities/DefaultTrustedClaimIssuer.ts:58

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‹EventIdentifier | null›

---

addedAtV2

▸ addedAtV2(): Promise‹EventIdentifier | null›

Defined in src/api/entities/DefaultTrustedClaimIssuer.ts:83

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‹EventIdentifier | null›

---

areSecondaryAccountsFrozen

▸ areSecondaryAccountsFrozen(): Promise‹boolean›

Inherited from Identity.areSecondaryAccountsFrozen

Defined in src/api/entities/Identity/index.ts:649

Check whether secondary Accounts are frozen

note can be subscribed to

Returns: Promise‹boolean›

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

Inherited from Identity.areSecondaryAccountsFrozen

Defined in src/api/entities/Identity/index.ts:650

Parameters:

Name	Type
callback	SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

---

checkRoles

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

Inherited from Identity.checkRoles

Defined in src/api/entities/Identity/index.ts:398

Check whether this Identity possesses all specified roles

Parameters:

Name	Type
roles	Role[]

Returns: Promise‹CheckRolesResult›

---

exists

▸ exists(): Promise‹boolean›

Inherited from Identity.exists

Overrides Entity.exists

Defined in src/api/entities/Identity/index.ts:779

Determine whether this Identity exists on chain

Returns: Promise‹boolean›

---

getAssetBalance

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

Inherited from Identity.getAssetBalance

Defined in src/api/entities/Identity/index.ts:163

Retrieve the balance of a particular Asset

note can be subscribed to

Parameters:

▪ args: object

Name	Type
ticker	string

Returns: Promise‹BigNumber›

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

Inherited from Identity.getAssetBalance

Defined in src/api/entities/Identity/index.ts:164

Parameters:

▪ args: object

Name	Type
ticker	string

▪ callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback›

---

getHeldAssets

▸ getHeldAssets(opts: object): Promise‹ResultSet‹Asset››

Inherited from Identity.getHeldAssets

Defined in src/api/entities/Identity/index.ts:311

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

Returns: Promise‹ResultSet‹Asset››

---

getHeldAssetsV2

▸ getHeldAssetsV2(opts: object): Promise‹ResultSet‹Asset››

Inherited from Identity.getHeldAssetsV2

Defined in src/api/entities/Identity/index.ts:356

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

note uses the middlewareV2

note supports pagination

Parameters:

▪Default value opts: object= {}

Name	Type
order?	AssetHoldersOrderBy
size?	BigNumber
start?	BigNumber

Returns: Promise‹ResultSet‹Asset››

---

getInstructions

▸ getInstructions(): Promise‹GroupedInstructions›

Inherited from Identity.getInstructions

Defined in src/api/entities/Identity/index.ts:527

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

Returns: Promise‹GroupedInstructions›

---

getPendingDistributions

▸ getPendingDistributions(): Promise‹DistributionWithDetails[]›

Inherited from Identity.getPendingDistributions

Defined in src/api/entities/Identity/index.ts:686

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

---

getPendingInstructions

▸ getPendingInstructions(): Promise‹Instruction[]›

Inherited from Identity.getPendingInstructions

Defined in src/api/entities/Identity/index.ts:596

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

Returns: Promise‹Instruction[]›

---

getPrimaryAccount

▸ getPrimaryAccount(): Promise‹PermissionedAccount›

Inherited from Identity.getPrimaryAccount

Defined in src/api/entities/Identity/index.ts:264

Retrieve the primary Account associated with the Identity

note can be subscribed to

Returns: Promise‹PermissionedAccount›

▸ getPrimaryAccount(callback: SubCallback‹PermissionedAccount›): Promise‹UnsubCallback›

Inherited from Identity.getPrimaryAccount

Defined in src/api/entities/Identity/index.ts:265

Parameters:

Name	Type
callback	SubCallback‹PermissionedAccount›

Returns: Promise‹UnsubCallback›

---

getScopeId

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

Inherited from Identity.getScopeId

Defined in src/api/entities/Identity/index.ts:505

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:

▪ args: object

Name	Type
asset	Asset | string

Returns: Promise‹string | null›

---

getSecondaryAccounts

▸ getSecondaryAccounts(): Promise‹PermissionedAccount[]›

Inherited from Identity.getSecondaryAccounts

Defined in src/api/entities/Identity/index.ts:740

Get the list of secondary Accounts related to the Identity

note can be subscribed to

Returns: Promise‹PermissionedAccount[]›

▸ getSecondaryAccounts(callback: SubCallback‹PermissionedAccount[]›): Promise‹UnsubCallback›

Inherited from Identity.getSecondaryAccounts

Defined in src/api/entities/Identity/index.ts:741

Parameters:

Name	Type
callback	SubCallback‹PermissionedAccount[]›

Returns: Promise‹UnsubCallback›

---

getTrustingAssets

▸ getTrustingAssets(): Promise‹Asset[]›

Inherited from Identity.getTrustingAssets

Defined in src/api/entities/Identity/index.ts:433

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

note uses the middleware

Returns: Promise‹Asset[]›

---

getTrustingAssetsV2

▸ getTrustingAssetsV2(): Promise‹Asset[]›

Inherited from Identity.getTrustingAssetsV2

Defined in src/api/entities/Identity/index.ts:450

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

note uses the middlewareV2

Returns: Promise‹Asset[]›

---

getVenues

▸ getVenues(): Promise‹Venue[]›

Inherited from Identity.getVenues

Defined in src/api/entities/Identity/index.ts:469

Retrieve all Venues created by this Identity

note can be subscribed to

Returns: Promise‹Venue[]›

▸ getVenues(callback: SubCallback‹Venue[]›): Promise‹UnsubCallback›

Inherited from Identity.getVenues

Defined in src/api/entities/Identity/index.ts:470

Parameters:

Name	Type
callback	SubCallback‹Venue[]›

Returns: Promise‹UnsubCallback›

---

hasRole

▸ hasRole(role: Role): Promise‹boolean›

Inherited from Identity.hasRole

Defined in src/api/entities/Identity/index.ts:115

Check whether this Identity possesses the specified Role

Parameters:

Name	Type
role	Role

Returns: Promise‹boolean›

---

hasRoles

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

Inherited from Identity.hasRoles

Defined in src/api/entities/Identity/index.ts:422

Check whether this Identity possesses all specified roles

deprecated in favor of checkRoles

Parameters:

Name	Type
roles	Role[]

Returns: Promise‹boolean›

---

hasValidCdd

▸ hasValidCdd(): Promise‹boolean›

Inherited from Identity.hasValidCdd

Defined in src/api/entities/Identity/index.ts:212

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›

---

isCddProvider

▸ isCddProvider(): Promise‹boolean›

Inherited from Identity.isCddProvider

Defined in src/api/entities/Identity/index.ts:245

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›

---

isEqual

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

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

isGcMember

▸ isGcMember(): Promise‹boolean›

Inherited from Identity.isGcMember

Defined in src/api/entities/Identity/index.ts:228

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›

---

toHuman

▸ toHuman(): string

Inherited from Identity.toHuman

Overrides Entity.toHuman

Defined in src/api/entities/Identity/index.ts:792

Return the Identity's DID

Returns: string

---

trustedFor

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

Defined in src/api/entities/DefaultTrustedClaimIssuer.ts:109

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‹ClaimType[] | null›

---

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

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

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers