-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer
api/entities/DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer
Represents a default trusted claim issuer for a specific Asset in the Polymesh blockchain
-
↳
DefaultTrustedClaimIssuer
- addedAt
- areSecondaryAccountsFrozen
- checkRoles
- exists
- getAssetBalance
- getHeldAssets
- getHistoricalInstructions
- getInstructions
- getInvolvedInstructions
- getPendingDistributions
- getPrimaryAccount
- getSecondaryAccounts
- getTrustingAssets
- getVenues
- hasRole
- hasValidCdd
- isCddProvider
- isEqual
- isGcMember
- toHuman
- trustedFor
- generateUuid
- unserialize
• asset: Asset
Asset for which this Identity is a Default Trusted Claim Issuer
api/entities/DefaultTrustedClaimIssuer.ts:35
• assetPermissions: AssetPermissions
api/entities/Identity/index.ts:110
• authorizations: IdentityAuthorizations
api/entities/Identity/index.ts:108
• did: string
Identity ID as stored in the blockchain
api/entities/Identity/index.ts:105
• portfolios: Portfolios
api/entities/Identity/index.ts:109
• uuid: string
▸ 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 middlewareV2
Note
there is a possibility that the data is not ready by the time it is requested. In that case, null is returned
Promise<null | EventIdentifier>
▸ areSecondaryAccountsFrozen(): Promise<boolean>
Check whether secondary Accounts are frozen
Note
can be subscribed to
Promise<boolean>
Identity.areSecondaryAccountsFrozen
▸ areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<boolean> |
Promise<UnsubCallback>
Identity.areSecondaryAccountsFrozen
▸ checkRoles(roles): Promise<CheckRolesResult>
Check whether this Identity possesses all specified roles
| Name | Type |
|---|---|
roles |
Role[] |
Promise<CheckRolesResult>
▸ exists(): Promise<boolean>
Determine whether this Identity exists on chain
Note
asset Identities aren't considered to exist for this check
Promise<boolean>
▸ getAssetBalance(args): Promise<BigNumber>
Retrieve the balance of a particular Asset
Note
can be subscribed to
| Name | Type |
|---|---|
args |
Object |
args.ticker |
string |
Promise<BigNumber>
▸ getAssetBalance(args, callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
args |
Object |
args.ticker |
string |
callback |
SubCallback<BigNumber> |
Promise<UnsubCallback>
▸ getHeldAssets(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
| Name | Type |
|---|---|
opts |
Object |
opts.order? |
AssetHoldersOrderBy |
opts.size? |
BigNumber |
opts.start? |
BigNumber |
▸ getHistoricalInstructions(): Promise<HistoricInstruction[]>
Retrieve all Instructions that have been associated with this Identity's DID
Note
uses the middleware V2
Promise<HistoricInstruction[]>
Identity.getHistoricalInstructions
▸ getInstructions(): Promise<GroupedInstructions>
Retrieve all Instructions where this Identity is a custodian of one or more portfolios in the legs, grouped by status
Promise<GroupedInstructions>
▸ getInvolvedInstructions(): Promise<GroupedInvolvedInstructions>
Retrieve all Instructions where this Identity is a participant (owner/custodian), grouped by the role of the Identity and Instruction status
Promise<GroupedInvolvedInstructions>
Identity.getInvolvedInstructions
▸ 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
Promise<DistributionWithDetails[]>
Identity.getPendingDistributions
▸ getPrimaryAccount(): Promise<PermissionedAccount>
Retrieve the primary Account associated with the Identity
Note
can be subscribed to
Promise<PermissionedAccount>
▸ getPrimaryAccount(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<PermissionedAccount> |
Promise<UnsubCallback>
▸ getSecondaryAccounts(paginationOpts?): Promise<ResultSet<PermissionedAccount>>
Get the list of secondary Accounts related to the Identity
Note
supports pagination
Note
can be subscribed to
| Name | Type |
|---|---|
paginationOpts? |
PaginationOptions |
Promise<ResultSet<PermissionedAccount>>
▸ getSecondaryAccounts(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<PermissionedAccount[]> |
Promise<UnsubCallback>
▸ getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
paginationOpts |
PaginationOptions |
callback |
SubCallback<PermissionedAccount[]> |
Promise<UnsubCallback>
▸ getTrustingAssets(): Promise<Asset[]>
Get the list of Assets for which this Identity is a trusted claim issuer
Note
uses the middlewareV2
Promise<Asset[]>
▸ getVenues(): Promise<Venue[]>
Retrieve all Venues created by this Identity
Note
can be subscribed to
Promise<Venue[]>
▸ hasRole(role): Promise<boolean>
Check whether this Identity possesses the specified Role
| Name | Type |
|---|---|
role |
Role |
Promise<boolean>
▸ hasValidCdd(): Promise<boolean>
Check whether this Identity has a valid CDD claim
Promise<boolean>
▸ isCddProvider(): Promise<boolean>
Check whether this Identity is a CDD provider
Promise<boolean>
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ isGcMember(): Promise<boolean>
Check whether this Identity is Governance Committee member
Promise<boolean>
▸ toHuman(): string
Return the Identity's DID
string
▸ 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
Promise<null | ClaimType[]>
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types