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

Hierarchy

Identity
DefaultTrustedClaimIssuer

Index

Properties

Methods

Properties

authorizations

authorizations: IdentityAuthorizations
Inherited from Identity.authorizations

Protected context

context: Context
Inherited from Entity.context

did

did: string
Inherited from Identity.did
identity ID as stored in the blockchain

portfolios

portfolios: Portfolios
Inherited from Identity.portfolios

ticker

ticker: string
ticker of the Security Token

tokenPermissions

tokenPermissions: TokenPermissions
Inherited from Identity.tokenPermissions

Optional trustedFor

trustedFor? : ClaimType[]
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
Inherited from Entity.uuid

Methods

addedAt

addedAt(): Promise‹EventIdentifier | null›
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›

areSecondaryKeysFrozen

areSecondaryKeysFrozen(): Promise‹boolean›
Check whether secondary keys are frozen
note can be subscribed to
Returns: Promise‹boolean›
areSecondaryKeysFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback

createVenue

createVenue(args: CreateVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueueVenue››
Inherited from Identity.createVenue
Create a Venue
note this method is of type ProcedureMethod, which means you can call createVenue.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueueVenue››

exists

exists(): Promise‹boolean›
Inherited from Identity.exists
Overrides Entity.exists
Determine whether this Identity exists on chain
Returns: Promise‹boolean›

freezeSecondaryKeys

freezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Identity.freezeSecondaryKeys
Freeze all the secondary keys in this Identity. This means revoking their permission to perform any operation on the blockchain and freezing their funds until the keys are unfrozen via unfreezeSecondaryKeys
note this method is of type ProcedureMethod, which means you can call freezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

getHeldTokens

getHeldTokens(opts: object): Promise‹ResultSetSecurityToken››
Inherited from Identity.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
Returns: Promise‹ResultSetSecurityToken››

getInstructions

getInstructions(): Promise‹GroupedInstructions
Inherited from Identity.getInstructions
Retrieve all Instructions where this Identity is a participant, grouped by status
Returns: Promise‹GroupedInstructions

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 Tokens this Identity has held
Returns: Promise‹DistributionWithDetails[]›

getPendingInstructions

getPendingInstructions(): Promise‹Instruction[]›
Retrieve all pending Instructions involving this Identity
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›

getPrimaryKey

getPrimaryKey(): Promise‹Account
Inherited from Identity.getPrimaryKey
Retrieve the primary key associated with the Identity
note can be subscribed to
Returns: Promise‹Account
getPrimaryKey(callback: SubCallbackAccount›): Promise‹UnsubCallback
Inherited from Identity.getPrimaryKey
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback

getScopeId

getScopeId(args: object): Promise‹string›
Inherited from Identity.getScopeId
Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token
note more on Investor Uniqueness: https://developers.polymesh.live/confidential_identity
Parameters:
args: object
Name
Type
token
SecurityToken | string
Returns: Promise‹string›

getSecondaryKeys

getSecondaryKeys(): Promise‹SecondaryKey[]›
Inherited from Identity.getSecondaryKeys
Get the list of secondary keys related to the Identity
note can be subscribed to
Returns: Promise‹SecondaryKey[]›
getSecondaryKeys(callback: SubCallbackSecondaryKey[]›): Promise‹UnsubCallback
Inherited from Identity.getSecondaryKeys
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback

getTokenBalance

getTokenBalance(args: object): Promise‹BigNumber›
Inherited from Identity.getTokenBalance
Retrieve the balance of a particular Security Token
note can be subscribed to
Parameters:
args: object
Name
Type
ticker
string
Returns: Promise‹BigNumber›
getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback
Inherited from Identity.getTokenBalance
Parameters:
args: object
Name
Type
ticker
string
callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback

getTrustingTokens

getTrustingTokens(args: object): Promise‹SecurityToken[]›
Inherited from Identity.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
Returns: Promise‹SecurityToken[]›

getVenues

getVenues(): Promise‹Venue[]›
Inherited from Identity.getVenues
Retrieve all Venues created by this Identity
note can be subscribed to
Returns: Promise‹Venue[]›
getVenues(callback: SubCallbackVenue[]›): Promise‹UnsubCallback
Inherited from Identity.getVenues
Parameters:
Name
Type
callback
SubCallbackVenue[]›
Returns: Promise‹UnsubCallback

hasRole

hasRole(role: Role): Promise‹boolean›
Inherited from Identity.hasRole
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
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹boolean›

hasValidCdd

hasValidCdd(): Promise‹boolean›
Inherited from Identity.hasValidCdd
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›

inviteAccount

inviteAccount(args: InviteAccountParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Identity.inviteAccount
Send an invitation to an Account to join this Identity
note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived
note this method is of type ProcedureMethod, which means you can call inviteAccount.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

isCddProvider

isCddProvider(): Promise‹boolean›
Inherited from Identity.isCddProvider
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
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
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›

modifyPermissions

modifyPermissions(args: ModifySignerPermissionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Identity.modifyPermissions
Modify all permissions of a list of secondary keys associated with the Identity
note this method is of type ProcedureMethod, which means you can call modifyPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

removeSecondaryKeys

removeSecondaryKeys(args: RemoveSecondaryKeysParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Identity.removeSecondaryKeys
Remove a list of secondary keys associated with the Identity
note this method is of type ProcedureMethod, which means you can call removeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

revokePermissions

revokePermissions(args: object, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Identity.revokePermissions
Revoke all permissions of a list of secondary keys associated with the Identity
note this method is of type ProcedureMethod, which means you can call revokePermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
args: object
Name
Type
secondaryKeys
Signer[]
Optional opts: ProcedureOpts
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): string
Inherited from Identity.toJson
Overrides Entity.toJson
Return the Identity's DID
Returns: string

unfreezeSecondaryKeys

unfreezeSecondaryKeys(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Unfreeze all the secondary keys in this Identity. This will restore their permissions as they were before being frozen
note this method is of type ProcedureMethod, which means you can call unfreezeSecondaryKeys.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago