-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.Identity.ChildIdentity.ChildIdentity
api/entities/Identity/ChildIdentity.ChildIdentity
Represents a child identity
-
↳
ChildIdentity
- areSecondaryAccountsFrozen
- checkRoles
- exists
- getAssetBalance
- getHeldAssets
- getHeldNfts
- getHistoricalInstructions
- getInstructions
- getInvolvedInstructions
- getMultiSigSigners
- getOffChainAuthorizationNonce
- getParentDid
- getPendingDistributions
- getPrimaryAccount
- getSecondaryAccounts
- getTrustingAssets
- getVenues
- hasRole
- hasValidCdd
- isAssetPreApproved
- isCddProvider
- isChild
- isEqual
- isGcMember
- preApprovedAssets
- toHuman
- unlinkChild
- unlinkFromParent
- generateUuid
- unserialize
• assetPermissions: AssetPermissions
api/entities/Identity/index.ts:132
• authorizations: IdentityAuthorizations
api/entities/Identity/index.ts:130
• did: string
Identity ID as stored in the blockchain
api/entities/Identity/index.ts:127
• portfolios: Portfolios
api/entities/Identity/index.ts:131
• uuid: string
▸ areSecondaryAccountsFrozen(): Promise<boolean>
Check whether secondary Accounts are frozen
Promise<boolean>
Note
can be subscribed to, if connected to node using a web socket
Identity.areSecondaryAccountsFrozen
api/entities/Identity/index.ts:713
▸ areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<boolean> |
Promise<UnsubCallback>
Identity.areSecondaryAccountsFrozen
api/entities/Identity/index.ts:714
▸ checkRoles(roles): Promise<CheckRolesResult>
Check whether this Identity possesses all specified roles
| Name | Type |
|---|---|
roles |
Role[] |
Promise<CheckRolesResult>
api/entities/Identity/index.ts:495
▸ exists(): Promise<boolean>
Determine whether this child Identity exists
Promise<boolean>
Note
asset Identities aren't considered to exist for this check
api/entities/Identity/ChildIdentity.ts:67
▸ getAssetBalance(args): Promise<BigNumber>
Retrieve the balance of a particular Asset
| Name | Type |
|---|---|
args |
Object |
args.ticker |
string |
Promise<BigNumber>
Note
can be subscribed to, if connected to node using a web socket
api/entities/Identity/index.ts:208
▸ getAssetBalance(args): Promise<BigNumber>
| Name | Type |
|---|---|
args |
Object |
args.assetId |
string |
Promise<BigNumber>
api/entities/Identity/index.ts:209
▸ getAssetBalance(args, callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
args |
Object |
args.ticker |
string |
callback |
SubCallback<BigNumber> |
Promise<UnsubCallback>
api/entities/Identity/index.ts:210
▸ getAssetBalance(args, callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
args |
Object |
args.assetId |
string |
callback |
SubCallback<BigNumber> |
Promise<UnsubCallback>
api/entities/Identity/index.ts:215
▸ getHeldAssets(opts?): Promise<ResultSet<FungibleAsset>>
Retrieve a list of all Assets which were held at one point by this Identity
| Name | Type |
|---|---|
opts |
Object |
opts.order? |
AssetHoldersOrderBy |
opts.size? |
BigNumber |
opts.start? |
BigNumber |
Promise<ResultSet<FungibleAsset>>
Note
uses the middlewareV2
Note
supports pagination
api/entities/Identity/index.ts:391
▸ getHeldNfts(opts?): Promise<ResultSet<HeldNfts>>
Retrieve a list of all NftCollections which were held at one point by this Identity
| Name | Type |
|---|---|
opts |
Object |
opts.order? |
NftHoldersOrderBy |
opts.size? |
BigNumber |
opts.start? |
BigNumber |
Note
uses the middlewareV2
Note
supports pagination
api/entities/Identity/index.ts:438
▸ getHistoricalInstructions(filter?): Promise<HistoricInstruction[]>
Retrieve all Instructions that have been associated with this Identity's DID
| Name | Type |
|---|---|
filter? |
Omit<InstructionPartiesFilters, "identity"> |
Promise<HistoricInstruction[]>
Note
uses the middleware V2
Note
supports pagination
Identity.getHistoricalInstructions
api/entities/Identity/index.ts:919
▸ 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>
api/entities/Identity/index.ts:567
▸ 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
api/entities/Identity/index.ts:654
▸ getMultiSigSigners(): Promise<MultiSigSigners[]>
Returns the list of MultiSig accounts along with their signatories this identity has responsibility for. The roles possible are:
- Admin: The identity is able to unilaterally modify the MultiSig properties, such as the signers and signatures required for a proposal
- Payer: The identity's primary key will be deducted any POLYX fees the MultiSig may incur
Promise<MultiSigSigners[]>
Note
this query can be potentially SLOW depending on the number of MultiSigs present on the chain
api/entities/Identity/index.ts:1073
▸ getOffChainAuthorizationNonce(): Promise<BigNumber>
Returns the off chain authorization nonce for this Identity
Promise<BigNumber>
Identity.getOffChainAuthorizationNonce
api/entities/Identity/index.ts:1208
▸ getParentDid(): Promise<null | Identity>
Returns the parent of this Identity (if any)
Promise<null | Identity>
api/entities/Identity/ChildIdentity.ts:31
▸ getPendingDistributions(): Promise<DistributionWithDetails[]>
Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid
Promise<DistributionWithDetails[]>
Note
uses the middleware
Note
this query can be potentially SLOW depending on which Assets this Identity has held
Identity.getPendingDistributions
api/entities/Identity/index.ts:752
▸ getPrimaryAccount(): Promise<PermissionedAccount>
Retrieve the primary Account associated with the Identity
Promise<PermissionedAccount>
Note
can be subscribed to, if connected to node using a web socket
api/entities/Identity/index.ts:327
▸ getPrimaryAccount(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<PermissionedAccount> |
Promise<UnsubCallback>
api/entities/Identity/index.ts:328
▸ getSecondaryAccounts(paginationOpts?): Promise<ResultSet<PermissionedAccount>>
Get the list of secondary Accounts related to the Identity
| Name | Type |
|---|---|
paginationOpts? |
PaginationOptions |
Promise<ResultSet<PermissionedAccount>>
Note
supports pagination
Note
can be subscribed to, if connected to node using a web socket
api/entities/Identity/index.ts:802
▸ getSecondaryAccounts(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<PermissionedAccount[]> |
Promise<UnsubCallback>
api/entities/Identity/index.ts:806
▸ getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
paginationOpts |
PaginationOptions |
callback |
SubCallback<PermissionedAccount[]> |
Promise<UnsubCallback>
api/entities/Identity/index.ts:810
▸ getTrustingAssets(): Promise<FungibleAsset[]>
Get the list of Assets for which this Identity is a trusted claim issuer
Promise<FungibleAsset[]>
Note
uses the middlewareV2
api/entities/Identity/index.ts:519
▸ getVenues(): Promise<Venue[]>
Retrieve all Venues created by this Identity
Promise<Venue[]>
api/entities/Identity/index.ts:539
▸ hasRole(role): Promise<boolean>
Check whether this Identity possesses the specified Role
| Name | Type |
|---|---|
role |
Role |
Promise<boolean>
api/entities/Identity/index.ts:160
▸ hasValidCdd(): Promise<boolean>
Check whether this Identity has a valid CDD claim
Promise<boolean>
api/entities/Identity/index.ts:275
▸ isAssetPreApproved(asset): Promise<boolean>
Returns whether or not this Identity has pre-approved a particular asset
| Name | Type |
|---|---|
asset |
string | BaseAsset
|
Promise<boolean>
api/entities/Identity/index.ts:1037
▸ isCddProvider(): Promise<boolean>
Check whether this Identity is a CDD provider
Promise<boolean>
api/entities/Identity/index.ts:308
▸ isChild(): Promise<boolean>
Check whether this Identity is a child Identity
Promise<boolean>
api/entities/Identity/index.ts:984
▸ 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>
api/entities/Identity/index.ts:291
▸ 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
| Name | Type |
|---|---|
paginationOpts? |
PaginationOptions |
api/entities/Identity/index.ts:995
▸ toHuman(): string
Return the Identity's DID
string
api/entities/Identity/index.ts:908
▸ unlinkChild(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Unlinks a child identity
| Name | Type |
|---|---|
args |
UnlinkChildParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Throws
if
- the
childis 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
api/entities/Identity/index.ts:977
▸ unlinkFromParent(opts?): Promise<GenericPolymeshTransaction<void, void>>
Unlinks this child identity from its parent
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Throws
if
- this identity doesn't have a parent
- the transaction signer is not the primary key of the child identity
Note
this method is of type NoArgsProcedureMethod, which means you can call unlinkFromParent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
api/entities/Identity/ChildIdentity.ts:83
▸ 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