Class: ChildIdentity
api/entities/Identity/ChildIdentity.ChildIdentity
Represents a child identity
Hierarchy
-
↳
ChildIdentity
Properties
assetPermissions
• assetPermissions: AssetPermissions
Inherited from
Defined in
api/entities/Identity/index.ts:128
authorizations
• authorizations: IdentityAuthorizations
Inherited from
Defined in
api/entities/Identity/index.ts:126
did
• did: string
Identity ID as stored in the blockchain
Inherited from
Defined in
api/entities/Identity/index.ts:123
portfolios
• portfolios: Portfolios
Inherited from
Defined in
api/entities/Identity/index.ts:127
uuid
• uuid: string
Inherited from
Defined in
Methods
areSecondaryAccountsFrozen
▸ areSecondaryAccountsFrozen(): Promise<boolean>
Check whether secondary Accounts are frozen
Returns
Promise<boolean>
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Identity.areSecondaryAccountsFrozen
Defined in
api/entities/Identity/index.ts:700
▸ areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<boolean> |
Returns
Promise<UnsubCallback>
Inherited from
Identity.areSecondaryAccountsFrozen
Defined in
api/entities/Identity/index.ts:701
checkRoles
▸ checkRoles(roles): Promise<CheckRolesResult>
Check whether this Identity possesses all specified roles
Parameters
| Name | Type |
|---|---|
roles | Role[] |
Returns
Promise<CheckRolesResult>
Inherited from
Defined in
api/entities/Identity/index.ts:483
exists
▸ exists(): Promise<boolean>
Determine whether this child Identity exists
Returns
Promise<boolean>
Note
asset Identities aren't considered to exist for this check
Overrides
Defined in
api/entities/Identity/ChildIdentity.ts:67
getAssetBalance
▸ getAssetBalance(args): Promise<BigNumber>
Retrieve the balance of a particular Asset
Parameters
| Name | Type |
|---|---|
args | Object |
args.ticker | string |
Returns
Promise<BigNumber>
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Defined in
api/entities/Identity/index.ts:204
▸ getAssetBalance(args): Promise<BigNumber>
Parameters
| Name | Type |
|---|---|
args | Object |
args.assetId | string |
Returns
Promise<BigNumber>
Inherited from
Defined in
api/entities/Identity/index.ts:205
▸ getAssetBalance(args, callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
args | Object |
args.ticker | string |
callback | SubCallback<BigNumber> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Identity/index.ts:206
▸ getAssetBalance(args, callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
args | Object |
args.assetId | string |
callback | SubCallback<BigNumber> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Identity/index.ts:211
getHeldAssets
▸ getHeldAssets(opts?): Promise<ResultSet<FungibleAsset>>
Retrieve a list of all Assets which were held at one point by this Identity
Parameters
| Name | Type |
|---|---|
opts | Object |
opts.order? | AssetHoldersOrderBy |
opts.size? | BigNumber |
opts.start? | BigNumber |
Returns
Promise<ResultSet<FungibleAsset>>
Note
uses the middlewareV2
Note
supports pagination
Inherited from
Defined in
api/entities/Identity/index.ts:378
getHeldNfts
▸ getHeldNfts(opts?): Promise<ResultSet<HeldNfts>>
Retrieve a list of all NftCollections which were held at one point by this Identity
Parameters
| Name | Type |
|---|---|
opts | Object |
opts.order? | NftHoldersOrderBy |
opts.size? | BigNumber |
opts.start? | BigNumber |
Returns
Note
uses the middlewareV2
Note
supports pagination
Inherited from
Defined in
api/entities/Identity/index.ts:425
getHistoricalInstructions
▸ getHistoricalInstructions(filter?): Promise<HistoricInstruction[]>
Retrieve all Instructions that have been associated with this Identity's DID
Parameters
| Name | Type |
|---|---|
filter? | Omit<HistoricalInstructionFilters, "identity"> |
Returns
Promise<HistoricInstruction[]>
Note
uses the middleware V2
Note
supports pagination
Inherited from
Identity.getHistoricalInstructions
Defined in
api/entities/Identity/index.ts:909
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
Defined in
api/entities/Identity/index.ts:554
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:641
getMultiSigSigners
▸ 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
Returns
Promise<MultiSigSigners[]>
Note
this query can be potentially SLOW depending on the number of MultiSigs present on the chain
Inherited from
Defined in
api/entities/Identity/index.ts:1046
getOffChainAuthorizationNonce
▸ getOffChainAuthorizationNonce(): Promise<BigNumber>
Returns the off chain authorization nonce for this Identity
Returns
Promise<BigNumber>
Inherited from
Identity.getOffChainAuthorizationNonce
Defined in
api/entities/Identity/index.ts:1124
getParentDid
▸ getParentDid(): Promise<null | Identity>
Returns the parent of this Identity (if any)
Returns
Promise<null | Identity>
Defined in
api/entities/Identity/ChildIdentity.ts:31
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:739
getPrimaryAccount
▸ getPrimaryAccount(): Promise<PermissionedAccount>
Retrieve the primary Account associated with the Identity
Returns
Promise<PermissionedAccount>
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Defined in
api/entities/Identity/index.ts:314
▸ getPrimaryAccount(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<PermissionedAccount> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Identity/index.ts:315
getSecondaryAccounts
▸ getSecondaryAccounts(paginationOpts?): Promise<ResultSet<PermissionedAccount>>
Get the list of secondary Accounts related to the Identity
Parameters
| Name | Type |
|---|---|
paginationOpts? | PaginationOptions |
Returns
Promise<ResultSet<PermissionedAccount>>
Note
supports pagination
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Defined in
api/entities/Identity/index.ts:792
▸ getSecondaryAccounts(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<PermissionedAccount[]> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Identity/index.ts:796
▸ getSecondaryAccounts(paginationOpts, callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
paginationOpts | PaginationOptions |
callback | SubCallback<PermissionedAccount[]> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Identity/index.ts:800
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
Defined in
api/entities/Identity/index.ts:507
getVenues
▸ getVenues(): Promise<Venue[]>
Retrieve all Venues created by this Identity
Returns
Promise<Venue[]>
Inherited from
Defined in
api/entities/Identity/index.ts:526
hasRole
▸ hasRole(role): Promise<boolean>
Check whether this Identity possesses the specified Role
Parameters
| Name | Type |
|---|---|
role | Role |
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Identity/index.ts:156
hasValidCdd
▸ hasValidCdd(): Promise<boolean>
Check whether this Identity has a valid CDD claim
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Identity/index.ts:262
isAssetPreApproved
▸ isAssetPreApproved(asset): Promise<boolean>
Returns whether or not this Identity has pre-approved a particular asset
Parameters
| Name | Type |
|---|---|
asset | string | BaseAsset |
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Identity/index.ts:1018
isCddProvider
▸ isCddProvider(): Promise<boolean>
Check whether this Identity is a CDD provider
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Identity/index.ts:295
isChild
▸ isChild(): Promise<boolean>
Check whether this Identity is a child Identity
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Identity/index.ts:973
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
entity | Entity<unknown, unknown> |
Returns
boolean
Inherited from
Defined in
isGcMember
▸ isGcMember(): Promise<boolean>
Check whether this Identity is Governance Committee member
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Identity/index.ts:278
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
| Name | Type |
|---|---|
paginationOpts? | PaginationOptions |
Returns
Inherited from
Defined in
api/entities/Identity/index.ts:984
toHuman
▸ toHuman(): string
Return the Identity's DID
Returns
string
Inherited from
Defined in
api/entities/Identity/index.ts:898
unlinkChild
▸ unlinkChild(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Unlinks a child identity
Parameters
| Name | Type |
|---|---|
args | UnlinkChildParams |
opts? | ProcedureOpts |
Returns
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
Inherited from
Defined in
api/entities/Identity/index.ts:966
unlinkFromParent
▸ unlinkFromParent(opts?): Promise<GenericPolymeshTransaction<void, void>>
Unlinks this child identity from its parent
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
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
Defined in
api/entities/Identity/ChildIdentity.ts:83
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type |
|---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type | Description |
|---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers