Skip to main content
Version: 24.2.x

Class: DefaultTrustedClaimIssuer

api/entities/DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer

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

Hierarchy

  • Identity

    DefaultTrustedClaimIssuer

Properties

asset

asset: FungibleAsset

Asset for which this Identity is a Default Trusted Claim Issuer

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:35


assetPermissions

assetPermissions: AssetPermissions

Inherited from

Identity.assetPermissions

Defined in

api/entities/Identity/index.ts:124


authorizations

authorizations: IdentityAuthorizations

Inherited from

Identity.authorizations

Defined in

api/entities/Identity/index.ts:122


did

did: string

Identity ID as stored in the blockchain

Inherited from

Identity.did

Defined in

api/entities/Identity/index.ts:119


portfolios

portfolios: Portfolios

Inherited from

Identity.portfolios

Defined in

api/entities/Identity/index.ts:123


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

Returns

Promise<null | EventIdentifier>

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

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:54


areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(): Promise<boolean>

Check whether secondary Accounts are frozen

Returns

Promise<boolean>

Note

can be subscribed to

Inherited from

Identity.areSecondaryAccountsFrozen

Defined in

api/entities/Identity/index.ts:663

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback<boolean>

Returns

Promise<UnsubCallback>

Inherited from

Identity.areSecondaryAccountsFrozen

Defined in

api/entities/Identity/index.ts:664


checkRoles

checkRoles(roles): Promise<CheckRolesResult>

Check whether this Identity possesses all specified roles

Parameters

NameType
rolesRole[]

Returns

Promise<CheckRolesResult>

Inherited from

Identity.checkRoles

Defined in

api/entities/Identity/index.ts:446


exists

exists(): Promise<boolean>

Determine whether this Identity exists on chain

Returns

Promise<boolean>

Note

asset Identities aren't considered to exist for this check

Inherited from

Identity.exists

Defined in

api/entities/Identity/index.ts:829


getAssetBalance

getAssetBalance(args): Promise<BigNumber>

Retrieve the balance of a particular Asset

Parameters

NameType
argsObject
args.tickerstring

Returns

Promise<BigNumber>

Note

can be subscribed to

Inherited from

Identity.getAssetBalance

Defined in

api/entities/Identity/index.ts:200

getAssetBalance(args, callback): Promise<UnsubCallback>

Parameters

NameType
argsObject
args.tickerstring
callbackSubCallback<BigNumber>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getAssetBalance

Defined in

api/entities/Identity/index.ts:201


getChildIdentities

getChildIdentities(): Promise<ChildIdentity[]>

Returns the list of all child identities

Returns

Promise<ChildIdentity[]>

Note

this query can be potentially SLOW depending on the number of parent Identities present on the chain

Inherited from

Identity.getChildIdentities

Defined in

api/entities/Identity/index.ts:881


getHeldAssets

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

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

Parameters

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

Returns

Promise<ResultSet <FungibleAsset>>

Note

uses the middlewareV2

Note

supports pagination

Inherited from

Identity.getHeldAssets

Defined in

api/entities/Identity/index.ts:354


getHeldNfts

getHeldNfts(opts?): Promise<ResultSet <HeldNfts>>

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

Parameters

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

Returns

Promise<ResultSet <HeldNfts>>

Note

uses the middlewareV2

Note

supports pagination

Inherited from

Identity.getHeldNfts

Defined in

api/entities/Identity/index.ts:399


getHistoricalInstructions

getHistoricalInstructions(): Promise<HistoricInstruction[]>

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

Returns

Promise<HistoricInstruction[]>

Note

uses the middleware V2

Inherited from

Identity.getHistoricalInstructions

Defined in

api/entities/Identity/index.ts:861


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

Defined in

api/entities/Identity/index.ts:517


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

Defined in

api/entities/Identity/index.ts:604


getPendingDistributions

getPendingDistributions(): Promise<DistributionWithDetails[]>

Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid

Returns

Promise<DistributionWithDetails[]>

Note

uses the middleware

Note

this query can be potentially SLOW depending on which Assets this Identity has held

Inherited from

Identity.getPendingDistributions

Defined in

api/entities/Identity/index.ts:700


getPrimaryAccount

getPrimaryAccount(): Promise<PermissionedAccount>

Retrieve the primary Account associated with the Identity

Returns

Promise<PermissionedAccount>

Note

can be subscribed to

Inherited from

Identity.getPrimaryAccount

Defined in

api/entities/Identity/index.ts:301

getPrimaryAccount(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback <PermissionedAccount>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getPrimaryAccount

Defined in

api/entities/Identity/index.ts:302


getSecondaryAccounts

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

Get the list of secondary Accounts related to the Identity

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet <PermissionedAccount>>

Note

supports pagination

Note

can be subscribed to

Inherited from

Identity.getSecondaryAccounts

Defined in

api/entities/Identity/index.ts:755

getSecondaryAccounts(callback): Promise<UnsubCallback>

Parameters

NameType
callbackSubCallback <PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getSecondaryAccounts

Defined in

api/entities/Identity/index.ts:759

getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>

Parameters

NameType
paginationOptsPaginationOptions
callbackSubCallback <PermissionedAccount[]>

Returns

Promise<UnsubCallback>

Inherited from

Identity.getSecondaryAccounts

Defined in

api/entities/Identity/index.ts:763


getTrustingAssets

getTrustingAssets(): Promise<FungibleAsset[]>

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

Returns

Promise<FungibleAsset[]>

Note

uses the middlewareV2

Inherited from

Identity.getTrustingAssets

Defined in

api/entities/Identity/index.ts:470


getVenues

getVenues(): Promise<Venue[]>

Retrieve all Venues created by this Identity

Returns

Promise<Venue[]>

Note

can be subscribed to

Inherited from

Identity.getVenues

Defined in

api/entities/Identity/index.ts:489


hasRole

hasRole(role): Promise<boolean>

Check whether this Identity possesses the specified Role

Parameters

NameType
roleRole

Returns

Promise<boolean>

Inherited from

Identity.hasRole

Defined in

api/entities/Identity/index.ts:152


hasValidCdd

hasValidCdd(): Promise<boolean>

Check whether this Identity has a valid CDD claim

Returns

Promise<boolean>

Inherited from

Identity.hasValidCdd

Defined in

api/entities/Identity/index.ts:249


isAssetPreApproved

isAssetPreApproved(asset): Promise<boolean>

Returns whether or not this Identity has pre-approved a particular asset

Parameters

NameType
assetstring | BaseAsset

Returns

Promise<boolean>

Inherited from

Identity.isAssetPreApproved

Defined in

api/entities/Identity/index.ts:969


isCddProvider

isCddProvider(): Promise<boolean>

Check whether this Identity is a CDD provider

Returns

Promise<boolean>

Inherited from

Identity.isCddProvider

Defined in

api/entities/Identity/index.ts:282


isChild

isChild(): Promise<boolean>

Check whether this Identity is a child Identity

Returns

Promise<boolean>

Inherited from

Identity.isChild

Defined in

api/entities/Identity/index.ts:922


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

Defined in

api/entities/Entity.ts:61


isGcMember

isGcMember(): Promise<boolean>

Check whether this Identity is Governance Committee member

Returns

Promise<boolean>

Inherited from

Identity.isGcMember

Defined in

api/entities/Identity/index.ts:265


preApprovedAssets

preApprovedAssets(paginationOpts?): Promise<ResultSet <Asset>>

Returns a list of all assets this Identity has pre-approved. These assets will not require affirmation when being received in settlements

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet <Asset>>

Inherited from

Identity.preApprovedAssets

Defined in

api/entities/Identity/index.ts:933


toHuman

toHuman(): string

Return the Identity's DID

Returns

string

Inherited from

Identity.toHuman

Defined in

api/entities/Identity/index.ts:852


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

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:80


unlinkChild

unlinkChild(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Unlinks a child identity

Parameters

NameType
argsUnlinkChildParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Throws

if

  • the child is not a child of this identity
  • the transaction signer is not the primary key of the parent identity

Note

this method is of type ProcedureMethod, which means you can call unlinkChild.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Inherited from

Identity.unlinkChild

Defined in

api/entities/Identity/index.ts:915


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

Defined in

api/entities/Entity.ts:14


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

Defined in

api/entities/Entity.ts:23